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

AWS::Neptune::DBInstance

AWS::Neptune::DBInstance 类型创建一个 Amazon Neptune 数据库实例。

更新数据库实例

您可以为您的数据库实例设置删除策略,以控制 AWS CloudFormation 在堆栈删除后如何处理实例。对于 Neptune 数据库实例,您可以选择保留 实例、删除 实例或为实例创建快照。默认 AWS CloudFormation 行为取决于 DBClusterIdentifier 属性:

  • 对于没有指定 DBClusterIdentifier 属性的 AWS::Neptune::DBInstance 资源,AWS CloudFormation 会保存数据库实例的快照。

  • 对于指定 DBClusterIdentifier 属性的 AWS::Neptune::DBInstance 资源,AWS CloudFormation 会删除数据库实例。

删除数据库实例

重要

如果数据库实例在更新过程中被删除或替换,则 AWS CloudFormation 会删除所有自动快照。但是,它会保留手动数据库快照。在需要替换的更新过程中,您可以应用堆栈策略以防止替换数据库实例。

当对标记为 Update requires: Replacement 的属性进行更新时,AWS CloudFormation 首先创建替代数据库实例,再将其他依赖资源的引用更改为指向该替代数据库实例,最后才删除旧的数据库实例。

重要

我们强烈建议您在更新堆栈之前制作数据库的快照。如果不这样做,则 AWS CloudFormation 替换数据库实例时会丢失数据。要保留您的数据,请执行以下过程:

  1. 停用任何使用数据库实例的应用程序,使数据库实例上没有任何活动。

  2. 创建数据库实例的快照。

  3. 如果您要使用数据库快照还原实例,请使用您的数据库实例更改来修改更新的模板,并添加 DBSnapshotIdentifier 属性(其中包含您要使用的数据库快照的 ID)。

  4. 更新堆栈。

语法

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

JSON

{ "Type" : "AWS::Neptune::DBInstance", "Properties" : { "AllowMajorVersionUpgrade" : Boolean, "AutoMinorVersionUpgrade" : Boolean, "AvailabilityZone" : String, "DBClusterIdentifier" : String, "DBInstanceClass" : String, "DBInstanceIdentifier" : String, "DBParameterGroupName" : String, "DBSnapshotIdentifier" : String, "DBSubnetGroupName" : String, "PreferredMaintenanceWindow" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::Neptune::DBInstance Properties: AllowMajorVersionUpgrade: Boolean AutoMinorVersionUpgrade: Boolean AvailabilityZone: String DBClusterIdentifier: String DBInstanceClass: String DBInstanceIdentifier: String DBParameterGroupName: String DBSnapshotIdentifier: String DBSubnetGroupName: String PreferredMaintenanceWindow: String Tags: - Tag

属性

AllowMajorVersionUpgrade

指示允许主要版本升级。更改此参数不会导致中断,所做更改会尽快以异步方式应用。将 EngineVersion 参数的值指定为不同于数据库实例当前版本的主要版本时,此参数必须设置为 true。

必需:否

类型:布尔值

Update requires: No interruption

AutoMinorVersionUpgrade

指示自动应用次要版本补丁。

在更新此属性时,可能会出现一些中断。

必需:否

类型:布尔值

Update requires: No interruption

AvailabilityZone

指定数据库实例所在可用区的名称。

必需:否

类型:字符串

Update requires: Replacement

DBClusterIdentifier

如果数据库实例属于某个数据库集群,则包含数据库实例所属的数据库集群的名称。

必需:否

类型:字符串

Update requires: Replacement

DBInstanceClass

包含数据库实例的计算和内存容量级别名称。

如果您更新此属性,则可能会出现一些中断。

必需:是

类型:字符串

Update requires: No interruption

DBInstanceIdentifier

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

必需:否

类型:字符串

Update requires: Replacement

DBParameterGroupName

现有数据库参数组或在模板中创建的 AWS::Neptune::DBParameterGroup 资源的引用的名称。如果引用的参数组的任何数据成员在更新期间发生更改,就可能要重新启动该数据库实例,从而造成运行中断。如果参数组包含静态参数,则无论这些参数是否发生了更改,更新都将触发重启操作。

必需:否

类型:字符串

Update requires: No interruption

DBSnapshotIdentifier

不支持该参数。

AWS::Neptune::DBInstance 不支持从快照中还原。

AWS::Neptune::DBCluster 支持从快照中还原。

必需:否

类型:字符串

Update requires: Replacement

DBSubnetGroupName

要与此数据库实例关联的数据库子网组。如果您更新了此值,则新子网组必须是新 Virtual Private Cloud (VPC) 中的子网组。

必需:否

类型:字符串

Update requires: Replacement

PreferredMaintenanceWindow

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

必需:否

类型:字符串

Update requires: No interruption

Tags

此数据库实例的任意标签组(键/值对)。

必需:否

类型Tag 的列表

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

Endpoint

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

Port

数据库实例接受连接的端口编号。例如:8182