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

AWS::DocDB::DBInstance

AWS::DocDB::DBInstance Amazon DocumentDB(与 MongoDB 兼容)资源描述 DBInstance。有关更多信息,请参阅 Amazon DocumentDB 开发人员指南 中的 DBInstance

语法

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

JSON

{ "Type" : "AWS::DocDB::DBInstance", "Properties" : { "AutoMinorVersionUpgrade" : Boolean, "AvailabilityZone" : String, "DBClusterIdentifier" : String, "DBInstanceClass" : String, "DBInstanceIdentifier" : String, "PreferredMaintenanceWindow" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::DocDB::DBInstance Properties: AutoMinorVersionUpgrade: Boolean AvailabilityZone: String DBClusterIdentifier: String DBInstanceClass: String DBInstanceIdentifier: String PreferredMaintenanceWindow: String Tags: - Tag

属性

AutoMinorVersionUpgrade

指示在维护窗口期间,将对该实例自动应用次要引擎升级。

默认值:true

必需:否

类型:布尔值

Update requires: No interruption

AvailabilityZone

在其中创建了实例的 Amazon EC2 可用区。

默认值:终端节点的 AWS 区域中系统随机选择的可用区。

示例:us-east-1d

必需:否

类型:字符串

Update requires: Replacement

DBClusterIdentifier

实例所属的集群的标识符。

必需:是

类型:字符串

Update requires: Replacement

DBInstanceClass

实例的计算和内存容量;例如,db.m4.large。如果您更改实例的类,则集群的服务可能会中断。

必需:是

类型:字符串

Update requires: No interruption

DBInstanceIdentifier

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

约束:

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

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

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

示例:mydbinstance

必需:否

类型:字符串

Update requires: Replacement

PreferredMaintenanceWindow

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

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

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

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

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

必需:否

类型:字符串

Update requires: No interruption

Tags

要分配给实例的标签。您可以为每个实例分配最多 10 个标签。

必需:否

类型Tag 的列表

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回 DBInstance 的名称,例如 sample-cluster-instance

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

Fn::GetAtt

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

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

Endpoint

实例的连接终端节点。例如:sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com

Port

数据库接受连接的端口号,如 27017

示例

JSON

{ "Type" : "AWS::DocDB::DBInstance", "Properties" : { "AutoMinorVersionUpgrade" : true, "AvailabilityZone" : "us-east-1c", "DBClusterIdentifier" : "sample-cluster", "DBInstanceClass" : "db.r5.large", "DBInstanceIdentifier" : "sample-cluster-instance-0", "PreferredMaintenanceWindow" : "sat:06:54-sat:07:24", "Tags" : [{ "Key": "String","Value": "String" }] } }

YAML

Type: "AWS::DocDB::DBInstance" Properties: AutoMinorVersionUpgrade: true AvailabilityZone: "us-east-1c" DBClusterIdentifier: "sample-cluster" DBInstanceClass: "db.r5.large" DBInstanceIdentifier: "sample-cluster-instance-0" PreferredMaintenanceWindow: "sat:06:54-sat:07:24" Tags: - Key: "String" Value: "String"

另请参阅