Neptune 数据库集群 API - Amazon Neptune
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

Neptune 数据库集群 API

结构:

操作:

DBCluster(结构)

包含 Amazon Neptune 数据库集群的详细信息。

此数据类型用作 DescribeDBClusters(操作) 操作中的响应元素。

Fields

  • AllocatedStorage – 数字 (integer)。

    AllocatedStorage 始终返回 1,因为 Neptune 数据库集群存储大小不固定,而是会根据需要自动调整。

  • AssociatedRoles— 数组DBClusterRoleDBCluster 角色对象。

    提供与数据库集群关联的 Amazon Identity and Access Management (IAM) 角色的列表。与数据库集群关联的 IAM 角色授予数据库集群代表您访问其他 Amazon 服务的权限。

  • AutomaticRestartTime – 时间戳.

    数据库群集将自动重新启动的时间。

  • AvailabilityZones— 一个 AvaililityZone 的数组 — UTF-8 字符串。

    提供可在其上创建数据库集群中实例的 EC2 可用区的列表。

  • BacktrackConsumedChangeRecords – 数字 (long)。

    不受 Neptune 支持。

  • BacktrackWindow – 数字 (long)。

    不受 Neptune 支持。

  • BackupRetentionPeriod – 数字 (integer)。

    指定自动数据库快照的保留天数。

  • Capacity – 数字 (integer)。

    不受 Neptune 支持。

  • CloneGroupId – UTF-8 字符串。

    标识数据库集群与之关联的克隆组。

  • ClusterCreateTime – 时间戳.

    指定创建数据库集群的时间,采用通用协调时间 (UTC)。

  • CopyTagsToSnapshot – Boolean.

    如果设置为true,则标签将复制到创建的数据库集群的任何快照中。

  • CrossAccountClone – Boolean.

    如果设置为true,则可以跨账户克隆数据库群集。

  • DatabaseName – UTF-8 字符串。

    包含此数据库集群在创建时提供的初始数据库的名称(如果在创建数据库集群时指定了初始数据库)。在数据库集群的使用期间会始终返回同一名称。

  • DBClusterArn – UTF-8 字符串。

    数据库集群的 Amazon 资源名称 (ARN)。

  • DBClusterIdentifier – UTF-8 字符串。

    包含用户提供的数据库集群标识符。此标识符是识别数据库集群的唯一键。

  • DBClusterMembers— 数组DBClusterMember数据库集群成员对象。

    提供组成数据库集群的实例的列表。

  • DBClusterParameterGroup – UTF-8 字符串。

    指定数据库集群的数据库集群参数组名称。

  • DbClusterResourceId – UTF-8 字符串。

    数据库集群在 Amazon 区域中唯一的不可变标识符。只要访问了用户数据库集群的 Amazon KMS 密钥,就可在 Amazon CloudTrail 日志条目中找到此标识符。

  • DBSubnetGroup – UTF-8 字符串。

    指定与数据库集群关联的子网组的信息,包括名称、描述和子网组中的子网。

  • DeletionProtection – Boolean.

    指示数据库集群是否已启用删除保护。在启用删除保护时,无法删除数据库。

  • EarliestBacktrackTime – 时间戳.

    不受 Neptune 支持。

  • EarliestRestorableTime – 时间戳.

    指定数据库可以使用时间点还原的最早还原时间。

  • EnabledCloudwatchLogsExports – UTF-8 字符串数组。

    此数据库集群配置为导出到 CloudWatch Logs 的日志类型的列表。

  • Endpoint – UTF-8 字符串。

    指定数据库集群的主实例的连接终端节点。

  • Engine – UTF-8 字符串。

    提供要用于此数据库集群的数据库引擎的名称。

  • EngineVersion – UTF-8 字符串。

    指示数据库引擎版本。

  • HostedZoneId – UTF-8 字符串。

    指定在您创建托管区域时 Amazon Route 53 分配的 ID。

  • IAMDatabaseAuthenticationEnabled – Boolean.

    如果启用了 Amazon Identity and Access Management (IAM) 账户与数据库账户之间的映射,则为 true,否则为 false。

  • KmsKeyId – UTF-8 字符串。

    如果StorageEncrypted为 true,则为加密数据库集群的 Amazon KMS 密钥标识符。

  • LatestRestorableTime – 时间戳.

    指定数据库可以使用时间点还原的最新还原时间。

  • MultiAZ – Boolean.

    指定数据库集群是否在多个可用区中有实例。

  • PendingModifiedValues – 一个 ClusterPendingModifiedValues 对象。

    不受 Neptune 支持。

  • PercentProgress – UTF-8 字符串。

    指定操作的进度百分比。

  • Port – 数字 (integer)。

    指定数据库引擎侦听的端口。

  • PreferredBackupWindow – UTF-8 字符串。

    指定在启用自动备份时,自动执行备份的日常时间范围,如 BackupRetentionPeriod 所规定。

  • PreferredMaintenanceWindow – UTF-8 字符串。

    指定可进行系统维护的每周时间范围(采用通用协调时间 (UTC))。

  • ReaderEndpoint – UTF-8 字符串。

    数据库集群的读取器终端节点。数据库集群的读取器终端节点跨数据库集群中可用的只读副本,实现连接的负载均衡。当客户端请求与读取器终端节点的新连接时,Neptune 将在数据库集群中的只读副本之间分配连接请求。该功能可帮助跨数据库集群中的多个只读副本平衡读取工作负载。

    如果发生了故障转移并且连接到的只读副本将提升到主实例,则将删除您的连接。要继续向集群中的其他只读副本发送读取工作负载,您可以随后重新连接到读取器终端节点。

  • ReadReplicaIdentifiers— 一个 ReadReplicaIdentifier 的数组 — UTF-8 字符串。

    包含一个或多个与此数据库集群关联的只读副本的标识符。

  • ReplicationSourceIdentifier – UTF-8 字符串。

    不受 Neptune 支持。

  • ReplicationType – UTF-8 字符串。

    不受 Neptune 支持。

  • Status – UTF-8 字符串。

    指定此数据库集群的当前状态。

  • StorageEncrypted – Boolean.

    指定数据库集群是否已加密。

  • VpcSecurityGroups— 数组VpcSecurityGroupMembershipVpcSecurityGroupMembership 对象。

    提供数据库集群所属的 VPC 安全组的列表。

DBCluster 用作下列对象的响应元素:

DBClusterMember(结构)

包含有关属于数据库集群的实例的信息。

Fields

  • DBClusterParameterGroupStatus – UTF-8 字符串。

    指定数据库集群的此成员的数据库集群参数组状态。

  • DBInstanceIdentifier – UTF-8 字符串。

    指定数据库集群的此成员的实例标识符。

  • IsClusterWriter – Boolean.

    如果集群成员是数据库集群的主实例,值为 true,否则为 false

  • PromotionTier – 数字 (integer)。

    该值指定在现有主实例发生故障后将只读副本提升为主实例的顺序。

DBClusterRole(结构)

描述与数据库集群关联的 Amazon Identity and Access Management (IAM) 角色。

Fields

  • FeatureName – UTF-8 字符串。

    与 Amazon Identity and Access Management (IAM) 角色关联的功能的名称。有关支持的功能名称的列表,请参阅DescribeDBEngineVersions.

  • RoleArn – UTF-8 字符串。

    与数据库集群关联的 IAM 角色的 Amazon 资源名称 (ARN)。

  • Status – UTF-8 字符串。

    描述 IAM 角色与数据库集群之间关联的状态。Status 属性返回以下值之一:

    • ACTIVE-该 IAM 角色 ARN 已与数据库集群关联,可用于代表您访问其他 Amazon 服务。

    • PENDING - 与数据库集群关联的 IAM 角色 ARN。

    • INVALID-该 IAM 角色 ARN 已与数据库集群关联,但数据库集群无法代入 IAM 角色以代表您访问其他 Amazon 服务。

ClusterPendingModifiedValues(结构)

定义数据库集群的待处理更改。

Fields

  • PendingCloudwatchLogsExports – 一个 PendingCloudwatchLogsExports 对象。

    PendingCloudwatchLogsExports 结构指定了已启用和已禁用 CloudWatch Logs 的待处理更改。

CreateDBCluster(操作)

        此 API 的 Amazon CLI 名称为:。create-db-cluster,并且 Python 名称是:create_db_cluster.

创建新的 Amazon Neptune 数据库集群。

您可以使用 ReplicationSourceIdentifier 参数创建数据库集群,作为其他数据库集群或 Amazon Neptune 数据库实例的只读副本。

请注意,当您直接使用 CreateDBCluster 创建新的集群时,默认情况下会禁用删除保护(在控制台中创建新的生产集群时,默认情况下会启用删除保护)。仅在数据库集群的 DeletionProtection 字段设置为 false 时,才能删除数据库集群。

请求

  • AvailabilityZones(在 CLI 中:--availability-zones,或者在 Python 中:availability_zones) — 一个 AvaililityZone 的数组 — UTF-8 字符串。

    可在其中创建数据库集群的实例的 EC2 可用区列表。

  • BackupRetentionPeriod(在 CLI 中:--backup-retention-period,或者在 Python 中:backup_retention_period) – 数字 (integer)。

    自动备份的保留天数。您必须指定最小值 1。

    默认值:1

    约束:

    • 值必须介于 1 到 35 之间

  • CopyTagsToSnapshot(在 CLI 中:--copy-tags-to-snapshot,或者在 Python 中:copy_tags_to_snapshot) – Boolean.

    如果设置为true,则标签将复制到创建的数据库集群的任何快照中。

  • DatabaseName(在 CLI 中:--database-name,或者在 Python 中:database_name) – UTF-8 字符串。

    数据库的名称,最多 64 个字母和数字字符。如果您不提供名称,Amazon Neptune 就不会在您正在创建的数据库集群中创建数据库。

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或者在 Python 中:db_cluster_identifier) –必填项:必需 UTF-8 字符串。

    数据库集群标识符。该参数作为一个小写字符串存储。

    约束:

    • 必须包含 1 到 63 个字母、数字或连字符。

    • 第一个字符必须是字母。

    • 不能以连字符结束或包含两个连续连字符。

    示例:my-cluster1

  • DBClusterParameterGroupName(在 CLI 中:--db-cluster-parameter-group-name,或者在 Python 中:db_cluster_parameter_group_name) – UTF-8 字符串。

    要与该数据库集群关联的数据库集群参数组的名称。如果省略此参数,则使用默认值。

    约束:

    • 如果提供,必须与现有 DBClusterParameterGroup 的名称匹配。

  • DBSubnetGroupName(在 CLI 中:--db-subnet-group-name,或者在 Python 中:db_subnet_group_name) – UTF-8 字符串。

    与此数据库集群关联的数据库子网组。

    约束:必须与现有 DB子网组的名称匹配。不能是默认值。

    示例:mySubnetgroup

  • DeletionProtection(在 CLI 中:--deletion-protection,或者在 Python 中:deletion_protection) – Boolean.

    一个值,指示数据库集群是否已启用删除保护。在启用删除保护时,无法删除数据库。默认情况下,将启用删除保护。

  • EnableCloudwatchLogsExports(在 CLI 中:--enable-cloudwatch-logs-exports,或者在 Python 中:enable_cloudwatch_logs_exports) – 一个 UTF-8 字符串数组。

    需要启用以导出到 CloudWatch Logs 的日志类型的列表。

  • EnableIAMDatabaseAuthentication(在 CLI 中:--enable-iam-database-authentication,或者在 Python 中:enable_iam_database_authentication) – Boolean.

    如果设置为true,为整个数据库集群启用 Amazon Identity and Access Management (IAM) 身份验证(无法在实例级别进行设置)。

    默认值: false.

  • Engine(在 CLI 中:--engine,或者在 Python 中:engine) –必填项:必需 UTF-8 字符串。

    用于此数据库集群的数据库引擎的名称。

    有效值:neptune

  • EngineVersion(在 CLI 中:--engine-version,或者在 Python 中:engine_version) – UTF-8 字符串。

    要用于新数据库集群的数据库引擎的版本号。

    示例:1.0.2.1

  • KmsKeyId(在 CLI 中:--kms-key-id,或者在 Python 中:kms_key_id) – UTF-8 字符串。

    加密数据库集群的 Amazon KMS 密钥标识符。

    KMS 密钥标识符是 KMS 加密密钥的 Amazon 资源名称 (ARN)。如果您创建数据库集群时使用的 Amazon 账户,是拥有加密新数据库集群所用 KMS 加密密钥的同一个账户,则您可以使用 KMS 密钥别名,而不用 KMS 加密钥的 ARN。

    未在 KmsKeyId 中指定加密密钥时:

    • 如果 ReplicationSourceIdentifier 标识了加密的源,则 Amazon Neptune 将使用加密源所用的加密密钥。否则,Amazon Neptune 将使用您的默认加密密钥。

    • 如果 StorageEncrypted 参数为 true,并且未指定 ReplicationSourceIdentifier,则 Amazon Neptune 将使用您的默认加密密钥。

    Amazon KMS 将为您的亚马逊账户创建默认加密密钥。您的亚马逊账户在每个亚马逊区域都有一个不同的默认加密钥。

    如果您在其他 Amazon 区域中创建加密数据库集群的只读副本,则必须将KmsKeyId设置为在目标亚马逊地区有效的 KMS 密钥 ID。此密钥用于在该 Amazon 区域中加密只读副本。

  • Port(在 CLI 中:--port,或者在 Python 中:port) – 数字 (integer)。

    数据库集群中的实例接受连接的端口号。

    默认值:8182

  • PreferredBackupWindow(在 CLI 中:--preferred-backup-window,或者在 Python 中:preferred_backup_window) – UTF-8 字符串。

    使用 BackupRetentionPeriod 参数启用了自动备份时,自动执行备份的日常时间范围。

    默认值是从每个亚马逊区域的 8 小时间段中随机选择的 30 分钟时间。若要查看可用的时间块,请参阅调整首选维护时段中的Amazon Neptune 用户指南。

    约束:

    • 必须采用 hh24:mi-hh24:mi 格式。

    • 必须采用通用协调时间 (UTC)。

    • 不得与首选维护时段冲突。

    • 必须至少为 30 分钟。

  • PreferredMaintenanceWindow(在 CLI 中:--preferred-maintenance-window,或者在 Python 中:preferred_maintenance_window) – UTF-8 字符串。

    可进行系统维护的每周时间范围(采用通用协调时间 (UTC))。

    格式:ddd:hh24:mi-ddd:hh24:mi

    默认值是从每亚马逊区域 8 小时的时间段中随机选择的 30 分钟时段 (随机选取周中的某天进行)。若要查看可用的时间块,请参阅调整首选维护时段中的Amazon Neptune 用户指南。

    有效天:Mon、Tue、Wing、Tu、Fra、Sat、Sun。

    约束:至少为 30 分钟的时段。

  • PreSignedUrl(在 CLI 中:--pre-signed-url,或者在 Python 中:pre_signed_url) – UTF-8 字符串。

    当前不支持此参数。

  • ReplicationSourceIdentifier(在 CLI 中:--replication-source-identifier,或者在 Python 中:replication_source_identifier) – UTF-8 字符串。

    源数据库实例或数据库集群(如果该数据库集群是作为只读副本创建的)的 Amazon 资源名称 (ARN)。

  • StorageEncrypted(在 CLI 中:--storage-encrypted,或者在 Python 中:storage_encrypted) – Boolean.

    指定数据库集群是否已加密。

  • Tags(在 CLI 中:--tags,或者在 Python 中:tags) — 数组标签标记对象。

    分配到新数据库集群的标签。

  • VpcSecurityGroupIds(在 CLI 中:--vpc-security-group-ids,或者在 Python 中:vpc_security_group_ids) — VPC 安全性组 — UTF-8 字符串。

    要与此数据库集群关联的 EC2 VPC 安全组的列表。

响应

包含 Amazon Neptune 数据库集群的详细信息。

此数据类型用作 DescribeDBClusters(操作) 操作中的响应元素。

  • AllocatedStorage(在 CLI 中:--allocated-storage,或者在 Python 中:allocated_storage) – 数字 (integer)。

    AllocatedStorage 始终返回 1,因为 Neptune 数据库集群存储大小不固定,而是会根据需要自动调整。

  • AssociatedRoles(在 CLI 中:--associated-roles,或者在 Python 中:associated_roles) — 数组DBClusterRoleDBCluster 角色对象。

    提供与数据库集群关联的 Amazon Identity and Access Management (IAM) 角色的列表。与数据库集群关联的 IAM 角色授予数据库集群代表您访问其他 Amazon 服务的权限。

  • AutomaticRestartTime(在 CLI 中:--automatic-restart-time,或者在 Python 中:automatic_restart_time) – 时间戳.

    数据库群集将自动重新启动的时间。

  • AvailabilityZones(在 CLI 中:--availability-zones,或者在 Python 中:availability_zones) — 一个 AvaililityZone 的数组 — UTF-8 字符串。

    提供可在其上创建数据库集群中实例的 EC2 可用区的列表。

  • BacktrackConsumedChangeRecords(在 CLI 中:--backtrack-consumed-change-records,或者在 Python 中:backtrack_consumed_change_records) – 数字 (long)。

    不受 Neptune 支持。

  • BacktrackWindow(在 CLI 中:--backtrack-window,或者在 Python 中:backtrack_window) – 数字 (long)。

    不受 Neptune 支持。

  • BackupRetentionPeriod(在 CLI 中:--backup-retention-period,或者在 Python 中:backup_retention_period) – 数字 (integer)。

    指定自动数据库快照的保留天数。

  • Capacity(在 CLI 中:--capacity,或者在 Python 中:capacity) – 数字 (integer)。

    不受 Neptune 支持。

  • CloneGroupId(在 CLI 中:--clone-group-id,或者在 Python 中:clone_group_id) – UTF-8 字符串。

    标识数据库集群与之关联的克隆组。

  • ClusterCreateTime(在 CLI 中:--cluster-create-time,或者在 Python 中:cluster_create_time) – 时间戳.

    指定创建数据库集群的时间,采用通用协调时间 (UTC)。

  • CopyTagsToSnapshot(在 CLI 中:--copy-tags-to-snapshot,或者在 Python 中:copy_tags_to_snapshot) – Boolean.

    如果设置为true,则标签将复制到创建的数据库集群的任何快照中。

  • CrossAccountClone(在 CLI 中:--cross-account-clone,或者在 Python 中:cross_account_clone) – Boolean.

    如果设置为true,则可以跨账户克隆数据库群集。

  • DatabaseName(在 CLI 中:--database-name,或者在 Python 中:database_name) – UTF-8 字符串。

    包含此数据库集群在创建时提供的初始数据库的名称(如果在创建数据库集群时指定了初始数据库)。在数据库集群的使用期间会始终返回同一名称。

  • DBClusterArn(在 CLI 中:--db-cluster-arn,或者在 Python 中:db_cluster_arn) – UTF-8 字符串。

    数据库集群的 Amazon 资源名称 (ARN)。

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或者在 Python 中:db_cluster_identifier) – UTF-8 字符串。

    包含用户提供的数据库集群标识符。此标识符是识别数据库集群的唯一键。

  • DBClusterMembers(在 CLI 中:--db-cluster-members,或者在 Python 中:db_cluster_members) — 数组DBClusterMemberDBCluster 成员对象。

    提供组成数据库集群的实例的列表。

  • DBClusterParameterGroup(在 CLI 中:--db-cluster-parameter-group,或者在 Python 中:db_cluster_parameter_group) – UTF-8 字符串。

    指定数据库集群的数据库集群参数组名称。

  • DbClusterResourceId(在 CLI 中:--db-cluster-resource-id,或者在 Python 中:db_cluster_resource_id) – UTF-8 字符串。

    数据库集群在 Amazon 区域中唯一的不可变标识符。只要访问了用户数据库集群的 Amazon KMS 密钥,就可在 Amazon CloudTrail 日志条目中找到此标识符。

  • DBSubnetGroup(在 CLI 中:--db-subnet-group,或者在 Python 中:db_subnet_group) – UTF-8 字符串。

    指定与数据库集群关联的子网组的信息,包括名称、描述和子网组中的子网。

  • DeletionProtection(在 CLI 中:--deletion-protection,或者在 Python 中:deletion_protection) – Boolean.

    指示数据库集群是否已启用删除保护。在启用删除保护时,无法删除数据库。

  • EarliestBacktrackTime(在 CLI 中:--earliest-backtrack-time,或者在 Python 中:earliest_backtrack_time) – 时间戳.

    不受 Neptune 支持。

  • EarliestRestorableTime(在 CLI 中:--earliest-restorable-time,或者在 Python 中:earliest_restorable_time) – 时间戳.

    指定数据库可以使用时间点还原的最早还原时间。

  • EnabledCloudwatchLogsExports(在 CLI 中:--enabled-cloudwatch-logs-exports,或者在 Python 中:enabled_cloudwatch_logs_exports) – 一个 UTF-8 字符串数组。

    此数据库集群配置为导出到 CloudWatch Logs 的日志类型的列表。

  • Endpoint(在 CLI 中:--endpoint,或者在 Python 中:endpoint) – UTF-8 字符串。

    指定数据库集群的主实例的连接终端节点。

  • Engine(在 CLI 中:--engine,或者在 Python 中:engine) – UTF-8 字符串。

    提供要用于此数据库集群的数据库引擎的名称。

  • EngineVersion(在 CLI 中:--engine-version,或者在 Python 中:engine_version) – UTF-8 字符串。

    指示数据库引擎版本。

  • HostedZoneId(在 CLI 中:--hosted-zone-id,或者在 Python 中:hosted_zone_id) – UTF-8 字符串。

    指定在您创建托管区域时 Amazon Route 53 分配的 ID。

  • IAMDatabaseAuthenticationEnabled(在 CLI 中:--iam-database-authentication-enabled,或者在 Python 中:iam_database_authentication_enabled) – Boolean.

    如果启用了 Amazon Identity and Access Management (IAM) 账户与数据库账户之间的映射,则为 true,否则为 false。

  • KmsKeyId(在 CLI 中:--kms-key-id,或者在 Python 中:kms_key_id) – UTF-8 字符串。

    如果StorageEncrypted为 true,则为加密数据库集群的 Amazon KMS 密钥标识符。

  • LatestRestorableTime(在 CLI 中:--latest-restorable-time,或者在 Python 中:latest_restorable_time) – 时间戳.

    指定数据库可以使用时间点还原的最新还原时间。

  • MultiAZ(在 CLI 中:--multi-az,或者在 Python 中:multi_az) – Boolean.

    指定数据库集群是否在多个可用区中有实例。

  • PendingModifiedValues(在 CLI 中:--pending-modified-values,或者在 Python 中:pending_modified_values) — AClusterPendingModifiedValues对象。

    不受 Neptune 支持。

  • PercentProgress(在 CLI 中:--percent-progress,或者在 Python 中:percent_progress) – UTF-8 字符串。

    指定操作的进度百分比。

  • Port(在 CLI 中:--port,或者在 Python 中:port) – 数字 (integer)。

    指定数据库引擎侦听的端口。

  • PreferredBackupWindow(在 CLI 中:--preferred-backup-window,或者在 Python 中:preferred_backup_window) – UTF-8 字符串。

    指定在启用自动备份时,自动执行备份的日常时间范围,如 BackupRetentionPeriod 所规定。

  • PreferredMaintenanceWindow(在 CLI 中:--preferred-maintenance-window,或者在 Python 中:preferred_maintenance_window) – UTF-8 字符串。

    指定可进行系统维护的每周时间范围(采用通用协调时间 (UTC))。

  • ReaderEndpoint(在 CLI 中:--reader-endpoint,或者在 Python 中:reader_endpoint) – UTF-8 字符串。

    数据库集群的读取器终端节点。数据库集群的读取器终端节点跨数据库集群中可用的只读副本,实现连接的负载均衡。当客户端请求与读取器终端节点的新连接时,Neptune 将在数据库集群中的只读副本之间分配连接请求。该功能可帮助跨数据库集群中的多个只读副本平衡读取工作负载。

    如果发生了故障转移并且连接到的只读副本将提升到主实例,则将删除您的连接。要继续向集群中的其他只读副本发送读取工作负载,您可以随后重新连接到读取器终端节点。

  • ReadReplicaIdentifiers(在 CLI 中:--read-replica-identifiers,或者在 Python 中:read_replica_identifiers) — 一个 ReadReplicaIdentifier 的数组 — UTF-8 字符串。

    包含一个或多个与此数据库集群关联的只读副本的标识符。

  • ReplicationSourceIdentifier(在 CLI 中:--replication-source-identifier,或者在 Python 中:replication_source_identifier) – UTF-8 字符串。

    不受 Neptune 支持。

  • ReplicationType(在 CLI 中:--replication-type,或者在 Python 中:replication_type) – UTF-8 字符串。

    不受 Neptune 支持。

  • Status(在 CLI 中:--status,或者在 Python 中:status) – UTF-8 字符串。

    指定此数据库集群的当前状态。

  • StorageEncrypted(在 CLI 中:--storage-encrypted,或者在 Python 中:storage_encrypted) – Boolean.

    指定数据库集群是否已加密。

  • VpcSecurityGroups(在 CLI 中:--vpc-security-groups,或者在 Python 中:vpc_security_groups) — 数组VpcSecurityGroupMembershipVpcSecurityGroupMembership 对象。

    提供数据库集群所属的 VPC 安全组的列表。

DeleteDBCluster(操作)

        此 API 的 Amazon CLI 名称为:。delete-db-cluster,并且 Python 名称是:delete_db_cluster.

DeleteDBCluster 操作将删除先前预置的数据库集群。在您删除数据库集群时,会删除该数据库集群的所有自动备份,且无法恢复。系统不会删除指定数据库集群的手动数据库集群快照。

请注意,如果启用了删除保护,则无法删除数据库集群。要删除数据库集群,您必须先将其 DeletionProtection 字段设置为 False

请求

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或者在 Python 中:db_cluster_identifier) –必填项:必需 UTF-8 字符串。

    要删除的数据库集群的数据库集群标识符。该参数不区分大小写。

    约束:

    • 必须匹配现有 DBClusterIdentifier。

  • FinalDBSnapshotIdentifier(在 CLI 中:--final-db-snapshot-identifier,或者在 Python 中:final_db_snapshot_identifier) – UTF-8 字符串。

    SkipFinalSnapshot 设置为 false 时,新创建数据库集群快照的数据库集群快照标识符。

    注意

    指定此参数并且将 SkipFinalShapshot 参数设置为 true 会导致错误。

    约束:

    • 必须为 1 到 255 个字母、数字或连字符。

    • 第一个字符必须是字母

    • 不能以连字符结束或包含两个连续连字符

  • SkipFinalSnapshot(在 CLI 中:--skip-final-snapshot,或者在 Python 中:skip_final_snapshot) – Boolean.

    确定删除数据库集群之前是否创建最终数据库集群快照。如果指定 true,则不创建数据库集群快照。如果指定 false,则删除数据库集群之前创建一个数据库集群快照。

    注意

    如果 SkipFinalSnapshotfalse,则必须指定 FinalDBSnapshotIdentifier

    默认值:false

响应

包含 Amazon Neptune 数据库集群的详细信息。

此数据类型用作 DescribeDBClusters(操作) 操作中的响应元素。

  • AllocatedStorage(在 CLI 中:--allocated-storage,或者在 Python 中:allocated_storage) – 数字 (integer)。

    AllocatedStorage 始终返回 1,因为 Neptune 数据库集群存储大小不固定,而是会根据需要自动调整。

  • AssociatedRoles(在 CLI 中:--associated-roles,或者在 Python 中:associated_roles) — 数组DBClusterRoleDBCluster 角色对象。

    提供与数据库集群关联的 Amazon Identity and Access Management (IAM) 角色的列表。与数据库集群关联的 IAM 角色授予数据库集群代表您访问其他 Amazon 服务的权限。

  • AutomaticRestartTime(在 CLI 中:--automatic-restart-time,或者在 Python 中:automatic_restart_time) – 时间戳.

    数据库群集将自动重新启动的时间。

  • AvailabilityZones(在 CLI 中:--availability-zones,或者在 Python 中:availability_zones) — 一个 AvaililityZone 的数组 — UTF-8 字符串。

    提供可在其上创建数据库集群中实例的 EC2 可用区的列表。

  • BacktrackConsumedChangeRecords(在 CLI 中:--backtrack-consumed-change-records,或者在 Python 中:backtrack_consumed_change_records) – 数字 (long)。

    不受 Neptune 支持。

  • BacktrackWindow(在 CLI 中:--backtrack-window,或者在 Python 中:backtrack_window) – 数字 (long)。

    不受 Neptune 支持。

  • BackupRetentionPeriod(在 CLI 中:--backup-retention-period,或者在 Python 中:backup_retention_period) – 数字 (integer)。

    指定自动数据库快照的保留天数。

  • Capacity(在 CLI 中:--capacity,或者在 Python 中:capacity) – 数字 (integer)。

    不受 Neptune 支持。

  • CloneGroupId(在 CLI 中:--clone-group-id,或者在 Python 中:clone_group_id) – UTF-8 字符串。

    标识数据库集群与之关联的克隆组。

  • ClusterCreateTime(在 CLI 中:--cluster-create-time,或者在 Python 中:cluster_create_time) – 时间戳.

    指定创建数据库集群的时间,采用通用协调时间 (UTC)。

  • CopyTagsToSnapshot(在 CLI 中:--copy-tags-to-snapshot,或者在 Python 中:copy_tags_to_snapshot) – Boolean.

    如果设置为true,则标签将复制到创建的数据库集群的任何快照中。

  • CrossAccountClone(在 CLI 中:--cross-account-clone,或者在 Python 中:cross_account_clone) – Boolean.

    如果设置为true,则可以跨账户克隆数据库群集。

  • DatabaseName(在 CLI 中:--database-name,或者在 Python 中:database_name) – UTF-8 字符串。

    包含此数据库集群在创建时提供的初始数据库的名称(如果在创建数据库集群时指定了初始数据库)。在数据库集群的使用期间会始终返回同一名称。

  • DBClusterArn(在 CLI 中:--db-cluster-arn,或者在 Python 中:db_cluster_arn) – UTF-8 字符串。

    数据库集群的 Amazon 资源名称 (ARN)。

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或者在 Python 中:db_cluster_identifier) – UTF-8 字符串。

    包含用户提供的数据库集群标识符。此标识符是识别数据库集群的唯一键。

  • DBClusterMembers(在 CLI 中:--db-cluster-members,或者在 Python 中:db_cluster_members) — 数组DBClusterMemberDBCluster 成员对象。

    提供组成数据库集群的实例的列表。

  • DBClusterParameterGroup(在 CLI 中:--db-cluster-parameter-group,或者在 Python 中:db_cluster_parameter_group) – UTF-8 字符串。

    指定数据库集群的数据库集群参数组名称。

  • DbClusterResourceId(在 CLI 中:--db-cluster-resource-id,或者在 Python 中:db_cluster_resource_id) – UTF-8 字符串。

    数据库集群在 Amazon 区域中唯一的不可变标识符。只要访问了用户数据库集群的 Amazon KMS 密钥,就可在 Amazon CloudTrail 日志条目中找到此标识符。

  • DBSubnetGroup(在 CLI 中:--db-subnet-group,或者在 Python 中:db_subnet_group) – UTF-8 字符串。

    指定与数据库集群关联的子网组的信息,包括名称、描述和子网组中的子网。

  • DeletionProtection(在 CLI 中:--deletion-protection,或者在 Python 中:deletion_protection) – Boolean.

    指示数据库集群是否已启用删除保护。在启用删除保护时,无法删除数据库。

  • EarliestBacktrackTime(在 CLI 中:--earliest-backtrack-time,或者在 Python 中:earliest_backtrack_time) – 时间戳.

    不受 Neptune 支持。

  • EarliestRestorableTime(在 CLI 中:--earliest-restorable-time,或者在 Python 中:earliest_restorable_time) – 时间戳.

    指定数据库可以使用时间点还原的最早还原时间。

  • EnabledCloudwatchLogsExports(在 CLI 中:--enabled-cloudwatch-logs-exports,或者在 Python 中:enabled_cloudwatch_logs_exports) – 一个 UTF-8 字符串数组。

    此数据库集群配置为导出到 CloudWatch Logs 的日志类型的列表。

  • Endpoint(在 CLI 中:--endpoint,或者在 Python 中:endpoint) – UTF-8 字符串。

    指定数据库集群的主实例的连接终端节点。

  • Engine(在 CLI 中:--engine,或者在 Python 中:engine) – UTF-8 字符串。

    提供要用于此数据库集群的数据库引擎的名称。

  • EngineVersion(在 CLI 中:--engine-version,或者在 Python 中:engine_version) – UTF-8 字符串。

    指示数据库引擎版本。

  • HostedZoneId(在 CLI 中:--hosted-zone-id,或者在 Python 中:hosted_zone_id) – UTF-8 字符串。

    指定在您创建托管区域时 Amazon Route 53 分配的 ID。

  • IAMDatabaseAuthenticationEnabled(在 CLI 中:--iam-database-authentication-enabled,或者在 Python 中:iam_database_authentication_enabled) – Boolean.

    如果启用了 Amazon Identity and Access Management (IAM) 账户与数据库账户之间的映射,则为 true,否则为 false。

  • KmsKeyId(在 CLI 中:--kms-key-id,或者在 Python 中:kms_key_id) – UTF-8 字符串。

    如果StorageEncrypted为 true,则为加密数据库集群的 Amazon KMS 密钥标识符。

  • LatestRestorableTime(在 CLI 中:--latest-restorable-time,或者在 Python 中:latest_restorable_time) – 时间戳.

    指定数据库可以使用时间点还原的最新还原时间。

  • MultiAZ(在 CLI 中:--multi-az,或者在 Python 中:multi_az) – Boolean.

    指定数据库集群是否在多个可用区中有实例。

  • PendingModifiedValues(在 CLI 中:--pending-modified-values,或者在 Python 中:pending_modified_values) — AClusterPendingModifiedValues对象。

    不受 Neptune 支持。

  • PercentProgress(在 CLI 中:--percent-progress,或者在 Python 中:percent_progress) – UTF-8 字符串。

    指定操作的进度百分比。

  • Port(在 CLI 中:--port,或者在 Python 中:port) – 数字 (integer)。

    指定数据库引擎侦听的端口。

  • PreferredBackupWindow(在 CLI 中:--preferred-backup-window,或者在 Python 中:preferred_backup_window) – UTF-8 字符串。

    指定在启用自动备份时,自动执行备份的日常时间范围,如 BackupRetentionPeriod 所规定。

  • PreferredMaintenanceWindow(在 CLI 中:--preferred-maintenance-window,或者在 Python 中:preferred_maintenance_window) – UTF-8 字符串。

    指定可进行系统维护的每周时间范围(采用通用协调时间 (UTC))。

  • ReaderEndpoint(在 CLI 中:--reader-endpoint,或者在 Python 中:reader_endpoint) – UTF-8 字符串。

    数据库集群的读取器终端节点。数据库集群的读取器终端节点跨数据库集群中可用的只读副本,实现连接的负载均衡。当客户端请求与读取器终端节点的新连接时,Neptune 将在数据库集群中的只读副本之间分配连接请求。该功能可帮助跨数据库集群中的多个只读副本平衡读取工作负载。

    如果发生了故障转移并且连接到的只读副本将提升到主实例,则将删除您的连接。要继续向集群中的其他只读副本发送读取工作负载,您可以随后重新连接到读取器终端节点。

  • ReadReplicaIdentifiers(在 CLI 中:--read-replica-identifiers,或者在 Python 中:read_replica_identifiers) — 一个 ReadReplicaIdentifier 的数组 — UTF-8 字符串。

    包含一个或多个与此数据库集群关联的只读副本的标识符。

  • ReplicationSourceIdentifier(在 CLI 中:--replication-source-identifier,或者在 Python 中:replication_source_identifier) – UTF-8 字符串。

    不受 Neptune 支持。

  • ReplicationType(在 CLI 中:--replication-type,或者在 Python 中:replication_type) – UTF-8 字符串。

    不受 Neptune 支持。

  • Status(在 CLI 中:--status,或者在 Python 中:status) – UTF-8 字符串。

    指定此数据库集群的当前状态。

  • StorageEncrypted(在 CLI 中:--storage-encrypted,或者在 Python 中:storage_encrypted) – Boolean.

    指定数据库集群是否已加密。

  • VpcSecurityGroups(在 CLI 中:--vpc-security-groups,或者在 Python 中:vpc_security_groups) — 数组VpcSecurityGroupMembershipVpcSecurityGroupMembership 对象。

    提供数据库集群所属的 VPC 安全组的列表。

ModifyDBCluster(操作)

        此 API 的 Amazon CLI 名称为:。modify-db-cluster,并且 Python 名称是:modify_db_cluster.

修改数据库集群的设置。您可通过在请求中指定这些参数以及新值,更改一个或多个数据库配置参数。

请求

  • ApplyImmediately(在 CLI 中:--apply-immediately,或者在 Python 中:apply_immediately) – Boolean.

    指定应尽快异步应用此请求中修改及任何待处理修改的值,无论数据库集群的 PreferredMaintenanceWindow 设置如何。如果此参数设置为 false,则在下一个维护时段中应用对数据库集群的更改。

    这些区域有:ApplyImmediately参数仅影响NewDBClusterIdentifier值。如果您设置ApplyImmediately参数值设置为 false,然后更改为NewDBClusterIdentifier值在下一维护时段内应用。所有其他更改会立即应用,而不管 ApplyImmediately 参数的值如何。

    默认值:false

  • BackupRetentionPeriod(在 CLI 中:--backup-retention-period,或者在 Python 中:backup_retention_period) – 数字 (integer)。

    自动备份的保留天数。您必须指定最小值 1。

    默认值:1

    约束:

    • 值必须介于 1 到 35 之间

  • CloudwatchLogsExportConfiguration(在 CLI 中:--cloudwatch-logs-export-configuration,或者在 Python 中:cloudwatch_logs_export_configuration) — ACloudwatchLogsExportConfiguration对象。

    要启用日志类型的配置设置,以便针对特定数据库集群导出到 CloudWatch Logs。

  • CopyTagsToSnapshot(在 CLI 中:--copy-tags-to-snapshot,或者在 Python 中:copy_tags_to_snapshot) – Boolean.

    如果设置为true,则标签将复制到创建的数据库集群的任何快照中。

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或者在 Python 中:db_cluster_identifier) –必填项:必需 UTF-8 字符串。

    要修改的集群的数据库集群标识符。此参数不区分大小写。

    约束:

    • 必须匹配现有 DBCluster 的标识符。

  • DBClusterParameterGroupName(在 CLI 中:--db-cluster-parameter-group-name,或者在 Python 中:db_cluster_parameter_group_name) – UTF-8 字符串。

    用于数据库集群的数据库集群参数组名称。

  • DeletionProtection(在 CLI 中:--deletion-protection,或者在 Python 中:deletion_protection) – Boolean.

    一个值,指示数据库集群是否已启用删除保护。在启用删除保护时,无法删除数据库。默认情况下,将禁用删除保护。

  • EnableIAMDatabaseAuthentication(在 CLI 中:--enable-iam-database-authentication,或者在 Python 中:enable_iam_database_authentication) – Boolean.

    如果为 true,则启用 Amazon Identity and Access Management (IAM) 账户与数据库账户之间的映射;否则为 false。

    默认值:false

  • EngineVersion(在 CLI 中:--engine-version,或者在 Python 中:engine_version) – UTF-8 字符串。

    要升级到的数据库引擎的版本号。更改此参数会导致中断。除非 ApplyImmediately 参数设置为 true,否则会在下个维护时段内应用更改。

    有关有效引擎版本的列表,请参阅 Amazon Neptune 的引擎版本,或调用 DescribeDBEngineVersions

  • NewDBClusterIdentifier(在 CLI 中:--new-db-cluster-identifier,或者在 Python 中:new_db_cluster_identifier) – UTF-8 字符串。

    重命名数据库集群时数据库集群的新标识符。此值以一个小写字符串存储。

    约束:

    • 必须包含 1 到 63 个字母、数字或连字符

    • 第一个字符必须是字母

    • 不能以连字符结束或包含两个连续连字符

    示例:my-cluster2

  • Port(在 CLI 中:--port,或者在 Python 中:port) – 数字 (integer)。

    数据库集群用于接受连接的端口号。

    约束:值必须为1150-65535

    默认值:与原始数据库集群相同的端口。

  • PreferredBackupWindow(在 CLI 中:--preferred-backup-window,或者在 Python 中:preferred_backup_window) – UTF-8 字符串。

    使用 BackupRetentionPeriod 参数启用了自动备份时,自动执行备份的日常时间范围。

    默认值是从每个亚马逊区域的 8 小时间段中随机选择的 30 分钟时间。

    约束:

    • 必须采用 hh24:mi-hh24:mi 格式。

    • 必须采用通用协调时间 (UTC)。

    • 不得与首选维护时段冲突。

    • 必须至少为 30 分钟。

  • PreferredMaintenanceWindow(在 CLI 中:--preferred-maintenance-window,或者在 Python 中:preferred_maintenance_window) – UTF-8 字符串。

    可进行系统维护的每周时间范围(采用通用协调时间 (UTC))。

    格式:ddd:hh24:mi-ddd:hh24:mi

    默认值是从每亚马逊区域 8 小时的时间段中随机选择的 30 分钟时段 (随机选取周中的某天进行)。

    有效天:Mon、Tue、Wing、Tu、Fra、Sat、Sun。

    约束:至少为 30 分钟的时段。

  • VpcSecurityGroupIds(在 CLI 中:--vpc-security-group-ids,或者在 Python 中:vpc_security_group_ids) — VPC 安全性组 — UTF-8 字符串。

    数据库集群所属的 VPC 安全组的列表。

响应

包含 Amazon Neptune 数据库集群的详细信息。

此数据类型用作 DescribeDBClusters(操作) 操作中的响应元素。

  • AllocatedStorage(在 CLI 中:--allocated-storage,或者在 Python 中:allocated_storage) – 数字 (integer)。

    AllocatedStorage 始终返回 1,因为 Neptune 数据库集群存储大小不固定,而是会根据需要自动调整。

  • AssociatedRoles(在 CLI 中:--associated-roles,或者在 Python 中:associated_roles) — 数组DBClusterRoleDBCluster 角色对象。

    提供与数据库集群关联的 Amazon Identity and Access Management (IAM) 角色的列表。与数据库集群关联的 IAM 角色授予数据库集群代表您访问其他 Amazon 服务的权限。

  • AutomaticRestartTime(在 CLI 中:--automatic-restart-time,或者在 Python 中:automatic_restart_time) – 时间戳.

    数据库群集将自动重新启动的时间。

  • AvailabilityZones(在 CLI 中:--availability-zones,或者在 Python 中:availability_zones) — 一个 AvaililityZone 的数组 — UTF-8 字符串。

    提供可在其上创建数据库集群中实例的 EC2 可用区的列表。

  • BacktrackConsumedChangeRecords(在 CLI 中:--backtrack-consumed-change-records,或者在 Python 中:backtrack_consumed_change_records) – 数字 (long)。

    不受 Neptune 支持。

  • BacktrackWindow(在 CLI 中:--backtrack-window,或者在 Python 中:backtrack_window) – 数字 (long)。

    不受 Neptune 支持。

  • BackupRetentionPeriod(在 CLI 中:--backup-retention-period,或者在 Python 中:backup_retention_period) – 数字 (integer)。

    指定自动数据库快照的保留天数。

  • Capacity(在 CLI 中:--capacity,或者在 Python 中:capacity) – 数字 (integer)。

    不受 Neptune 支持。

  • CloneGroupId(在 CLI 中:--clone-group-id,或者在 Python 中:clone_group_id) – UTF-8 字符串。

    标识数据库集群与之关联的克隆组。

  • ClusterCreateTime(在 CLI 中:--cluster-create-time,或者在 Python 中:cluster_create_time) – 时间戳.

    指定创建数据库集群的时间,采用通用协调时间 (UTC)。

  • CopyTagsToSnapshot(在 CLI 中:--copy-tags-to-snapshot,或者在 Python 中:copy_tags_to_snapshot) – Boolean.

    如果设置为true,则标签将复制到创建的数据库集群的任何快照中。

  • CrossAccountClone(在 CLI 中:--cross-account-clone,或者在 Python 中:cross_account_clone) – Boolean.

    如果设置为true,则可以跨账户克隆数据库群集。

  • DatabaseName(在 CLI 中:--database-name,或者在 Python 中:database_name) – UTF-8 字符串。

    包含此数据库集群在创建时提供的初始数据库的名称(如果在创建数据库集群时指定了初始数据库)。在数据库集群的使用期间会始终返回同一名称。

  • DBClusterArn(在 CLI 中:--db-cluster-arn,或者在 Python 中:db_cluster_arn) – UTF-8 字符串。

    数据库集群的 Amazon 资源名称 (ARN)。

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或者在 Python 中:db_cluster_identifier) – UTF-8 字符串。

    包含用户提供的数据库集群标识符。此标识符是识别数据库集群的唯一键。

  • DBClusterMembers(在 CLI 中:--db-cluster-members,或者在 Python 中:db_cluster_members) — 数组DBClusterMember数据库集群成员对象。

    提供组成数据库集群的实例的列表。

  • DBClusterParameterGroup(在 CLI 中:--db-cluster-parameter-group,或者在 Python 中:db_cluster_parameter_group) – UTF-8 字符串。

    指定数据库集群的数据库集群参数组名称。

  • DbClusterResourceId(在 CLI 中:--db-cluster-resource-id,或者在 Python 中:db_cluster_resource_id) – UTF-8 字符串。

    数据库集群在 Amazon 区域中唯一的不可变标识符。只要访问了用户数据库集群的 Amazon KMS 密钥,就可在 Amazon CloudTrail 日志条目中找到此标识符。

  • DBSubnetGroup(在 CLI 中:--db-subnet-group,或者在 Python 中:db_subnet_group) – UTF-8 字符串。

    指定与数据库集群关联的子网组的信息,包括名称、描述和子网组中的子网。

  • DeletionProtection(在 CLI 中:--deletion-protection,或者在 Python 中:deletion_protection) – Boolean.

    指示数据库集群是否已启用删除保护。在启用删除保护时,无法删除数据库。

  • EarliestBacktrackTime(在 CLI 中:--earliest-backtrack-time,或者在 Python 中:earliest_backtrack_time) – 时间戳.

    不受 Neptune 支持。

  • EarliestRestorableTime(在 CLI 中:--earliest-restorable-time,或者在 Python 中:earliest_restorable_time) – 时间戳.

    指定数据库可以使用时间点还原的最早还原时间。

  • EnabledCloudwatchLogsExports(在 CLI 中:--enabled-cloudwatch-logs-exports,或者在 Python 中:enabled_cloudwatch_logs_exports) – 一个 UTF-8 字符串数组。

    此数据库集群配置为导出到 CloudWatch Logs 的日志类型的列表。

  • Endpoint(在 CLI 中:--endpoint,或者在 Python 中:endpoint) – UTF-8 字符串。

    指定数据库集群的主实例的连接终端节点。

  • Engine(在 CLI 中:--engine,或者在 Python 中:engine) – UTF-8 字符串。

    提供要用于此数据库集群的数据库引擎的名称。

  • EngineVersion(在 CLI 中:--engine-version,或者在 Python 中:engine_version) – UTF-8 字符串。

    指示数据库引擎版本。

  • HostedZoneId(在 CLI 中:--hosted-zone-id,或者在 Python 中:hosted_zone_id) – UTF-8 字符串。

    指定在您创建托管区域时 Amazon Route 53 分配的 ID。

  • IAMDatabaseAuthenticationEnabled(在 CLI 中:--iam-database-authentication-enabled,或者在 Python 中:iam_database_authentication_enabled) – Boolean.

    如果启用了 Amazon Identity and Access Management (IAM) 账户与数据库账户之间的映射,则为 true,否则为 false。

  • KmsKeyId(在 CLI 中:--kms-key-id,或者在 Python 中:kms_key_id) – UTF-8 字符串。

    如果StorageEncrypted为 true,则为加密数据库集群的 Amazon KMS 密钥标识符。

  • LatestRestorableTime(在 CLI 中:--latest-restorable-time,或者在 Python 中:latest_restorable_time) – 时间戳.

    指定数据库可以使用时间点还原的最新还原时间。

  • MultiAZ(在 CLI 中:--multi-az,或者在 Python 中:multi_az) – Boolean.

    指定数据库集群是否在多个可用区中有实例。

  • PendingModifiedValues(在 CLI 中:--pending-modified-values,或者在 Python 中:pending_modified_values) — AClusterPendingModifiedValues对象。

    不受 Neptune 支持。

  • PercentProgress(在 CLI 中:--percent-progress,或者在 Python 中:percent_progress) – UTF-8 字符串。

    指定操作的进度百分比。

  • Port(在 CLI 中:--port,或者在 Python 中:port) – 数字 (integer)。

    指定数据库引擎侦听的端口。

  • PreferredBackupWindow(在 CLI 中:--preferred-backup-window,或者在 Python 中:preferred_backup_window) – UTF-8 字符串。

    指定在启用自动备份时,自动执行备份的日常时间范围,如 BackupRetentionPeriod 所规定。

  • PreferredMaintenanceWindow(在 CLI 中:--preferred-maintenance-window,或者在 Python 中:preferred_maintenance_window) – UTF-8 字符串。

    指定可进行系统维护的每周时间范围(采用通用协调时间 (UTC))。

  • ReaderEndpoint(在 CLI 中:--reader-endpoint,或者在 Python 中:reader_endpoint) – UTF-8 字符串。

    数据库集群的读取器终端节点。数据库集群的读取器终端节点跨数据库集群中可用的只读副本,实现连接的负载均衡。当客户端请求与读取器终端节点的新连接时,Neptune 将在数据库集群中的只读副本之间分配连接请求。该功能可帮助跨数据库集群中的多个只读副本平衡读取工作负载。

    如果发生了故障转移并且连接到的只读副本将提升到主实例,则将删除您的连接。要继续向集群中的其他只读副本发送读取工作负载,您可以随后重新连接到读取器终端节点。

  • ReadReplicaIdentifiers(在 CLI 中:--read-replica-identifiers,或者在 Python 中:read_replica_identifiers) — 一个 ReadReplicaIdentifier 的数组 — UTF-8 字符串。

    包含一个或多个与此数据库集群关联的只读副本的标识符。

  • ReplicationSourceIdentifier(在 CLI 中:--replication-source-identifier,或者在 Python 中:replication_source_identifier) – UTF-8 字符串。

    不受 Neptune 支持。

  • ReplicationType(在 CLI 中:--replication-type,或者在 Python 中:replication_type) – UTF-8 字符串。

    不受 Neptune 支持。

  • Status(在 CLI 中:--status,或者在 Python 中:status) – UTF-8 字符串。

    指定此数据库集群的当前状态。

  • StorageEncrypted(在 CLI 中:--storage-encrypted,或者在 Python 中:storage_encrypted) – Boolean.

    指定数据库集群是否已加密。

  • VpcSecurityGroups(在 CLI 中:--vpc-security-groups,或者在 Python 中:vpc_security_groups) — 数组VpcSecurityGroupMembershipVpcSecurityGroupMembership 对象。

    提供数据库集群所属的 VPC 安全组的列表。

StartDBCluster(操作)

        此 API 的 Amazon CLI 名称为:。start-db-cluster,并且 Python 名称是:start_db_cluster.

启动已通过 Amazon 控制台、Amazon CLI 停止 db-cluster 命令或 StopDBCluster API 停止的 Amazon Neptune 数据库集群。

请求

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或者在 Python 中:db_cluster_identifier) –必填项:必需 UTF-8 字符串。

    要启动的 Neptune 数据库集群的数据库集群标识符。该参数作为一个小写字符串存储。

响应

包含 Amazon Neptune 数据库集群的详细信息。

此数据类型用作 DescribeDBClusters(操作) 操作中的响应元素。

  • AllocatedStorage(在 CLI 中:--allocated-storage,或者在 Python 中:allocated_storage) – 数字 (integer)。

    AllocatedStorage 始终返回 1,因为 Neptune 数据库集群存储大小不固定,而是会根据需要自动调整。

  • AssociatedRoles(在 CLI 中:--associated-roles,或者在 Python 中:associated_roles) — 数组DBClusterRoleDBCluster 角色对象。

    提供与数据库集群关联的 Amazon Identity and Access Management (IAM) 角色的列表。与数据库集群关联的 IAM 角色授予数据库集群代表您访问其他 Amazon 服务的权限。

  • AutomaticRestartTime(在 CLI 中:--automatic-restart-time,或者在 Python 中:automatic_restart_time) – 时间戳.

    数据库群集将自动重新启动的时间。

  • AvailabilityZones(在 CLI 中:--availability-zones,或者在 Python 中:availability_zones) — 一个 AvaililityZone 的数组 — UTF-8 字符串。

    提供可在其上创建数据库集群中实例的 EC2 可用区的列表。

  • BacktrackConsumedChangeRecords(在 CLI 中:--backtrack-consumed-change-records,或者在 Python 中:backtrack_consumed_change_records) – 数字 (long)。

    不受 Neptune 支持。

  • BacktrackWindow(在 CLI 中:--backtrack-window,或者在 Python 中:backtrack_window) – 数字 (long)。

    不受 Neptune 支持。

  • BackupRetentionPeriod(在 CLI 中:--backup-retention-period,或者在 Python 中:backup_retention_period) – 数字 (integer)。

    指定自动数据库快照的保留天数。

  • Capacity(在 CLI 中:--capacity,或者在 Python 中:capacity) – 数字 (integer)。

    不受 Neptune 支持。

  • CloneGroupId(在 CLI 中:--clone-group-id,或者在 Python 中:clone_group_id) – UTF-8 字符串。

    标识数据库集群与之关联的克隆组。

  • ClusterCreateTime(在 CLI 中:--cluster-create-time,或者在 Python 中:cluster_create_time) – 时间戳.

    指定创建数据库集群的时间,采用通用协调时间 (UTC)。

  • CopyTagsToSnapshot(在 CLI 中:--copy-tags-to-snapshot,或者在 Python 中:copy_tags_to_snapshot) – Boolean.

    如果设置为true,则标签将复制到创建的数据库集群的任何快照中。

  • CrossAccountClone(在 CLI 中:--cross-account-clone,或者在 Python 中:cross_account_clone) – Boolean.

    如果设置为true,则可以跨账户克隆数据库群集。

  • DatabaseName(在 CLI 中:--database-name,或者在 Python 中:database_name) – UTF-8 字符串。

    包含此数据库集群在创建时提供的初始数据库的名称(如果在创建数据库集群时指定了初始数据库)。在数据库集群的使用期间会始终返回同一名称。

  • DBClusterArn(在 CLI 中:--db-cluster-arn,或者在 Python 中:db_cluster_arn) – UTF-8 字符串。

    数据库集群的 Amazon 资源名称 (ARN)。

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或者在 Python 中:db_cluster_identifier) – UTF-8 字符串。

    包含用户提供的数据库集群标识符。此标识符是识别数据库集群的唯一键。

  • DBClusterMembers(在 CLI 中:--db-cluster-members,或者在 Python 中:db_cluster_members) — 数组DBClusterMember数据库集群成员对象。

    提供组成数据库集群的实例的列表。

  • DBClusterParameterGroup(在 CLI 中:--db-cluster-parameter-group,或者在 Python 中:db_cluster_parameter_group) – UTF-8 字符串。

    指定数据库集群的数据库集群参数组名称。

  • DbClusterResourceId(在 CLI 中:--db-cluster-resource-id,或者在 Python 中:db_cluster_resource_id) – UTF-8 字符串。

    数据库集群在 Amazon 区域中唯一的不可变标识符。只要访问了用户数据库集群的 Amazon KMS 密钥,就可在 Amazon CloudTrail 日志条目中找到此标识符。

  • DBSubnetGroup(在 CLI 中:--db-subnet-group,或者在 Python 中:db_subnet_group) – UTF-8 字符串。

    指定与数据库集群关联的子网组的信息,包括名称、描述和子网组中的子网。

  • DeletionProtection(在 CLI 中:--deletion-protection,或者在 Python 中:deletion_protection) – Boolean.

    指示数据库集群是否已启用删除保护。在启用删除保护时,无法删除数据库。

  • EarliestBacktrackTime(在 CLI 中:--earliest-backtrack-time,或者在 Python 中:earliest_backtrack_time) – 时间戳.

    不受 Neptune 支持。

  • EarliestRestorableTime(在 CLI 中:--earliest-restorable-time,或者在 Python 中:earliest_restorable_time) – 时间戳.

    指定数据库可以使用时间点还原的最早还原时间。

  • EnabledCloudwatchLogsExports(在 CLI 中:--enabled-cloudwatch-logs-exports,或者在 Python 中:enabled_cloudwatch_logs_exports) – 一个 UTF-8 字符串数组。

    此数据库集群配置为导出到 CloudWatch Logs 的日志类型的列表。

  • Endpoint(在 CLI 中:--endpoint,或者在 Python 中:endpoint) – UTF-8 字符串。

    指定数据库集群的主实例的连接终端节点。

  • Engine(在 CLI 中:--engine,或者在 Python 中:engine) – UTF-8 字符串。

    提供要用于此数据库集群的数据库引擎的名称。

  • EngineVersion(在 CLI 中:--engine-version,或者在 Python 中:engine_version) – UTF-8 字符串。

    指示数据库引擎版本。

  • HostedZoneId(在 CLI 中:--hosted-zone-id,或者在 Python 中:hosted_zone_id) – UTF-8 字符串。

    指定在您创建托管区域时 Amazon Route 53 分配的 ID。

  • IAMDatabaseAuthenticationEnabled(在 CLI 中:--iam-database-authentication-enabled,或者在 Python 中:iam_database_authentication_enabled) – Boolean.

    如果启用了 Amazon Identity and Access Management (IAM) 账户与数据库账户之间的映射,则为 true,否则为 false。

  • KmsKeyId(在 CLI 中:--kms-key-id,或者在 Python 中:kms_key_id) – UTF-8 字符串。

    如果StorageEncrypted为 true,则为加密数据库集群的 Amazon KMS 密钥标识符。

  • LatestRestorableTime(在 CLI 中:--latest-restorable-time,或者在 Python 中:latest_restorable_time) – 时间戳.

    指定数据库可以使用时间点还原的最新还原时间。

  • MultiAZ(在 CLI 中:--multi-az,或者在 Python 中:multi_az) – Boolean.

    指定数据库集群是否在多个可用区中有实例。

  • PendingModifiedValues(在 CLI 中:--pending-modified-values,或者在 Python 中:pending_modified_values) — AClusterPendingModifiedValues对象。

    不受 Neptune 支持。

  • PercentProgress(在 CLI 中:--percent-progress,或者在 Python 中:percent_progress) – UTF-8 字符串。

    指定操作的进度百分比。

  • Port(在 CLI 中:--port,或者在 Python 中:port) – 数字 (integer)。

    指定数据库引擎侦听的端口。

  • PreferredBackupWindow(在 CLI 中:--preferred-backup-window,或者在 Python 中:preferred_backup_window) – UTF-8 字符串。

    指定在启用自动备份时,自动执行备份的日常时间范围,如 BackupRetentionPeriod 所规定。

  • PreferredMaintenanceWindow(在 CLI 中:--preferred-maintenance-window,或者在 Python 中:preferred_maintenance_window) – UTF-8 字符串。

    指定可进行系统维护的每周时间范围(采用通用协调时间 (UTC))。

  • ReaderEndpoint(在 CLI 中:--reader-endpoint,或者在 Python 中:reader_endpoint) – UTF-8 字符串。

    数据库集群的读取器终端节点。数据库集群的读取器终端节点跨数据库集群中可用的只读副本,实现连接的负载均衡。当客户端请求与读取器终端节点的新连接时,Neptune 将在数据库集群中的只读副本之间分配连接请求。该功能可帮助跨数据库集群中的多个只读副本平衡读取工作负载。

    如果发生了故障转移并且连接到的只读副本将提升到主实例,则将删除您的连接。要继续向集群中的其他只读副本发送读取工作负载,您可以随后重新连接到读取器终端节点。

  • ReadReplicaIdentifiers(在 CLI 中:--read-replica-identifiers,或者在 Python 中:read_replica_identifiers) — 一个 ReadReplicaIdentifier 的数组 — UTF-8 字符串。

    包含一个或多个与此数据库集群关联的只读副本的标识符。

  • ReplicationSourceIdentifier(在 CLI 中:--replication-source-identifier,或者在 Python 中:replication_source_identifier) – UTF-8 字符串。

    不受 Neptune 支持。

  • ReplicationType(在 CLI 中:--replication-type,或者在 Python 中:replication_type) – UTF-8 字符串。

    不受 Neptune 支持。

  • Status(在 CLI 中:--status,或者在 Python 中:status) – UTF-8 字符串。

    指定此数据库集群的当前状态。

  • StorageEncrypted(在 CLI 中:--storage-encrypted,或者在 Python 中:storage_encrypted) – Boolean.

    指定数据库集群是否已加密。

  • VpcSecurityGroups(在 CLI 中:--vpc-security-groups,或者在 Python 中:vpc_security_groups) — 数组VpcSecurityGroupMembershipVpcSecurityGroupMembership 对象。

    提供数据库集群所属的 VPC 安全组的列表。

StopDBCluster(操作)

        此 API 的 Amazon CLI 名称为:。stop-db-cluster,并且 Python 名称是:stop_db_cluster.

停止 Amazon Neptune 数据库集群。在停止数据库集群时,Neptune 将保留数据库集群的元数据,包括其终端节点和数据库参数组。

此外,Neptune 将保留事务日志,以便您可以在必要时执行时间点还原。

请求

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或者在 Python 中:db_cluster_identifier) –必填项:必需 UTF-8 字符串。

    要停止的 Neptune 数据库集群的数据库集群标识符。该参数作为一个小写字符串存储。

响应

包含 Amazon Neptune 数据库集群的详细信息。

此数据类型用作 DescribeDBClusters(操作) 操作中的响应元素。

  • AllocatedStorage(在 CLI 中:--allocated-storage,或者在 Python 中:allocated_storage) – 数字 (integer)。

    AllocatedStorage 始终返回 1,因为 Neptune 数据库集群存储大小不固定,而是会根据需要自动调整。

  • AssociatedRoles(在 CLI 中:--associated-roles,或者在 Python 中:associated_roles) — 数组DBClusterRoleDBCluster 角色对象。

    提供与数据库集群关联的 Amazon Identity and Access Management (IAM) 角色的列表。与数据库集群关联的 IAM 角色授予数据库集群代表您访问其他 Amazon 服务的权限。

  • AutomaticRestartTime(在 CLI 中:--automatic-restart-time,或者在 Python 中:automatic_restart_time) – 时间戳.

    数据库群集将自动重新启动的时间。

  • AvailabilityZones(在 CLI 中:--availability-zones,或者在 Python 中:availability_zones) — 一个 AvaililityZone 的数组 — UTF-8 字符串。

    提供可在其上创建数据库集群中实例的 EC2 可用区的列表。

  • BacktrackConsumedChangeRecords(在 CLI 中:--backtrack-consumed-change-records,或者在 Python 中:backtrack_consumed_change_records) – 数字 (long)。

    不受 Neptune 支持。

  • BacktrackWindow(在 CLI 中:--backtrack-window,或者在 Python 中:backtrack_window) – 数字 (long)。

    不受 Neptune 支持。

  • BackupRetentionPeriod(在 CLI 中:--backup-retention-period,或者在 Python 中:backup_retention_period) – 数字 (integer)。

    指定自动数据库快照的保留天数。

  • Capacity(在 CLI 中:--capacity,或者在 Python 中:capacity) – 数字 (integer)。

    不受 Neptune 支持。

  • CloneGroupId(在 CLI 中:--clone-group-id,或者在 Python 中:clone_group_id) – UTF-8 字符串。

    标识数据库集群与之关联的克隆组。

  • ClusterCreateTime(在 CLI 中:--cluster-create-time,或者在 Python 中:cluster_create_time) – 时间戳.

    指定创建数据库集群的时间,采用通用协调时间 (UTC)。

  • CopyTagsToSnapshot(在 CLI 中:--copy-tags-to-snapshot,或者在 Python 中:copy_tags_to_snapshot) – Boolean.

    如果设置为true,则标签将复制到创建的数据库集群的任何快照中。

  • CrossAccountClone(在 CLI 中:--cross-account-clone,或者在 Python 中:cross_account_clone) – Boolean.

    如果设置为true,则可以跨账户克隆数据库群集。

  • DatabaseName(在 CLI 中:--database-name,或者在 Python 中:database_name) – UTF-8 字符串。

    包含此数据库集群在创建时提供的初始数据库的名称(如果在创建数据库集群时指定了初始数据库)。在数据库集群的使用期间会始终返回同一名称。

  • DBClusterArn(在 CLI 中:--db-cluster-arn,或者在 Python 中:db_cluster_arn) – UTF-8 字符串。

    数据库集群的 Amazon 资源名称 (ARN)。

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或者在 Python 中:db_cluster_identifier) – UTF-8 字符串。

    包含用户提供的数据库集群标识符。此标识符是识别数据库集群的唯一键。

  • DBClusterMembers(在 CLI 中:--db-cluster-members,或者在 Python 中:db_cluster_members) — 数组DBClusterMember数据库集群成员对象。

    提供组成数据库集群的实例的列表。

  • DBClusterParameterGroup(在 CLI 中:--db-cluster-parameter-group,或者在 Python 中:db_cluster_parameter_group) – UTF-8 字符串。

    指定数据库集群的数据库集群参数组名称。

  • DbClusterResourceId(在 CLI 中:--db-cluster-resource-id,或者在 Python 中:db_cluster_resource_id) – UTF-8 字符串。

    数据库集群在 Amazon 区域中唯一的不可变标识符。只要访问了用户数据库集群的 Amazon KMS 密钥,就可在 Amazon CloudTrail 日志条目中找到此标识符。

  • DBSubnetGroup(在 CLI 中:--db-subnet-group,或者在 Python 中:db_subnet_group) – UTF-8 字符串。

    指定与数据库集群关联的子网组的信息,包括名称、描述和子网组中的子网。

  • DeletionProtection(在 CLI 中:--deletion-protection,或者在 Python 中:deletion_protection) – Boolean.

    指示数据库集群是否已启用删除保护。在启用删除保护时,无法删除数据库。

  • EarliestBacktrackTime(在 CLI 中:--earliest-backtrack-time,或者在 Python 中:earliest_backtrack_time) – 时间戳.

    不受 Neptune 支持。

  • EarliestRestorableTime(在 CLI 中:--earliest-restorable-time,或者在 Python 中:earliest_restorable_time) – 时间戳.

    指定数据库可以使用时间点还原的最早还原时间。

  • EnabledCloudwatchLogsExports(在 CLI 中:--enabled-cloudwatch-logs-exports,或者在 Python 中:enabled_cloudwatch_logs_exports) – 一个 UTF-8 字符串数组。

    此数据库集群配置为导出到 CloudWatch Logs 的日志类型的列表。

  • Endpoint(在 CLI 中:--endpoint,或者在 Python 中:endpoint) – UTF-8 字符串。

    指定数据库集群的主实例的连接终端节点。

  • Engine(在 CLI 中:--engine,或者在 Python 中:engine) – UTF-8 字符串。

    提供要用于此数据库集群的数据库引擎的名称。

  • EngineVersion(在 CLI 中:--engine-version,或者在 Python 中:engine_version) – UTF-8 字符串。

    指示数据库引擎版本。

  • HostedZoneId(在 CLI 中:--hosted-zone-id,或者在 Python 中:hosted_zone_id) – UTF-8 字符串。

    指定在您创建托管区域时 Amazon Route 53 分配的 ID。

  • IAMDatabaseAuthenticationEnabled(在 CLI 中:--iam-database-authentication-enabled,或者在 Python 中:iam_database_authentication_enabled) – Boolean.

    如果启用了 Amazon Identity and Access Management (IAM) 账户与数据库账户之间的映射,则为 true,否则为 false。

  • KmsKeyId(在 CLI 中:--kms-key-id,或者在 Python 中:kms_key_id) – UTF-8 字符串。

    如果StorageEncrypted为 true,则为加密数据库集群的 Amazon KMS 密钥标识符。

  • LatestRestorableTime(在 CLI 中:--latest-restorable-time,或者在 Python 中:latest_restorable_time) – 时间戳.

    指定数据库可以使用时间点还原的最新还原时间。

  • MultiAZ(在 CLI 中:--multi-az,或者在 Python 中:multi_az) – Boolean.

    指定数据库集群是否在多个可用区中有实例。

  • PendingModifiedValues(在 CLI 中:--pending-modified-values,或者在 Python 中:pending_modified_values) — AClusterPendingModifiedValues对象。

    不受 Neptune 支持。

  • PercentProgress(在 CLI 中:--percent-progress,或者在 Python 中:percent_progress) – UTF-8 字符串。

    指定操作的进度百分比。

  • Port(在 CLI 中:--port,或者在 Python 中:port) – 数字 (integer)。

    指定数据库引擎侦听的端口。

  • PreferredBackupWindow(在 CLI 中:--preferred-backup-window,或者在 Python 中:preferred_backup_window) – UTF-8 字符串。

    指定在启用自动备份时,自动执行备份的日常时间范围,如 BackupRetentionPeriod 所规定。

  • PreferredMaintenanceWindow(在 CLI 中:--preferred-maintenance-window,或者在 Python 中:preferred_maintenance_window) – UTF-8 字符串。

    指定可进行系统维护的每周时间范围(采用通用协调时间 (UTC))。

  • ReaderEndpoint(在 CLI 中:--reader-endpoint,或者在 Python 中:reader_endpoint) – UTF-8 字符串。

    数据库集群的读取器终端节点。数据库集群的读取器终端节点跨数据库集群中可用的只读副本,实现连接的负载均衡。当客户端请求与读取器终端节点的新连接时,Neptune 将在数据库集群中的只读副本之间分配连接请求。该功能可帮助跨数据库集群中的多个只读副本平衡读取工作负载。

    如果发生了故障转移并且连接到的只读副本将提升到主实例,则将删除您的连接。要继续向集群中的其他只读副本发送读取工作负载,您可以随后重新连接到读取器终端节点。

  • ReadReplicaIdentifiers(在 CLI 中:--read-replica-identifiers,或者在 Python 中:read_replica_identifiers) — 一个 ReadReplicaIdentifier 的数组 — UTF-8 字符串。

    包含一个或多个与此数据库集群关联的只读副本的标识符。

  • ReplicationSourceIdentifier(在 CLI 中:--replication-source-identifier,或者在 Python 中:replication_source_identifier) – UTF-8 字符串。

    不受 Neptune 支持。

  • ReplicationType(在 CLI 中:--replication-type,或者在 Python 中:replication_type) – UTF-8 字符串。

    不受 Neptune 支持。

  • Status(在 CLI 中:--status,或者在 Python 中:status) – UTF-8 字符串。

    指定此数据库集群的当前状态。

  • StorageEncrypted(在 CLI 中:--storage-encrypted,或者在 Python 中:storage_encrypted) – Boolean.

    指定数据库集群是否已加密。

  • VpcSecurityGroups(在 CLI 中:--vpc-security-groups,或者在 Python 中:vpc_security_groups) — 数组VpcSecurityGroupMembershipVpcSecurityGroupMembership 对象。

    提供数据库集群所属的 VPC 安全组的列表。

AddRoleToDBCluster(操作)

        此 API 的 Amazon CLI 名称为:。add-role-to-db-cluster,并且 Python 名称是:add_role_to_db_cluster.

关联 Identity and Access Management (IAM) 角色与 Neptune 数据库集群。

请求

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或者在 Python 中:db_cluster_identifier) –必填项:必需 UTF-8 字符串。

    IAM 角色与之关联的数据库集群的名称。

  • FeatureName(在 CLI 中:--feature-name,或者在 Python 中:feature_name) – UTF-8 字符串。

    要与 IAM 角色关联的 Neptune 数据库群集的功能的名称。有关支持的功能名称的列表,请参阅DBEngineVersion.

  • RoleArn(在 CLI 中:--role-arn,或者在 Python 中:role_arn) –必填项:必需 UTF-8 字符串。

    与 Neptune 数据库集群关联的 IAM 角色的 Amazon 资源名称 (ARN),例如 arn:aws:iam::123456789012:role/NeptuneAccessRole

Response

  • 无响应参数。

RemoveRoleFromDBCluster(操作)

        此 API 的 Amazon CLI 名称为:。remove-role-from-db-cluster,并且 Python 名称是:remove_role_from_db_cluster.

取消数据库集群与 Identity and Access Management (IAM) 角色的关联。

请求

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或者在 Python 中:db_cluster_identifier) –必填项:必需 UTF-8 字符串。

    从中取消与 IAM 角色关联的数据库集群的名称。

  • FeatureName(在 CLI 中:--feature-name,或者在 Python 中:feature_name) – UTF-8 字符串。

    要解除 IAM 角色关联的数据库群集的功能的名称。有关支持的功能名称的列表,请参阅DescribeDBEngineVersions.

  • RoleArn(在 CLI 中:--role-arn,或者在 Python 中:role_arn) –必填项:必需 UTF-8 字符串。

    要取消与数据库集群关联的 IAM 角色的 Amazon 资源名称 (ARN),例如 arn:aws:iam::123456789012:role/NeptuneAccessRole

Response

  • 无响应参数。

FailoverDBCluster(操作)

        此 API 的 Amazon CLI 名称为:。failover-db-cluster,并且 Python 名称是:failover_db_cluster.

强制数据库集群故障转移。

数据库集群的故障转移会将数据库集群中的只读副本之一(只读实例)提升为主实例(集群写入器)。

Amazon Neptune 在主实例发生故障时自动故障转移到只读副本(如果存在)。当您要模拟主实例的故障以进行测试时,可以强制进行故障转移。由于数据库集群中的每个实例都有自己的终端节点地址,您需要在故障转移完成后清理并重新建立使用这些终端节点地址的任何现有连接。

请求

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或者在 Python 中:db_cluster_identifier) – UTF-8 字符串。

    用于强制进行故障转移的数据库集群标识符。此参数不区分大小写。

    约束:

    • 必须匹配现有 DBCluster 的标识符。

  • TargetDBInstanceIdentifier(在 CLI 中:--target-db-instance-identifier,或者在 Python 中:target_db_instance_identifier) – UTF-8 字符串。

    提升为主实例的实例的名称。

    您必须指定数据库集群中只读副本的实例标识符。例如:mydbcluster-replica1

响应

包含 Amazon Neptune 数据库集群的详细信息。

此数据类型用作 DescribeDBClusters(操作) 操作中的响应元素。

  • AllocatedStorage(在 CLI 中:--allocated-storage,或者在 Python 中:allocated_storage) – 数字 (integer)。

    AllocatedStorage 始终返回 1,因为 Neptune 数据库集群存储大小不固定,而是会根据需要自动调整。

  • AssociatedRoles(在 CLI 中:--associated-roles,或者在 Python 中:associated_roles) — 数组DBClusterRoleDBCluster 角色对象。

    提供与数据库集群关联的 Amazon Identity and Access Management (IAM) 角色的列表。与数据库集群关联的 IAM 角色授予数据库集群代表您访问其他 Amazon 服务的权限。

  • AutomaticRestartTime(在 CLI 中:--automatic-restart-time,或者在 Python 中:automatic_restart_time) – 时间戳.

    数据库群集将自动重新启动的时间。

  • AvailabilityZones(在 CLI 中:--availability-zones,或者在 Python 中:availability_zones) — 一个 AvaililityZone 的数组 — UTF-8 字符串。

    提供可在其上创建数据库集群中实例的 EC2 可用区的列表。

  • BacktrackConsumedChangeRecords(在 CLI 中:--backtrack-consumed-change-records,或者在 Python 中:backtrack_consumed_change_records) – 数字 (long)。

    不受 Neptune 支持。

  • BacktrackWindow(在 CLI 中:--backtrack-window,或者在 Python 中:backtrack_window) – 数字 (long)。

    不受 Neptune 支持。

  • BackupRetentionPeriod(在 CLI 中:--backup-retention-period,或者在 Python 中:backup_retention_period) – 数字 (integer)。

    指定自动数据库快照的保留天数。

  • Capacity(在 CLI 中:--capacity,或者在 Python 中:capacity) – 数字 (integer)。

    不受 Neptune 支持。

  • CloneGroupId(在 CLI 中:--clone-group-id,或者在 Python 中:clone_group_id) – UTF-8 字符串。

    标识数据库集群与之关联的克隆组。

  • ClusterCreateTime(在 CLI 中:--cluster-create-time,或者在 Python 中:cluster_create_time) – 时间戳.

    指定创建数据库集群的时间,采用通用协调时间 (UTC)。

  • CopyTagsToSnapshot(在 CLI 中:--copy-tags-to-snapshot,或者在 Python 中:copy_tags_to_snapshot) – Boolean.

    如果设置为true,则标签将复制到创建的数据库集群的任何快照中。

  • CrossAccountClone(在 CLI 中:--cross-account-clone,或者在 Python 中:cross_account_clone) – Boolean.

    如果设置为true,则可以跨账户克隆数据库群集。

  • DatabaseName(在 CLI 中:--database-name,或者在 Python 中:database_name) – UTF-8 字符串。

    包含此数据库集群在创建时提供的初始数据库的名称(如果在创建数据库集群时指定了初始数据库)。在数据库集群的使用期间会始终返回同一名称。

  • DBClusterArn(在 CLI 中:--db-cluster-arn,或者在 Python 中:db_cluster_arn) – UTF-8 字符串。

    数据库集群的 Amazon 资源名称 (ARN)。

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或者在 Python 中:db_cluster_identifier) – UTF-8 字符串。

    包含用户提供的数据库集群标识符。此标识符是识别数据库集群的唯一键。

  • DBClusterMembers(在 CLI 中:--db-cluster-members,或者在 Python 中:db_cluster_members) — 数组DBClusterMember数据库集群成员对象。

    提供组成数据库集群的实例的列表。

  • DBClusterParameterGroup(在 CLI 中:--db-cluster-parameter-group,或者在 Python 中:db_cluster_parameter_group) – UTF-8 字符串。

    指定数据库集群的数据库集群参数组名称。

  • DbClusterResourceId(在 CLI 中:--db-cluster-resource-id,或者在 Python 中:db_cluster_resource_id) – UTF-8 字符串。

    数据库集群在 Amazon 区域中唯一的不可变标识符。只要访问了用户数据库集群的 Amazon KMS 密钥,就可在 Amazon CloudTrail 日志条目中找到此标识符。

  • DBSubnetGroup(在 CLI 中:--db-subnet-group,或者在 Python 中:db_subnet_group) – UTF-8 字符串。

    指定与数据库集群关联的子网组的信息,包括名称、描述和子网组中的子网。

  • DeletionProtection(在 CLI 中:--deletion-protection,或者在 Python 中:deletion_protection) – Boolean.

    指示数据库集群是否已启用删除保护。在启用删除保护时,无法删除数据库。

  • EarliestBacktrackTime(在 CLI 中:--earliest-backtrack-time,或者在 Python 中:earliest_backtrack_time) – 时间戳.

    不受 Neptune 支持。

  • EarliestRestorableTime(在 CLI 中:--earliest-restorable-time,或者在 Python 中:earliest_restorable_time) – 时间戳.

    指定数据库可以使用时间点还原的最早还原时间。

  • EnabledCloudwatchLogsExports(在 CLI 中:--enabled-cloudwatch-logs-exports,或者在 Python 中:enabled_cloudwatch_logs_exports) – 一个 UTF-8 字符串数组。

    此数据库集群配置为导出到 CloudWatch Logs 的日志类型的列表。

  • Endpoint(在 CLI 中:--endpoint,或者在 Python 中:endpoint) – UTF-8 字符串。

    指定数据库集群的主实例的连接终端节点。

  • Engine(在 CLI 中:--engine,或者在 Python 中:engine) – UTF-8 字符串。

    提供要用于此数据库集群的数据库引擎的名称。

  • EngineVersion(在 CLI 中:--engine-version,或者在 Python 中:engine_version) – UTF-8 字符串。

    指示数据库引擎版本。

  • HostedZoneId(在 CLI 中:--hosted-zone-id,或者在 Python 中:hosted_zone_id) – UTF-8 字符串。

    指定在您创建托管区域时 Amazon Route 53 分配的 ID。

  • IAMDatabaseAuthenticationEnabled(在 CLI 中:--iam-database-authentication-enabled,或者在 Python 中:iam_database_authentication_enabled) – Boolean.

    如果启用了 Amazon Identity and Access Management (IAM) 账户与数据库账户之间的映射,则为 true,否则为 false。

  • KmsKeyId(在 CLI 中:--kms-key-id,或者在 Python 中:kms_key_id) – UTF-8 字符串。

    如果StorageEncrypted为 true,则为加密数据库集群的 Amazon KMS 密钥标识符。

  • LatestRestorableTime(在 CLI 中:--latest-restorable-time,或者在 Python 中:latest_restorable_time) – 时间戳.

    指定数据库可以使用时间点还原的最新还原时间。

  • MultiAZ(在 CLI 中:--multi-az,或者在 Python 中:multi_az) – Boolean.

    指定数据库集群是否在多个可用区中有实例。

  • PendingModifiedValues(在 CLI 中:--pending-modified-values,或者在 Python 中:pending_modified_values) — AClusterPendingModifiedValues对象。

    不受 Neptune 支持。

  • PercentProgress(在 CLI 中:--percent-progress,或者在 Python 中:percent_progress) – UTF-8 字符串。

    指定操作的进度百分比。

  • Port(在 CLI 中:--port,或者在 Python 中:port) – 数字 (integer)。

    指定数据库引擎侦听的端口。

  • PreferredBackupWindow(在 CLI 中:--preferred-backup-window,或者在 Python 中:preferred_backup_window) – UTF-8 字符串。

    指定在启用自动备份时,自动执行备份的日常时间范围,如 BackupRetentionPeriod 所规定。

  • PreferredMaintenanceWindow(在 CLI 中:--preferred-maintenance-window,或者在 Python 中:preferred_maintenance_window) – UTF-8 字符串。

    指定可进行系统维护的每周时间范围(采用通用协调时间 (UTC))。

  • ReaderEndpoint(在 CLI 中:--reader-endpoint,或者在 Python 中:reader_endpoint) – UTF-8 字符串。

    数据库集群的读取器终端节点。数据库集群的读取器终端节点跨数据库集群中可用的只读副本,实现连接的负载均衡。当客户端请求与读取器终端节点的新连接时,Neptune 将在数据库集群中的只读副本之间分配连接请求。该功能可帮助跨数据库集群中的多个只读副本平衡读取工作负载。

    如果发生了故障转移并且连接到的只读副本将提升到主实例,则将删除您的连接。要继续向集群中的其他只读副本发送读取工作负载,您可以随后重新连接到读取器终端节点。

  • ReadReplicaIdentifiers(在 CLI 中:--read-replica-identifiers,或者在 Python 中:read_replica_identifiers) — 一个 ReadReplicaIdentifier 的数组 — UTF-8 字符串。

    包含一个或多个与此数据库集群关联的只读副本的标识符。

  • ReplicationSourceIdentifier(在 CLI 中:--replication-source-identifier,或者在 Python 中:replication_source_identifier) – UTF-8 字符串。

    不受 Neptune 支持。

  • ReplicationType(在 CLI 中:--replication-type,或者在 Python 中:replication_type) – UTF-8 字符串。

    不受 Neptune 支持。

  • Status(在 CLI 中:--status,或者在 Python 中:status) – UTF-8 字符串。

    指定此数据库集群的当前状态。

  • StorageEncrypted(在 CLI 中:--storage-encrypted,或者在 Python 中:storage_encrypted) – Boolean.

    指定数据库集群是否已加密。

  • VpcSecurityGroups(在 CLI 中:--vpc-security-groups,或者在 Python 中:vpc_security_groups) — 数组VpcSecurityGroupMembershipVpcSecurityGroupMembership 对象。

    提供数据库集群所属的 VPC 安全组的列表。

PromoteReadReplicaDBCluster(操作)

        此 API 的 Amazon CLI 名称为:。promote-read-replica-db-cluster,并且 Python 名称是:promote_read_replica_db_cluster.

不支持.

请求

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或者在 Python 中:db_cluster_identifier) –必填项:必需 UTF-8 字符串。

    不支持.

响应

包含 Amazon Neptune 数据库集群的详细信息。

此数据类型用作 DescribeDBClusters(操作) 操作中的响应元素。

  • AllocatedStorage(在 CLI 中:--allocated-storage,或者在 Python 中:allocated_storage) – 数字 (integer)。

    AllocatedStorage 始终返回 1,因为 Neptune 数据库集群存储大小不固定,而是会根据需要自动调整。

  • AssociatedRoles(在 CLI 中:--associated-roles,或者在 Python 中:associated_roles) — 数组DBClusterRoleDBCluster 角色对象。

    提供与数据库集群关联的 Amazon Identity and Access Management (IAM) 角色的列表。与数据库集群关联的 IAM 角色授予数据库集群代表您访问其他 Amazon 服务的权限。

  • AutomaticRestartTime(在 CLI 中:--automatic-restart-time,或者在 Python 中:automatic_restart_time) – 时间戳.

    数据库群集将自动重新启动的时间。

  • AvailabilityZones(在 CLI 中:--availability-zones,或者在 Python 中:availability_zones) — 一个 AvaililityZone 的数组 — UTF-8 字符串。

    提供可在其上创建数据库集群中实例的 EC2 可用区的列表。

  • BacktrackConsumedChangeRecords(在 CLI 中:--backtrack-consumed-change-records,或者在 Python 中:backtrack_consumed_change_records) – 数字 (long)。

    不受 Neptune 支持。

  • BacktrackWindow(在 CLI 中:--backtrack-window,或者在 Python 中:backtrack_window) – 数字 (long)。

    不受 Neptune 支持。

  • BackupRetentionPeriod(在 CLI 中:--backup-retention-period,或者在 Python 中:backup_retention_period) – 数字 (integer)。

    指定自动数据库快照的保留天数。

  • Capacity(在 CLI 中:--capacity,或者在 Python 中:capacity) – 数字 (integer)。

    不受 Neptune 支持。

  • CloneGroupId(在 CLI 中:--clone-group-id,或者在 Python 中:clone_group_id) – UTF-8 字符串。

    标识数据库集群与之关联的克隆组。

  • ClusterCreateTime(在 CLI 中:--cluster-create-time,或者在 Python 中:cluster_create_time) – 时间戳.

    指定创建数据库集群的时间,采用通用协调时间 (UTC)。

  • CopyTagsToSnapshot(在 CLI 中:--copy-tags-to-snapshot,或者在 Python 中:copy_tags_to_snapshot) – Boolean.

    如果设置为true,则标签将复制到创建的数据库集群的任何快照中。

  • CrossAccountClone(在 CLI 中:--cross-account-clone,或者在 Python 中:cross_account_clone) – Boolean.

    如果设置为true,则可以跨账户克隆数据库群集。

  • DatabaseName(在 CLI 中:--database-name,或者在 Python 中:database_name) – UTF-8 字符串。

    包含此数据库集群在创建时提供的初始数据库的名称(如果在创建数据库集群时指定了初始数据库)。在数据库集群的使用期间会始终返回同一名称。

  • DBClusterArn(在 CLI 中:--db-cluster-arn,或者在 Python 中:db_cluster_arn) – UTF-8 字符串。

    数据库集群的 Amazon 资源名称 (ARN)。

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或者在 Python 中:db_cluster_identifier) – UTF-8 字符串。

    包含用户提供的数据库集群标识符。此标识符是识别数据库集群的唯一键。

  • DBClusterMembers(在 CLI 中:--db-cluster-members,或者在 Python 中:db_cluster_members) — 数组DBClusterMember数据库集群成员对象。

    提供组成数据库集群的实例的列表。

  • DBClusterParameterGroup(在 CLI 中:--db-cluster-parameter-group,或者在 Python 中:db_cluster_parameter_group) – UTF-8 字符串。

    指定数据库集群的数据库集群参数组名称。

  • DbClusterResourceId(在 CLI 中:--db-cluster-resource-id,或者在 Python 中:db_cluster_resource_id) – UTF-8 字符串。

    数据库集群在 Amazon 区域中唯一的不可变标识符。只要访问了用户数据库集群的 Amazon KMS 密钥,就可在 Amazon CloudTrail 日志条目中找到此标识符。

  • DBSubnetGroup(在 CLI 中:--db-subnet-group,或者在 Python 中:db_subnet_group) – UTF-8 字符串。

    指定与数据库集群关联的子网组的信息,包括名称、描述和子网组中的子网。

  • DeletionProtection(在 CLI 中:--deletion-protection,或者在 Python 中:deletion_protection) – Boolean.

    指示数据库集群是否已启用删除保护。在启用删除保护时,无法删除数据库。

  • EarliestBacktrackTime(在 CLI 中:--earliest-backtrack-time,或者在 Python 中:earliest_backtrack_time) – 时间戳.

    不受 Neptune 支持。

  • EarliestRestorableTime(在 CLI 中:--earliest-restorable-time,或者在 Python 中:earliest_restorable_time) – 时间戳.

    指定数据库可以使用时间点还原的最早还原时间。

  • EnabledCloudwatchLogsExports(在 CLI 中:--enabled-cloudwatch-logs-exports,或者在 Python 中:enabled_cloudwatch_logs_exports) – 一个 UTF-8 字符串数组。

    此数据库集群配置为导出到 CloudWatch Logs 的日志类型的列表。

  • Endpoint(在 CLI 中:--endpoint,或者在 Python 中:endpoint) – UTF-8 字符串。

    指定数据库集群的主实例的连接终端节点。

  • Engine(在 CLI 中:--engine,或者在 Python 中:engine) – UTF-8 字符串。

    提供要用于此数据库集群的数据库引擎的名称。

  • EngineVersion(在 CLI 中:--engine-version,或者在 Python 中:engine_version) – UTF-8 字符串。

    指示数据库引擎版本。

  • HostedZoneId(在 CLI 中:--hosted-zone-id,或者在 Python 中:hosted_zone_id) – UTF-8 字符串。

    指定在您创建托管区域时 Amazon Route 53 分配的 ID。

  • IAMDatabaseAuthenticationEnabled(在 CLI 中:--iam-database-authentication-enabled,或者在 Python 中:iam_database_authentication_enabled) – Boolean.

    如果启用了 Amazon Identity and Access Management (IAM) 账户与数据库账户之间的映射,则为 true,否则为 false。

  • KmsKeyId(在 CLI 中:--kms-key-id,或者在 Python 中:kms_key_id) – UTF-8 字符串。

    如果StorageEncrypted为 true,则为加密数据库集群的 Amazon KMS 密钥标识符。

  • LatestRestorableTime(在 CLI 中:--latest-restorable-time,或者在 Python 中:latest_restorable_time) – 时间戳.

    指定数据库可以使用时间点还原的最新还原时间。

  • MultiAZ(在 CLI 中:--multi-az,或者在 Python 中:multi_az) – Boolean.

    指定数据库集群是否在多个可用区中有实例。

  • PendingModifiedValues(在 CLI 中:--pending-modified-values,或者在 Python 中:pending_modified_values) — AClusterPendingModifiedValues对象。

    不受 Neptune 支持。

  • PercentProgress(在 CLI 中:--percent-progress,或者在 Python 中:percent_progress) – UTF-8 字符串。

    指定操作的进度百分比。

  • Port(在 CLI 中:--port,或者在 Python 中:port) – 数字 (integer)。

    指定数据库引擎侦听的端口。

  • PreferredBackupWindow(在 CLI 中:--preferred-backup-window,或者在 Python 中:preferred_backup_window) – UTF-8 字符串。

    指定在启用自动备份时,自动执行备份的日常时间范围,如 BackupRetentionPeriod 所规定。

  • PreferredMaintenanceWindow(在 CLI 中:--preferred-maintenance-window,或者在 Python 中:preferred_maintenance_window) – UTF-8 字符串。

    指定可进行系统维护的每周时间范围(采用通用协调时间 (UTC))。

  • ReaderEndpoint(在 CLI 中:--reader-endpoint,或者在 Python 中:reader_endpoint) – UTF-8 字符串。

    数据库集群的读取器终端节点。数据库集群的读取器终端节点跨数据库集群中可用的只读副本,实现连接的负载均衡。当客户端请求与读取器终端节点的新连接时,Neptune 将在数据库集群中的只读副本之间分配连接请求。该功能可帮助跨数据库集群中的多个只读副本平衡读取工作负载。

    如果发生了故障转移并且连接到的只读副本将提升到主实例,则将删除您的连接。要继续向集群中的其他只读副本发送读取工作负载,您可以随后重新连接到读取器终端节点。

  • ReadReplicaIdentifiers(在 CLI 中:--read-replica-identifiers,或者在 Python 中:read_replica_identifiers) — 一个 ReadReplicaIdentifier 的数组 — UTF-8 字符串。

    包含一个或多个与此数据库集群关联的只读副本的标识符。

  • ReplicationSourceIdentifier(在 CLI 中:--replication-source-identifier,或者在 Python 中:replication_source_identifier) – UTF-8 字符串。

    不受 Neptune 支持。

  • ReplicationType(在 CLI 中:--replication-type,或者在 Python 中:replication_type) – UTF-8 字符串。

    不受 Neptune 支持。

  • Status(在 CLI 中:--status,或者在 Python 中:status) – UTF-8 字符串。

    指定此数据库集群的当前状态。

  • StorageEncrypted(在 CLI 中:--storage-encrypted,或者在 Python 中:storage_encrypted) – Boolean.

    指定数据库集群是否已加密。

  • VpcSecurityGroups(在 CLI 中:--vpc-security-groups,或者在 Python 中:vpc_security_groups) — 数组VpcSecurityGroupMembershipVpcSecurityGroupMembership 对象。

    提供数据库集群所属的 VPC 安全组的列表。

DescribeDBClusters(操作)

        此 API 的 Amazon CLI 名称为:。describe-db-clusters,并且 Python 名称是:describe_db_clusters.

返回有关预配置的数据库集群的信息,并支持分页。

注意

此操作还可以返回 Amazon RDS 集群和 Amazon DocDB 集群的信息。

请求

  • DBClusterIdentifier(在 CLI 中:--db-cluster-identifier,或者在 Python 中:db_cluster_identifier) – UTF-8 字符串。

    用户提供的数据库集群标识符。如果指定了此参数,则只返回特定数据库集群的信息。该参数不区分大小写。

    约束:

    • 如果提供,则必须匹配现有 DBClusterIdentifier。

  • Filters(在 CLI 中:--filters,或者在 Python 中:filters) — 数组筛选筛选对象。

    筛选条件指定要描述的一个或多个数据库集群。

    支持的筛选条件:

    • db-cluster-id - 接受数据库集群标识符和数据库集群 Amazon 资源名称 (ARN)。结果列表中仅包含由这些 ARN 确定的数据库集群的相关信息。

    • engine - 接受引擎名称(例如 neptune),并将结果列表限制为由该引擎创建的数据库集群。

    例如,要从 Amazon CLI 调用此 API 并进行筛选,以便仅返回 Neptune 数据库集群,您可以使用以下命令:

    aws neptune describe-db-clusters \ --filters Name=engine,Values=neptune
  • Marker(在 CLI 中:--marker,或者在 Python 中:marker) – UTF-8 字符串。

    由之前的 DescribeDBClusters(操作) 请求提供的可选分页标记。如果指定此参数,则响应仅包含标记之外的记录,最大数量为 MaxRecords 指定的值。

  • MaxRecords(在 CLI 中:--max-records,或者在 Python 中:max_records) – 数字 (integer)。

    包括在响应中的最大记录数。如果存在的记录数超过了指定的MaxRecords 值,则在响应中包含称为标记的分页记号,以便检索剩余的结果。

    默认值:100

    约束:至少为 20,最高为 100。

响应

  • DBClusters(在 CLI 中:--db-clusters,或者在 Python 中:db_clusters) — 数组DBClusterDBCluster 对象。

    包含用户的数据库集群列表。

  • Marker(在 CLI 中:--marker,或者在 Python 中:marker) – UTF-8 字符串。

    分页标记,您可在后续的 DescribeDBClusters 请求中使用。