AWS CloudFormation
Guía del usuario (Versión de API 2010-05-15)

AWS::Neptune::DBCluster

El recurso AWS::Neptune::DBCluster crea un clúster de base de datos de Amazon Neptune. Neptune es una base de datos de gráficos completamente administrada.

nota

Actualmente, solo puede crear este recurso en las regiones de AWS en las que se admite Amazon Neptuno.

Si no establece una DeletionPolicy para los recursos de AWS::Neptune::DBCluster, el comportamiento de eliminación predeterminado es que se eliminará el volumen completo sin una instantánea. Para conservar una copia de seguridad del volumen, la DeletionPolicy debe establecerse en Snapshot. Para obtener más información sobre cómo AWS CloudFormation elimina recursos, consulte el Atributo DeletionPolicy.

Sintaxis

Para declarar esta entidad en su plantilla de AWS CloudFormation, utilice la siguiente sintaxis:

JSON

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

YAML

Type: AWS::Neptune::DBCluster Properties: AvailabilityZones: - String BackupRetentionPeriod: Integer DBClusterIdentifier: String DBClusterParameterGroupName: String DBSubnetGroupName: String IamAuthEnabled: Boolean KmsKeyId: String Port: Integer PreferredBackupWindow: String PreferredMaintenanceWindow: String SnapshotIdentifier: String StorageEncrypted: Boolean Tags: - Tag VpcSecurityGroupIds: - String

Properties

AvailabilityZones

Proporciona la lista de zonas de disponibilidad de EC2 en las que se pueden crear instancias en el clúster de base de datos.

Obligatorio: No

Tipo: lista de cadena

Update requires: Replacement

BackupRetentionPeriod

Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.

Es posible que se produzcan algunas interrupciones durante la actualización. Consulte ModifyDBInstance en la Guía del usuario de Amazon Neptune User Guide para obtener más información.

Obligatorio: No

Tipo: entero

Update requires: No interruption

DBClusterIdentifier

Contiene un identificador de clúster de base de datos suministrado por el usuario. Este identificador es la clave única que identifica un clúster de base de datos.

Obligatorio: No

Tipo: cadena

Update requires: Replacement

DBClusterParameterGroupName

Proporciona el nombre del grupo de parámetros de clúster de base de datos.

Es posible que se produzcan algunas interrupciones durante la actualización. Consulte ModifyDBInstance en la Guía del usuario de Amazon Neptune User Guide para obtener más información.

Obligatorio: No

Tipo: cadena

Update requires: No interruption

DBSubnetGroupName

Especifica información sobre el grupo de subred asociado con el clúster de base de datos, incluido el nombre, la descripción y subredes en el grupo de subred.

Obligatorio: No

Tipo: cadena

Update requires: Replacement

IamAuthEnabled

"True" si la asignación de cuentas de AWS Identity and Access Management (IAM) a cuentas de base de datos está habilitada; de lo contrario, el valor es "false".

Obligatorio: No

Tipo: booleano

Update requires: No interruption

KmsKeyId

Si StorageEncrypted tiene el valor "true", el identificador de la clave de AWS KMS para el clúster de base de datos cifrado.

Obligatorio: No

Tipo: cadena

Update requires: Replacement

Port

Especifica el puerto en el que escucha el motor de la base de datos.

Obligatorio: No

Tipo: entero

Update requires: No interruption

PreferredBackupWindow

Especifica el intervalo de tiempo diario durante el cual se crean copias de seguridad automatizadas si las copias de seguridad automatizadas están habilitadas, de acuerdo con la propiedad BackupRetentionPeriod.

Es posible que se produzcan algunas interrupciones durante la actualización.

Obligatorio: No

Tipo: cadena

Update requires: No interruption

PreferredMaintenanceWindow

Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).

Obligatorio: No

Tipo: cadena

Update requires: No interruption

SnapshotIdentifier

Contiene el identificador del clúster de base de datos de origen si este clúster de base de datos es una réplica de lectura.

Obligatorio: No

Tipo: cadena

Update requires: Replacement

StorageEncrypted

Indica si el clúster de base de datos está cifrado.

Si especifica la propiedad DBClusterIdentifier, DBSnapshotIdentifier o SourceDBInstanceIdentifier, no especifique esta propiedad. El valor se hereda del clúster, la instantánea o la instancia de base de datos de origen. Si especifica la propiedad KmsKeyId, debe habilitar el cifrado.

Si especifica el KmsKeyId, debe habilitar el cifrado estableciendo StorageEncrypted en true.

Obligatorio: No

Tipo: booleano

Update requires: Replacement

Tags

Las etiquetas asignadas a este clúster.

Obligatorio: No

Tipo: lista de Tag

Update requires: No interruption

VpcSecurityGroupIds

Proporciona una lista de grupos de seguridad de VPC a los que pertenece el clúster de base de datos.

Obligatorio: No

Tipo: lista de cadena

Update requires: No interruption

Valores devueltos

Ref.

Cuando se transfiere el ID lógico de este recurso a la función Ref intrínseca, Ref devuelve el nombre del recurso.

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

Fn::GetAtt

La función Fn::GetAtt intrínseca devuelve un valor para un atributo especificado de este tipo. Los valores siguientes son los atributos disponibles y los valores devueltos de ejemplo.

Para obtener más información acerca del uso de la función Fn::GetAtt intrínseca, consulte Fn::GetAtt.

ClusterResourceId

El ID de recurso del clúster de base de datos. Por ejemplo: cluster-ABCD1234EFGH5678IJKL90MNOP. El ID de clúster identifica el clúster de forma exclusiva y se utiliza en elementos como las políticas de autenticación de IAM.

Endpoint

El punto de enlace de conexión para el clúster de base de datos. Por ejemplo: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

Port

El número de puerto en el que el clúster de base de datos acepta las conexiones. Por ejemplo: 8182.

ReadEndpoint

El punto de enlace del lector para el clúster de base de datos. Por ejemplo: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com