CreateDBCluster - Amazon DocumentDB
请求参数响应元素错误另请参阅

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

CreateDBCluster

创建新的 Amazon DocumentDB 集群。

请求参数

有关所有操作的通用参数的信息，请参阅通用参数。

DBClusterIdentifier

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

约束：

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

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

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

示例：my-cluster

类型：字符串

必需：是

Engine

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

有效值：docdb

类型：字符串

必需：是

AvailabilityZones。 AvailabilityZone.N

可以在集群中创建实例的 Amazon EC2 可用区域列表。

类型：字符串数组

必需：否

BackupRetentionPeriod

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

默认值：1

约束：

  • 必须为介于 1 和 35 之间的值。

类型：整数

必需：否

DBClusterParameterGroupName

要与此集群关联的集群参数组的名称。

类型：字符串

必需：否

DBSubnetGroupName

要与此集群关联的子网组。

约束：必须与现有 DBSubnetGroup 的名称匹配。不能是默认值。

示例：mySubnetgroup

类型：字符串

必需：否

DeletionProtection

指定是否可以删除此集群。如果 DeletionProtection 启用，则无法删除集群，除非集群经修改并 DeletionProtection 禁用。DeletionProtection 防止意外删除集群。

类型：布尔值

必需：否

EnableCloudwatchLogsExports.member.n

需要启用才能导出到 Amazon CloudWatch 日志的日志类型列表。您可以启用审核日志或分析器日志。有关更多信息，请参阅审核 Amazon DocumentDB 事件和分析 Amazon DocumentDB 操作。

类型：字符串数组

必需：否

EngineVersion

要使用的数据库引擎的版本号。--engine-version 将默认为最新的主引擎版本。对于生产工作负载，我们建议使用预期的主引擎版本明确声明此参数。

类型：字符串

必需：否

GlobalClusterIdentifier

新全局集群的集群标识符。

类型：字符串

长度限制：长度下限为 1。最大长度为 255。

模式：[A-Za-z][0-9A-Za-z-:._]*

必需：否

KmsKeyId

加密集群的 AWS KMS 密钥标识符。

AWS KMS 密钥标识符是 AWS KMS 加密密钥的 Amazon 资源名称 (ARN)。如果您使用拥有用于加密新集群的 AWS KMS 加密密钥的集群创建集群，则可以使用 AWS KMS 密钥别名代替 ARN 作为 AWS KMS 加密密钥。 AWS 账户

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

  • 如果 StorageEncrypted 参数为 true，则 Amazon DocumentDB 将使用您的默认加密密钥。

AWS KMS 为您创建默认加密密钥 AWS 账户。每个 AWS 账户 都有不同的默认加密密钥 AWS 区域。

类型：字符串

必需：否

ManageMasterUserPassword

指定是否使用亚马逊 Web Services Secrets Manager 管理主用户密码。

限制：如果已指定，则无法使用 Amazon Web Services Sec MasterUserPassword rets Manager 管理主用户密码。

类型：布尔值

必需：否

MasterUsername

集群的主用户名称。

约束：

  • 必须为 1 到 63 个字母或数字。

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

  • 不能是所选数据库引擎的保留字。

类型：字符串

必需：否

MasterUserPassword

主数据库用户的密码。此密码可以包含除正斜杠 (/)、双引号 (") 或 @ 符号之外的任何可打印的 ASCII 字符。

约束：必须包含 8 到 100 个字符。

类型：字符串

必需：否

MasterUserSecretKmsKeyId

Amazon Web Services KMS 密钥标识符，用于加密在亚马逊 Web Services Secrets Manager 中自动生成和管理的密钥。只有当主用户密码由 Amazon DocumentDB 在数据库集群的 Amazon Web Services Secrets Manager 中管理时，此设置才有效。

Amazon Web Services KMS 密钥标识符是 KMS 密钥的密钥 ARN、密钥 ID、别名 ARN 或 KMS 密钥的别名。要在不同的亚马逊 Web Services 账户中使用 KMS 密钥，请指定密钥 ARN 或别名 ARN。

如果您未指定MasterUserSecretKmsKeyId，则使用 aws/secretsmanager KMS 密钥对密钥进行加密。如果密钥位于另一个 Amazon Web Services 账户中，则无法使用 KMS 密aws/secretsmanager钥加密该密钥，必须使用客户管理的 KMS 密钥。

您的 Amazon Web Services 账户有默认 KMS 密钥。您的亚马逊 Web Services 账户在每个亚马逊云科技区域都有不同的默认 KMS 密钥。

类型：字符串

必需：否

Port

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

类型：整数

必需：否

PreferredBackupWindow

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

默认值是从 8 小时的时间段中随机选择一个 30 分钟的窗口。 AWS 区域

约束：

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

  • 必须采用通用协调时间（UTC）。

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

  • 必须至少为 30 分钟。

类型：字符串

必需：否

PreferredMaintenanceWindow

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

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

默认值是从 8 小时的时间段中随机选择一个 30 分钟的窗口 AWS 区域，出现在一周中的随机某一天。

有效日：Mon、Tue、Wed、Thu、Fri、Sat、Sun

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

类型：字符串

必需：否

PreSignedUrl

当前不支持。

类型：字符串

必需：否

StorageEncrypted

指定集群是否已加密。

类型：布尔值

必需：否

StorageType

与数据库集群关联的存储类型。

有关 Amazon DocumentDB 集群存储类型的信息，请参阅《Amazon DocumentDB 开发人员指南》中的集群存储配置。

存储类型的有效值 - standard | iopt1

默认值为 standard

注意

创建存储类型设置为 iopt1 的 DocumentDB 数据库集群时，响应中会返回存储类型。将存储类型设置为 standard 时不会返回该存储类型。

类型：字符串

必需：否

Tags.Tag.N

要分配给集群的标签。

类型：Tag 对象数组

必需：否

VpcSecurityGroupIds。 VpcSecurityGroupId.N

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

类型：字符串数组

必需：否

响应元素

服务返回以下元素。

DBCluster

有关集群的详细信息。

类型：DBCluster 对象

错误

有关所有操作的常见错误的信息，请参阅常见错误。

DBClusterAlreadyExistsFault

用户已拥有具有给定标识符的集群。

HTTP 状态代码：400

DBClusterNotFoundFault

DBClusterIdentifier 并不引用现有集群。

HTTP 状态代码：404

DBClusterParameterGroupNotFound

DBClusterParameterGroupName 并不引用现有集群参数组。

HTTP 状态代码：404

DBClusterQuotaExceededFault

无法创建集群，因为您已达到允许的集群最大配额。

HTTP 状态代码：403

DBInstanceNotFound

DBInstanceIdentifier 并不引用现有实例。

HTTP 状态代码：404

DBSubnetGroupDoesNotCoverEnoughAZs

除非只有一个可用区，否则子网组中的子网应至少包含两个可用区。

HTTP 状态代码：400

DBSubnetGroupNotFoundFault

DBSubnetGroupName 并不引用现有子网组。

HTTP 状态代码：404

GlobalClusterNotFoundFault

GlobalClusterIdentifier 并不引用现有全局集群。

HTTP 状态代码：404

InsufficientStorageClusterCapacity

当前操作没有足够的可用存储空间。通过更新子网组来使用具有更多可用存储空间的不同可用区，可以解决此错误。

HTTP 状态代码：400

InvalidDBClusterStateFault

集群未处于有效状态。

HTTP 状态代码：400

InvalidDBInstanceState

指定的实例未处于可用 状态。

HTTP 状态代码：400

InvalidDBSubnetGroupStateFault

无法删除子网组，因为它正在使用中。

HTTP 状态代码：400

InvalidGlobalClusterStateFault

当集群处于这种状态时，无法执行请求的操作。

HTTP 状态代码：400

InvalidSubnet

请求的子网无效，或者请求的多个子网并非全部位于同一个常见虚拟私有云（VPC）中。

HTTP 状态代码：400

InvalidVPCNetworkStateFault

由于所做的更改，子网组在创建后并不会覆盖所有可用区。

HTTP 状态代码：400

KMSKeyNotAccessibleFault

访问 AWS KMS 密钥时出错。

HTTP 状态代码：400

StorageQuotaExceeded

该请求会导致您超出跨所有实例可提供的已允许存储量。

HTTP 状态代码：400

另请参阅

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：