AWS::DocDB::DBCluster - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::DocDB::DBCluster

AWS::DocDB::DBCluster Amazon DocumentDB(与 MongoDB 兼容)资源描述 DBCluster。Amazon DocumentDB 是一个完全托管的兼容 MongoDB 的文档数据库引擎。有关更多信息,请参阅 Amazon DocumentDB 开发人员指南 中的 DBCluster

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Type" : "AWS::DocDB::DBCluster", "Properties" : { "AvailabilityZones" : [ String, ... ], "BackupRetentionPeriod" : Integer, "DBClusterIdentifier" : String, "DBClusterParameterGroupName" : String, "DBSubnetGroupName" : String, "DeletionProtection" : Boolean, "EnableCloudwatchLogsExports" : [ String, ... ], "EngineVersion" : String, "KmsKeyId" : String, "MasterUsername" : String, "MasterUserPassword" : String, "Port" : Integer, "PreferredBackupWindow" : String, "PreferredMaintenanceWindow" : String, "SnapshotIdentifier" : String, "StorageEncrypted" : Boolean, "Tags" : [ Tag, ... ], "VpcSecurityGroupIds" : [ String, ... ] } }

YAML

Type: AWS::DocDB::DBCluster Properties: AvailabilityZones: - String BackupRetentionPeriod: Integer DBClusterIdentifier: String DBClusterParameterGroupName: String DBSubnetGroupName: String DeletionProtection: Boolean EnableCloudwatchLogsExports: - String EngineVersion: String KmsKeyId: String MasterUsername: String MasterUserPassword: String Port: Integer PreferredBackupWindow: String PreferredMaintenanceWindow: String SnapshotIdentifier: String StorageEncrypted: Boolean Tags: - Tag VpcSecurityGroupIds: - String

属性

AvailabilityZones

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

必需:否

类型:字符串列表

Update requires: Replacement

BackupRetentionPeriod

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

默认值:1

约束:

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

必需:否

类型:整数

Update requires: No interruption

DBClusterIdentifier

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

约束:

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

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

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

示例:my-cluster

必需:否

类型:字符串

Update requires: Replacement

DBClusterParameterGroupName

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

必需:否

类型:字符串

Update requires: No interruption

DBSubnetGroupName

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

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

示例:mySubnetgroup

必需:否

类型:字符串

Update requires: Replacement

DeletionProtection

防止意外删除集群。如果启用,则无法删除集群,除非集群被修改并 DeletionProtection 被禁用。

必需:否

类型:布尔值

Update requires: No interruption

EnableCloudwatchLogsExports

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

必需:否

类型:字符串列表

Update requires: No interruption

EngineVersion

要使用的数据库引擎的版本号。

必需:否

类型:字符串

Update requires: Replacement

KmsKeyId

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

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

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

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

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

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

如果您在其他 AWS 区域中创建加密集群的副本,则必须将 KmsKeyId 设置为在目标 AWS 区域中有效的 KMS 密钥 ID。此密钥用于在该 AWS 区域中加密副本。

必需:否

类型:字符串

Update requires: Replacement

MasterUsername

集群的主用户名称。

约束:

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

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

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

必需:条件

类型:字符串

Update requires: Replacement

MasterUserPassword

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

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

必需:条件

类型:字符串

Update requires: No interruption

Port

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

必需:否

类型:整数

Update requires: No interruption

PreferredBackupWindow

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

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

约束:

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

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

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

  • 必须至少为 30 分钟。

必需:否

类型:字符串

Update requires: No interruption

PreferredMaintenanceWindow

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

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

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

有效值:Mon、Tue、Wed、Thu、Fri、Sat、Sun

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

必需:否

类型:字符串

Update requires: No interruption

SnapshotIdentifier

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

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

约束:

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

必需:否

类型:字符串

Update requires: Replacement

StorageEncrypted

指定集群是否已加密。

必需:条件

类型:布尔值

Update requires: Replacement

Tags

要分配给集群的标签。

必需:否

类型Tag 的列表

Update requires: No interruption

VpcSecurityGroupIds

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

必需:否

类型:字符串列表

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回 DBClusterIdentifier,例如 mycluster

For more information about using the Ref function, see Ref.

Fn::GetAtt

Fn::GetAtt 内部函数返回此类型的一个指定属性的值。以下为可用属性和示例返回值。

有关使用 Fn::GetAtt 内部函数的更多信息,请参阅 Fn::GetAtt

ClusterResourceId

集群的资源 ID;例如:cluster-ABCD1234EFGH5678IJKL90MNOP。集群 ID 唯一标识集群并用于 IAM 身份验证策略等项目。

Endpoint

集群的连接终端节点,例如 sample-cluster.cluster-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com

Port

集群接受连接的端口号。例如:27017

ReadEndpoint

集群的读取器终端节点。例如:sample-cluster.cluster-ro-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com

示例

JSON

{ "AWSTemplateFormatVersion" : "2010-09-09", "Resources" : { "myDBInstance" : { "Type" : "AWS::DocDB::DBCluster", "Properties" : { "BackupRetentionPeriod" : 8, "DBClusterIdentifier" : "sample-cluster", "DBClusterParameterGroupName" : "default.docdb3.6", "DBSubnetGroupName" : "default", "KmsKeyId" : "your-kms-key-id", "MasterUsername" : "your-master-username", "MasterUserPassword" : "your-master-user-password", "Port" : "27017", "PreferredBackupWindow" : "07:34-08:04", "PreferredMaintenanceWindow" : "sat:04:51-sat:05:21", "SnapshotIdentifier" : "sample-cluster-snapshot-id", "StorageEncrypted" : true, "Tags" : [ {"Key" : "String", "Value" : "String"} ] } } } }

YAML

AWSTemplateFormatVersion: "2010-09-09" Resources: myDBInstance: Type: "AWS::DocDB::DBCluster" Properties: BackupRetentionPeriod : 8 DBClusterIdentifier : "sample-cluster" DBClusterParameterGroupName : "default.docdb3.6" DBSubnetGroupName : "default" KmsKeyId : "your-kms-key-id" MasterUsername : "your-master-username" MasterUserPassword : "your-master-user-password" Port : "27017" PreferredBackupWindow : "07:34-08:04" PreferredMaintenanceWindow : "sat:04:51-sat:05:21" SnapshotIdentifier : "sample-cluster-snapshot-id" StorageEncrypted : true Tags: - Key: "String" Value: "String"

另请参阅