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

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

Neptune 快照 API

结构:

操作:

DBClusterSnapshot(结构)

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

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

Fields

  • AllocatedStorage – 数字 (integer)。

    指定分配的存储大小(以 GiB 为单位)。

  • AvailabilityZones— 一个可用性区的数组 — 一个 UTF-8 字符串。

    提供数据库集群快照中的实例可以还原到的 EC2 可用区列表。

  • ClusterCreateTime – 时间戳.

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

  • DBClusterIdentifier – UTF-8 字符串。

    指定从中创建了此数据库集群快照的数据库集群的标识符。

  • DBClusterSnapshotArn – UTF-8 字符串。

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

  • DBClusterSnapshotIdentifier – UTF-8 字符串。

    指定数据库集群快照的标识符。必须与现有快照的标识符匹配。

    在使用 DBClusterSnapshotIdentifier 还原数据库集群后,您必须为该数据库集群的任何将来更新指定相同的 DBClusterSnapshotIdentifier。当您为更新指定此属性时,不会再次从快照还原数据库群集,并且数据库中的数据也不会更改。

    不过,如果您不指定 DBClusterSnapshotIdentifier,则会创建空数据库集群,并删除原始数据库集群。如果指定的属性与以前的快照还原属性不同,则从 DBClusterSnapshotIdentifier 指定的快照中还原数据库集群,并删除原始数据库集群。

  • Engine – UTF-8 字符串。

    指定数据库引擎的名称。

  • EngineVersion – UTF-8 字符串。

    提供此数据库集群快照的数据库引擎的版本。

  • IAMDatabaseAuthenticationEnabled – Boolean.

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

  • KmsKeyId – UTF-8 字符串。

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

  • LicenseModel – UTF-8 字符串。

    提供此数据库集群快照的许可模式信息。

  • PercentProgress – 数字 (integer)。

    指定估计的已传输数据百分比。

  • Port – 数字 (integer)。

    指定获取快照时数据库集群侦听的端口。

  • SnapshotCreateTime – 时间戳.

    提供获取快照的时间,以通用协调时 (UTC) 表示。

  • SnapshotType – UTF-8 字符串。

    提供数据库集群快照的类型。

  • SourceDBClusterSnapshotArn – UTF-8 字符串。

    如果数据库集群快照复制自源数据库集群快照,则为源数据库集群快照的 Amazon 资源名称 (ARN),否则为 null 值。

  • Status – UTF-8 字符串。

    指定此数据库集群快照的状态。

  • StorageEncrypted – Boolean.

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

  • VpcId – UTF-8 字符串。

    提供与数据库集群快照关联的 VPC ID。

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

DBClusterSnapshotAttribute(结构)

包含手动数据库集群快照属性的名称和值。

手动数据库集群快照属性用于授权其他 Amazon 账户还原手动数据库集群快照。有关更多信息,请参阅 ModifyDBClusterSnapshotAttribute(操作) API 操作。

Fields

  • AttributeName – UTF-8 字符串。

    手动数据库集群快照属性的名称。

    名为restore指有权复制或还原手动数据库集群快照的 Amazon 账户列表。有关更多信息,请参阅 ModifyDBClusterSnapshotAttribute(操作) API 操作。

  • AttributeValues— 一个属性 Values — 一个 UTF-8 字符串数组。

    手动数据库集群快照属性的值。

    如果AttributeName字段设置为restore,则此元素返回已授权复制或还原手动数据库集群快照的 Amazon 账户的 ID 列表。如果值为all,则手动数据库集群快照为公有,可供所有 Amazon 账户复制或还原。

DBClusterSnapshotAttributesResult(结构)

包含成功调用DescribeDBClusterSnapshotAttributes(操作) API 操作的结果。

手动数据库集群快照属性用于授权其他 Amazon 账户复制或还原手动数据库集群快照。有关更多信息,请参阅 ModifyDBClusterSnapshotAttribute(操作) API 操作。

Fields

  • DBClusterSnapshotAttributes— 数组DBClusterSnapshotAttribute数据库快照属性对象。

    手动数据库集群快照的属性和值的列表。

  • DBClusterSnapshotIdentifier – UTF-8 字符串。

    属性应用到的手动数据库集群快照的标识符。

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

CreateDBClusterSnapshot(操作)

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

创建数据库集群的快照。

请求

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

    要为其创建快照的数据库集群的标识符。此参数不区分大小写。

    约束:

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

    示例:my-cluster1

  • DBClusterSnapshotIdentifier(在 CLI 中:--db-cluster-snapshot-identifier,或者在 Python 中:db_cluster_snapshot_identifier) –:必需 UTF-8 字符串。

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

    约束:

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

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

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

    示例:my-cluster1-snapshot1

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

    要分配给数据库集群快照的标签。

响应

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

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

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

    指定分配的存储大小(以 GiB 为单位)。

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

    提供数据库集群快照中的实例可以还原到的 EC2 可用区列表。

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

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

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

    指定从中创建了此数据库集群快照的数据库集群的标识符。

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

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

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

    指定数据库集群快照的标识符。必须与现有快照的标识符匹配。

    在使用 DBClusterSnapshotIdentifier 还原数据库集群后,您必须为该数据库集群的任何将来更新指定相同的 DBClusterSnapshotIdentifier。当您为更新指定此属性时,不会再次从快照还原数据库群集,并且数据库中的数据也不会更改。

    不过,如果您不指定 DBClusterSnapshotIdentifier,则会创建空数据库集群,并删除原始数据库集群。如果指定的属性与以前的快照还原属性不同,则从 DBClusterSnapshotIdentifier 指定的快照中还原数据库集群,并删除原始数据库集群。

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

    指定数据库引擎的名称。

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

    提供此数据库集群快照的数据库引擎的版本。

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

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

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

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

  • LicenseModel(在 CLI 中:--license-model,或者在 Python 中:license_model) – UTF-8 字符串。

    提供此数据库集群快照的许可模式信息。

  • PercentProgress(在 CLI 中:--percent-progress,或者在 Python 中:percent_progress) – 数字 (integer)。

    指定估计的已传输数据百分比。

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

    指定获取快照时数据库集群侦听的端口。

  • SnapshotCreateTime(在 CLI 中:--snapshot-create-time,或者在 Python 中:snapshot_create_time) – 时间戳.

    提供获取快照的时间,以通用协调时 (UTC) 表示。

  • SnapshotType(在 CLI 中:--snapshot-type,或者在 Python 中:snapshot_type) – UTF-8 字符串。

    提供数据库集群快照的类型。

  • SourceDBClusterSnapshotArn(在 CLI 中:--source-db-cluster-snapshot-arn,或者在 Python 中:source_db_cluster_snapshot_arn) – UTF-8 字符串。

    如果数据库集群快照复制自源数据库集群快照,则为源数据库集群快照的 Amazon 资源名称 (ARN),否则为 null 值。

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

    指定此数据库集群快照的状态。

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

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

  • VpcId(在 CLI 中:--vpc-id,或者在 Python 中:vpc_id) – UTF-8 字符串。

    提供与数据库集群快照关联的 VPC ID。

DeleteDBClusterSnapshot(操作)

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

删除数据库集群快照。如果正在复制快照,则复制操作将会终止。

注意

只有处于 available 状态的数据库集群快照才能删除。

请求

  • DBClusterSnapshotIdentifier(在 CLI 中:--db-cluster-snapshot-identifier,或者在 Python 中:db_cluster_snapshot_identifier) –:必需 UTF-8 字符串。

    要删除的数据库集群快照的标识符。

    约束:必须是available状态。

响应

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

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

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

    指定分配的存储大小(以 GiB 为单位)。

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

    提供数据库集群快照中的实例可以还原到的 EC2 可用区列表。

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

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

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

    指定从中创建了此数据库集群快照的数据库集群的标识符。

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

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

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

    指定数据库集群快照的标识符。必须与现有快照的标识符匹配。

    在使用 DBClusterSnapshotIdentifier 还原数据库集群后,您必须为该数据库集群的任何将来更新指定相同的 DBClusterSnapshotIdentifier。当您为更新指定此属性时,不会再次从快照还原数据库群集,并且数据库中的数据也不会更改。

    不过,如果您不指定 DBClusterSnapshotIdentifier,则会创建空数据库集群,并删除原始数据库集群。如果指定的属性与以前的快照还原属性不同,则从 DBClusterSnapshotIdentifier 指定的快照中还原数据库集群,并删除原始数据库集群。

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

    指定数据库引擎的名称。

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

    提供此数据库集群快照的数据库引擎的版本。

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

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

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

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

  • LicenseModel(在 CLI 中:--license-model,或者在 Python 中:license_model) – UTF-8 字符串。

    提供此数据库集群快照的许可模式信息。

  • PercentProgress(在 CLI 中:--percent-progress,或者在 Python 中:percent_progress) – 数字 (integer)。

    指定估计的已传输数据百分比。

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

    指定获取快照时数据库集群侦听的端口。

  • SnapshotCreateTime(在 CLI 中:--snapshot-create-time,或者在 Python 中:snapshot_create_time) – 时间戳.

    提供获取快照的时间,以通用协调时 (UTC) 表示。

  • SnapshotType(在 CLI 中:--snapshot-type,或者在 Python 中:snapshot_type) – UTF-8 字符串。

    提供数据库集群快照的类型。

  • SourceDBClusterSnapshotArn(在 CLI 中:--source-db-cluster-snapshot-arn,或者在 Python 中:source_db_cluster_snapshot_arn) – UTF-8 字符串。

    如果数据库集群快照复制自源数据库集群快照,则为源数据库集群快照的 Amazon 资源名称 (ARN),否则为 null 值。

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

    指定此数据库集群快照的状态。

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

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

  • VpcId(在 CLI 中:--vpc-id,或者在 Python 中:vpc_id) – UTF-8 字符串。

    提供与数据库集群快照关联的 VPC ID。

CopyDBClusterSnapshot(操作)

        此 API 的 Amazon CLI 名称为:copy-db-cluster-snapshot,并且 Python 名称是:copy_db_cluster_snapshot.

复制数据库集群的快照。

要从共享的手动数据库集群快照复制数据库集群快照,SourceDBClusterSnapshotIdentifier 必须为共享数据库集群快照的 Amazon 资源名称 (ARN)。

请求

  • CopyTags(在 CLI 中:--copy-tags,或者在 Python 中:copy_tags) – Boolean.

    如果为 true,则将源数据库集群快照的所有标签复制到目标数据库集群快照;否则为 false。默认为 false。

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

    加密数据库集群快照的 Amazon KMS 密钥 ID。KMS 密钥 ID 是 Amazon 资源名称 (ARN)、KMS 密钥标识符或 KMS 加密密钥的 KMS 密钥别名。

    如果您从 Amazon 账户复制加密的数据库集群快照,则可以为KmsKeyId使用新的 KMS 加密密钥对副本进行加密。如果您不为 KmsKeyId 指定值,则使用与源数据库集群快照相同的 KMS 密钥来加密数据库集群快照的副本。

    如果您复制从其他 Amazon 账户共享的加密数据库集群快照,则必须为KmsKeyId.

    KMS 加密密钥特定于创建它时所在的亚马逊区域,您无法将一个亚马逊区域的加密密钥用于另一个亚马逊区域。

    您无法在复制时加密未加密的数据库集群快照。如果您尝试复制未加密的数据库集群快照并为 KmsKeyId 参数指定值,则会返回错误。

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

    当前不支持。

  • SourceDBClusterSnapshotIdentifier(在 CLI 中:--source-db-cluster-snapshot-identifier,或者在 Python 中:source_db_cluster_snapshot_identifier) –:必需 UTF-8 字符串。

    要复制的数据库集群快照的标识符。此参数不区分大小写。

    约束:

    • 必须指定处于“available”状态的有效系统快照。

    • 指定有效的数据库快照标识符。

    示例:my-cluster-snapshot1

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

    分配到新数据库集群快照副本的标签。

  • TargetDBClusterSnapshotIdentifier(在 CLI 中:--target-db-cluster-snapshot-identifier,或者在 Python 中:target_db_cluster_snapshot_identifier) –:必需 UTF-8 字符串。

    要从源数据库集群快照创建的新数据库集群快照标识符。此参数不区分大小写。

    约束:

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

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

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

    示例:my-cluster-snapshot2

响应

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

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

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

    指定分配的存储大小(以 GiB 为单位)。

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

    提供数据库集群快照中的实例可以还原到的 EC2 可用区列表。

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

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

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

    指定从中创建了此数据库集群快照的数据库集群的标识符。

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

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

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

    指定数据库集群快照的标识符。必须与现有快照的标识符匹配。

    在使用 DBClusterSnapshotIdentifier 还原数据库集群后,您必须为该数据库集群的任何将来更新指定相同的 DBClusterSnapshotIdentifier。当您为更新指定此属性时,不会再次从快照还原数据库群集,并且数据库中的数据也不会更改。

    不过,如果您不指定 DBClusterSnapshotIdentifier,则会创建空数据库集群,并删除原始数据库集群。如果指定的属性与以前的快照还原属性不同,则从 DBClusterSnapshotIdentifier 指定的快照中还原数据库集群,并删除原始数据库集群。

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

    指定数据库引擎的名称。

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

    提供此数据库集群快照的数据库引擎的版本。

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

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

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

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

  • LicenseModel(在 CLI 中:--license-model,或者在 Python 中:license_model) – UTF-8 字符串。

    提供此数据库集群快照的许可模式信息。

  • PercentProgress(在 CLI 中:--percent-progress,或者在 Python 中:percent_progress) – 数字 (integer)。

    指定估计的已传输数据百分比。

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

    指定获取快照时数据库集群侦听的端口。

  • SnapshotCreateTime(在 CLI 中:--snapshot-create-time,或者在 Python 中:snapshot_create_time) – 时间戳.

    提供获取快照的时间,以通用协调时 (UTC) 表示。

  • SnapshotType(在 CLI 中:--snapshot-type,或者在 Python 中:snapshot_type) – UTF-8 字符串。

    提供数据库集群快照的类型。

  • SourceDBClusterSnapshotArn(在 CLI 中:--source-db-cluster-snapshot-arn,或者在 Python 中:source_db_cluster_snapshot_arn) – UTF-8 字符串。

    如果数据库集群快照复制自源数据库集群快照,则为源数据库集群快照的 Amazon 资源名称 (ARN),否则为 null 值。

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

    指定此数据库集群快照的状态。

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

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

  • VpcId(在 CLI 中:--vpc-id,或者在 Python 中:vpc_id) – UTF-8 字符串。

    提供与数据库集群快照关联的 VPC ID。

ModifyDBClusterSnapshotAttribute(操作)

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

向手动数据库集群快照添加属性和值,或者从中删除属性和值。

要与其他 Amazon 账户共享手动数据库集群快照,请指定restore作为AttributeName并使用ValuesToAdd参数添加有权还原手动数据库集群快照的 Amazon 账户 ID 列表。使用值all以公开手动数据库集群快照,这意味着所有 Amazon 账户都可以复制或还原它。不要添加all值,如果任何手动数据库集群快照包含您不想向所有 Amazon 账户公开的私有信息,则为此。如果手动数据库集群快照已加密,则可以共享它,但只能通过为ValuesToAdd参数。在这种情况下,您不能使用 all 作为该参数的值。

要查看哪些 Amazon 账户有权复制或还原手动数据库集群快照,或者手动数据库集群快照为公有还是私有,请使用DescribeDBClusterSnapshotAttributes(操作)API 操作。

请求

  • AttributeName(在 CLI 中:--attribute-name,或者在 Python 中:attribute_name) –:必需 UTF-8 字符串。

    要修改的数据库集群快照属性的名称。

    要管理其他 Amazon 账户复制或还原手动数据库集群快照的授权,请将此值设置为restore.

  • DBClusterSnapshotIdentifier(在 CLI 中:--db-cluster-snapshot-identifier,或者在 Python 中:db_cluster_snapshot_identifier) –:必需 UTF-8 字符串。

    要修改其属性的数据库集群快照的标识符。

  • ValuesToAdd(在 CLI 中:--values-to-add,或者在 Python 中:values_to_add) — 一个属性 Values — 一个 UTF-8 字符串数组。

    要添加到 AttributeName 所指定属性中的数据库集群快照属性的列表。

    要授权其他 Amazon 账户复制或还原手动数据库集群快照,请设置此列表,在其中包含一个或多个 Amazon 账户 ID,或者all以使手动数据库集群快照可由所有 Amazon 账户还原。不要添加all值,如果任何手动数据库集群快照包含您不想向所有 Amazon 账户公开的私有信息,则为此。

  • ValuesToRemove(在 CLI 中:--values-to-remove,或者在 Python 中:values_to_remove) — 一个属性 Values — 一个 UTF-8 字符串数组。

    要从 AttributeName 所指定属性中删除的数据库集群快照属性的列表。

    要删除其他 Amazon 账户复制或还原手动数据库集群快照的授权,请设置此列表,在其中包含一个或多个 Amazon 账户标识符,或者all删除对任何 Amazon 帐户复制或还原数据库集群快照的授权。如果指定all,这是一个亚马逊账户,其账户 ID 已明确添加到restore属性仍可以复制或还原手动数据库集群快照。

响应

包含成功调用DescribeDBClusterSnapshotAttributes(操作) API 操作的结果。

手动数据库集群快照属性用于授权其他 Amazon 账户复制或还原手动数据库集群快照。有关更多信息,请参阅 ModifyDBClusterSnapshotAttribute(操作) API 操作。

  • DBClusterSnapshotAttributes(在 CLI 中:--db-cluster-snapshot-attributes,或者在 Python 中:db_cluster_snapshot_attributes) — 数组DBClusterSnapshotAttribute数据库快照属性对象。

    手动数据库集群快照的属性和值的列表。

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

    属性应用到的手动数据库集群快照的标识符。

RestoreDBClusterFromSnapshot(操作)

        此 API 的 Amazon CLI 名称为::。restore-db-cluster-from-snapshot,并且 Python 名称是:restore_db_cluster_from_snapshot.

从数据库快照或数据库集群快照创建新的数据库集群。

如果指定数据库快照,则使用默认配置和默认安全组,从源数据库快照创建目标数据库集群。

如果指定数据库集群快照,则使用具有与原始源数据库集群相同配置的源数据库集群恢复点,创建目标数据库集群,不同之处在于新数据库集群在默认安全组中创建。

请求

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

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

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

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

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

    不支持.

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

    从数据库快照或数据库集群快照创建的数据库集群的名称。该参数不区分大小写。

    约束:

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

    • 第一个字符必须是字母

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

    示例:my-snapshot-id

  • 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 字符串。

    用于新数据库集群的数据库子网组的名称。

    约束:如果提供,必须与现有 DBSubnetGroup 的名称匹配。

    示例:mySubnetgroup

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

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

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

    要导出到 Amazon CloudWatch Logs 的已还原数据库集群的日志列表。

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

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

    默认值:false

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

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

    默认值:与源相同

    约束:必须与源的引擎兼容

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

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

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

    从数据库快照或数据库集群快照还原加密数据库集群时使用的 Amazon KMS 密钥标识符。

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

    如果您未指定 KmsKeyId 参数的值,则会出现以下情况:

    • 如果 SnapshotIdentifier 中的数据库快照或数据库集群快照已加密,将使用用于加密数据库快照或数据库集群快照的同一 KMS 密钥加密还原的数据库集群。

    • 如果 SnapshotIdentifier 中的数据库快照或数据库集群快照未加密,还原的数据库集群也不会加密。

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

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

    约束:值必须为1150-65535

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

  • SnapshotIdentifier(在 CLI 中:--snapshot-identifier,或者在 Python 中:snapshot_identifier) –:必需 UTF-8 字符串。

    要从中进行还原的数据库快照或数据库集群快照的标识符。

    您可以使用名称或 Amazon 资源名称 (ARN) 指定数据库集群快照。但是,您只能使用 ARN 指定数据库快照。

    约束:

    • 必须与现有快照的标识符匹配。

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

    要分配给所还原数据库集群的标签。

  • VpcSecurityGroupIds(在 CLI 中:--vpc-security-group-ids,或者在 Python 中:vpc_security_group_ids) — VpcSecurityGroup 的数组 — UTF-8 字符串。

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

响应

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

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

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

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

  • AssociatedRoles(在 CLI 中:--associated-roles,或者在 Python 中:associated_roles) — 数组DBClusterRole数据库群集角色。

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

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

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

  • AvailabilityZones(在 CLI 中:--availability-zones,或者在 Python 中:availability_zones) — 一个可用性区的数组 — 一个 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 or 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 安全组的列表。

RestoreDBClusterToPointInTime(操作)

        此 API 的 Amazon CLI 名称为::。restore-db-cluster-to-point-in-time,并且 Python 名称是:restore_db_cluster_to_point_in_time.

将数据库集群还原到任意时间点。用户可以还原到 LatestRestorableTime 之前最多 BackupRetentionPeriod 天的任意时间点。使用具有与原始数据库集群相同配置的源数据库集群创建目标数据库集群,不同之处在于新数据库集群在默认数据库安全组中创建。

注意

此操作仅还原数据库集群,而不还原该数据库集群的数据库实例。您必须调用CreateDBInstance(操作)操作为还原的数据库集群创建数据库实例,并在 DBClusterIdentifier 中指定还原的数据库集群的标识符。只有在完成 RestoreDBClusterToPointInTime 操作并且数据库集群可用后,您才能创建数据库实例。

请求

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

    要创建的新数据库集群的名称。

    约束:

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

    • 第一个字符必须是字母

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

  • 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 字符串。

    要用于新数据库集群的数据库子网组名称。

    约束:如果提供,必须与现有 DBSubnetGroup 的名称匹配。

    示例: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 or Access Management (IAM) 账户与数据库账户之间的映射;否则为 false。

    默认值:false

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

    从加密数据库集群快照还原加密数据库集群时使用的 Amazon KMS 密钥标识符。

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

    您可以还原到新数据库集群,并使用与加密源数据库集群所用密钥不同的 KMS 密钥,加密新数据库集群。新数据库集群使用由 KmsKeyId 参数确定的 KMS 密钥加密。

    如果您未指定 KmsKeyId 参数的值,则会出现以下情况:

    • 如果数据库集群已加密,将使用用于加密源数据库集群的同一 KMS 密钥加密还原的数据库集群。

    • 如果数据库集群未加密,还原的数据库集群也不会加密。

    如果 DBClusterIdentifier 引用未加密的数据库集群,则将拒绝恢复请求。

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

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

    约束:值必须为1150-65535

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

  • RestoreToTime(在 CLI 中:--restore-to-time,或者在 Python 中:restore_to_time) – 时间戳.

    要将数据库集群还原到的日期和时间。

    有效值: 值必须为通用协调时 (UTC) 格式的时间

    约束:

    • 必须在数据库实例的最新可还原时间之前

    • 如果未提供 UseLatestRestorableTime 参数,则必须指定

    • 如果 UseLatestRestorableTime 参数为 true,则无法指定

    • 如果 RestoreType 参数为 copy-on-write,则无法指定

    示例:2015-03-07T23:45:00Z

  • RestoreType(在 CLI 中:--restore-type,或者在 Python 中:restore_type) – UTF-8 字符串。

    要执行的还原类型。可以指定以下值之一:

    • full-copy – 新数据库集群作为源数据库集群的完整副本还原。

    • copy-on-write – 新数据库集群作为源数据库集群的克隆还原。

    如果您没有指定 RestoreType 值,则新数据库集群作为源数据库集群的完整副本还原。

  • SourceDBClusterIdentifier(在 CLI 中:--source-db-cluster-identifier,或者在 Python 中:source_db_cluster_identifier) –:必需 UTF-8 字符串。

    要从中还原的源数据库集群的标识符。

    约束:

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

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

    要应用到所还原数据库集群的标签。

  • UseLatestRestorableTime(在 CLI 中:--use-latest-restorable-time,或者在 Python 中:use_latest_restorable_time) – Boolean.

    值设置为 true 时,将数据库集群还原到最新可还原的备份时间,否则为 false

    默认值:false

    约束:如果是否指定的RestoreToTime参数。

  • VpcSecurityGroupIds(在 CLI 中:--vpc-security-group-ids,或者在 Python 中:vpc_security_group_ids) — VpcSecurityGroup 的数组 — UTF-8 字符串。

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

响应

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

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

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

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

  • AssociatedRoles(在 CLI 中:--associated-roles,或者在 Python 中:associated_roles) — 数组DBClusterRole数据库群集角色。

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

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

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

  • AvailabilityZones(在 CLI 中:--availability-zones,或者在 Python 中:availability_zones) — 一个可用性区的数组 — 一个 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 or 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 安全组的列表。

DescribeDBClusterSnapshots(操作)

        此 API 的 Amazon CLI 名称为::。describe-db-cluster-snapshots,并且 Python 名称是:describe_db_cluster_snapshots.

返回有关数据库集群快照的信息。此 API 操作支持分页。

请求

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

    要为其检索数据库集群快照列表的数据库集群的 ID。此参数不能与 DBClusterSnapshotIdentifier 参数结合使用。此参数不区分大小写。

    约束:

    • 如果提供,则必须与现有 DBCluster 的标识符匹配。

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

    要描述的特定数据库集群快照标识符。此参数不能与 DBClusterIdentifier 参数结合使用。此值以一个小写字符串存储。

    约束:

    • 如果提供,则必须与现有 DBClusterSnapshot 的标识符匹配。

    • 如果此标识符用于自动快照,则还必须指定 SnapshotType 参数。

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

    当前不支持此参数。

  • IncludePublic(在 CLI 中:--include-public,或者在 Python 中:include_public) – Boolean.

    如果为 true,则包括可由所有 Amazon 账户复制或还原的公有手动数据库集群快照,否则为 false。默认为 false。默认为 false。

    您可使用 ModifyDBClusterSnapshotAttribute(操作) API 操作,将手动数据库集群快照作为公有来共享。

  • IncludeShared(在 CLI 中:--include-shared,或者在 Python 中:include_shared) – Boolean.

    如果为 true,则包括来自其他 Amazon 账户且此 Amazon 账户已授权复制或还原的共享手动数据库集群快照,否则为 false。默认为 false

    您可以通过ModifyDBClusterSnapshotAttribute(操作)API 操作。

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

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

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

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

    默认值:100

    约束:最低为 20,最高为 100。

  • SnapshotType(在 CLI 中:--snapshot-type,或者在 Python 中:snapshot_type) – UTF-8 字符串。

    要返回的数据库集群快照的类型。可以指定以下值之一:

    • automated-返回由 Amazon Neptune 为您的 Amazon 账户自动获取的所有数据库集群快照。

    • manual-返回由您的 Amazon 账户获取的所有数据库集群快照。

    • shared-返回与您 Amazon 账户共享的所有手动数据库集群快照。

    • public – 返回已标记为公有的所有数据库集群快照。

    如果您未指定 SnapshotType 值,则返回自动和手动数据库集群快照。您可以通过将 IncludeShared 参数设置为 true,在这些结果中包括共享数据库集群快照。您可以通过将 IncludePublic 参数设置为 true,在这些结果中包括公有数据库集群快照。

    IncludeSharedIncludePublic 参数不适用于 SnapshotType 的值 manualautomatedSnapshotType 设置为 shared 时,IncludePublic 参数不适用。SnapshotType 设置为 public 时,IncludeShared 参数不适用。

响应

  • DBClusterSnapshots(在 CLI 中:--db-cluster-snapshots,或者在 Python 中:db_cluster_snapshots) — 数组DBClusterSnapshot数据库集快照对象。

    提供用户的数据库集群快照的列表。

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

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

DescribeDBClusterSnapshotAttributes(操作)

        此 API 的 Amazon CLI 名称为::。describe-db-cluster-snapshot-attributes,并且 Python 名称是:describe_db_cluster_snapshot_attributes.

返回手动数据库集群快照的数据库集群快照属性名称和值的列表。

与其他亚马逊账户共享快照时,DescribeDBClusterSnapshotAttributes返回restore属性以及有权复制或还原手动数据库集群快照的 Amazon 账户的 ID 列表。如果all包含在restore属性,则手动数据库集群快照为公有,可以由所有 Amazon 账户复制或还原。

要为 Amazon 账户添加或删除用于复制或还原手动数据库集群快照的权限,或者使手动数据库集群快照为公有或私有,请使用ModifyDBClusterSnapshotAttribute(操作)API 操作。

请求

  • DBClusterSnapshotIdentifier(在 CLI 中:--db-cluster-snapshot-identifier,或者在 Python 中:db_cluster_snapshot_identifier) –:必需 UTF-8 字符串。

    要描述其属性的数据库集群快照的标识符。

响应

包含成功调用DescribeDBClusterSnapshotAttributes(操作) API 操作的结果。

手动数据库集群快照属性用于授权其他 Amazon 账户复制或还原手动数据库集群快照。有关更多信息,请参阅 ModifyDBClusterSnapshotAttribute(操作) API 操作。

  • DBClusterSnapshotAttributes(在 CLI 中:--db-cluster-snapshot-attributes,或者在 Python 中:db_cluster_snapshot_attributes) — 数组DBClusterSnapshotAttribute数据库快照属性对象。

    手动数据库集群快照的属性和值的列表。

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

    属性应用到的手动数据库集群快照的标识符。