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

AWS::Neptune::DBCluster

AWS::Neptune::DBCluster 资源创建一个 Amazon Neptune 数据库集群。Neptune 是一种完全托管的图形数据库。

注意

目前,您只能在支持 Amazon Neptune 的 AWS 区域中创建此资源。

如果没有为 AWS::Neptune::DBCluster 资源设置 DeletionPolicy,则默认删除行为是删除整个卷且不创建快照。要保留卷的备份,DeletionPolicy 应设置为 Snapshot。有关 AWS CloudFormation 如何删除资源的更多信息,请参阅 DeletionPolicy 属性

您可以使用 AWS::Neptune::DBCluster.DeletionProtection 帮助防止意外删除数据库集群。

语法

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

JSON

{ "Type" : "AWS::Neptune::DBCluster", "Properties" : { "AvailabilityZones" : [ String, ... ], "BackupRetentionPeriod" : Integer, "DBClusterIdentifier" : String, "DBClusterParameterGroupName" : String, "DBSubnetGroupName" : String, "DeletionProtection" : Boolean, "EnableCloudwatchLogsExports" : [ String, ... ], "EngineVersion" : String, "IamAuthEnabled" : Boolean, "KmsKeyId" : String, "Port" : Integer, "PreferredBackupWindow" : String, "PreferredMaintenanceWindow" : String, "RestoreToTime" : String, "RestoreType" : String, "SnapshotIdentifier" : String, "SourceDBClusterIdentifier" : String, "StorageEncrypted" : Boolean, "Tags" : [ Tag, ... ], "UseLatestRestorableTime" : Boolean, "VpcSecurityGroupIds" : [ String, ... ] } }

YAML

Type: AWS::Neptune::DBCluster Properties: AvailabilityZones: - String BackupRetentionPeriod: Integer DBClusterIdentifier: String DBClusterParameterGroupName: String DBSubnetGroupName: String DeletionProtection: Boolean EnableCloudwatchLogsExports: - String EngineVersion: String IamAuthEnabled: Boolean KmsKeyId: String Port: Integer PreferredBackupWindow: String PreferredMaintenanceWindow: String RestoreToTime: String RestoreType: String SnapshotIdentifier: String SourceDBClusterIdentifier: String StorageEncrypted: Boolean Tags: - Tag UseLatestRestorableTime: Boolean VpcSecurityGroupIds: - String

属性

AvailabilityZones

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

必需:否

类型:字符串列表

Update requires: Replacement

BackupRetentionPeriod

指定自动数据库快照的保留天数。

更新可能需要一些中断。有关更多信息,请参阅《Amazon Neptune 用户指南》中的ModifyDBInstance

必需:否

类型:整数

Update requires: No interruption

DBClusterIdentifier

包含用户提供的数据库集群标识符。此标识符是识别数据库集群的唯一键。

必需:否

类型:字符串

Update requires: Replacement

DBClusterParameterGroupName

提供数据库集群参数组的名称。

更新可能需要一些中断。有关更多信息,请参阅《Amazon Neptune 用户指南》中的ModifyDBInstance

必需:否

类型:字符串

Update requires: No interruption

DBSubnetGroupName

指定与数据库集群关联的子网组的信息,包括名称、描述和子网组中的子网。

必需:否

类型:字符串

Update requires: Replacement

DeletionProtection

指示数据库集群是否已启用删除保护。在启用删除保护时,无法删除数据库。

必需:否

类型:布尔值

Update requires: No interruption

EnableCloudwatchLogsExports

指定需要启用以导出到 CloudWatch Logs 的日志类型的列表。

必需:否

类型:字符串列表

Update requires: No interruption

EngineVersion

指示数据库引擎版本。

必需:否

类型:字符串

Update requires: Replacement

IamAuthEnabled

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

必需:否

类型:布尔值

Update requires: No interruption

KmsKeyId

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

必需:否

类型:字符串

Update requires: Replacement

Port

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

必需:否

类型:整数

Update requires: No interruption

PreferredBackupWindow

指定在启用自动备份时,自动执行备份的日常时间范围,如 BackupRetentionPeriod 所规定。

更新可能需要一些中断。

必需:否

类型:字符串

Update requires: No interruption

PreferredMaintenanceWindow

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

必需:否

类型:字符串

Update requires: No interruption

RestoreToTime

Not currently supported by AWS CloudFormation.

必需:否

类型:字符串

Update requires: Replacement

RestoreType

Not currently supported by AWS CloudFormation.

必需:否

类型:字符串

Update requires: Replacement

SnapshotIdentifier

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

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

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

必需:否

类型:字符串

Update requires: Replacement

SourceDBClusterIdentifier

Not currently supported by AWS CloudFormation.

必需:否

类型:字符串

Update requires: Replacement

StorageEncrypted

指示数据库集群是否已加密。

如果您指定了 DBClusterIdentifierDBSnapshotIdentifierSourceDBInstanceIdentifier 属性,请勿指定该属性。该值继承自群集、快照或源数据库实例。如果指定 KmsKeyId 属性,则必须启用加密。

如果指定 KmsKeyId 属性,则必须通过将 StorageEncrypted 设置为 true 来启用加密。

必需:否

类型:布尔值

Update requires: Replacement

Tags

分配给该集群的标签。

必需:否

类型Tag 的列表

Update requires: No interruption

UseLatestRestorableTime

Not currently supported by AWS CloudFormation.

必需:否

类型:布尔值

Update requires: Replacement

VpcSecurityGroupIds

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

必需:否

类型:字符串列表

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回 资源名称。

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

数据库集群的连接终端节点。例如:mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

Port

数据库集群用于接受连接的端口号。例如:8182

ReadEndpoint

数据库集群的读取器终端节点。例如:mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com