本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
CreateDBCluster
创建新的 Amazon DocumentDB 集群。
请求参数
有关所有操作通用的参数的信息,请参阅常见参数.
- DBClusterIdentifier
-
集群标识符。该参数作为一个小写字符串存储。
约束:
-
必须包含 1 到 63 个字母、数字或连字符。
-
第一个字符必须是字母。
-
不能以连字符结束或包含两个连续连字符。
示例:
my-cluster类型: 字符串
:必需 是
-
- Engine
-
要用于此集群的数据库引擎的名称。
有效值:
docdb类型: 字符串
:必需 是
- 可用性区域。可用性区域。N
-
可在其中创建集群中的实例的 Amazon EC2 可用区的列表。
类型: 字符串数组
:必需 否
- BackupRetentionPeriod
-
自动备份的保留天数。您必须指定最小值 1。
默认值:1
约束:
-
必须为介于 1 和 35 之间的值。
类型: 整数
:必需 否
-
- DBClusterParameterGroupName
-
要与此集群关联的集群参数组的名称。
类型: 字符串
:必需 否
- DBSubnetGroupName
-
要与此集群关联的子网组。
约束:必须与现有
DBSubnetGroup的名称匹配。不能是默认值。示例:
mySubnetgroup类型: 字符串
:必需 否
- DeletionProtection
-
指定是否可以删除此集群。如果
DeletionProtection如果启用,则无法删除集群,除非它被修改并且DeletionProtection已禁用。DeletionProtection防止意外删除集群。类型: Boolean
:必需 否
- 启用 CloudWatch LogSports.Member。
-
需要启用以导出到 Amazon CloudWatch Logs 的日志类型的列表。您可以启用审核日志或分析器日志。有关更多信息,请参阅 。审核 Amazon DocumentDB 事件和分析 Amazon DocumentDB 操作.
类型: 字符串数组
:必需 否
- EngineVersion
-
要使用的数据库引擎的版本号。这些区域有:
--engine-version将默认为最新的主引擎版本。对于生产工作负载,我们建议使用预期的主引擎版本明确声明此参数。类型: 字符串
:必需 否
- GlobalClusterIdentifier
-
新全局集群的集群标识符。
类型: 字符串
长度约束:最小长度为 1。长度上限为 255。
模式:
[A-Za-z][0-9A-Za-z-:._]*:必需 否
- KmsKeyId
-
这些区域有:Amazon KMS已加密集群的密钥标识符。
这些区域有:Amazon KMS密钥标识符是用于Amazon KMS加密密钥。如果你使用相同的创建集群Amazon Web Services 账户那拥有Amazon KMS用来加密新集群的加密密钥,可以使用Amazon KMS的密钥别名而不是 ARNAmazon KMS加密密钥。
未在
KmsKeyId中指定加密密钥时:-
如果
StorageEncrypted参数为true,则 Amazon DocumentDB 将使用您的默认加密密钥。
Amazon KMS创建默认加密密钥Amazon Web Services 账户. 您的Amazon Web Services 账户每个密钥有一个不同的默认加密密钥Amazon Web Services 区域.
类型: 字符串
:必需 否
-
- MasterUsername
-
集群的主用户名称。
约束:
-
必须为 1 到 63 个字母或数字。
-
第一个字符必须是字母。
-
不能是所选数据库引擎的保留字。
类型: 字符串
:必需 否
-
- MasterUserPassword
-
主数据库用户的密码。此密码可以包含除正斜杠 (/)、双引号 (") 或 @ 符号之外的任何可打印的 ASCII 字符。
约束:必须包含 8 到 100 个字符。
类型: 字符串
:必需 否
- Port
-
群集中的实例接受连接的端口号。
类型: 整数
:必需 否
- PreferredBackupWindow
-
使用
BackupRetentionPeriod参数启用了自动备份时,自动执行备份的日常时间范围。默认值是从每个时间段中随机选择的 30 分钟时间。Amazon Web Services 区域.
约束:
-
必须采用
hh24:mi-hh24:mi格式。 -
必须采用通用协调时间 (UTC)。
-
不得与首选维护时段冲突。
-
必须至少为 30 分钟。
类型: 字符串
:必需 否
-
- PreferredMaintenanceWindow
-
可进行系统维护的每周时间范围(采用通用协调时间 (UTC))。
格式:
ddd:hh24:mi-ddd:hh24:mi默认值是从每个时间段中随机选择的 30 分钟时间。Amazon Web Services 区域,可以是一周中的任意一天。
有效值:Mon、Ted、Wed、Tu、Fri、Sat、Sun
约束:窗口至少为 30 分钟。
类型: 字符串
:必需 否
- PreSignedUrl
-
当前不支持。
类型: 字符串
:必需 否
- StorageEncrypted
-
指定集群是否已加密。
类型: Boolean
:必需 否
- 标签 s.Tag.N
-
要分配给集群的标签。
类型: 数组Tag对象
:必需 否
- vpc 安全组 ID.vpc 安全组 ID.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
-
访问时出错Amazon KMS键。
HTTP 状态代码:400
- StorageQuotaExceeded
-
此请求将导致您超出所有实例中允许的可用存储量。
HTTP 状态代码:400
另请参阅
有关在特定语言的Amazon软件开发工具包中使用此 API 的更多信息,请参阅以下内容: