

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

# Referencia de la API de administración de Amazon Neptune
<a name="api"></a>

En este capítulo se documentan las operaciones de las API de Neptune que puede utilizar para administrar y mantener el clúster de base de datos de Neptune.

Neptune funciona en clústeres de servidores de base de datos que están conectados en una topología de replicación. Por lo tanto, la administración de Neptune suele requerir la implementación de cambios en varios servidores y asegurarse de que todas las réplicas de Neptune mantengan el ritmo del servidor principal.

Dado que Neptune escala de manera transparente el almacenamiento subyacente a medida que crecen sus datos, la administración de Neptune requiere relativamente poco esfuerzo administrativo del almacenamiento en disco. Del mismo modo, dado que Neptune realiza automáticamente copias de seguridad continuas, el clúster de Neptune no requiere una planificación extensa ni tiempo de inactividad a la hora de realizarlas. 

**Contents**
+ [API de clústeres de base de datos de Neptune](api-clusters.md)
  + [CreateDBCluster (acción)](api-clusters.md#CreateDBCluster)
  + [DeleteDBCluster (acción)](api-clusters.md#DeleteDBCluster)
  + [ModifyDBCluster (acción)](api-clusters.md#ModifyDBCluster)
  + [StartDBCluster (acción)](api-clusters.md#StartDBCluster)
  + [StopDBCluster (acción)](api-clusters.md#StopDBCluster)
  + [AddRoleToDBCluster (acción)](api-clusters.md#AddRoleToDBCluster)
  + [RemoveRoleFromDBCluster (acción)](api-clusters.md#RemoveRoleFromDBCluster)
  + [FailoverDBCluster (acción)](api-clusters.md#FailoverDBCluster)
  + [PromoteReadReplicaDBCluster (acción)](api-clusters.md#PromoteReadReplicaDBCluster)
  + [DescribeDBClusters (acción)](api-clusters.md#DescribeDBClusters)
  + [*Estructuras:*](api-clusters.md#api-clusters-structures-spacer)
  + [DBCluster (estructura)](api-clusters.md#DBCluster)
  + [DBClusterMember (estructura)](api-clusters.md#DBClusterMember)
  + [DBClusterRole (estructura)](api-clusters.md#DBClusterRole)
  + [CloudwatchLogsExportConfiguration (estructura)](api-clusters.md#CloudwatchLogsExportConfiguration)
  + [PendingCloudwatchLogsExports (estructura)](api-clusters.md#PendingCloudwatchLogsExports)
  + [ClusterPendingModifiedValues (estructura)](api-clusters.md#ClusterPendingModifiedValues)
+ [API de base de datos global de Neptune](api-global-dbs.md)
  + [CreateGlobalCluster (acción)](api-global-dbs.md#CreateGlobalCluster)
  + [DeleteGlobalCluster (acción)](api-global-dbs.md#DeleteGlobalCluster)
  + [ModifyGlobalCluster (acción)](api-global-dbs.md#ModifyGlobalCluster)
  + [DescribeGlobalClusters (acción)](api-global-dbs.md#DescribeGlobalClusters)
  + [FailoverGlobalCluster (acción)](api-global-dbs.md#FailoverGlobalCluster)
  + [RemoveFromGlobalCluster (acción)](api-global-dbs.md#RemoveFromGlobalCluster)
  + [*Estructuras:*](api-global-dbs.md#api-global-dbs-structures-spacer)
  + [GlobalCluster (estructura)](api-global-dbs.md#GlobalCluster)
  + [GlobalClusterMember (estructura)](api-global-dbs.md#GlobalClusterMember)
+ [API de instancias de Neptune](api-instances.md)
  + [CreateDBInstance (acción)](api-instances.md#CreateDBInstance)
  + [DeleteDBInstance (acción)](api-instances.md#DeleteDBInstance)
  + [ModifyDBInstance (acción)](api-instances.md#ModifyDBInstance)
  + [RebootDBInstance (acción)](api-instances.md#RebootDBInstance)
  + [DescribeDBInstances (acción)](api-instances.md#DescribeDBInstances)
  + [DescribeOrderableDBInstanceOptions (acción)](api-instances.md#DescribeOrderableDBInstanceOptions)
  + [DescribeValidDBInstanceModifications (acción)](api-instances.md#DescribeValidDBInstanceModifications)
  + [*Estructuras:*](api-instances.md#api-instances-structures-spacer)
  + [DBInstance (estructura)](api-instances.md#DBInstance)
  + [DBInstanceStatusInfo (estructura)](api-instances.md#DBInstanceStatusInfo)
  + [OrderableDBInstanceOption (estructura)](api-instances.md#OrderableDBInstanceOption)
  + [PendingModifiedValues (estructura)](api-instances.md#PendingModifiedValues)
  + [ValidStorageOptions (estructura)](api-instances.md#ValidStorageOptions)
  + [ValidDBInstanceModificationsMessage (estructura)](api-instances.md#ValidDBInstanceModificationsMessage)
+ [API de parámetros de Neptune](api-parameters.md)
  + [CopyDBParameterGroup (acción)](api-parameters.md#CopyDBParameterGroup)
  + [CopyDBClusterParameterGroup (acción)](api-parameters.md#CopyDBClusterParameterGroup)
  + [CreateDBParameterGroup (acción)](api-parameters.md#CreateDBParameterGroup)
  + [CreateDBClusterParameterGroup (acción)](api-parameters.md#CreateDBClusterParameterGroup)
  + [DeleteDBParameterGroup (acción)](api-parameters.md#DeleteDBParameterGroup)
  + [DeleteDBClusterParameterGroup (acción)](api-parameters.md#DeleteDBClusterParameterGroup)
  + [ModifyDBParameterGroup (acción)](api-parameters.md#ModifyDBParameterGroup)
  + [ModifyDBClusterParameterGroup (acción)](api-parameters.md#ModifyDBClusterParameterGroup)
  + [ResetDBParameterGroup (acción)](api-parameters.md#ResetDBParameterGroup)
  + [ResetDBClusterParameterGroup (acción)](api-parameters.md#ResetDBClusterParameterGroup)
  + [DescribeDBParameters (acción)](api-parameters.md#DescribeDBParameters)
  + [DescribeDBParameterGroups (acción)](api-parameters.md#DescribeDBParameterGroups)
  + [DescribeDBClusterParameters (acción)](api-parameters.md#DescribeDBClusterParameters)
  + [DescribeDBClusterParameterGroups (acción)](api-parameters.md#DescribeDBClusterParameterGroups)
  + [DescribeEngineDefaultParameters (acción)](api-parameters.md#DescribeEngineDefaultParameters)
  + [DescribeEngineDefaultClusterParameters (acción)](api-parameters.md#DescribeEngineDefaultClusterParameters)
  + [*Estructuras:*](api-parameters.md#api-parameters-structures-spacer)
  + [Parameter (estructura)](api-parameters.md#Parameter)
  + [DBParameterGroup (estructura)](api-parameters.md#DBParameterGroup)
  + [DBClusterParameterGroup (estructura)](api-parameters.md#DBClusterParameterGroup)
  + [DBParameterGroupStatus (estructura)](api-parameters.md#DBParameterGroupStatus)
+ [API de subred de Neptune](api-subnets.md)
  + [CreateDBSubnetGroup (acción)](api-subnets.md#CreateDBSubnetGroup)
  + [DeleteDBSubnetGroup (acción)](api-subnets.md#DeleteDBSubnetGroup)
  + [ModifyDBSubnetGroup (acción)](api-subnets.md#ModifyDBSubnetGroup)
  + [DescribeDBSubnetGroups (acción)](api-subnets.md#DescribeDBSubnetGroups)
  + [*Estructuras:*](api-subnets.md#api-subnets-structures-spacer)
  + [Subred (estructura)](api-subnets.md#Subnet)
  + [DBSubnetGroup (estructura)](api-subnets.md#DBSubnetGroup)
+ [API de instantáneas de Neptune](api-snapshots.md)
  + [CreateDBClusterSnapshot (acción)](api-snapshots.md#CreateDBClusterSnapshot)
  + [DeleteDBClusterSnapshot (acción)](api-snapshots.md#DeleteDBClusterSnapshot)
  + [CopyDBClusterSnapshot (acción)](api-snapshots.md#CopyDBClusterSnapshot)
  + [ModifyDBClusterSnapshotAttribute (acción)](api-snapshots.md#ModifyDBClusterSnapshotAttribute)
  + [RestoreDBClusterFromSnapshot (acción)](api-snapshots.md#RestoreDBClusterFromSnapshot)
  + [RestoreDBClusterToPointInTime (acción)](api-snapshots.md#RestoreDBClusterToPointInTime)
  + [DescribeDBClusterSnapshots (acción)](api-snapshots.md#DescribeDBClusterSnapshots)
  + [DescribeDBClusterSnapshotAttributes (acción)](api-snapshots.md#DescribeDBClusterSnapshotAttributes)
  + [*Estructuras:*](api-snapshots.md#api-snapshots-structures-spacer)
  + [DBClusterSnapshot (estructura)](api-snapshots.md#DBClusterSnapshot)
  + [DBClusterSnapshotAttribute (estructura)](api-snapshots.md#DBClusterSnapshotAttribute)
  + [DBClusterSnapshotAttributesResult (estructura)](api-snapshots.md#DBClusterSnapshotAttributesResult)
+ [API de eventos de Neptune](api-events.md)
  + [CreateEventSubscription (acción)](api-events.md#CreateEventSubscription)
  + [DeleteEventSubscription (acción)](api-events.md#DeleteEventSubscription)
  + [ModifyEventSubscription (acción)](api-events.md#ModifyEventSubscription)
  + [DescribeEventSubscriptions (acción)](api-events.md#DescribeEventSubscriptions)
  + [AddSourceIdentifierToSubscription (acción)](api-events.md#AddSourceIdentifierToSubscription)
  + [RemoveSourceIdentifierFromSubscription (acción)](api-events.md#RemoveSourceIdentifierFromSubscription)
  + [DescribeEvents (acción)](api-events.md#DescribeEvents)
  + [DescribeEventCategories (acción)](api-events.md#DescribeEventCategories)
  + [*Estructuras:*](api-events.md#api-events-structures-spacer)
  + [Event (estructura)](api-events.md#Event)
  + [EventCategoriesMap (estructura)](api-events.md#EventCategoriesMap)
  + [EventSubscription (estructura)](api-events.md#EventSubscription)
+ [Otras API de Neptune](api-other-apis.md)
  + [AddTagsToResource (acción)](api-other-apis.md#AddTagsToResource)
  + [ListTagsForResource (acción)](api-other-apis.md#ListTagsForResource)
  + [RemoveTagsFromResource (acción)](api-other-apis.md#RemoveTagsFromResource)
  + [ApplyPendingMaintenanceAction (acción)](api-other-apis.md#ApplyPendingMaintenanceAction)
  + [DescribePendingMaintenanceActions (acción)](api-other-apis.md#DescribePendingMaintenanceActions)
  + [DescribeDBEngineVersions (acción)](api-other-apis.md#DescribeDBEngineVersions)
  + [*Estructuras:*](api-other-apis.md#api-other-apis-structures-spacer)
  + [DBEngineVersion (estructura)](api-other-apis.md#DBEngineVersion)
  + [EngineDefaults (estructura)](api-other-apis.md#EngineDefaults)
  + [PendingMaintenanceAction (estructura)](api-other-apis.md#PendingMaintenanceAction)
  + [ResourcePendingMaintenanceActions (estructura)](api-other-apis.md#ResourcePendingMaintenanceActions)
  + [UpgradeTarget (estructura)](api-other-apis.md#UpgradeTarget)
  + [Tag (estructura)](api-other-apis.md#Tag)
+ [Tipos de datos comunes de Neptune](api-datatypes.md)
  + [AvailabilityZone (estructura)](api-datatypes.md#AvailabilityZone)
  + [DBSecurityGroupMembership (estructura)](api-datatypes.md#DBSecurityGroupMembership)
  + [DomainMembership (estructura)](api-datatypes.md#DomainMembership)
  + [DoubleRange (estructura)](api-datatypes.md#DoubleRange)
  + [Endpoint (estructura)](api-datatypes.md#Endpoint)
  + [Filter (estructura)](api-datatypes.md#Filter)
  + [Range (estructura)](api-datatypes.md#Range)
  + [ServerlessV2ScalingConfiguration (estructura)](api-datatypes.md#ServerlessV2ScalingConfiguration)
  + [ServerlessV2ScalingConfigurationInfo (estructura)](api-datatypes.md#ServerlessV2ScalingConfigurationInfo)
  + [Zona horaria (estructura)](api-datatypes.md#Timezone)
  + [VpcSecurityGroupMembership (estructura)](api-datatypes.md#VpcSecurityGroupMembership)
+ [Excepciones de Neptune específicas de API individuales](api-faults.md)
  + [AuthorizationAlreadyExistsFault (estructura)](api-faults.md#AuthorizationAlreadyExistsFault)
  + [AuthorizationNotFoundFault (estructura)](api-faults.md#AuthorizationNotFoundFault)
  + [AuthorizationQuotaExceededFault (estructura)](api-faults.md#AuthorizationQuotaExceededFault)
  + [CertificateNotFoundFault (estructura)](api-faults.md#CertificateNotFoundFault)
  + [DBClusterAlreadyExistsFault (estructura)](api-faults.md#DBClusterAlreadyExistsFault)
  + [DBClusterNotFoundFault (estructura)](api-faults.md#DBClusterNotFoundFault)
  + [DBClusterParameterGroupNotFoundFault (estructura)](api-faults.md#DBClusterParameterGroupNotFoundFault)
  + [DBClusterQuotaExceededFault (estructura)](api-faults.md#DBClusterQuotaExceededFault)
  + [DBClusterRoleAlreadyExistsFault (estructura)](api-faults.md#DBClusterRoleAlreadyExistsFault)
  + [DBClusterRoleNotFoundFault (estructura)](api-faults.md#DBClusterRoleNotFoundFault)
  + [DBClusterRoleQuotaExceededFault (estructura)](api-faults.md#DBClusterRoleQuotaExceededFault)
  + [DBClusterSnapshotAlreadyExistsFault (estructura)](api-faults.md#DBClusterSnapshotAlreadyExistsFault)
  + [DBClusterSnapshotNotFoundFault (estructura)](api-faults.md#DBClusterSnapshotNotFoundFault)
  + [DBInstanceAlreadyExistsFault (estructura)](api-faults.md#DBInstanceAlreadyExistsFault)
  + [DBInstanceNotFoundFault (estructura)](api-faults.md#DBInstanceNotFoundFault)
  + [DBLogFileNotFoundFault (estructura)](api-faults.md#DBLogFileNotFoundFault)
  + [DBParameterGroupAlreadyExistsFault (estructura)](api-faults.md#DBParameterGroupAlreadyExistsFault)
  + [DBParameterGroupNotFoundFault (estructura)](api-faults.md#DBParameterGroupNotFoundFault)
  + [DBParameterGroupQuotaExceededFault (estructura)](api-faults.md#DBParameterGroupQuotaExceededFault)
  + [DBSecurityGroupAlreadyExistsFault (estructura)](api-faults.md#DBSecurityGroupAlreadyExistsFault)
  + [DBSecurityGroupNotFoundFault (estructura)](api-faults.md#DBSecurityGroupNotFoundFault)
  + [DBSecurityGroupNotSupportedFault (estructura)](api-faults.md#DBSecurityGroupNotSupportedFault)
  + [DBSecurityGroupQuotaExceededFault (estructura)](api-faults.md#DBSecurityGroupQuotaExceededFault)
  + [DBSnapshotAlreadyExistsFault (estructura)](api-faults.md#DBSnapshotAlreadyExistsFault)
  + [DBSnapshotNotFoundFault (estructura)](api-faults.md#DBSnapshotNotFoundFault)
  + [DBSubnetGroupAlreadyExistsFault (estructura)](api-faults.md#DBSubnetGroupAlreadyExistsFault)
  + [DBSubnetGroupDoesNotCoverEnoughAZs (estructura)](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
  + [DBSubnetGroupNotAllowedFault (estructura)](api-faults.md#DBSubnetGroupNotAllowedFault)
  + [DBSubnetGroupNotFoundFault (estructura)](api-faults.md#DBSubnetGroupNotFoundFault)
  + [DBSubnetGroupQuotaExceededFault (estructura)](api-faults.md#DBSubnetGroupQuotaExceededFault)
  + [DBSubnetQuotaExceededFault (estructura)](api-faults.md#DBSubnetQuotaExceededFault)
  + [DBUpgradeDependencyFailureFault (estructura)](api-faults.md#DBUpgradeDependencyFailureFault)
  + [DomainNotFoundFault (estructura)](api-faults.md#DomainNotFoundFault)
  + [EventSubscriptionQuotaExceededFault (estructura)](api-faults.md#EventSubscriptionQuotaExceededFault)
  + [GlobalClusterAlreadyExistsFault (estructura)](api-faults.md#GlobalClusterAlreadyExistsFault)
  + [GlobalClusterNotFoundFault (estructura)](api-faults.md#GlobalClusterNotFoundFault)
  + [GlobalClusterQuotaExceededFault (estructura)](api-faults.md#GlobalClusterQuotaExceededFault)
  + [InstanceQuotaExceededFault (estructura)](api-faults.md#InstanceQuotaExceededFault)
  + [InsufficientDBClusterCapacityFault (estructura)](api-faults.md#InsufficientDBClusterCapacityFault)
  + [InsufficientDBInstanceCapacityFault (estructura)](api-faults.md#InsufficientDBInstanceCapacityFault)
  + [InsufficientStorageClusterCapacityFault (estructura)](api-faults.md#InsufficientStorageClusterCapacityFault)
  + [InvalidDBClusterEndpointStateFault (estructura)](api-faults.md#InvalidDBClusterEndpointStateFault)
  + [InvalidDBClusterSnapshotStateFault (estructura)](api-faults.md#InvalidDBClusterSnapshotStateFault)
  + [InvalidDBClusterStateFault (estructura)](api-faults.md#InvalidDBClusterStateFault)
  + [InvalidDBInstanceStateFault (estructura)](api-faults.md#InvalidDBInstanceStateFault)
  + [InvalidDBParameterGroupStateFault (estructura)](api-faults.md#InvalidDBParameterGroupStateFault)
  + [InvalidDBSecurityGroupStateFault (estructura)](api-faults.md#InvalidDBSecurityGroupStateFault)
  + [InvalidDBSnapshotStateFault (estructura)](api-faults.md#InvalidDBSnapshotStateFault)
  + [InvalidDBSubnetGroupFault (estructura)](api-faults.md#InvalidDBSubnetGroupFault)
  + [InvalidDBSubnetGroupStateFault (estructura)](api-faults.md#InvalidDBSubnetGroupStateFault)
  + [InvalidDBSubnetStateFault (estructura)](api-faults.md#InvalidDBSubnetStateFault)
  + [InvalidEventSubscriptionStateFault (estructura)](api-faults.md#InvalidEventSubscriptionStateFault)
  + [InvalidGlobalClusterStateFault (estructura)](api-faults.md#InvalidGlobalClusterStateFault)
  + [InvalidOptionGroupStateFault (estructura)](api-faults.md#InvalidOptionGroupStateFault)
  + [InvalidRestoreFault (estructura)](api-faults.md#InvalidRestoreFault)
  + [InvalidSubnet (estructura)](api-faults.md#InvalidSubnet)
  + [InvalidVPCNetworkStateFault (estructura)](api-faults.md#InvalidVPCNetworkStateFault)
  + [KMSKeyNotAccessibleFault (estructura)](api-faults.md#KMSKeyNotAccessibleFault)
  + [OptionGroupNotFoundFault (estructura)](api-faults.md#OptionGroupNotFoundFault)
  + [PointInTimeRestoreNotEnabledFault (estructura)](api-faults.md#PointInTimeRestoreNotEnabledFault)
  + [ProvisionedIopsNotAvailableInAZFault (estructura)](api-faults.md#ProvisionedIopsNotAvailableInAZFault)
  + [ResourceNotFoundFault (estructura)](api-faults.md#ResourceNotFoundFault)
  + [SNSInvalidTopicFault (estructura)](api-faults.md#SNSInvalidTopicFault)
  + [SNSNoAuthorizationFault (estructura)](api-faults.md#SNSNoAuthorizationFault)
  + [SNSTopicArnNotFoundFault (estructura)](api-faults.md#SNSTopicArnNotFoundFault)
  + [SharedSnapshotQuotaExceededFault (estructura)](api-faults.md#SharedSnapshotQuotaExceededFault)
  + [SnapshotQuotaExceededFault (estructura)](api-faults.md#SnapshotQuotaExceededFault)
  + [SourceNotFoundFault (estructura)](api-faults.md#SourceNotFoundFault)
  + [StorageQuotaExceededFault (estructura)](api-faults.md#StorageQuotaExceededFault)
  + [StorageTypeNotSupportedFault (estructura)](api-faults.md#StorageTypeNotSupportedFault)
  + [SubnetAlreadyInUse (estructura)](api-faults.md#SubnetAlreadyInUse)
  + [SubscriptionAlreadyExistFault (estructura)](api-faults.md#SubscriptionAlreadyExistFault)
  + [SubscriptionCategoryNotFoundFault (estructura)](api-faults.md#SubscriptionCategoryNotFoundFault)
  + [SubscriptionNotFoundFault (estructura)](api-faults.md#SubscriptionNotFoundFault)

# API de clústeres de base de datos de Neptune
<a name="api-clusters"></a>

**Acciones:**
+ [CreateDBCluster (acción)](#CreateDBCluster)
+ [DeleteDBCluster (acción)](#DeleteDBCluster)
+ [ModifyDBCluster (acción)](#ModifyDBCluster)
+ [StartDBCluster (acción)](#StartDBCluster)
+ [StopDBCluster (acción)](#StopDBCluster)
+ [AddRoleToDBCluster (acción)](#AddRoleToDBCluster)
+ [RemoveRoleFromDBCluster (acción)](#RemoveRoleFromDBCluster)
+ [FailoverDBCluster (acción)](#FailoverDBCluster)
+ [PromoteReadReplicaDBCluster (acción)](#PromoteReadReplicaDBCluster)
+ [DescribeDBClusters (acción)](#DescribeDBClusters)

**Estructuras:**
+ [DBCluster (estructura)](#DBCluster)
+ [DBClusterMember (estructura)](#DBClusterMember)
+ [DBClusterRole (estructura)](#DBClusterRole)
+ [CloudwatchLogsExportConfiguration (estructura)](#CloudwatchLogsExportConfiguration)
+ [PendingCloudwatchLogsExports (estructura)](#PendingCloudwatchLogsExports)
+ [ClusterPendingModifiedValues (estructura)](#ClusterPendingModifiedValues)

## CreateDBCluster (acción)
<a name="CreateDBCluster"></a>

         El nombre de la AWS CLI para esta API es: `create-db-cluster`.

Crea un nuevo clúster de base de datos Amazon Neptune.

Puede utilizar el parámetro `ReplicationSourceIdentifier` para crear el clúster de base de datos como réplica de lectura de otro clúster de base de datos o una instancia de base de datos de Amazon Neptune.

Tenga en cuenta que cuando crea un nuevo clúster mediante `CreateDBCluster` directamente, la protección de eliminación está deshabilitada de forma predeterminada (cuando crea un nuevo clúster de producción en la consola, la protección de eliminación está habilitada de forma predeterminada). Solo puede eliminar un clúster de base de datos si su campo `DeletionProtection` está establecido en `false`.

**Solicitud**
+ **AvailabilityZones** (en la CLI: `--availability-zones`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de zonas de disponibilidad de EC2 en el que las que se pueden crear instancias en el clúster de base de datos.
+ **BackupRetentionPeriod** (en la CLI: `--backup-retention-period`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El número de días durante los que se retienen las copias de seguridad automatizadas. Debe especificar un valor mínimo de 1.

  Valor predeterminado: 1

  Restricciones:
  + Debe ser un valor entre 1 y 35.
+ **CopyTagsToSnapshot** (en la CLI: `--copy-tags-to-snapshot`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  *Si se establece en `true`, las etiquetas se copian en cualquier instantánea del clúster de base de datos que se cree.*
+ **DatabaseName** (en la CLI: `--database-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre para la base de datos de hasta 64 caracteres alfanuméricos. Si no proporciona un nombre, Amazon Neptune no creará una base de datos en el clúster de base de datos que está creando.
+ **DBClusterIdentifier** (en la CLI: `--db-cluster-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Identificador de clúster de base de datos. Este parámetro se almacena como una cadena en minúsculas.

  Restricciones:
  + Deben contener de 1 a 63 caracteres (letras, números o guiones).
  + El primer carácter debe ser una letra.
  + No puede terminar por un guion ni contener dos guiones consecutivos.

  Ejemplo:: `my-cluster1`
+ **DBClusterParameterGroupName** (en la CLI: `--db-cluster-parameter-group-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   El nombre del grupo de parámetros del clúster de base de datos que desea asociar a este clúster de base de datos. Si este argumento se omite, se utiliza el predeterminado.

  Restricciones:
  + Si se suministra, debe coincidir con el nombre de un DBClusterParameterGroup existente.
+ **DBSubnetGroupName** (en la CLI: `--db-subnet-group-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Un grupo de subred de base de datos con el que asociar este clúster de base de datos.

  Limitaciones: debe coincidir con el nombre de un DBSubnetGroup existente. No debe ser predeterminado.

  Ejemplo:: `mySubnetgroup`
+ **DeletionProtection** (en la CLI: `--deletion-protection`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor que indica si el clúster de base de datos tiene habilitada la protección contra eliminación. La base de datos no se puede eliminar cuando está habilitada la protección contra eliminación. La protección contra eliminación está habilitada de forma predeterminada.
+ **EnableCloudwatchLogsExports** (en la CLI: `--enable-cloudwatch-logs-exports`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de tipos de registro para los que este clúster de base de datos debe exportar a los registros de CloudWatch. Los tipos de registro válidos son: `audit` (para publicar registros de auditoría) y `slowquery` (para publicar registros de consultas lentas). Consulte [Publicación de registros de Neptune en Registros de Amazon CloudWatch](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **EnableIAMDatabaseAuthentication** (en la CLI: `--enable-iam-database-authentication`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Si se establece en `true`, habilita la autenticación de Amazon Identity and Access Management (IAM) para todo el clúster de base de datos (no se puede configurar en el nivel de instancia).

  Valor predeterminado: `false`.
+ **Engine** (en la CLI: `--engine`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del motor de base de datos que se debe utilizar para este clúster de base de datos.

  Valores válidos: `neptune`
+ **EngineVersion** (en la CLI: `--engine-version`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Número de versión del motor de base de datos que se va a usar con el nuevo clúster de base de datos.

  Ejemplo:: `1.2.1.0`
+ **GlobalClusterIdentifier** (en la CLI:`--global-cluster-identifier`): un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  El ID de la base de datos global de Neptune a la que se debe añadir este nuevo clúster de base de datos.
+ **KmsKeyId** (en la CLI: `--kms-key-id`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador de la clave de Amazon KMS de un clúster de base de datos cifrado.

  El identificador de la clave de KMS es el Nombre de recurso de Amazon (ARN) de la clave de cifrado de KMS. Si está creando un clúster de base de datos con la misma cuenta de Amazon a la que pertenece la clave de cifrado de KMS utilizada para cifrar el clúster de base de datos nuevo, puede utilizar el alias de la clave de KMS en lugar del ARN para la clave de cifrado de KMS.

  Si no se especifica una clave de cifrado en `KmsKeyId`:
  + Si `ReplicationSourceIdentifier` identifica un origen de cifrado, Amazon Neptune utilizará la clave de cifrado que se utiliza para cifrar el origen. De lo contrario, Amazon Neptune utilizará su clave de cifrado predeterminada.
  + Si el parámetro `StorageEncrypted` es "true" y no se especifica `ReplicationSourceIdentifier`, Amazon Neptune utilizará su clave de cifrado predeterminada.

  Amazon KMS crea la clave de cifrado predeterminada para su cuenta de Amazon. Su cuenta de Amazon dispone de una clave de cifrado predeterminada diferente para cada región de Amazon.

  Si crea una réplica de lectura de un clúster de base de datos cifrado en otra región de Amazon, debe configurar `KmsKeyId` en un ID de la clave de KMS que sea válido en la región de Amazon de destino. Esta clave se utiliza para cifrar la réplica de lectura en esa región de Amazon.
+ **Port** (en la CLI: `--port`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El número de puerto en el que las instancias en el clúster de base datos aceptan conexiones.

   Valor predeterminado: `8182`
+ **PreferredBackupWindow** (en la CLI: `--preferred-backup-window`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El intervalo de tiempo diario durante el que se crean las copias de seguridad automatizadas si las copias de seguridad automatizadas están habilitadas con el parámetro `BackupRetentionPeriod`.

  El valor predeterminado es un periodo de 30 minutos seleccionado al azar dentro de un bloque de 8 horas para cada región de Amazon. Para ver los bloques de tiempo disponibles, consulte [Periodo de mantenimiento de Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-maintaining.html#manage-console-maintaining-window) en la *Guía del usuario de Amazon Neptune*.

  Restricciones:
  + Tiene que tener el formato `hh24:mi-hh24:mi`.
  + Debe indicarse en Tiempo universal coordinado (UTC).
  + No debe entrar en conflicto con la ventana de mantenimiento preferida.
  + Debe durar al menos 30 minutos.
+ **PreferredMaintenanceWindow** (en la CLI: `--preferred-maintenance-window`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

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

  Formato: `ddd:hh24:mi-ddd:hh24:mi`

  El valor predeterminado es un periodo de 30 minutos seleccionado al azar de un bloque de 8 horas de tiempo para cada región de Amazon, que tiene lugar un día de la semana de forma aleatoria. Para ver los bloques de tiempo disponibles, consulte [Periodo de mantenimiento de Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-maintaining.html#manage-console-maintaining-window) en la *Guía del usuario de Amazon Neptune*.

  Días válidos: lunes, martes, miércoles, jueves, viernes, sábado, domingo.

  Restricciones: ventana mínima de 30 minutos.
+ **PreSignedUrl** (en la CLI: `--pre-signed-url`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Este parámetro es incompatible en estos momentos.
+ **ReplicationSourceIdentifier** (en la CLI: `--replication-source-identifier`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) de la instancia de base de datos de origen o el clúster de base de datos si este clúster de base de datos se crea como réplica de lectura.
+ **ServerlessV2ScalingConfiguration** (en la CLI: `--serverless-v2-scaling-configuration`): un objeto [ServerlessV2ScalingConfiguration](api-datatypes.md#ServerlessV2ScalingConfiguration).

  Incluye la configuración de escalado de un clúster de base de datos de Neptune sin servidor.

  Para obtener más información, consulte [Uso de Amazon Neptune sin servidor](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) en la *Guía del usuario de Amazon Neptune*.
+ **StorageEncrypted** (en la CLI: `--storage-encrypted`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos está cifrado.
+ **StorageType** (en la CLI: `--storage-type`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de almacenamiento para el nuevo clúster de base de datos.

  Valores válidos:
  + **`standard`**: (*predeterminado*) configura un almacenamiento de bases de datos rentable para aplicaciones con un uso de E/S de moderado a pequeño. Si se establece en `standard`, el tipo de almacenamiento no aparece en la respuesta.
  + **`iopt1`**: habilita el [almacenamiento optimizado para E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage) que está diseñado para satisfacer las necesidades de las cargas de trabajo de gráficos con uso intensivo de operaciones de E/S que requieren precios predecibles con una latencia de E/S baja y un rendimiento de E/S constante.

    El almacenamiento optimizado para E/S de Neptune solo está disponible a partir de la versión 1.3.0.0 del motor.
+ **Tags** (en la CLI: `--tags`): una matriz de objetos [Tag](api-other-apis.md#Tag).

  Las etiquetas para asignar al nuevo clúster de base de datos.
+ **VpcSecurityGroupIds** (en la CLI: `--vpc-security-group-ids`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de grupos de seguridad de VPC de EC2 para asociar a este clúster de base de datos.

**Respuesta**

Contiene los detalles de un clúster de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en [DescribeDBClusters (acción)](#DescribeDBClusters).
+ **AllocatedStorage**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  `AllocatedStorage` siempre devuelve 1, ya que el tamaño de almacenamiento del clúster de base de datos de Neptune no es fijo, sino que se ajusta automáticamente según sea necesario.
+ **AssociatedRoles**: matriz de objetos [DBClusterRole](#DBClusterRole).

  Proporciona una lista de los roles de Amazon Identity and Access Management (IAM) que están asociados con el clúster de base de datos. Los roles de IAM que están asociados a un clúster de base de datos conceden permiso para que este obtenga acceso a otros servicios de Amazon en su nombre.
+ **AutomaticRestartTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Hora en la que el clúster de base de datos se reiniciará automáticamente.
+ **AvailabilityZones**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la lista de zonas de disponibilidad de EC2 en las que se pueden crear instancias en el clúster de base de datos.
+ **BacktrackConsumedChangeRecords**: un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BacktrackWindow**: un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BackupRetentionPeriod**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
+ **Capacity**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  No es compatible con Neptune.
+ **CloneGroupId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Identifica el grupo de clones al que está asociado el clúster de base de datos.
+ **ClusterCreateTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la hora a la que se creó el clúster de base de datos, en tiempo universal coordinado (UTC).
+ **CopyTagsToSnapshot**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  *Si se establece en `true`, las etiquetas se copian en cualquier instantánea del clúster de base de datos que se cree.*
+ **CrossAccountClone**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Si se establece en `true`, el clúster de base de datos se puede clonar en todas las cuentas.
+ **DatabaseName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el nombre de la base de datos inicial de este clúster de base de datos que se proporcionó en el momento de la creación, si se especificó uno cuando se creó el clúster de base de datos. Este mismo nombre se devuelve durante el tiempo que dura el clúster de base de datos.
+ **DBClusterArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el clúster de base de datos.
+ **DBClusterIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DBClusterMembers**: matriz de objetos [DBClusterMember](#DBClusterMember).

  Proporciona la lista de instancias que componen el clúster de base de datos.
+ **DBClusterParameterGroup**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre del grupo de parámetros del clúster de base de datos para el clúster de base de datos.
+ **DbClusterResourceId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador inmutable único de la región de Amazon para el clúster de base de datos. Este identificador se encuentra en las entradas de registro de Amazon CloudTrail siempre que se accede a la clave de Amazon KMS para el clúster de base de datos.
+ **DBSubnetGroup**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DeletionProtection**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si el clúster de base de datos tiene habilitada la protección contra eliminación o no. La base de datos no se puede eliminar cuando está habilitada la protección contra eliminación.
+ **EarliestBacktrackTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  No es compatible con Neptune.
+ **EarliestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **EnabledCloudwatchLogsExports**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de tipos de registro para los que este clúster de base de datos está configurado para exportar a los registros de CloudWatch. Los tipos de registro válidos son: `audit` (para publicar registros de auditoría en CloudWatch) y slowquery (para publicar registros de consultas lentas en CloudWatch). Consulte [Publicación de registros de Neptune en Registros de Amazon CloudWatch](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el punto de enlace de conexión para la instancia principal del clúster de base de datos.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del motor de base de datos que se debe utilizar para este clúster de base de datos.
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica la versión del motor de base de datos.
+ **GlobalClusterIdentifier**: un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  Incluye un identificador de clúster de base de datos global facilitado por el usuario. Este identificador es la clave única que identifica una base de datos global.
+ **HostedZoneId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el ID que Amazon Route 53 asigna al crear una zona alojada.
+ **IAMDatabaseAuthenticationEnabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True (Verdadero) si la asignación de cuentas de Amazon Identity and Access Management (IAM) a cuentas de base de datos está habilitada; de lo contrario, el valor es false (falso).
+ **IOOptimizedNextAllowedModificationTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  La próxima vez, podrá modificar el clúster de base de datos para utilizar el tipo de almacenamiento `iopt1`.
+ **KmsKeyId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si el valor de `StorageEncrypted` es true (verdadero), el identificador de la clave de Amazon KMS para el clúster de base de datos cifrado.
+ **LatestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **MultiAZ**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos tiene instancias en varias zonas de disponibilidad.
+ **PendingModifiedValues**: un objeto [ClusterPendingModifiedValues](#ClusterPendingModifiedValues).

  Este tipo de datos se utiliza como un elemento de respuesta en la operación `ModifyDBCluster` e incluye cambios que se aplicarán durante el siguiente periodo de mantenimiento.
+ **PercentProgress**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el progreso de la operación como porcentaje.
+ **Port**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto en el que escucha el motor de la base de datos.
+ **PreferredBackupWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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`.
+ **PreferredMaintenanceWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
+ **ReaderEndpoint**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El punto de enlace del lector para el clúster de base de datos. El punto de enlace del lector de un clúster de base de datos equilibra la carga de las conexiones entre las réplicas de lectura que están disponibles en un clúster de base de datos. A medida que los clientes solicitan nuevas conexiones al punto de enlace del lector, Neptune distribuye las solicitudes de conexión entre las réplicas de lectura del clúster de base de datos. Esta funcionalidad puede ayudar a equilibrar la carga de trabajo de lectura entre las distintas réplicas de lectura en el clúster de base de datos.

  Si se produce una conmutación por error y la réplica de lectura a la que está conectado se convierte en la nueva instancia principal, la conexión se interrumpe. Para seguir enviando la carga de trabajo de lectura a otras réplicas de lectura del clúster, puede volver a conectarse al punto de enlace del lector.
+ **ReadReplicaIdentifiers**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de las réplicas de lectura asociados con este clúster de base de datos.
+ **ReplicationSourceIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ReplicationType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ServerlessV2ScalingConfiguration**: un objeto [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

  Muestra la configuración de escalado de un clúster de base de datos de Neptune sin servidor.

  Para obtener más información, consulte [Uso de Amazon Neptune sin servidor](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) en la *Guía del usuario de Amazon Neptune*.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de este clúster de base de datos.
+ **StorageEncrypted**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos está cifrado.
+ **StorageType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de almacenamiento que se utiliza para el clúster de base de datos.

  Valores válidos:
  + **`standard`**: (*predeterminado*) proporciona un almacenamiento de bases de datos rentable para aplicaciones con un uso de E/S de moderado a pequeño.
  + **`iopt1`**: habilita el [almacenamiento optimizado para E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage) que está diseñado para satisfacer las necesidades de las cargas de trabajo de gráficos con uso intensivo de operaciones de E/S que requieren precios predecibles con una latencia de E/S baja y un rendimiento de E/S constante.

    El almacenamiento optimizado para E/S de Neptune solo está disponible a partir de la versión 1.3.0.0 del motor.
+ **VpcSecurityGroups**: matriz de objetos [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Errores**
+ [DBClusterAlreadyExistsFault](api-faults.md#DBClusterAlreadyExistsFault)
+ [InsufficientStorageClusterCapacityFault](api-faults.md#InsufficientStorageClusterCapacityFault)
+ [DBClusterQuotaExceededFault](api-faults.md#DBClusterQuotaExceededFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [InvalidVPCNetworkStateFault](api-faults.md#InvalidVPCNetworkStateFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [InvalidDBSubnetGroupStateFault](api-faults.md#InvalidDBSubnetGroupStateFault)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)
+ [InvalidDBInstanceStateFault](api-faults.md#InvalidDBInstanceStateFault)
+ [DBClusterParameterGroupNotFoundFault](api-faults.md#DBClusterParameterGroupNotFoundFault)
+ [KMSKeyNotAccessibleFault](api-faults.md#KMSKeyNotAccessibleFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [DBSubnetGroupDoesNotCoverEnoughAZs](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
+ [InvalidGlobalClusterStateFault](api-faults.md#InvalidGlobalClusterStateFault)

## DeleteDBCluster (acción)
<a name="DeleteDBCluster"></a>

         El nombre de la AWS CLI para esta API es: `delete-db-cluster`.

La acción DeleteDBCluster elimina un clúster de base de datos aprovisionado previamente. Al eliminar un clúster de base de datos, se eliminan todas las copias de seguridad automatizadas para ese clúster de base de datos y no se pueden recuperar. Las instantáneas manuales del clúster de base de datos del clúster de base de datos especificado no se eliminan.

Tenga en cuenta que el clúster de base de datos no se puede eliminar si la protección de eliminación está habilitada. Para eliminarlo, primero debe establecer el campo `DeletionProtection` en `False`.

**Solicitud**
+ **DBClusterIdentifier** (en la CLI: `--db-cluster-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador del clúster de base de datos del clúster de base de datos que se va a eliminar. Este parámetro no distingue entre mayúsculas y minúsculas.

  Restricciones:
  + Debe coincidir con un DBClusterIdentifier existente.
+ **FinalDBSnapshotIdentifier** (en la CLI: `--final-db-snapshot-identifier`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   El identificador de instantánea de clúster de base de datos de la nueva instantánea del clúster de base de datos creada al configurar `SkipFinalSnapshot` como `false`.
**nota**  
 Si se especifica este parámetro y también se establece el parámetro `SkipFinalShapshot` en "true", se producirá un error.

  Restricciones:
  + Debe tener de 1 a 255 letras, números o guiones.
  + El primer carácter debe ser una letra
  + No puede terminar por un guion ni contener dos guiones consecutivos
+ **SkipFinalSnapshot** (en la CLI: `--skip-final-snapshot`): un booleano, del tipo: `boolean` (un valor booleano [true o false]).

   Determina si se crea una instantánea de clúster de base de datos antes de que se elimine el clúster de base de datos. Si se especifica `true`, no se crea ninguna instantánea del clúster de base de datos. Si se especifica `false`, se crea una instantánea de clúster de base de datos antes de que se elimine el clúster de base de datos.
**nota**  
Debe especificar un parámetro `FinalDBSnapshotIdentifier` si `SkipFinalSnapshot` es `false`.

  Predeterminado: `false`

**Respuesta**

Contiene los detalles de un clúster de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en [DescribeDBClusters (acción)](#DescribeDBClusters).
+ **AllocatedStorage**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  `AllocatedStorage` siempre devuelve 1, ya que el tamaño de almacenamiento del clúster de base de datos de Neptune no es fijo, sino que se ajusta automáticamente según sea necesario.
+ **AssociatedRoles**: matriz de objetos [DBClusterRole](#DBClusterRole).

  Proporciona una lista de los roles de Amazon Identity and Access Management (IAM) que están asociados con el clúster de base de datos. Los roles de IAM que están asociados a un clúster de base de datos conceden permiso para que este obtenga acceso a otros servicios de Amazon en su nombre.
+ **AutomaticRestartTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Hora en la que el clúster de base de datos se reiniciará automáticamente.
+ **AvailabilityZones**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la lista de zonas de disponibilidad de EC2 en las que se pueden crear instancias en el clúster de base de datos.
+ **BacktrackConsumedChangeRecords**: un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BacktrackWindow**: un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BackupRetentionPeriod**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
+ **Capacity**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  No es compatible con Neptune.
+ **CloneGroupId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Identifica el grupo de clones al que está asociado el clúster de base de datos.
+ **ClusterCreateTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la hora a la que se creó el clúster de base de datos, en tiempo universal coordinado (UTC).
+ **CopyTagsToSnapshot**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  *Si se establece en `true`, las etiquetas se copian en cualquier instantánea del clúster de base de datos que se cree.*
+ **CrossAccountClone**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Si se establece en `true`, el clúster de base de datos se puede clonar en todas las cuentas.
+ **DatabaseName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el nombre de la base de datos inicial de este clúster de base de datos que se proporcionó en el momento de la creación, si se especificó uno cuando se creó el clúster de base de datos. Este mismo nombre se devuelve durante el tiempo que dura el clúster de base de datos.
+ **DBClusterArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el clúster de base de datos.
+ **DBClusterIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DBClusterMembers**: matriz de objetos [DBClusterMember](#DBClusterMember).

  Proporciona la lista de instancias que componen el clúster de base de datos.
+ **DBClusterParameterGroup**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre del grupo de parámetros del clúster de base de datos para el clúster de base de datos.
+ **DbClusterResourceId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador inmutable único de la región de Amazon para el clúster de base de datos. Este identificador se encuentra en las entradas de registro de Amazon CloudTrail siempre que se accede a la clave de Amazon KMS para el clúster de base de datos.
+ **DBSubnetGroup**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DeletionProtection**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si el clúster de base de datos tiene habilitada la protección contra eliminación o no. La base de datos no se puede eliminar cuando está habilitada la protección contra eliminación.
+ **EarliestBacktrackTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  No es compatible con Neptune.
+ **EarliestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **EnabledCloudwatchLogsExports**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de tipos de registro para los que este clúster de base de datos está configurado para exportar a los registros de CloudWatch. Los tipos de registro válidos son: `audit` (para publicar registros de auditoría en CloudWatch) y slowquery (para publicar registros de consultas lentas en CloudWatch). Consulte [Publicación de registros de Neptune en Registros de Amazon CloudWatch](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el punto de enlace de conexión para la instancia principal del clúster de base de datos.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del motor de base de datos que se debe utilizar para este clúster de base de datos.
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica la versión del motor de base de datos.
+ **GlobalClusterIdentifier**: un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  Incluye un identificador de clúster de base de datos global facilitado por el usuario. Este identificador es la clave única que identifica una base de datos global.
+ **HostedZoneId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el ID que Amazon Route 53 asigna al crear una zona alojada.
+ **IAMDatabaseAuthenticationEnabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True (Verdadero) si la asignación de cuentas de Amazon Identity and Access Management (IAM) a cuentas de base de datos está habilitada; de lo contrario, el valor es false (falso).
+ **IOOptimizedNextAllowedModificationTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  La próxima vez, podrá modificar el clúster de base de datos para utilizar el tipo de almacenamiento `iopt1`.
+ **KmsKeyId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si el valor de `StorageEncrypted` es true (verdadero), el identificador de la clave de Amazon KMS para el clúster de base de datos cifrado.
+ **LatestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **MultiAZ**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos tiene instancias en varias zonas de disponibilidad.
+ **PendingModifiedValues**: un objeto [ClusterPendingModifiedValues](#ClusterPendingModifiedValues).

  Este tipo de datos se utiliza como un elemento de respuesta en la operación `ModifyDBCluster` e incluye cambios que se aplicarán durante el siguiente periodo de mantenimiento.
+ **PercentProgress**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el progreso de la operación como porcentaje.
+ **Port**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto en el que escucha el motor de la base de datos.
+ **PreferredBackupWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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`.
+ **PreferredMaintenanceWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
+ **ReaderEndpoint**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El punto de enlace del lector para el clúster de base de datos. El punto de enlace del lector de un clúster de base de datos equilibra la carga de las conexiones entre las réplicas de lectura que están disponibles en un clúster de base de datos. A medida que los clientes solicitan nuevas conexiones al punto de enlace del lector, Neptune distribuye las solicitudes de conexión entre las réplicas de lectura del clúster de base de datos. Esta funcionalidad puede ayudar a equilibrar la carga de trabajo de lectura entre las distintas réplicas de lectura en el clúster de base de datos.

  Si se produce una conmutación por error y la réplica de lectura a la que está conectado se convierte en la nueva instancia principal, la conexión se interrumpe. Para seguir enviando la carga de trabajo de lectura a otras réplicas de lectura del clúster, puede volver a conectarse al punto de enlace del lector.
+ **ReadReplicaIdentifiers**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de las réplicas de lectura asociados con este clúster de base de datos.
+ **ReplicationSourceIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ReplicationType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ServerlessV2ScalingConfiguration**: un objeto [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

  Muestra la configuración de escalado de un clúster de base de datos de Neptune sin servidor.

  Para obtener más información, consulte [Uso de Amazon Neptune sin servidor](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) en la *Guía del usuario de Amazon Neptune*.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de este clúster de base de datos.
+ **StorageEncrypted**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos está cifrado.
+ **StorageType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de almacenamiento que se utiliza para el clúster de base de datos.

  Valores válidos:
  + **`standard`**: (*predeterminado*) proporciona un almacenamiento de bases de datos rentable para aplicaciones con un uso de E/S de moderado a pequeño.
  + **`iopt1`**: habilita el [almacenamiento optimizado para E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage) que está diseñado para satisfacer las necesidades de las cargas de trabajo de gráficos con uso intensivo de operaciones de E/S que requieren precios predecibles con una latencia de E/S baja y un rendimiento de E/S constante.

    El almacenamiento optimizado para E/S de Neptune solo está disponible a partir de la versión 1.3.0.0 del motor.
+ **VpcSecurityGroups**: matriz de objetos [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Errores**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [DBClusterSnapshotAlreadyExistsFault](api-faults.md#DBClusterSnapshotAlreadyExistsFault)
+ [SnapshotQuotaExceededFault](api-faults.md#SnapshotQuotaExceededFault)
+ [InvalidDBClusterSnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)

## ModifyDBCluster (acción)
<a name="ModifyDBCluster"></a>

         El nombre de la AWS CLI para esta API es: `modify-db-cluster`.

Modificar una configuración para un clúster de base de datos. Puede cambiar uno o varios parámetros de configuración de la base de datos mediante la especificación de estos parámetros y los nuevos valores en la solicitud.

**Solicitud**
+ **AllowMajorVersionUpgrade** (en la CLI: `--allow-major-version-upgrade`): un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor que indica si se permiten actualizaciones entre distintas versiones principales.

  Restricciones: debe establecer el indicador allow-major-version-upgrade al proporcionar un parámetro `EngineVersion` que utiliza una versión principal diferente de la versión actual del clúster de base de datos.
+ **ApplyImmediately** (en la CLI: `--apply-immediately`): un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor que especifica si las modificaciones de esta solicitud y todas las modificaciones pendientes se asignan de manera asincrónica en cuanto sea posible, independientemente del valor de `PreferredMaintenanceWindow` del clúster de base de datos. Si este parámetro es `false`, los cambios realizados en el clúster de base de datos se aplican durante la siguiente ventana de mantenimiento.

  El parámetro `ApplyImmediately` solo afecta a los valores `NewDBClusterIdentifier`. Si establece el valor del parámetro `ApplyImmediately` en False, los cambios en los valores `NewDBClusterIdentifier` se aplicarán durante el siguiente periodo de mantenimiento. Todas los demás cambios se aplican de inmediato, con independencia del valor del parámetro `ApplyImmediately`.

  Predeterminado: `false`
+ **BackupRetentionPeriod** (en la CLI: `--backup-retention-period`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El número de días durante los que se retienen las copias de seguridad automatizadas. Debe especificar un valor mínimo de 1.

  Valor predeterminado: 1

  Restricciones:
  + Debe ser un valor entre 1 y 35.
+ **CloudwatchLogsExportConfiguration** (en la CLI: `--cloudwatch-logs-export-configuration`): un objeto [CloudwatchLogsExportConfiguration](#CloudwatchLogsExportConfiguration).

  La opción de configuración para los tipos de registro que debe habilitarse para la exportación a CloudWatch Logs para un clúster de base de datos específico. Consulte [Uso de la CLI para publicar registros de auditoría de Neptune en los regisgtros de CloudWatch](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html#cloudwatch-logs-cli).
+ **CopyTagsToSnapshot** (en la CLI: `--copy-tags-to-snapshot`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  *Si se establece en `true`, las etiquetas se copian en cualquier instantánea del clúster de base de datos que se cree.*
+ **DBClusterIdentifier** (en la CLI: `--db-cluster-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador del clúster de base de datos del clúster que se va a modificar. Este parámetro no distingue entre mayúsculas y minúsculas.

  Restricciones:
  + Debe coincidir con el identificador de un DBCluster existente.
+ **DBClusterParameterGroupName** (en la CLI: `--db-cluster-parameter-group-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del grupo de parámetros del clúster de base de datos que se va a usar para el clúster de base de datos.
+ **DBInstanceParameterGroupName** (en la CLI: `--db-instance-parameter-group-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del grupo de parámetros de base de datos que se aplicará a todas las instancias del clúster de base de datos. 
**nota**  
Al aplicar un grupo de parámetros mediante `DBInstanceParameterGroupName`, los cambios de parámetros no se aplicarán durante el siguiente periodo de mantenimiento, sino que se aplicarán inmediatamente.

  Predeterminado: la configuración de nombre existente

  Restricciones:
  + El grupo de parámetros de base de datos debe estar en la misma familia de grupos de parámetros de base de datos que la versión de clúster de base de datos de destino.
  + El parámetro `DBInstanceParameterGroupName` solo es válido en combinación con el parámetro `AllowMajorVersionUpgrade`.
+ **DeletionProtection** (en la CLI: `--deletion-protection`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor que indica si el clúster de base de datos tiene habilitada la protección contra eliminación. La base de datos no se puede eliminar cuando está habilitada la protección contra eliminación. La protección contra eliminación está deshabilitada de forma predeterminada.
+ **EnableIAMDatabaseAuthentication** (en la CLI: `--enable-iam-database-authentication`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  True para habilitar el mapeo de cuentas de Amazon Identity and Access Management (IAM) a cuentas de base de datos; de lo contrario, el valor es False.

  Predeterminado: `false`
+ **EngineVersion** (en la CLI: `--engine-version`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El número de versión del motor de base de datos al que desea realizar la actualización. El cambio de este parámetro produce una interrupción. El cambio se aplicará durante el siguiente período de mantenimiento, salvo que el parámetro `ApplyImmediately` esté establecido en "true".

  Para obtener una lista de las versiones válidas del motor, consulte [Versiones del motor de Amazon Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases.html) o llame a [DescribeDBEngineVersions (acción)](api-other-apis.md#DescribeDBEngineVersions).
+ **NewDBClusterIdentifier** (en la CLI: `--new-db-cluster-identifier`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nuevo identificador del clúster de base de datos cuando se cambia el nombre de un clúster de base de datos. Este valor se almacena como una cadena en minúsculas.

  Restricciones:
  + Deben contener de 1 a 63 caracteres (letras, números o guiones).
  + El primer carácter debe ser una letra
  + No puede terminar por un guion ni contener dos guiones consecutivos

  Ejemplo:: `my-cluster2`
+ **Port** (en la CLI: `--port`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

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

  Limitaciones: el valor debe ser `1150-65535`

  Valor predeterminado: el mismo puerto que el clúster de base de datos original.
+ **PreferredBackupWindow** (en la CLI: `--preferred-backup-window`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El intervalo de tiempo diario durante el que se crean las copias de seguridad automatizadas si las copias de seguridad automatizadas están habilitadas con el parámetro `BackupRetentionPeriod`.

  El valor predeterminado es un periodo de 30 minutos seleccionado al azar dentro de un bloque de 8 horas para cada región de Amazon.

  Restricciones:
  + Tiene que tener el formato `hh24:mi-hh24:mi`.
  + Debe indicarse en Tiempo universal coordinado (UTC).
  + No debe entrar en conflicto con la ventana de mantenimiento preferida.
  + Debe durar al menos 30 minutos.
+ **PreferredMaintenanceWindow** (en la CLI: `--preferred-maintenance-window`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

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

  Formato: `ddd:hh24:mi-ddd:hh24:mi`

  El valor predeterminado es un periodo de 30 minutos seleccionado al azar de un bloque de 8 horas de tiempo para cada región de Amazon, que tiene lugar un día de la semana de forma aleatoria.

  Días válidos: lunes, martes, miércoles, jueves, viernes, sábado, domingo.

  Restricciones: ventana mínima de 30 minutos.
+ **ServerlessV2ScalingConfiguration** (en la CLI: `--serverless-v2-scaling-configuration`): un objeto [ServerlessV2ScalingConfiguration](api-datatypes.md#ServerlessV2ScalingConfiguration).

  Incluye la configuración de escalado de un clúster de base de datos de Neptune sin servidor.

  Para obtener más información, consulte [Uso de Amazon Neptune sin servidor](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) en la *Guía del usuario de Amazon Neptune*.
+ **StorageType** (en la CLI: `--storage-type`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de almacenamiento que se va a asociar al clúster de base de datos.

  Valores válidos:
  + **`standard`**: (*predeterminado*) configura un almacenamiento de bases de datos rentable para aplicaciones con un uso de E/S de moderado a pequeño.
  + **`iopt1`**: habilita el [almacenamiento optimizado para E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage) que está diseñado para satisfacer las necesidades de las cargas de trabajo de gráficos con uso intensivo de operaciones de E/S que requieren precios predecibles con una latencia de E/S baja y un rendimiento de E/S constante.

    El almacenamiento optimizado para E/S de Neptune solo está disponible a partir de la versión 1.3.0.0 del motor.
+ **VpcSecurityGroupIds** (en la CLI: `--vpc-security-group-ids`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

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

**Respuesta**

Contiene los detalles de un clúster de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en [DescribeDBClusters (acción)](#DescribeDBClusters).
+ **AllocatedStorage**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  `AllocatedStorage` siempre devuelve 1, ya que el tamaño de almacenamiento del clúster de base de datos de Neptune no es fijo, sino que se ajusta automáticamente según sea necesario.
+ **AssociatedRoles**: matriz de objetos [DBClusterRole](#DBClusterRole).

  Proporciona una lista de los roles de Amazon Identity and Access Management (IAM) que están asociados con el clúster de base de datos. Los roles de IAM que están asociados a un clúster de base de datos conceden permiso para que este obtenga acceso a otros servicios de Amazon en su nombre.
+ **AutomaticRestartTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Hora en la que el clúster de base de datos se reiniciará automáticamente.
+ **AvailabilityZones**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la lista de zonas de disponibilidad de EC2 en las que se pueden crear instancias en el clúster de base de datos.
+ **BacktrackConsumedChangeRecords**: un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BacktrackWindow**: un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BackupRetentionPeriod**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
+ **Capacity**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  No es compatible con Neptune.
+ **CloneGroupId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Identifica el grupo de clones al que está asociado el clúster de base de datos.
+ **ClusterCreateTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la hora a la que se creó el clúster de base de datos, en tiempo universal coordinado (UTC).
+ **CopyTagsToSnapshot**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  *Si se establece en `true`, las etiquetas se copian en cualquier instantánea del clúster de base de datos que se cree.*
+ **CrossAccountClone**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Si se establece en `true`, el clúster de base de datos se puede clonar en todas las cuentas.
+ **DatabaseName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el nombre de la base de datos inicial de este clúster de base de datos que se proporcionó en el momento de la creación, si se especificó uno cuando se creó el clúster de base de datos. Este mismo nombre se devuelve durante el tiempo que dura el clúster de base de datos.
+ **DBClusterArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el clúster de base de datos.
+ **DBClusterIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DBClusterMembers**: matriz de objetos [DBClusterMember](#DBClusterMember).

  Proporciona la lista de instancias que componen el clúster de base de datos.
+ **DBClusterParameterGroup**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre del grupo de parámetros del clúster de base de datos para el clúster de base de datos.
+ **DbClusterResourceId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador inmutable único de la región de Amazon para el clúster de base de datos. Este identificador se encuentra en las entradas de registro de Amazon CloudTrail siempre que se accede a la clave de Amazon KMS para el clúster de base de datos.
+ **DBSubnetGroup**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DeletionProtection**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si el clúster de base de datos tiene habilitada la protección contra eliminación o no. La base de datos no se puede eliminar cuando está habilitada la protección contra eliminación.
+ **EarliestBacktrackTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  No es compatible con Neptune.
+ **EarliestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **EnabledCloudwatchLogsExports**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de tipos de registro para los que este clúster de base de datos está configurado para exportar a los registros de CloudWatch. Los tipos de registro válidos son: `audit` (para publicar registros de auditoría en CloudWatch) y slowquery (para publicar registros de consultas lentas en CloudWatch). Consulte [Publicación de registros de Neptune en Registros de Amazon CloudWatch](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el punto de enlace de conexión para la instancia principal del clúster de base de datos.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del motor de base de datos que se debe utilizar para este clúster de base de datos.
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica la versión del motor de base de datos.
+ **GlobalClusterIdentifier**: un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  Incluye un identificador de clúster de base de datos global facilitado por el usuario. Este identificador es la clave única que identifica una base de datos global.
+ **HostedZoneId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el ID que Amazon Route 53 asigna al crear una zona alojada.
+ **IAMDatabaseAuthenticationEnabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True (Verdadero) si la asignación de cuentas de Amazon Identity and Access Management (IAM) a cuentas de base de datos está habilitada; de lo contrario, el valor es false (falso).
+ **IOOptimizedNextAllowedModificationTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  La próxima vez, podrá modificar el clúster de base de datos para utilizar el tipo de almacenamiento `iopt1`.
+ **KmsKeyId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si el valor de `StorageEncrypted` es true (verdadero), el identificador de la clave de Amazon KMS para el clúster de base de datos cifrado.
+ **LatestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **MultiAZ**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos tiene instancias en varias zonas de disponibilidad.
+ **PendingModifiedValues**: un objeto [ClusterPendingModifiedValues](#ClusterPendingModifiedValues).

  Este tipo de datos se utiliza como un elemento de respuesta en la operación `ModifyDBCluster` e incluye cambios que se aplicarán durante el siguiente periodo de mantenimiento.
+ **PercentProgress**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el progreso de la operación como porcentaje.
+ **Port**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto en el que escucha el motor de la base de datos.
+ **PreferredBackupWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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`.
+ **PreferredMaintenanceWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
+ **ReaderEndpoint**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El punto de enlace del lector para el clúster de base de datos. El punto de enlace del lector de un clúster de base de datos equilibra la carga de las conexiones entre las réplicas de lectura que están disponibles en un clúster de base de datos. A medida que los clientes solicitan nuevas conexiones al punto de enlace del lector, Neptune distribuye las solicitudes de conexión entre las réplicas de lectura del clúster de base de datos. Esta funcionalidad puede ayudar a equilibrar la carga de trabajo de lectura entre las distintas réplicas de lectura en el clúster de base de datos.

  Si se produce una conmutación por error y la réplica de lectura a la que está conectado se convierte en la nueva instancia principal, la conexión se interrumpe. Para seguir enviando la carga de trabajo de lectura a otras réplicas de lectura del clúster, puede volver a conectarse al punto de enlace del lector.
+ **ReadReplicaIdentifiers**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de las réplicas de lectura asociados con este clúster de base de datos.
+ **ReplicationSourceIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ReplicationType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ServerlessV2ScalingConfiguration**: un objeto [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

  Muestra la configuración de escalado de un clúster de base de datos de Neptune sin servidor.

  Para obtener más información, consulte [Uso de Amazon Neptune sin servidor](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) en la *Guía del usuario de Amazon Neptune*.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de este clúster de base de datos.
+ **StorageEncrypted**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos está cifrado.
+ **StorageType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de almacenamiento que se utiliza para el clúster de base de datos.

  Valores válidos:
  + **`standard`**: (*predeterminado*) proporciona un almacenamiento de bases de datos rentable para aplicaciones con un uso de E/S de moderado a pequeño.
  + **`iopt1`**: habilita el [almacenamiento optimizado para E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage) que está diseñado para satisfacer las necesidades de las cargas de trabajo de gráficos con uso intensivo de operaciones de E/S que requieren precios predecibles con una latencia de E/S baja y un rendimiento de E/S constante.

    El almacenamiento optimizado para E/S de Neptune solo está disponible a partir de la versión 1.3.0.0 del motor.
+ **VpcSecurityGroups**: matriz de objetos [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Errores**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [InvalidVPCNetworkStateFault](api-faults.md#InvalidVPCNetworkStateFault)
+ [InvalidDBSubnetGroupStateFault](api-faults.md#InvalidDBSubnetGroupStateFault)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)
+ [DBClusterParameterGroupNotFoundFault](api-faults.md#DBClusterParameterGroupNotFoundFault)
+ [InvalidDBSecurityGroupStateFault](api-faults.md#InvalidDBSecurityGroupStateFault)
+ [InvalidDBInstanceStateFault](api-faults.md#InvalidDBInstanceStateFault)
+ [DBClusterAlreadyExistsFault](api-faults.md#DBClusterAlreadyExistsFault)
+ [StorageTypeNotSupportedFault](api-faults.md#StorageTypeNotSupportedFault)

## StartDBCluster (acción)
<a name="StartDBCluster"></a>

         El nombre de la AWS CLI para esta API es: `start-db-cluster`.

Inicia un clúster de base de datos de Amazon Neptune que se detuvo con la consola de Amazon, el comando de la CLI de Amazon stop-db-cluster o la API StopDBCluster.

**Solicitud**
+ **DBClusterIdentifier** (en la CLI: `--db-cluster-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador del clúster de base de datos del clúster de base de datos de Neptune que se va a iniciar. Este parámetro se almacena como una cadena en minúsculas.

**Respuesta**

Contiene los detalles de un clúster de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en [DescribeDBClusters (acción)](#DescribeDBClusters).
+ **AllocatedStorage**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  `AllocatedStorage` siempre devuelve 1, ya que el tamaño de almacenamiento del clúster de base de datos de Neptune no es fijo, sino que se ajusta automáticamente según sea necesario.
+ **AssociatedRoles**: matriz de objetos [DBClusterRole](#DBClusterRole).

  Proporciona una lista de los roles de Amazon Identity and Access Management (IAM) que están asociados con el clúster de base de datos. Los roles de IAM que están asociados a un clúster de base de datos conceden permiso para que este obtenga acceso a otros servicios de Amazon en su nombre.
+ **AutomaticRestartTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Hora en la que el clúster de base de datos se reiniciará automáticamente.
+ **AvailabilityZones**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la lista de zonas de disponibilidad de EC2 en las que se pueden crear instancias en el clúster de base de datos.
+ **BacktrackConsumedChangeRecords**: un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BacktrackWindow**: un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BackupRetentionPeriod**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
+ **Capacity**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  No es compatible con Neptune.
+ **CloneGroupId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Identifica el grupo de clones al que está asociado el clúster de base de datos.
+ **ClusterCreateTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la hora a la que se creó el clúster de base de datos, en tiempo universal coordinado (UTC).
+ **CopyTagsToSnapshot**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  *Si se establece en `true`, las etiquetas se copian en cualquier instantánea del clúster de base de datos que se cree.*
+ **CrossAccountClone**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Si se establece en `true`, el clúster de base de datos se puede clonar en todas las cuentas.
+ **DatabaseName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el nombre de la base de datos inicial de este clúster de base de datos que se proporcionó en el momento de la creación, si se especificó uno cuando se creó el clúster de base de datos. Este mismo nombre se devuelve durante el tiempo que dura el clúster de base de datos.
+ **DBClusterArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el clúster de base de datos.
+ **DBClusterIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DBClusterMembers**: matriz de objetos [DBClusterMember](#DBClusterMember).

  Proporciona la lista de instancias que componen el clúster de base de datos.
+ **DBClusterParameterGroup**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre del grupo de parámetros del clúster de base de datos para el clúster de base de datos.
+ **DbClusterResourceId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador inmutable único de la región de Amazon para el clúster de base de datos. Este identificador se encuentra en las entradas de registro de Amazon CloudTrail siempre que se accede a la clave de Amazon KMS para el clúster de base de datos.
+ **DBSubnetGroup**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DeletionProtection**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si el clúster de base de datos tiene habilitada la protección contra eliminación o no. La base de datos no se puede eliminar cuando está habilitada la protección contra eliminación.
+ **EarliestBacktrackTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  No es compatible con Neptune.
+ **EarliestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **EnabledCloudwatchLogsExports**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de tipos de registro para los que este clúster de base de datos está configurado para exportar a los registros de CloudWatch. Los tipos de registro válidos son: `audit` (para publicar registros de auditoría en CloudWatch) y slowquery (para publicar registros de consultas lentas en CloudWatch). Consulte [Publicación de registros de Neptune en Registros de Amazon CloudWatch](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el punto de enlace de conexión para la instancia principal del clúster de base de datos.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del motor de base de datos que se debe utilizar para este clúster de base de datos.
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica la versión del motor de base de datos.
+ **GlobalClusterIdentifier**: un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  Incluye un identificador de clúster de base de datos global facilitado por el usuario. Este identificador es la clave única que identifica una base de datos global.
+ **HostedZoneId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el ID que Amazon Route 53 asigna al crear una zona alojada.
+ **IAMDatabaseAuthenticationEnabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True (Verdadero) si la asignación de cuentas de Amazon Identity and Access Management (IAM) a cuentas de base de datos está habilitada; de lo contrario, el valor es false (falso).
+ **IOOptimizedNextAllowedModificationTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  La próxima vez, podrá modificar el clúster de base de datos para utilizar el tipo de almacenamiento `iopt1`.
+ **KmsKeyId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si el valor de `StorageEncrypted` es true (verdadero), el identificador de la clave de Amazon KMS para el clúster de base de datos cifrado.
+ **LatestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **MultiAZ**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos tiene instancias en varias zonas de disponibilidad.
+ **PendingModifiedValues**: un objeto [ClusterPendingModifiedValues](#ClusterPendingModifiedValues).

  Este tipo de datos se utiliza como un elemento de respuesta en la operación `ModifyDBCluster` e incluye cambios que se aplicarán durante el siguiente periodo de mantenimiento.
+ **PercentProgress**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el progreso de la operación como porcentaje.
+ **Port**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto en el que escucha el motor de la base de datos.
+ **PreferredBackupWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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`.
+ **PreferredMaintenanceWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
+ **ReaderEndpoint**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El punto de enlace del lector para el clúster de base de datos. El punto de enlace del lector de un clúster de base de datos equilibra la carga de las conexiones entre las réplicas de lectura que están disponibles en un clúster de base de datos. A medida que los clientes solicitan nuevas conexiones al punto de enlace del lector, Neptune distribuye las solicitudes de conexión entre las réplicas de lectura del clúster de base de datos. Esta funcionalidad puede ayudar a equilibrar la carga de trabajo de lectura entre las distintas réplicas de lectura en el clúster de base de datos.

  Si se produce una conmutación por error y la réplica de lectura a la que está conectado se convierte en la nueva instancia principal, la conexión se interrumpe. Para seguir enviando la carga de trabajo de lectura a otras réplicas de lectura del clúster, puede volver a conectarse al punto de enlace del lector.
+ **ReadReplicaIdentifiers**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de las réplicas de lectura asociados con este clúster de base de datos.
+ **ReplicationSourceIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ReplicationType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ServerlessV2ScalingConfiguration**: un objeto [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

  Muestra la configuración de escalado de un clúster de base de datos de Neptune sin servidor.

  Para obtener más información, consulte [Uso de Amazon Neptune sin servidor](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) en la *Guía del usuario de Amazon Neptune*.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de este clúster de base de datos.
+ **StorageEncrypted**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos está cifrado.
+ **StorageType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de almacenamiento que se utiliza para el clúster de base de datos.

  Valores válidos:
  + **`standard`**: (*predeterminado*) proporciona un almacenamiento de bases de datos rentable para aplicaciones con un uso de E/S de moderado a pequeño.
  + **`iopt1`**: habilita el [almacenamiento optimizado para E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage) que está diseñado para satisfacer las necesidades de las cargas de trabajo de gráficos con uso intensivo de operaciones de E/S que requieren precios predecibles con una latencia de E/S baja y un rendimiento de E/S constante.

    El almacenamiento optimizado para E/S de Neptune solo está disponible a partir de la versión 1.3.0.0 del motor.
+ **VpcSecurityGroups**: matriz de objetos [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Errores**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [InvalidDBInstanceStateFault](api-faults.md#InvalidDBInstanceStateFault)

## StopDBCluster (acción)
<a name="StopDBCluster"></a>

         El nombre de la AWS CLI para esta API es: `stop-db-cluster`.

Detiene un nuevo clúster de base de datos Amazon Neptune. Cuando se detiene un clúster de base de datos, Neptune conserva los metadatos del clúster de base de datos, incluidos sus puntos de enlace y grupos de parámetros de base de datos.

Neptune también conserva los registros de transacciones para que se pueda realizar una restauración a un momento dado si es necesario.

**Solicitud**
+ **DBClusterIdentifier** (en la CLI: `--db-cluster-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador del clúster de base de datos del clúster de base de datos de Neptune que se va a detener. Este parámetro se almacena como una cadena en minúsculas.

**Respuesta**

Contiene los detalles de un clúster de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en [DescribeDBClusters (acción)](#DescribeDBClusters).
+ **AllocatedStorage**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  `AllocatedStorage` siempre devuelve 1, ya que el tamaño de almacenamiento del clúster de base de datos de Neptune no es fijo, sino que se ajusta automáticamente según sea necesario.
+ **AssociatedRoles**: matriz de objetos [DBClusterRole](#DBClusterRole).

  Proporciona una lista de los roles de Amazon Identity and Access Management (IAM) que están asociados con el clúster de base de datos. Los roles de IAM que están asociados a un clúster de base de datos conceden permiso para que este obtenga acceso a otros servicios de Amazon en su nombre.
+ **AutomaticRestartTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Hora en la que el clúster de base de datos se reiniciará automáticamente.
+ **AvailabilityZones**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la lista de zonas de disponibilidad de EC2 en las que se pueden crear instancias en el clúster de base de datos.
+ **BacktrackConsumedChangeRecords**: un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BacktrackWindow**: un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BackupRetentionPeriod**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
+ **Capacity**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  No es compatible con Neptune.
+ **CloneGroupId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Identifica el grupo de clones al que está asociado el clúster de base de datos.
+ **ClusterCreateTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la hora a la que se creó el clúster de base de datos, en tiempo universal coordinado (UTC).
+ **CopyTagsToSnapshot**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  *Si se establece en `true`, las etiquetas se copian en cualquier instantánea del clúster de base de datos que se cree.*
+ **CrossAccountClone**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Si se establece en `true`, el clúster de base de datos se puede clonar en todas las cuentas.
+ **DatabaseName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el nombre de la base de datos inicial de este clúster de base de datos que se proporcionó en el momento de la creación, si se especificó uno cuando se creó el clúster de base de datos. Este mismo nombre se devuelve durante el tiempo que dura el clúster de base de datos.
+ **DBClusterArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el clúster de base de datos.
+ **DBClusterIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DBClusterMembers**: matriz de objetos [DBClusterMember](#DBClusterMember).

  Proporciona la lista de instancias que componen el clúster de base de datos.
+ **DBClusterParameterGroup**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre del grupo de parámetros del clúster de base de datos para el clúster de base de datos.
+ **DbClusterResourceId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador inmutable único de la región de Amazon para el clúster de base de datos. Este identificador se encuentra en las entradas de registro de Amazon CloudTrail siempre que se accede a la clave de Amazon KMS para el clúster de base de datos.
+ **DBSubnetGroup**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DeletionProtection**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si el clúster de base de datos tiene habilitada la protección contra eliminación o no. La base de datos no se puede eliminar cuando está habilitada la protección contra eliminación.
+ **EarliestBacktrackTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  No es compatible con Neptune.
+ **EarliestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **EnabledCloudwatchLogsExports**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de tipos de registro para los que este clúster de base de datos está configurado para exportar a los registros de CloudWatch. Los tipos de registro válidos son: `audit` (para publicar registros de auditoría en CloudWatch) y slowquery (para publicar registros de consultas lentas en CloudWatch). Consulte [Publicación de registros de Neptune en Registros de Amazon CloudWatch](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el punto de enlace de conexión para la instancia principal del clúster de base de datos.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del motor de base de datos que se debe utilizar para este clúster de base de datos.
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica la versión del motor de base de datos.
+ **GlobalClusterIdentifier**: un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  Incluye un identificador de clúster de base de datos global facilitado por el usuario. Este identificador es la clave única que identifica una base de datos global.
+ **HostedZoneId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el ID que Amazon Route 53 asigna al crear una zona alojada.
+ **IAMDatabaseAuthenticationEnabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True (Verdadero) si la asignación de cuentas de Amazon Identity and Access Management (IAM) a cuentas de base de datos está habilitada; de lo contrario, el valor es false (falso).
+ **IOOptimizedNextAllowedModificationTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  La próxima vez, podrá modificar el clúster de base de datos para utilizar el tipo de almacenamiento `iopt1`.
+ **KmsKeyId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si el valor de `StorageEncrypted` es true (verdadero), el identificador de la clave de Amazon KMS para el clúster de base de datos cifrado.
+ **LatestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **MultiAZ**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos tiene instancias en varias zonas de disponibilidad.
+ **PendingModifiedValues**: un objeto [ClusterPendingModifiedValues](#ClusterPendingModifiedValues).

  Este tipo de datos se utiliza como un elemento de respuesta en la operación `ModifyDBCluster` e incluye cambios que se aplicarán durante el siguiente periodo de mantenimiento.
+ **PercentProgress**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el progreso de la operación como porcentaje.
+ **Port**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto en el que escucha el motor de la base de datos.
+ **PreferredBackupWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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`.
+ **PreferredMaintenanceWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
+ **ReaderEndpoint**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El punto de enlace del lector para el clúster de base de datos. El punto de enlace del lector de un clúster de base de datos equilibra la carga de las conexiones entre las réplicas de lectura que están disponibles en un clúster de base de datos. A medida que los clientes solicitan nuevas conexiones al punto de enlace del lector, Neptune distribuye las solicitudes de conexión entre las réplicas de lectura del clúster de base de datos. Esta funcionalidad puede ayudar a equilibrar la carga de trabajo de lectura entre las distintas réplicas de lectura en el clúster de base de datos.

  Si se produce una conmutación por error y la réplica de lectura a la que está conectado se convierte en la nueva instancia principal, la conexión se interrumpe. Para seguir enviando la carga de trabajo de lectura a otras réplicas de lectura del clúster, puede volver a conectarse al punto de enlace del lector.
+ **ReadReplicaIdentifiers**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de las réplicas de lectura asociados con este clúster de base de datos.
+ **ReplicationSourceIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ReplicationType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ServerlessV2ScalingConfiguration**: un objeto [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

  Muestra la configuración de escalado de un clúster de base de datos de Neptune sin servidor.

  Para obtener más información, consulte [Uso de Amazon Neptune sin servidor](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) en la *Guía del usuario de Amazon Neptune*.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de este clúster de base de datos.
+ **StorageEncrypted**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos está cifrado.
+ **StorageType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de almacenamiento que se utiliza para el clúster de base de datos.

  Valores válidos:
  + **`standard`**: (*predeterminado*) proporciona un almacenamiento de bases de datos rentable para aplicaciones con un uso de E/S de moderado a pequeño.
  + **`iopt1`**: habilita el [almacenamiento optimizado para E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage) que está diseñado para satisfacer las necesidades de las cargas de trabajo de gráficos con uso intensivo de operaciones de E/S que requieren precios predecibles con una latencia de E/S baja y un rendimiento de E/S constante.

    El almacenamiento optimizado para E/S de Neptune solo está disponible a partir de la versión 1.3.0.0 del motor.
+ **VpcSecurityGroups**: matriz de objetos [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Errores**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [InvalidDBInstanceStateFault](api-faults.md#InvalidDBInstanceStateFault)

## AddRoleToDBCluster (acción)
<a name="AddRoleToDBCluster"></a>

         El nombre de la AWS CLI para esta API es: `add-role-to-db-cluster`.

Asocia un rol de Identity and Access Management (IAM) con un clúster de base de datos de Neptune.

**Solicitud**
+ **DBClusterIdentifier** (en la CLI: `--db-cluster-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del clúster de base de datos con el que asociar el rol de IAM.
+ **FeatureName** (en la CLI: `--feature-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la característica del clúster de base de datos de Neptune con el que asociar el rol de IAM. Para ver la lista de nombres de características admitidos, consulte [DBEngineVersion (estructura)](api-other-apis.md#DBEngineVersion).
+ **RoleArn** (en la CLI: `--role-arn`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) del rol de IAM que se va a asociar al clúster de base de datos de Neptune, por ejemplo `arn:aws:iam::123456789012:role/NeptuneAccessRole`.

**Respuesta**
+ *Sin parámetros de respuesta.*

**Errores**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [DBClusterRoleAlreadyExistsFault](api-faults.md#DBClusterRoleAlreadyExistsFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [DBClusterRoleQuotaExceededFault](api-faults.md#DBClusterRoleQuotaExceededFault)

## RemoveRoleFromDBCluster (acción)
<a name="RemoveRoleFromDBCluster"></a>

         El nombre de la AWS CLI para esta API es: `remove-role-from-db-cluster`.

Disocia un rol de Identity and Access Management (IAM) de un clúster de base de datos.

**Solicitud**
+ **DBClusterIdentifier** (en la CLI: `--db-cluster-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del clúster de base de datos del que disociar el rol de IAM.
+ **FeatureName** (en la CLI: `--feature-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la característica del clúster de base de datos del que se va a anular la asociación del rol de IAM. Para ver la lista de nombres de características admitidos, consulte [DescribeDBEngineVersions (acción)](api-other-apis.md#DescribeDBEngineVersions).
+ **RoleArn** (en la CLI: `--role-arn`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) del rol de IAM que se va a disasociar del clúster de base de datos, por ejemplo `arn:aws:iam::123456789012:role/NeptuneAccessRole`.

**Respuesta**
+ *Sin parámetros de respuesta.*

**Errores**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [DBClusterRoleNotFoundFault](api-faults.md#DBClusterRoleNotFoundFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)

## FailoverDBCluster (acción)
<a name="FailoverDBCluster"></a>

         El nombre de la AWS CLI para esta API es: `failover-db-cluster`.

Fuerza una conmutación por error para un clúster de base de datos.

Una conmutación por error de un clúster de base de datos promueve una de las réplicas de lectura (instancias de solo lectura) del clúster de base de datos a instancia principal (la instancia de escritura del clúster).

Amazon Neptune conmuta automáticamente a una réplica de lectura, si existe, cuando se produce un error en la instancia principal. Puede forzar una conmutación por error cuando desee simular un error en una instancia principal para realizar pruebas. Como cada instancia de un clúster de base de datos tiene su propia dirección de punto de enlace, tendrá que eliminar y restablecer las conexiones existentes que utilizan dichas direcciones de punto de enlace cuando se haya completado la conmutación por error.

**Solicitud**
+ **DBClusterIdentifier** (en la CLI: `--db-cluster-identifier`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Un identificador del clúster de base de datos para forzar una conmutación por error. Este parámetro no distingue entre mayúsculas y minúsculas.

  Restricciones:
  + Debe coincidir con el identificador de un DBCluster existente.
+ **TargetDBInstanceIdentifier** (en la CLI: `--target-db-instance-identifier`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la instancia que se va a promover a instancia principal.

  Debe especificar el identificador de instancias para una réplica de lectura del clúster de base de datos. Por ejemplo, `mydbcluster-replica1`.

**Respuesta**

Contiene los detalles de un clúster de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en [DescribeDBClusters (acción)](#DescribeDBClusters).
+ **AllocatedStorage**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  `AllocatedStorage` siempre devuelve 1, ya que el tamaño de almacenamiento del clúster de base de datos de Neptune no es fijo, sino que se ajusta automáticamente según sea necesario.
+ **AssociatedRoles**: matriz de objetos [DBClusterRole](#DBClusterRole).

  Proporciona una lista de los roles de Amazon Identity and Access Management (IAM) que están asociados con el clúster de base de datos. Los roles de IAM que están asociados a un clúster de base de datos conceden permiso para que este obtenga acceso a otros servicios de Amazon en su nombre.
+ **AutomaticRestartTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Hora en la que el clúster de base de datos se reiniciará automáticamente.
+ **AvailabilityZones**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la lista de zonas de disponibilidad de EC2 en las que se pueden crear instancias en el clúster de base de datos.
+ **BacktrackConsumedChangeRecords**: un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BacktrackWindow**: un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BackupRetentionPeriod**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
+ **Capacity**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  No es compatible con Neptune.
+ **CloneGroupId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Identifica el grupo de clones al que está asociado el clúster de base de datos.
+ **ClusterCreateTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la hora a la que se creó el clúster de base de datos, en tiempo universal coordinado (UTC).
+ **CopyTagsToSnapshot**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  *Si se establece en `true`, las etiquetas se copian en cualquier instantánea del clúster de base de datos que se cree.*
+ **CrossAccountClone**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Si se establece en `true`, el clúster de base de datos se puede clonar en todas las cuentas.
+ **DatabaseName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el nombre de la base de datos inicial de este clúster de base de datos que se proporcionó en el momento de la creación, si se especificó uno cuando se creó el clúster de base de datos. Este mismo nombre se devuelve durante el tiempo que dura el clúster de base de datos.
+ **DBClusterArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el clúster de base de datos.
+ **DBClusterIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DBClusterMembers**: matriz de objetos [DBClusterMember](#DBClusterMember).

  Proporciona la lista de instancias que componen el clúster de base de datos.
+ **DBClusterParameterGroup**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre del grupo de parámetros del clúster de base de datos para el clúster de base de datos.
+ **DbClusterResourceId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador inmutable único de la región de Amazon para el clúster de base de datos. Este identificador se encuentra en las entradas de registro de Amazon CloudTrail siempre que se accede a la clave de Amazon KMS para el clúster de base de datos.
+ **DBSubnetGroup**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DeletionProtection**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si el clúster de base de datos tiene habilitada la protección contra eliminación o no. La base de datos no se puede eliminar cuando está habilitada la protección contra eliminación.
+ **EarliestBacktrackTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  No es compatible con Neptune.
+ **EarliestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **EnabledCloudwatchLogsExports**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de tipos de registro para los que este clúster de base de datos está configurado para exportar a los registros de CloudWatch. Los tipos de registro válidos son: `audit` (para publicar registros de auditoría en CloudWatch) y slowquery (para publicar registros de consultas lentas en CloudWatch). Consulte [Publicación de registros de Neptune en Registros de Amazon CloudWatch](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el punto de enlace de conexión para la instancia principal del clúster de base de datos.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del motor de base de datos que se debe utilizar para este clúster de base de datos.
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica la versión del motor de base de datos.
+ **GlobalClusterIdentifier**: un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  Incluye un identificador de clúster de base de datos global facilitado por el usuario. Este identificador es la clave única que identifica una base de datos global.
+ **HostedZoneId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el ID que Amazon Route 53 asigna al crear una zona alojada.
+ **IAMDatabaseAuthenticationEnabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True (Verdadero) si la asignación de cuentas de Amazon Identity and Access Management (IAM) a cuentas de base de datos está habilitada; de lo contrario, el valor es false (falso).
+ **IOOptimizedNextAllowedModificationTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  La próxima vez, podrá modificar el clúster de base de datos para utilizar el tipo de almacenamiento `iopt1`.
+ **KmsKeyId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si el valor de `StorageEncrypted` es true (verdadero), el identificador de la clave de Amazon KMS para el clúster de base de datos cifrado.
+ **LatestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **MultiAZ**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos tiene instancias en varias zonas de disponibilidad.
+ **PendingModifiedValues**: un objeto [ClusterPendingModifiedValues](#ClusterPendingModifiedValues).

  Este tipo de datos se utiliza como un elemento de respuesta en la operación `ModifyDBCluster` e incluye cambios que se aplicarán durante el siguiente periodo de mantenimiento.
+ **PercentProgress**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el progreso de la operación como porcentaje.
+ **Port**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto en el que escucha el motor de la base de datos.
+ **PreferredBackupWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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`.
+ **PreferredMaintenanceWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
+ **ReaderEndpoint**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El punto de enlace del lector para el clúster de base de datos. El punto de enlace del lector de un clúster de base de datos equilibra la carga de las conexiones entre las réplicas de lectura que están disponibles en un clúster de base de datos. A medida que los clientes solicitan nuevas conexiones al punto de enlace del lector, Neptune distribuye las solicitudes de conexión entre las réplicas de lectura del clúster de base de datos. Esta funcionalidad puede ayudar a equilibrar la carga de trabajo de lectura entre las distintas réplicas de lectura en el clúster de base de datos.

  Si se produce una conmutación por error y la réplica de lectura a la que está conectado se convierte en la nueva instancia principal, la conexión se interrumpe. Para seguir enviando la carga de trabajo de lectura a otras réplicas de lectura del clúster, puede volver a conectarse al punto de enlace del lector.
+ **ReadReplicaIdentifiers**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de las réplicas de lectura asociados con este clúster de base de datos.
+ **ReplicationSourceIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ReplicationType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ServerlessV2ScalingConfiguration**: un objeto [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

  Muestra la configuración de escalado de un clúster de base de datos de Neptune sin servidor.

  Para obtener más información, consulte [Uso de Amazon Neptune sin servidor](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) en la *Guía del usuario de Amazon Neptune*.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de este clúster de base de datos.
+ **StorageEncrypted**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos está cifrado.
+ **StorageType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de almacenamiento que se utiliza para el clúster de base de datos.

  Valores válidos:
  + **`standard`**: (*predeterminado*) proporciona un almacenamiento de bases de datos rentable para aplicaciones con un uso de E/S de moderado a pequeño.
  + **`iopt1`**: habilita el [almacenamiento optimizado para E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage) que está diseñado para satisfacer las necesidades de las cargas de trabajo de gráficos con uso intensivo de operaciones de E/S que requieren precios predecibles con una latencia de E/S baja y un rendimiento de E/S constante.

    El almacenamiento optimizado para E/S de Neptune solo está disponible a partir de la versión 1.3.0.0 del motor.
+ **VpcSecurityGroups**: matriz de objetos [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Errores**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [InvalidDBInstanceStateFault](api-faults.md#InvalidDBInstanceStateFault)

## PromoteReadReplicaDBCluster (acción)
<a name="PromoteReadReplicaDBCluster"></a>

         El nombre de la AWS CLI para esta API es: `promote-read-replica-db-cluster`.

No admitido.

**Solicitud**
+ **DBClusterIdentifier** (en la CLI: `--db-cluster-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No admitido.

**Respuesta**

Contiene los detalles de un clúster de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en [DescribeDBClusters (acción)](#DescribeDBClusters).
+ **AllocatedStorage**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  `AllocatedStorage` siempre devuelve 1, ya que el tamaño de almacenamiento del clúster de base de datos de Neptune no es fijo, sino que se ajusta automáticamente según sea necesario.
+ **AssociatedRoles**: matriz de objetos [DBClusterRole](#DBClusterRole).

  Proporciona una lista de los roles de Amazon Identity and Access Management (IAM) que están asociados con el clúster de base de datos. Los roles de IAM que están asociados a un clúster de base de datos conceden permiso para que este obtenga acceso a otros servicios de Amazon en su nombre.
+ **AutomaticRestartTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Hora en la que el clúster de base de datos se reiniciará automáticamente.
+ **AvailabilityZones**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la lista de zonas de disponibilidad de EC2 en las que se pueden crear instancias en el clúster de base de datos.
+ **BacktrackConsumedChangeRecords**: un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BacktrackWindow**: un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BackupRetentionPeriod**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
+ **Capacity**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  No es compatible con Neptune.
+ **CloneGroupId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Identifica el grupo de clones al que está asociado el clúster de base de datos.
+ **ClusterCreateTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la hora a la que se creó el clúster de base de datos, en tiempo universal coordinado (UTC).
+ **CopyTagsToSnapshot**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  *Si se establece en `true`, las etiquetas se copian en cualquier instantánea del clúster de base de datos que se cree.*
+ **CrossAccountClone**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Si se establece en `true`, el clúster de base de datos se puede clonar en todas las cuentas.
+ **DatabaseName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el nombre de la base de datos inicial de este clúster de base de datos que se proporcionó en el momento de la creación, si se especificó uno cuando se creó el clúster de base de datos. Este mismo nombre se devuelve durante el tiempo que dura el clúster de base de datos.
+ **DBClusterArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el clúster de base de datos.
+ **DBClusterIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DBClusterMembers**: matriz de objetos [DBClusterMember](#DBClusterMember).

  Proporciona la lista de instancias que componen el clúster de base de datos.
+ **DBClusterParameterGroup**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre del grupo de parámetros del clúster de base de datos para el clúster de base de datos.
+ **DbClusterResourceId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador inmutable único de la región de Amazon para el clúster de base de datos. Este identificador se encuentra en las entradas de registro de Amazon CloudTrail siempre que se accede a la clave de Amazon KMS para el clúster de base de datos.
+ **DBSubnetGroup**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DeletionProtection**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si el clúster de base de datos tiene habilitada la protección contra eliminación o no. La base de datos no se puede eliminar cuando está habilitada la protección contra eliminación.
+ **EarliestBacktrackTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  No es compatible con Neptune.
+ **EarliestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **EnabledCloudwatchLogsExports**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de tipos de registro para los que este clúster de base de datos está configurado para exportar a los registros de CloudWatch. Los tipos de registro válidos son: `audit` (para publicar registros de auditoría en CloudWatch) y slowquery (para publicar registros de consultas lentas en CloudWatch). Consulte [Publicación de registros de Neptune en Registros de Amazon CloudWatch](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el punto de enlace de conexión para la instancia principal del clúster de base de datos.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del motor de base de datos que se debe utilizar para este clúster de base de datos.
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica la versión del motor de base de datos.
+ **GlobalClusterIdentifier**: un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  Incluye un identificador de clúster de base de datos global facilitado por el usuario. Este identificador es la clave única que identifica una base de datos global.
+ **HostedZoneId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el ID que Amazon Route 53 asigna al crear una zona alojada.
+ **IAMDatabaseAuthenticationEnabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True (Verdadero) si la asignación de cuentas de Amazon Identity and Access Management (IAM) a cuentas de base de datos está habilitada; de lo contrario, el valor es false (falso).
+ **IOOptimizedNextAllowedModificationTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  La próxima vez, podrá modificar el clúster de base de datos para utilizar el tipo de almacenamiento `iopt1`.
+ **KmsKeyId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si el valor de `StorageEncrypted` es true (verdadero), el identificador de la clave de Amazon KMS para el clúster de base de datos cifrado.
+ **LatestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **MultiAZ**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos tiene instancias en varias zonas de disponibilidad.
+ **PendingModifiedValues**: un objeto [ClusterPendingModifiedValues](#ClusterPendingModifiedValues).

  Este tipo de datos se utiliza como un elemento de respuesta en la operación `ModifyDBCluster` e incluye cambios que se aplicarán durante el siguiente periodo de mantenimiento.
+ **PercentProgress**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el progreso de la operación como porcentaje.
+ **Port**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto en el que escucha el motor de la base de datos.
+ **PreferredBackupWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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`.
+ **PreferredMaintenanceWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
+ **ReaderEndpoint**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El punto de enlace del lector para el clúster de base de datos. El punto de enlace del lector de un clúster de base de datos equilibra la carga de las conexiones entre las réplicas de lectura que están disponibles en un clúster de base de datos. A medida que los clientes solicitan nuevas conexiones al punto de enlace del lector, Neptune distribuye las solicitudes de conexión entre las réplicas de lectura del clúster de base de datos. Esta funcionalidad puede ayudar a equilibrar la carga de trabajo de lectura entre las distintas réplicas de lectura en el clúster de base de datos.

  Si se produce una conmutación por error y la réplica de lectura a la que está conectado se convierte en la nueva instancia principal, la conexión se interrumpe. Para seguir enviando la carga de trabajo de lectura a otras réplicas de lectura del clúster, puede volver a conectarse al punto de enlace del lector.
+ **ReadReplicaIdentifiers**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de las réplicas de lectura asociados con este clúster de base de datos.
+ **ReplicationSourceIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ReplicationType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ServerlessV2ScalingConfiguration**: un objeto [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

  Muestra la configuración de escalado de un clúster de base de datos de Neptune sin servidor.

  Para obtener más información, consulte [Uso de Amazon Neptune sin servidor](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) en la *Guía del usuario de Amazon Neptune*.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de este clúster de base de datos.
+ **StorageEncrypted**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos está cifrado.
+ **StorageType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de almacenamiento que se utiliza para el clúster de base de datos.

  Valores válidos:
  + **`standard`**: (*predeterminado*) proporciona un almacenamiento de bases de datos rentable para aplicaciones con un uso de E/S de moderado a pequeño.
  + **`iopt1`**: habilita el [almacenamiento optimizado para E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage) que está diseñado para satisfacer las necesidades de las cargas de trabajo de gráficos con uso intensivo de operaciones de E/S que requieren precios predecibles con una latencia de E/S baja y un rendimiento de E/S constante.

    El almacenamiento optimizado para E/S de Neptune solo está disponible a partir de la versión 1.3.0.0 del motor.
+ **VpcSecurityGroups**: matriz de objetos [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Errores**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)

## DescribeDBClusters (acción)
<a name="DescribeDBClusters"></a>

         El nombre de la AWS CLI para esta API es: `describe-db-clusters`.

Devuelve información sobre clústeres de base de datos aprovisionados y admite la paginación.

**nota**  
Esta operación también puede devolver información para clústeres de Amazon RDS y clústeres de Amazon DocDB.

**Solicitud**
+ **DBClusterIdentifier** (en la CLI: `--db-cluster-identifier`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador de clúster de base de datos suministrado por el usuario. Si se especifica este parámetro, se devuelve información solo del clúster de base de datos específico. Este parámetro no distingue entre mayúsculas y minúsculas.

  Restricciones:
  + Si se suministra, debe coincidir con un DBClusterIdentifier existente.
+ **Filters** (en la CLI: `--filters`): una matriz de objetos [Filtro](api-datatypes.md#Filter).

  Un filtro que especifica uno o varios clústeres de bases de datos para describir.

  Filtros compatibles:
  + `db-cluster-id`: acepta identificadores de clúster de base de datos y Nombres de recursos de Amazon (ARN). La lista de resultados solo incluirá información sobre los clústeres de base de datos identificados por estos ARN.
  + `engine` - Acepta un nombre de motor (como `neptune`), y restringe la lista de resultados a clústeres de base de datos creados por ese motor.

  Por ejemplo, para invocar esta API desde la CLI de Amazon y filtrar de modo que solo se devuelvan los clústeres de base de datos de Neptune, puede utilizar el siguiente comando:  
**Example**  

  ```
  aws neptune describe-db-clusters \
              --filters  Name=engine,Values=neptune
  ```
+ **Marker** (en la CLI: `--marker`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Un token de paginación opcional proporcionado por una solicitud [DescribeDBClusters (acción)](#DescribeDBClusters) anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.
+ **MaxRecords** (en la CLI: `--max-records`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación que se conoce como marcador, de modo que se pueda recuperar el resto de resultados.

  Predeterminado: 100

  Restricciones: mínimo 20, máximo 100.

**Respuesta**
+ **DBClusters**: matriz de objetos [DBCluster](#DBCluster).

  Contiene una lista de los clústeres de base de datos para el usuario.
+ **Marker**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Un token de paginación que se pueda utilizar en una solicitud DescribeDBClusters posterior.

**Errores**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

## *Estructuras:*
<a name="api-clusters-structures-spacer"></a>

## DBCluster (estructura)
<a name="DBCluster"></a>

Contiene los detalles de un clúster de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en [DescribeDBClusters (acción)](#DescribeDBClusters).

**Campos**
+ **AllocatedStorage**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  `AllocatedStorage` siempre devuelve 1, ya que el tamaño de almacenamiento del clúster de base de datos de Neptune no es fijo, sino que se ajusta automáticamente según sea necesario.
+ **AssociatedRoles**: se trata de una matriz de objetos [DBClusterRole](#DBClusterRole).

  Proporciona una lista de los roles de Amazon Identity and Access Management (IAM) que están asociados con el clúster de base de datos. Los roles de IAM que están asociados a un clúster de base de datos conceden permiso para que este obtenga acceso a otros servicios de Amazon en su nombre.
+ **AutomaticRestartTime**: se trata de un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Hora en la que el clúster de base de datos se reiniciará automáticamente.
+ **AvailabilityZones**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la lista de zonas de disponibilidad de EC2 en las que se pueden crear instancias en el clúster de base de datos.
+ **BacktrackConsumedChangeRecords**: se trata de un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BacktrackWindow**: se trata de un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BackupRetentionPeriod**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
+ **Capacity**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  No es compatible con Neptune.
+ **CloneGroupId**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Identifica el grupo de clones al que está asociado el clúster de base de datos.
+ **ClusterCreateTime**: se trata de un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la hora a la que se creó el clúster de base de datos, en tiempo universal coordinado (UTC).
+ **CopyTagsToSnapshot**: se trata de un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  *Si se establece en `true`, las etiquetas se copian en cualquier instantánea del clúster de base de datos que se cree.*
+ **CrossAccountClone**: se trata de un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Si se establece en `true`, el clúster de base de datos se puede clonar en todas las cuentas.
+ **DatabaseName**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el nombre de la base de datos inicial de este clúster de base de datos que se proporcionó en el momento de la creación, si se especificó uno cuando se creó el clúster de base de datos. Este mismo nombre se devuelve durante el tiempo que dura el clúster de base de datos.
+ **DBClusterArn**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el clúster de base de datos.
+ **DBClusterIdentifier**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DBClusterMembers**: se trata de una matriz de objetos [DBClusterMember](#DBClusterMember).

  Proporciona la lista de instancias que componen el clúster de base de datos.
+ **DBClusterParameterGroup**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre del grupo de parámetros del clúster de base de datos para el clúster de base de datos.
+ **DbClusterResourceId**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador inmutable único de la región de Amazon para el clúster de base de datos. Este identificador se encuentra en las entradas de registro de Amazon CloudTrail siempre que se accede a la clave de Amazon KMS para el clúster de base de datos.
+ **DBSubnetGroup**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DeletionProtection**: se trata de un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si el clúster de base de datos tiene habilitada la protección contra eliminación o no. La base de datos no se puede eliminar cuando está habilitada la protección contra eliminación.
+ **EarliestBacktrackTime**: se trata de un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  No es compatible con Neptune.
+ **EarliestRestorableTime**: se trata de un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **EnabledCloudwatchLogsExports**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de tipos de registro para los que este clúster de base de datos está configurado para exportar a los registros de CloudWatch. Los tipos de registro válidos son: `audit` (para publicar registros de auditoría en CloudWatch) y slowquery (para publicar registros de consultas lentas en CloudWatch). Consulte [Publicación de registros de Neptune en Registros de Amazon CloudWatch](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el punto de enlace de conexión para la instancia principal del clúster de base de datos.
+ **Engine**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del motor de base de datos que se debe utilizar para este clúster de base de datos.
+ **EngineVersion**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica la versión del motor de base de datos.
+ **GlobalClusterIdentifier**: se trata de un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  Incluye un identificador de clúster de base de datos global facilitado por el usuario. Este identificador es la clave única que identifica una base de datos global.
+ **HostedZoneId**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el ID que Amazon Route 53 asigna al crear una zona alojada.
+ **IAMDatabaseAuthenticationEnabled**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True (Verdadero) si la asignación de cuentas de Amazon Identity and Access Management (IAM) a cuentas de base de datos está habilitada; de lo contrario, el valor es false (falso).
+ **IOOptimizedNextAllowedModificationTime**: se trata de un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  La próxima vez, podrá modificar el clúster de base de datos para utilizar el tipo de almacenamiento `iopt1`.
+ **KmsKeyId**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si el valor de `StorageEncrypted` es true (verdadero), el identificador de la clave de Amazon KMS para el clúster de base de datos cifrado.
+ **LatestRestorableTime**: se trata de un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **MultiAZ**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos tiene instancias en varias zonas de disponibilidad.
+ **PendingModifiedValues**: se trata de un objeto [ClusterPendingModifiedValues](#ClusterPendingModifiedValues).

  Este tipo de datos se utiliza como un elemento de respuesta en la operación `ModifyDBCluster` e incluye cambios que se aplicarán durante el siguiente periodo de mantenimiento.
+ **PercentProgress**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el progreso de la operación como porcentaje.
+ **Port**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto en el que escucha el motor de la base de datos.
+ **PreferredBackupWindow**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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`.
+ **PreferredMaintenanceWindow**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
+ **ReaderEndpoint**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El punto de enlace del lector para el clúster de base de datos. El punto de enlace del lector de un clúster de base de datos equilibra la carga de las conexiones entre las réplicas de lectura que están disponibles en un clúster de base de datos. A medida que los clientes solicitan nuevas conexiones al punto de enlace del lector, Neptune distribuye las solicitudes de conexión entre las réplicas de lectura del clúster de base de datos. Esta funcionalidad puede ayudar a equilibrar la carga de trabajo de lectura entre las distintas réplicas de lectura en el clúster de base de datos.

  Si se produce una conmutación por error y la réplica de lectura a la que está conectado se convierte en la nueva instancia principal, la conexión se interrumpe. Para seguir enviando la carga de trabajo de lectura a otras réplicas de lectura del clúster, puede volver a conectarse al punto de enlace del lector.
+ **ReadReplicaIdentifiers**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de las réplicas de lectura asociados con este clúster de base de datos.
+ **ReplicationSourceIdentifier**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ReplicationType**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ServerlessV2ScalingConfiguration**: se trata de un objeto [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

  Muestra la configuración de escalado de un clúster de base de datos de Neptune sin servidor.

  Para obtener más información, consulte [Uso de Amazon Neptune sin servidor](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) en la *Guía del usuario de Amazon Neptune*.
+ **Status**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de este clúster de base de datos.
+ **StorageEncrypted**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos está cifrado.
+ **StorageType**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de almacenamiento que se utiliza para el clúster de base de datos.

  Valores válidos:
  + **`standard`**: (*predeterminado*) proporciona un almacenamiento de bases de datos rentable para aplicaciones con un uso de E/S de moderado a pequeño.
  + **`iopt1`**: habilita el [almacenamiento optimizado para E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage) que está diseñado para satisfacer las necesidades de las cargas de trabajo de gráficos con uso intensivo de operaciones de E/S que requieren precios predecibles con una latencia de E/S baja y un rendimiento de E/S constante.

    El almacenamiento optimizado para E/S de Neptune solo está disponible a partir de la versión 1.3.0.0 del motor.
+ **VpcSecurityGroups**: se trata de una matriz de objetos [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

`DBCluster` se utiliza como el elemento de respuesta para:
+ [CreateDBCluster](#CreateDBCluster)
+ [DeleteDBCluster](#DeleteDBCluster)
+ [FailoverDBCluster](#FailoverDBCluster)
+ [ModifyDBCluster](#ModifyDBCluster)
+ [PromoteReadReplicaDBCluster](#PromoteReadReplicaDBCluster)
+ [RestoreDBClusterFromSnapshot](api-snapshots.md#RestoreDBClusterFromSnapshot)
+ [RestoreDBClusterToPointInTime](api-snapshots.md#RestoreDBClusterToPointInTime)
+ [StartDBCluster](#StartDBCluster)
+ [StopDBCluster](#StopDBCluster)

## DBClusterMember (estructura)
<a name="DBClusterMember"></a>

Contiene información sobre una instancia que forma parte de un clúster de base de datos.

**Campos**
+ **DBClusterParameterGroupStatus**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado del grupo de parámetros del clúster de base de datos para este miembro del clúster de base de datos.
+ **DBInstanceIdentifier**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el identificador de la instancia de este miembro del clúster de base de datos.
+ **IsClusterWriter**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  El valor que es `true` si el miembro del clúster es la instancia principal del clúster de base de datos y `false` en caso contrario.
+ **PromotionTier**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Un valor que especifica el orden en que se promueve una réplica de lectura a la instancia principal tras un error de la instancia principal existente.

## DBClusterRole (estructura)
<a name="DBClusterRole"></a>

Describe un rol de Amazon Identity and Access Management (IAM) que está asociado con un clúster de base de datos.

**Campos**
+ **FeatureName**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la característica asociada al rol de Amazon Identity and Access Management (IAM). Para ver la lista de nombres de características admitidos, consulte [DescribeDBEngineVersions (acción)](api-other-apis.md#DescribeDBEngineVersions). 
+ **RoleArn**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) del rol de IAM asociado al clúster de base de datos.
+ **Status**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Describe el estado de asociación entre el rol de IAM y el clúster de base de datos. La propiedad del estado devuelve uno de los siguientes valores:
  + `ACTIVE`: el ARN del rol de IAM se asocia con el clúster de base de datos y se puede utilizar para obtener acceso a otros servicios de Amazon en su nombre.
  + `PENDING`: el ARN del rol de IAM se está asociando al clúster de base de datos.
  + `INVALID`: el ARN del rol de IAM se asocia con el clúster de base de datos, pero el clúster de base de datos no puede asumir el rol de IAM para acceder a otros servicios de Amazon en su nombre.

## CloudwatchLogsExportConfiguration (estructura)
<a name="CloudwatchLogsExportConfiguration"></a>

La opción de configuración para los tipos de registro que se debe habilitar para la exportación a CloudWatch Logs para una instancia de base de datos específica o un clúster de base de datos.

Las matrices `EnableLogTypes` y `DisableLogTypes` determinan qué registros se exportarán (o no) a CloudWatch Logs.

Los tipos de registro válidos son: `audit` (para publicar registros de auditoría) y `slowquery` (para publicar registros de consultas lentas). Consulte [Publicación de registros de Neptune en Registros de Amazon CloudWatch](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).

**Campos**
+ **DisableLogTypes**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La lista de tipos de registros que desea deshabilitar.
+ **EnableLogTypes**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La lista de tipos de registros que desea habilitar.

## PendingCloudwatchLogsExports (estructura)
<a name="PendingCloudwatchLogsExports"></a>

Una lista de los tipos de registro cuya configuración sigue pendiente. En otras palabras, estos tipos de registro se están activando o desactivando.

Los tipos de registro válidos son: `audit` (para publicar registros de auditoría) y `slowquery` (para publicar registros de consultas lentas). Consulte [Publicación de registros de Neptune en Registros de Amazon CloudWatch](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).

**Campos**
+ **LogTypesToDisable**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Tipos de registro que están en proceso de habilitarse. Una vez habilitados, estos tipos de registro se exportan a CloudWatch Logs.
+ **LogTypesToEnable**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Tipos de registro que están en proceso de desactivación. Una vez desactivados, estos tipos de registro no se exportan a CloudWatch Logs.

## ClusterPendingModifiedValues (estructura)
<a name="ClusterPendingModifiedValues"></a>

Este tipo de datos se utiliza como un elemento de respuesta en la operación `ModifyDBCluster` e incluye cambios que se aplicarán durante el siguiente periodo de mantenimiento.

**Campos**
+ **AllocatedStorage**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El tamaño de almacenamiento asignado en gibibytes (GiB) para los motores de base de datos. Para Neptune, `AllocatedStorage` siempre devuelve 1, ya que el tamaño de almacenamiento del clúster de base de datos de Neptune no es fijo, sino que se ajusta automáticamente según sea necesario.
+ **BackupRetentionPeriod**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El número de días durante los que se conservan las instantáneas de base de datos automáticas.
+ **DBClusterIdentifier**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El valor DBClusterIdentifier del clúster de base de datos.
+ **EngineVersion**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La versión del motor de base de datos.
+ **IAMDatabaseAuthenticationEnabled**: se trata de un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor que indica si se habilita el mapeo de cuentas de AWS Identity and Access Management (IAM) a la base de datos.
+ **Iops**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El valor de las IOPS aprovisionadas (las operaciones de E/S por segundo). Este ajuste es solo para clústeres de base de datos Multi-AZ.
+ **PendingCloudwatchLogsExports**: se trata de un objeto [PendingCloudwatchLogsExports](#PendingCloudwatchLogsExports).

  Esta estructura `PendingCloudwatchLogsExports` especifica los cambios pendientes en los que los registros de CloudWatch están habilitados y cuáles están deshabilitados.
+ **StorageType**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El cambio pendiente en el tipo de almacenamiento del clúster de base de datos.   Valores válidos:
  + **`standard`**: (*predeterminado*) configura un almacenamiento de bases de datos rentable para aplicaciones con un uso de E/S de moderado a pequeño.
  + **`iopt1`**: habilita el [almacenamiento optimizado para E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage) que está diseñado para satisfacer las necesidades de las cargas de trabajo de gráficos con uso intensivo de operaciones de E/S que requieren precios predecibles con una latencia de E/S baja y un rendimiento de E/S constante.

    El almacenamiento optimizado para E/S de Neptune solo está disponible a partir de la versión 1.3.0.0 del motor.

# API de base de datos global de Neptune
<a name="api-global-dbs"></a>

**Acciones:**
+ [CreateGlobalCluster (acción)](#CreateGlobalCluster)
+ [DeleteGlobalCluster (acción)](#DeleteGlobalCluster)
+ [ModifyGlobalCluster (acción)](#ModifyGlobalCluster)
+ [DescribeGlobalClusters (acción)](#DescribeGlobalClusters)
+ [FailoverGlobalCluster (acción)](#FailoverGlobalCluster)
+ [RemoveFromGlobalCluster (acción)](#RemoveFromGlobalCluster)

**Estructuras:**
+ [GlobalCluster (estructura)](#GlobalCluster)
+ [GlobalClusterMember (estructura)](#GlobalClusterMember)

## CreateGlobalCluster (acción)
<a name="CreateGlobalCluster"></a>

         El nombre de la AWS CLI para esta API es: `create-global-cluster`.

Crea una base de datos global de Neptune que abarca varias regiones de Amazon. La base de datos global incluye un único clúster principal con capacidad de lectura-escritura y clústeres secundarios de solo lectura que reciben datos del clúster principal mediante replicación de alta velocidad realizada por el subsistema de almacenamiento de Neptune.

Puede crear una base de datos global que inicialmente esté vacía y, a continuación, añadirle un clúster principal y clústeres secundarios, o puede especificar un clúster de Neptune existente durante la operación de creación para que se convierta en el clúster principal de la base de datos global.

**Solicitud**
+ **DatabaseName** (en la CLI: `--database-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre para la nueva base de datos global (hasta 64 caracteres alfanuméricos).
+ **DeletionProtection** (en la CLI: `--deletion-protection`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  La configuración de protección contra eliminación para la nueva base de datos global. La base de datos no se puede eliminar cuando está habilitada la protección contra eliminación.
+ **Engine** (en la CLI: `--engine`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del motor de base de datos que se debe utilizar en la base de datos global.

  Valores válidos: -.: `neptune`
+ **EngineVersion** (en la CLI: `--engine-version`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La versión del motor de Neptune que utilizará la base de datos global.

  Valores válidos: `1.2.0.0` o posterior.
+ **GlobalClusterIdentifier** (en la CLI:`--global-cluster-identifier`): *obligatorio* un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  Identificador de clúster del nuevo clúster de base de datos global.
+ **SourceDBClusterIdentifier** (en la CLI: `--source-db-cluster-identifier`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  (*Opcional*) El nombre de recurso de Amazon (ARN) de un clúster de base de datos de Neptune existente para usarlo como clúster principal de la nueva base de datos global.
+ **StorageEncrypted** (en la CLI: `--storage-encrypted`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  La configuración de cifrado de almacenamiento para el nuevo clúster de base de datos global.

**Respuesta**

Incluye los detalles de una base de datos global de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en las acciones [CreateGlobalCluster (acción)](#CreateGlobalCluster), [DescribeGlobalClusters (acción)](#DescribeGlobalClusters), [ModifyGlobalCluster (acción)](#ModifyGlobalCluster), [DeleteGlobalCluster (acción)](#DeleteGlobalCluster), [FailoverGlobalCluster (acción)](#FailoverGlobalCluster) y [RemoveFromGlobalCluster (acción)](#RemoveFromGlobalCluster).
+ **DeletionProtection**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  La configuración de protección contra eliminación para la nueva base de datos global.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El motor de base de datos de Neptune utilizado por la base de datos global (`"neptune"`).
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La versión del motor de Neptune utilizado por la base de datos global.
+ **GlobalClusterArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para la base de datos global.
+ **GlobalClusterIdentifier**: un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  Incluye un identificador de clúster de base de datos global facilitado por el usuario. Este identificador es la clave única que identifica una base de datos global.
+ **GlobalClusterMembers**: matriz de objetos [GlobalClusterMember](#GlobalClusterMember).

  Una lista de los ARN de clústeres y los ARN de instancias de todos los clústeres de bases de datos que forman parte de la base de datos global.
+ **GlobalClusterResourceId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Un identificador inmutable para la base de datos global que es único en todas las regiones. Este identificador se encuentra en las entradas de registro de CloudTrail siempre que se accede a la clave de KMS para el clúster de base de datos.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de esta base de datos global.
+ **StorageEncrypted**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  La configuración de cifrado de almacenamiento para la base de datos global.

**Errores**
+ [GlobalClusterAlreadyExistsFault](api-faults.md#GlobalClusterAlreadyExistsFault)
+ [GlobalClusterQuotaExceededFault](api-faults.md#GlobalClusterQuotaExceededFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

## DeleteGlobalCluster (acción)
<a name="DeleteGlobalCluster"></a>

         El nombre de la AWS CLI para esta API es: `delete-global-cluster`.

Elimina una de base de datos global. El clúster principal y todos los secundarios ya deben estar desconectados o eliminados.

**Solicitud**
+ **GlobalClusterIdentifier** (en la CLI:`--global-cluster-identifier`): *obligatorio* un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  El identificador del clúster de la base de datos global que se está eliminando.

**Respuesta**

Incluye los detalles de una base de datos global de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en las acciones [CreateGlobalCluster (acción)](#CreateGlobalCluster), [DescribeGlobalClusters (acción)](#DescribeGlobalClusters), [ModifyGlobalCluster (acción)](#ModifyGlobalCluster), [DeleteGlobalCluster (acción)](#DeleteGlobalCluster), [FailoverGlobalCluster (acción)](#FailoverGlobalCluster) y [RemoveFromGlobalCluster (acción)](#RemoveFromGlobalCluster).
+ **DeletionProtection**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  La configuración de protección contra eliminación para la nueva base de datos global.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El motor de base de datos de Neptune utilizado por la base de datos global (`"neptune"`).
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La versión del motor de Neptune utilizado por la base de datos global.
+ **GlobalClusterArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para la base de datos global.
+ **GlobalClusterIdentifier**: un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  Incluye un identificador de clúster de base de datos global facilitado por el usuario. Este identificador es la clave única que identifica una base de datos global.
+ **GlobalClusterMembers**: matriz de objetos [GlobalClusterMember](#GlobalClusterMember).

  Una lista de los ARN de clústeres y los ARN de instancias de todos los clústeres de bases de datos que forman parte de la base de datos global.
+ **GlobalClusterResourceId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Un identificador inmutable para la base de datos global que es único en todas las regiones. Este identificador se encuentra en las entradas de registro de CloudTrail siempre que se accede a la clave de KMS para el clúster de base de datos.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de esta base de datos global.
+ **StorageEncrypted**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  La configuración de cifrado de almacenamiento para la base de datos global.

**Errores**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
+ [InvalidGlobalClusterStateFault](api-faults.md#InvalidGlobalClusterStateFault)

## ModifyGlobalCluster (acción)
<a name="ModifyGlobalCluster"></a>

         El nombre de la AWS CLI para esta API es: `modify-global-cluster`.

Modifique una configuración para un clúster global de Amazon Neptune. Puede cambiar uno o varios parámetros de configuración de la base de datos mediante la especificación de estos parámetros y sus nuevos valores en la solicitud.

**Solicitud**
+ **AllowMajorVersionUpgrade** (en la CLI: `--allow-major-version-upgrade`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Es un valor que indica si se permiten actualizaciones de las versiones principales.

  Restricciones: debe permitir las actualizaciones de versiones principales si especifica un valor para el parámetro `EngineVersion` que es una versión principal diferente de la versión actual del clúster de base de datos.

  Si actualiza la versión principal de una base de datos global, los grupos de parámetros del clúster y de la instancia de base de datos se configuran en los grupos de parámetros predeterminados de la nueva versión, por lo que tendrá que aplicar cualquier grupo de parámetros personalizado después de completar la actualización.
+ **DeletionProtection** (en la CLI: `--deletion-protection`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si la base de datos global tiene habilitada la protección contra eliminación. La base de datos global no se puede eliminar cuando está habilitada la protección contra eliminación.
+ **EngineVersion** (en la CLI: `--engine-version`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El número de versión del motor de base de datos al que desea realizar la actualización. El cambio de este parámetro provocará una interrupción. El cambio se aplicará durante el siguiente periodo de mantenimiento, salvo que el parámetro `ApplyImmediately` esté habilitado.

  Para ver una lista con todas las versiones del motor de Neptune disponibles, utilice el siguiente comando:  
**Example**  

  ```
  aws neptune describe-db-engine-versions \
            --engine neptune \
            --query '*[]|[?SupportsGlobalDatabases == 'true'].[EngineVersion]'
  ```
+ **GlobalClusterIdentifier** (en la CLI:`--global-cluster-identifier`): *obligatorio* un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  El identificador del clúster de base de datos del clúster global que se va a modificar. Este parámetro no distingue entre mayúsculas y minúsculas.

  Restricciones: debe coincidir con el identificador de un clúster de base de datos global existente.
+ **NewGlobalClusterIdentifier** (en la CLI:`--new-global-cluster-identifier`): un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  Un nuevo identificador de clúster para asignar a la base de datos global. Este valor se almacena como una cadena en minúsculas.

  Restricciones:
  + Deben contener de 1 a 63 caracteres (letras, números o guiones).
  + El primer carácter debe ser una letra.
  + No se pueden incluir dos guiones consecutivos ni acabar con guion.

  Ejemplo:: `my-cluster2`

**Respuesta**

Incluye los detalles de una base de datos global de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en las acciones [CreateGlobalCluster (acción)](#CreateGlobalCluster), [DescribeGlobalClusters (acción)](#DescribeGlobalClusters), [ModifyGlobalCluster (acción)](#ModifyGlobalCluster), [DeleteGlobalCluster (acción)](#DeleteGlobalCluster), [FailoverGlobalCluster (acción)](#FailoverGlobalCluster) y [RemoveFromGlobalCluster (acción)](#RemoveFromGlobalCluster).
+ **DeletionProtection**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  La configuración de protección contra eliminación para la nueva base de datos global.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El motor de base de datos de Neptune utilizado por la base de datos global (`"neptune"`).
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La versión del motor de Neptune utilizado por la base de datos global.
+ **GlobalClusterArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para la base de datos global.
+ **GlobalClusterIdentifier**: un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  Incluye un identificador de clúster de base de datos global facilitado por el usuario. Este identificador es la clave única que identifica una base de datos global.
+ **GlobalClusterMembers**: matriz de objetos [GlobalClusterMember](#GlobalClusterMember).

  Una lista de los ARN de clústeres y los ARN de instancias de todos los clústeres de bases de datos que forman parte de la base de datos global.
+ **GlobalClusterResourceId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Un identificador inmutable para la base de datos global que es único en todas las regiones. Este identificador se encuentra en las entradas de registro de CloudTrail siempre que se accede a la clave de KMS para el clúster de base de datos.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de esta base de datos global.
+ **StorageEncrypted**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  La configuración de cifrado de almacenamiento para la base de datos global.

**Errores**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
+ [InvalidGlobalClusterStateFault](api-faults.md#InvalidGlobalClusterStateFault)

## DescribeGlobalClusters (acción)
<a name="DescribeGlobalClusters"></a>

         El nombre de la AWS CLI para esta API es: `describe-global-clusters`.

Devuelve información sobre los clústeres de bases de datos globales de Neptune. Esta API admite la paginación.

**Solicitud**
+ **GlobalClusterIdentifier** (en la CLI:`--global-cluster-identifier`): un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  El identificador de clúster de base de datos suministrado por el usuario. Si se especifica este parámetro, solo se devuelve información del clúster de base de datos especificado. Este parámetro no distingue entre mayúsculas y minúsculas.

  Restricciones: si se proporciona, debe coincidir con el identificador de un clúster de base de datos existente.
+ **Marker** (en la CLI: `--marker`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  (*Opcional*) Un token de paginación devuelto por una llamada anterior a `DescribeGlobalClusters`. Si se especifica este parámetro, la respuesta solo incluirá registros más allá del marcador, hasta el número especificado por `MaxRecords`.
+ **MaxRecords** (en la CLI: `--max-records`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de marcador paginación que puede utilizar para recuperar el resto de resultados.

  Valor predeterminado: `100`

  Restricciones: mínimo 20, máximo 100.

**Respuesta**
+ **GlobalClusters**: matriz de objetos [GlobalCluster](#GlobalCluster).

  La lista de instancias y clústeres globales devuelta por esta solicitud.
+ **Marker**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Un token de paginación. Si se devuelve este parámetro en la respuesta, hay más registros disponibles, que se pueden recuperar mediante una o varias llamadas adicionales a `DescribeGlobalClusters`.

**Errores**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)

## FailoverGlobalCluster (acción)
<a name="FailoverGlobalCluster"></a>

         El nombre de la AWS CLI para esta API es: `failover-global-cluster`.

Inicia el proceso de conmutación por error para una base de datos global de Neptune.

Una conmutación por error para una base de datos global de Neptune convierte uno de los clústeres de base de datos secundarios de solo lectura en el clúster de base de datos principal y degrada el clúster de base de datos principal a un clúster de base de datos secundario (de solo lectura). Dicho de otro modo, se cambia el rol del clúster de base de datos principal actual y del clúster de base de datos secundario de destino seleccionado. El clúster de base de datos secundario seleccionado asume todas las capacidades de lectura/escritura de la base de datos global de Neptune.

**nota**  
Esta acción **solo** se aplica a las bases de datos globales de Neptune. Esta acción solo está pensada para usarse en bases de datos globales de Neptune en buen estado con clústeres de bases de datos de Neptune en buen estado y sin interrupciones en toda la región, para probar escenarios de recuperación de desastres o para volver a configurar la topología de la base de datos global.

**Solicitud**
+ **GlobalClusterIdentifier** (en la CLI:`--global-cluster-identifier`): *obligatorio* un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  Identificador de la base de datos global de Neptune que debe conmutarse por error. El identificador es la clave única asignada por el usuario cuando se creó la base de datos global de Neptune. Dicho de otro modo, es el nombre de la base de datos global que quiere conmutar por error.

  Restricciones: debe coincidir con el identificador de una base de datos global de Neptune existente.
+ **TargetDbClusterIdentifier** (en la CLI: `--target-db-cluster-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de recurso de Amazon (ARN) del clúster de base de datos secundario de Neptune que desea promover para que sea el principal de la base de datos global.

**Respuesta**

Incluye los detalles de una base de datos global de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en las acciones [CreateGlobalCluster (acción)](#CreateGlobalCluster), [DescribeGlobalClusters (acción)](#DescribeGlobalClusters), [ModifyGlobalCluster (acción)](#ModifyGlobalCluster), [DeleteGlobalCluster (acción)](#DeleteGlobalCluster), [FailoverGlobalCluster (acción)](#FailoverGlobalCluster) y [RemoveFromGlobalCluster (acción)](#RemoveFromGlobalCluster).
+ **DeletionProtection**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  La configuración de protección contra eliminación para la nueva base de datos global.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El motor de base de datos de Neptune utilizado por la base de datos global (`"neptune"`).
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La versión del motor de Neptune utilizado por la base de datos global.
+ **GlobalClusterArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para la base de datos global.
+ **GlobalClusterIdentifier**: un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  Incluye un identificador de clúster de base de datos global facilitado por el usuario. Este identificador es la clave única que identifica una base de datos global.
+ **GlobalClusterMembers**: matriz de objetos [GlobalClusterMember](#GlobalClusterMember).

  Una lista de los ARN de clústeres y los ARN de instancias de todos los clústeres de bases de datos que forman parte de la base de datos global.
+ **GlobalClusterResourceId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Un identificador inmutable para la base de datos global que es único en todas las regiones. Este identificador se encuentra en las entradas de registro de CloudTrail siempre que se accede a la clave de KMS para el clúster de base de datos.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de esta base de datos global.
+ **StorageEncrypted**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  La configuración de cifrado de almacenamiento para la base de datos global.

**Errores**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
+ [InvalidGlobalClusterStateFault](api-faults.md#InvalidGlobalClusterStateFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

## RemoveFromGlobalCluster (acción)
<a name="RemoveFromGlobalCluster"></a>

         El nombre de la AWS CLI para esta API es: `remove-from-global-cluster`.

Desconecta un clúster de base de datos de Neptune de una base de datos global de Neptune. Un clúster secundario se convierte en un clúster independiente normal con capacidad de lectura y escritura en lugar de ser de solo lectura, y ya no recibe datos del clúster principal.

**Solicitud**
+ **DbClusterIdentifier** (en la CLI: `--db-cluster-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) que identifica el clúster que se va a desconectar del clúster de base de datos global de Neptune.
+ **GlobalClusterIdentifier** (en la CLI:`--global-cluster-identifier`): *obligatorio* un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  El identificador de la base de datos global de Neptune de la que se va a desconectar el clúster de base de datos Neptune especificado.

**Respuesta**

Incluye los detalles de una base de datos global de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en las acciones [CreateGlobalCluster (acción)](#CreateGlobalCluster), [DescribeGlobalClusters (acción)](#DescribeGlobalClusters), [ModifyGlobalCluster (acción)](#ModifyGlobalCluster), [DeleteGlobalCluster (acción)](#DeleteGlobalCluster), [FailoverGlobalCluster (acción)](#FailoverGlobalCluster) y [RemoveFromGlobalCluster (acción)](#RemoveFromGlobalCluster).
+ **DeletionProtection**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  La configuración de protección contra eliminación para la nueva base de datos global.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El motor de base de datos de Neptune utilizado por la base de datos global (`"neptune"`).
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La versión del motor de Neptune utilizado por la base de datos global.
+ **GlobalClusterArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para la base de datos global.
+ **GlobalClusterIdentifier**: un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  Incluye un identificador de clúster de base de datos global facilitado por el usuario. Este identificador es la clave única que identifica una base de datos global.
+ **GlobalClusterMembers**: matriz de objetos [GlobalClusterMember](#GlobalClusterMember).

  Una lista de los ARN de clústeres y los ARN de instancias de todos los clústeres de bases de datos que forman parte de la base de datos global.
+ **GlobalClusterResourceId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Un identificador inmutable para la base de datos global que es único en todas las regiones. Este identificador se encuentra en las entradas de registro de CloudTrail siempre que se accede a la clave de KMS para el clúster de base de datos.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de esta base de datos global.
+ **StorageEncrypted**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  La configuración de cifrado de almacenamiento para la base de datos global.

**Errores**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
+ [InvalidGlobalClusterStateFault](api-faults.md#InvalidGlobalClusterStateFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

## *Estructuras:*
<a name="api-global-dbs-structures-spacer"></a>

## GlobalCluster (estructura)
<a name="GlobalCluster"></a>

Incluye los detalles de una base de datos global de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en las acciones [CreateGlobalCluster (acción)](#CreateGlobalCluster), [DescribeGlobalClusters (acción)](#DescribeGlobalClusters), [ModifyGlobalCluster (acción)](#ModifyGlobalCluster), [DeleteGlobalCluster (acción)](#DeleteGlobalCluster), [FailoverGlobalCluster (acción)](#FailoverGlobalCluster) y [RemoveFromGlobalCluster (acción)](#RemoveFromGlobalCluster).

**Campos**
+ **DeletionProtection**: se trata de un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  La configuración de protección contra eliminación para la nueva base de datos global.
+ **Engine**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El motor de base de datos de Neptune utilizado por la base de datos global (`"neptune"`).
+ **EngineVersion**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La versión del motor de Neptune utilizado por la base de datos global.
+ **GlobalClusterArn**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para la base de datos global.
+ **GlobalClusterIdentifier**: se trata de un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  Incluye un identificador de clúster de base de datos global facilitado por el usuario. Este identificador es la clave única que identifica una base de datos global.
+ **GlobalClusterMembers**: se trata de una matriz de objetos [GlobalClusterMember](#GlobalClusterMember).

  Una lista de los ARN de clústeres y los ARN de instancias de todos los clústeres de bases de datos que forman parte de la base de datos global.
+ **GlobalClusterResourceId**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Un identificador inmutable para la base de datos global que es único en todas las regiones. Este identificador se encuentra en las entradas de registro de CloudTrail siempre que se accede a la clave de KMS para el clúster de base de datos.
+ **Status**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de esta base de datos global.
+ **StorageEncrypted**: se trata de un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  La configuración de cifrado de almacenamiento para la base de datos global.

`GlobalCluster` se utiliza como el elemento de respuesta para:
+ [CreateGlobalCluster](#CreateGlobalCluster)
+ [ModifyGlobalCluster](#ModifyGlobalCluster)
+ [DeleteGlobalCluster](#DeleteGlobalCluster)
+ [RemoveFromGlobalCluster](#RemoveFromGlobalCluster)
+ [FailoverGlobalCluster](#FailoverGlobalCluster)

## GlobalClusterMember (estructura)
<a name="GlobalClusterMember"></a>

 Una estructura de datos con información sobre cualquier clúster principal y secundario asociado a una base de datos global de Neptune. 

**Campos**
+ **DBClusterArn**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   El Nombre de recurso de Amazon (ARN) para el clúster de base de datos. 
+ **IsWriter**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

   Especifica si el clúster de Neptune es el clúster principal (es decir, tiene capacidad de lectura y escritura) de la base de datos global de Neptune a la que está asociado. 
+ **Readers**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   El Nombre de recurso de Amazon (ARN) para cada clúster secundario de solo lectura asociado a la base de datos global de Neptune. 

# API de instancias de Neptune
<a name="api-instances"></a>

**Acciones:**
+ [CreateDBInstance (acción)](#CreateDBInstance)
+ [DeleteDBInstance (acción)](#DeleteDBInstance)
+ [ModifyDBInstance (acción)](#ModifyDBInstance)
+ [RebootDBInstance (acción)](#RebootDBInstance)
+ [DescribeDBInstances (acción)](#DescribeDBInstances)
+ [DescribeOrderableDBInstanceOptions (acción)](#DescribeOrderableDBInstanceOptions)
+ [DescribeValidDBInstanceModifications (acción)](#DescribeValidDBInstanceModifications)

**Estructuras:**
+ [DBInstance (estructura)](#DBInstance)
+ [DBInstanceStatusInfo (estructura)](#DBInstanceStatusInfo)
+ [OrderableDBInstanceOption (estructura)](#OrderableDBInstanceOption)
+ [PendingModifiedValues (estructura)](#PendingModifiedValues)
+ [ValidStorageOptions (estructura)](#ValidStorageOptions)
+ [ValidDBInstanceModificationsMessage (estructura)](#ValidDBInstanceModificationsMessage)

## CreateDBInstance (acción)
<a name="CreateDBInstance"></a>

         El nombre de la AWS CLI para esta API es: `create-db-instance`.

Crea una nueva instancia de base de datos.

**Solicitud**
+ **AutoMinorVersionUpgrade** (en la CLI: `--auto-minor-version-upgrade`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Indica que las actualizaciones de motor secundarias se aplican automáticamente a la instancia de base de datos durante el intervalo de mantenimiento.

  Valor predeterminado: `true`
+ **AvailabilityZone** (en la CLI: `--availability-zone`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   La zona de disponibilidad de EC2 en la que se crea la instancia de base de datos.

  Valor predeterminado: una zona de disponibilidad aleatoria y elegida por el sistema en la región de Amazon del punto de conexión.

   Ejemplo:: `us-east-1d`

   Restricción: el parámetro AvailabilityZone no puede especificarse si el parámetro Multi-AZ se establece en `true`. La zona de disponibilidad especificada debe estar en la misma región de Amazon que el actual punto de conexión.
+ **BackupRetentionPeriod** (en la CLI: `--backup-retention-period`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El número de días durante los que se retienen las copias de seguridad automatizadas.

  No se usa. El clúster de base de datos administra el periodo de retención de copias de seguridad automatizadas. Para obtener más información, consulte [CreateDBCluster (acción)](api-clusters.md#CreateDBCluster).

  Valor predeterminado: 1

  Restricciones:
  + Debe ser un valor entre 0 y 35.
  + No se puede establecerse en 0 si la instancia de base de datos es un origen a las réplicas de lectura
+ **CopyTagsToSnapshot** (en la CLI: `--copy-tags-to-snapshot`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  "True" para copiar todas las etiquetas de la instancia de base de datos a instantáneas de la instancia de base de datos, de lo contrario "false". El valor predeterminado es false.
+ **DBClusterIdentifier** (en la CLI: `--db-cluster-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador del clúster de base de datos al que pertenecerá la instancia.

  Para obtener más información acerca de la creación de un clúster de bases de datos, consulte [CreateDBCluster (acción)](api-clusters.md#CreateDBCluster).

  Tipo: cadena
+ **DBInstanceClass** (en la CLI: `--db-instance-class`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La capacidad de memoria y de cómputo de la instancia de base de datos, por ejemplo, `db.m4.large`. No todas las clases de instancia de base de datos están disponibles en todas las regiones de Amazon.
+ **DBInstanceIdentifier** (en la CLI: `--db-instance-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador de instancias de base de datos. Este parámetro se almacena como una cadena en minúsculas.

  Restricciones:
  + Deben contener de 1 a 63 caracteres (letras, números o guiones).
  + El primer carácter debe ser una letra.
  + No puede terminar por un guion ni contener dos guiones consecutivos.

  Ejemplo:: `mydbinstance`
+ **DBName** (en la CLI: `--db-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No admitido.
+ **DBParameterGroupName** (en la CLI: `--db-parameter-group-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Nombre del grupo de parámetros de base de datos que desea asociar a esta instancia de base de datos. Si se omite este argumento, se utiliza el DBParameterGroup predeterminado para el motor especificado.

  Restricciones:
  + Debe tener de 1 a 255 letras, números o guiones.
  + El primer carácter debe ser una letra
  + No puede terminar por un guion ni contener dos guiones consecutivos
+ **DBSecurityGroups** (en la CLI: `--db-security-groups`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Lista de grupos de seguridad de base de datos que se van a asociar a esta instancia de base de datos.

  Valor predeterminado: el grupo de seguridad de base de datos predeterminado para el motor de base de datos.
+ **DBSubnetGroupName** (en la CLI: `--db-subnet-group-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Un grupo de subred de base de datos con el que asociar esta instancia de base de datos.

  Si no hay un grupo de subred de base de datos, entonces se trata de una instancia de base de datos no VPC.
+ **DeletionProtection** (en la CLI: `--deletion-protection`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Es un valor que indica si la instancia de base de datos tiene habilitada la protección contra eliminación. La base de datos no se puede eliminar cuando está habilitada la protección contra eliminación. La protección contra eliminación está deshabilitada de forma predeterminada. Consulte [Eliminación de una instancia de base de datos](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html).

  Las instancias de base de datos en un clúster de bases de datos se pueden eliminar incluso cuando la protección contra eliminación esté habilitada su clúster de bases de datos principal.
+ **Domain** (en la CLI: `--domain`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifique el dominio de Active Directory en el que crear la instancia.
+ **DomainIAMRoleName** (en la CLI: `--domain-iam-role-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifique el nombre del rol de IAM que se utilizará al realizar llamadas a la API al servicio de directorio.
+ **EnableCloudwatchLogsExports** (en la CLI: `--enable-cloudwatch-logs-exports`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La lista de tipos de registro que deben habilitarse para exportar a CloudWatch Logs.
+ **EnableIAMDatabaseAuthentication** (en la CLI: `--enable-iam-database-authentication`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  No es compatible con Neptune (se pasa por alto).
+ **Engine** (en la CLI: `--engine`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Nombre del motor de base de datos que se va a usar para esta instancia.

  Valores válidos: `neptune`
+ **EngineVersion** (en la CLI: `--engine-version`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El número de versión del motor de base de datos que se debe usar. En la actualidad, no tiene ningún efecto establecer este parámetro.
+ **Iops** (en la CLI: `--iops`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  La cantidad de IOPS provisionadas (operaciones de entrada/salida por segundo) asignada inicialmente para la instancia de base de datos.
+ **KmsKeyId** (en la CLI: `--kms-key-id`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador de la clave de Amazon KMS de una instancia de base de datos cifrada.

  El identificador de la clave de KMS es el Nombre de recurso de Amazon (ARN) de la clave de cifrado de KMS. Si está creando una instancia de base de datos con la misma cuenta de Amazon a la que pertenece la clave de cifrado de KMS utilizada para cifrar la nueva instancia de base de datos, puede utilizar el alias de la clave de KMS en lugar del ARN de la clave de cifrado de KMS.

  No se usa. El clúster de base de datos administra el identificador de claves de KMS. Para obtener más información, consulte [CreateDBCluster (acción)](api-clusters.md#CreateDBCluster).

  Si el parámetro `StorageEncrypted` es "true", y no especifica un valor para el parámetro `KmsKeyId`, Amazon Neptune utilizará su clave de cifrado predeterminada. Amazon KMS crea la clave de cifrado predeterminada para su cuenta de Amazon. Su cuenta de Amazon dispone de una clave de cifrado predeterminada diferente para cada región de Amazon.
+ **LicenseModel** (en la CLI: `--license-model`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Información del modelo de licencias de esta instancia de base de datos.

   Valores válidos: `license-included` \$1 `bring-your-own-license` \$1 `general-public-license`
+ **MonitoringInterval** (en la CLI: `--monitoring-interval`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El intervalo, en segundos, entre puntos cuando se recopila las métricas de monitorización mejoradas para la instancia de base de datos. Para deshabilitar la recopilación de métricas de monitorización mejorada, especifique 0. El valor predeterminado es 0.

  Si se especifica `MonitoringRoleArn`, también debe establecer `MonitoringInterval` en un valor distinto de 0.

  Valores válidos: `0, 1, 5, 10, 15, 30, 60`
+ **MonitoringRoleArn** (en la CLI: `--monitoring-role-arn`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN del rol de IAM que permite a Neptune enviar métricas de monitorización mejoradas a Amazon CloudWatch Logs. Por ejemplo, `arn:aws:iam:123456789012:role/emaccess`.

  Si se establece `MonitoringInterval` en un valor distinto de 0, debe suministrar un valor para `MonitoringRoleArn`.
+ **MultiAZ** (en la CLI: `--multi-az`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si la instancia de base de datos es una implementación Multi-AZ. No puede establecer el parámetro AvailabilityZone si el parámetro MultiAZ está establecido en "true".
+ **Port** (en la CLI: `--port`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El número de puerto en el que la base de datos acepta conexiones.

  No se usa. El clúster de base de datos administra el puerto. Para obtener más información, consulte [CreateDBCluster (acción)](api-clusters.md#CreateDBCluster).

   Valor predeterminado: `8182`

  Tipo: número entero
+ **PreferredBackupWindow** (en la CLI: `--preferred-backup-window`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   El intervalo de tiempo diario durante el que se crean las copias de seguridad automatizadas.

  No se usa. El clúster de base de datos administra el intervalo de tiempo diario para la creación de copias de seguridad automatizadas. Para obtener más información, consulte [CreateDBCluster (acción)](api-clusters.md#CreateDBCluster).
+ **PreferredMaintenanceWindow** (en la CLI: `--preferred-maintenance-window`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

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

   Formato: `ddd:hh24:mi-ddd:hh24:mi`

  El valor predeterminado es un periodo de 30 minutos seleccionado al azar de un bloque de 8 horas de tiempo para cada región de Amazon, que tiene lugar un día de la semana de forma aleatoria.

  Días válidos: lunes, martes, miércoles, jueves, viernes, sábado, domingo.

  Restricciones: ventana mínima de 30 minutos.
+ **PromotionTier** (en la CLI: `--promotion-tier`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Un valor que especifica el orden en que se promueven las réplicas de lectura a instancia principal tras un error de la instancia principal existente. 

  Valor predeterminado: 1

  Valores válidos: 0 - 15
+ **PubliclyAccessible** (en la CLI: `--publicly-accessible`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Hay que dejar de utilizar este marcador.
+ **StorageEncrypted** (en la CLI: `--storage-encrypted`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si la instancia de base de datos está cifrada.

  No se usa. El cifrado para las instancias de base de datos es gestionado por el clúster de base de datos. Para obtener más información, consulte [CreateDBCluster (acción)](api-clusters.md#CreateDBCluster).

  Valor predeterminado: false
+ **StorageType** (en la CLI: `--storage-type`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No se usa. En Neptune, el tipo de almacenamiento se administra en el nivel de clúster de base de datos.
+ **Tags** (en la CLI: `--tags`): una matriz de objetos [Tag](api-other-apis.md#Tag).

  Las etiquetas que se van a asignar a la nueva instancia.
+ **TdeCredentialArn** (en la CLI: `--tde-credential-arn`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN del almacén de claves con el que asociar la instancia para el cifrado de TDE.
+ **TdeCredentialPassword** (en la CLI: `--tde-credential-password`): una SensitiveString, del tipo: `string` (una cadena codificada con UTF-8).

  La contraseña del ARN dado del almacén de claves para poder obtener acceso al dispositivo.
+ **Timezone** (en la CLI: `--timezone`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La zona horaria de la instancia de base de datos.
+ **VpcSecurityGroupIds** (en la CLI: `--vpc-security-group-ids`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Lista de grupos de seguridad de VPC de EC2 que se van a asociar a esta instancia de base de datos.

  No se usa. La lista asociada de grupos de seguridad de VPC de EC2 administrada por este clúster de base de datos. Para obtener más información, consulte [CreateDBCluster (acción)](api-clusters.md#CreateDBCluster).

  Valor predeterminado: el grupo de seguridad de VPC de EC2 predeterminado para la VPC del grupo de la subred de base de datos.

**Respuesta**

Contiene los detalles de una instancia de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBInstances (acción)](#DescribeDBInstances).
+ **AutoMinorVersionUpgrade**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Indica que hay parches de versión secundaria que se aplican automáticamente.
+ **AvailabilityZone**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre de la zona de disponibilidad en la que se encuentra la instancia de base de datos.
+ **BackupRetentionPeriod**: un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
+ **CACertificateIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador del certificado de CA para esta instancia de base de datos.
+ **CopyTagsToSnapshot**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si las etiquetas se copian de la instancia de base de datos a instantáneas de la instancia de base de datos.
+ **DBClusterIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si la instancia de base de datos es miembro de un clúster de base de datos, contiene el nombre del clúster de base de datos del que la instancia de base de datos es miembro.
+ **DBInstanceArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) de la instancia de base de datos.
+ **DBInstanceClass**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el nombre de la clase de capacidad de cómputo y memoria de la instancia de base de datos.
+ **DBInstanceIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene un identificador de bases de datos facilitado por el usuario. Este identificador es la clave única que identifica una instancia de base de datos.
+ **DbInstancePort**: un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto que escucha la instancia de base de datos. Si la instancia de base de datos forma parte de un clúster de base de datos, este puede ser un puerto distinto del puerto del clúster de base de datos.
+ **DBInstanceStatus**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de esta base de datos.
+ **DbiResourceId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador inmutable único de la región de Amazon para la instancia de base de datos. Este identificador se encuentra en entradas de registro de Amazon CloudTrail cuando se accede a la clave de Amazon KMS para la instancia de base de datos.
+ **DBName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la base de datos.
+ **DBParameterGroups**: matriz de objetos [DBParameterGroupStatus](api-parameters.md#DBParameterGroupStatus).

  Proporciona la lista de grupos de parámetros de base de datos que se aplica a esta instancia de base de datos.
+ **DBSecurityGroups**: matriz de objetos [DBSecurityGroupMembership](api-datatypes.md#DBSecurityGroupMembership).

   Proporciona la lista de elementos de grupo de seguridad de base de datos que contiene solo los subelementos `DBSecurityGroup.Name` y `DBSecurityGroup.Status`.
+ **DBSubnetGroup**: un objeto [DBSubnetGroup](api-subnets.md#DBSubnetGroup).

  Especifica información sobre el grupo de subred asociado a la instancia de base de datos, incluido el nombre, la descripción y subredes en el grupo de subred.
+ **DeletionProtection**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si la instancia de base de datos tiene habilitada la protección contra eliminación. La instancia no se puede eliminar cuando está habilitada la protección contra eliminación. Consulte [Eliminación de una instancia de base de datos](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html).
+ **DomainMemberships**: matriz de objetos [DomainMembership](api-datatypes.md#DomainMembership).

  No admitido
+ **EnabledCloudwatchLogsExports**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de tipos de registro para los que esta instancia de base de datos está configurada para exportar a CloudWatch Logs.
+ **Endpoint**: un objeto [Punto de conexión](api-datatypes.md#Endpoint).

  Especifica el punto de conexión.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del motor de base de datos que se va a usar para esta instancia de base de datos.
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica la versión del motor de base de datos.
+ **EnhancedMonitoringResourceArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) del flujo de registros de Amazon CloudWatch Logs que recibe los datos de métricas de monitorización mejorada para la instancia de base de datos.
+ **IAMDatabaseAuthenticationEnabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True si la autenticación de Amazon Identity and Access Management (IAM) está habilitada; de lo contrario, el valor es False.
+ **InstanceCreateTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Proporciona la fecha y hora en que se creó la instancia de base de datos.
+ **Iops**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el valor de las IOPS provisionadas (las operaciones de E/S por segundo).
+ **KmsKeyId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
+ **LatestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **LicenseModel**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Información del modelo de licencias de esta instancia de base de datos.
+ **MonitoringInterval**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El intervalo, en segundos, entre puntos cuando se recopila las métricas de monitorización mejoradas para la instancia de base de datos.
+ **MonitoringRoleArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN del rol de IAM que permite a Neptune enviar métricas de monitorización mejoradas a Amazon CloudWatch Logs.
+ **MultiAZ**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si la instancia de base de datos es una implementación Multi-AZ.
+ **PendingModifiedValues**: un objeto [PendingModifiedValues](#PendingModifiedValues).

  Especifica que los cambios a la instancia de base de datos están pendientes. Este elemento sólo se incluye cuando los cambios están pendientes. Los cambios específicos se identifican por subelementos.
+ **PreferredBackupWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   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`.
+ **PreferredMaintenanceWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
+ **PromotionTier**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Un valor que especifica el orden en que se promueve una réplica de lectura a la instancia principal tras un error de la instancia principal existente. 
+ **PubliclyAccessible**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Hay que dejar de utilizar este marcador.
+ **ReadReplicaDBClusterIdentifiers**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de los clústeres de base de datos que son réplicas de lectura de esta instancia de base de datos.
+ **ReadReplicaDBInstanceIdentifiers**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de las réplicas de lectura asociados con esta instancia de base de datos.
+ **ReadReplicaSourceDBInstanceIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el identificador de la instancia de base de datos de origen si esta instancia de base de datos es una réplica de lectura.
+ **SecondaryAvailabilityZone**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si está presente, especifica el nombre de la zona de disponibilidad secundaria para una instancia de base de datos compatible con Multi-AZ.
+ **StatusInfos**: matriz de objetos [DBInstanceStatusInfo](#DBInstanceStatusInfo).

  El estado de una réplica de lectura. Si la instancia no es una réplica de lectura, está en blanco.
+ **StorageEncrypted**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
+ **StorageType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el tipo de almacenamiento asociado con la instancia de base de datos.
+ **TdeCredentialArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN del almacén de claves con el que se asocia la instancia para el cifrado de TDE.
+ **Timezone**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No admitido.
+ **VpcSecurityGroups**: matriz de objetos [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

  Proporciona una lista de elementos de grupos de seguridad de VPC a la que pertenece la instancia de base de datos.

**Errores**
+ [DBInstanceAlreadyExistsFault](api-faults.md#DBInstanceAlreadyExistsFault)
+ [InsufficientDBInstanceCapacityFault](api-faults.md#InsufficientDBInstanceCapacityFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [DBSecurityGroupNotFoundFault](api-faults.md#DBSecurityGroupNotFoundFault)
+ [InstanceQuotaExceededFault](api-faults.md#InstanceQuotaExceededFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [DBSubnetGroupDoesNotCoverEnoughAZs](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)
+ [InvalidVPCNetworkStateFault](api-faults.md#InvalidVPCNetworkStateFault)
+ [ProvisionedIopsNotAvailableInAZFault](api-faults.md#ProvisionedIopsNotAvailableInAZFault)
+ [OptionGroupNotFoundFault](api-faults.md#OptionGroupNotFoundFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [StorageTypeNotSupportedFault](api-faults.md#StorageTypeNotSupportedFault)
+ [AuthorizationNotFoundFault](api-faults.md#AuthorizationNotFoundFault)
+ [KMSKeyNotAccessibleFault](api-faults.md#KMSKeyNotAccessibleFault)
+ [DomainNotFoundFault](api-faults.md#DomainNotFoundFault)

## DeleteDBInstance (acción)
<a name="DeleteDBInstance"></a>

         El nombre de la AWS CLI para esta API es: `delete-db-instance`.

La acción DeleteDBInstance elimina una instancia de base de datos aprovisionada anteriormente. Al eliminar una instancia de base de datos, se eliminan todas las copias de seguridad automatizadas para esa instancia y no se pueden recuperar. Las instantáneas de base de datos manuales de la instancia de base de datos que va a eliminar `DeleteDBInstance` no se eliminan.

 Si solicita a una instantánea de base de datos final el estado de la instancia de base de datos de Amazon Neptune es `deleting` hasta que se crea la instantánea de base de datos. La acción de la API `DescribeDBInstance` se utiliza para monitorizar el estado de esta operación. La acción no se puede cancelar o revertir una vez enviada.

Tenga en cuenta que cuando una instancia de base de datos se encuentra en un estado de error y tiene un estado de `failed`, `incompatible-restore` o `incompatible-network`, solo puede eliminarlo cuando el parámetro `SkipFinalSnapshot` se establece en `true`.

No puede eliminar una instancia de base de datos si es la única instancia en el clúster de base de datos o si tiene habilitada la protección contra eliminación.

**Solicitud**
+ **DBInstanceIdentifier** (en la CLI: `--db-instance-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador de instancias de bases de datos para la instancia de base de datos que se va a eliminar. Este parámetro no distingue entre mayúsculas y minúsculas.

  Restricciones:
  + Debe coincidir con el nombre de una instancia de base de datos existente.
+ **FinalDBSnapshotIdentifier** (en la CLI: `--final-db-snapshot-identifier`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   El DBSnapshotIdentifier del nuevo DBSnapshot se crea cuando SkipFinalSnapshot se establece en `false`.
**nota**  
Si se especifica este parámetro y también se establece el parámetro SkipFinalShapshot en "true", se producirá un error.

  Restricciones:
  + Debe tener de 1 a 255 letras o números.
  + El primer carácter debe ser una letra
  + No puede terminar por un guion ni contener dos guiones consecutivos
  + No puede especificarse al eliminar una réplica de lectura.
+ **SkipFinalSnapshot** (en la CLI: `--skip-final-snapshot`): un booleano, del tipo: `boolean` (un valor booleano [true o false]).

   Determina si se crea una instantánea de base de datos antes de que se elimine la instancia de base de datos. Si se especifica `true`, no se crea DBSnapshot. Si se especifica `false`, se crea una instantánea de base de datos antes de que se elimine la instancia de base de datos.

  Tenga en cuenta que cuando una instancia de base de datos se encuentra en los estados "failed", "incompatible-restore" o "incompatible-network", solo puede eliminarla cuando el parámetro SkipFinalSnapshot se establece en "true".

  Especifique `true` al eliminar una réplica de lectura.
**nota**  
Deberá especificarse el parámetro FinalDBSnapshotIdentifier si SkipFinalSnapshot es `false`.

  Predeterminado: `false`

**Respuesta**

Contiene los detalles de una instancia de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBInstances (acción)](#DescribeDBInstances).
+ **AutoMinorVersionUpgrade**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Indica que hay parches de versión secundaria que se aplican automáticamente.
+ **AvailabilityZone**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre de la zona de disponibilidad en la que se encuentra la instancia de base de datos.
+ **BackupRetentionPeriod**: un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
+ **CACertificateIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador del certificado de CA para esta instancia de base de datos.
+ **CopyTagsToSnapshot**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si las etiquetas se copian de la instancia de base de datos a instantáneas de la instancia de base de datos.
+ **DBClusterIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si la instancia de base de datos es miembro de un clúster de base de datos, contiene el nombre del clúster de base de datos del que la instancia de base de datos es miembro.
+ **DBInstanceArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) de la instancia de base de datos.
+ **DBInstanceClass**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el nombre de la clase de capacidad de cómputo y memoria de la instancia de base de datos.
+ **DBInstanceIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene un identificador de bases de datos facilitado por el usuario. Este identificador es la clave única que identifica una instancia de base de datos.
+ **DbInstancePort**: un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto que escucha la instancia de base de datos. Si la instancia de base de datos forma parte de un clúster de base de datos, este puede ser un puerto distinto del puerto del clúster de base de datos.
+ **DBInstanceStatus**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de esta base de datos.
+ **DbiResourceId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador inmutable único de la región de Amazon para la instancia de base de datos. Este identificador se encuentra en entradas de registro de Amazon CloudTrail cuando se accede a la clave de Amazon KMS para la instancia de base de datos.
+ **DBName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la base de datos.
+ **DBParameterGroups**: matriz de objetos [DBParameterGroupStatus](api-parameters.md#DBParameterGroupStatus).

  Proporciona la lista de grupos de parámetros de base de datos que se aplica a esta instancia de base de datos.
+ **DBSecurityGroups**: matriz de objetos [DBSecurityGroupMembership](api-datatypes.md#DBSecurityGroupMembership).

   Proporciona la lista de elementos de grupo de seguridad de base de datos que contiene solo los subelementos `DBSecurityGroup.Name` y `DBSecurityGroup.Status`.
+ **DBSubnetGroup**: un objeto [DBSubnetGroup](api-subnets.md#DBSubnetGroup).

  Especifica información sobre el grupo de subred asociado a la instancia de base de datos, incluido el nombre, la descripción y subredes en el grupo de subred.
+ **DeletionProtection**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si la instancia de base de datos tiene habilitada la protección contra eliminación. La instancia no se puede eliminar cuando está habilitada la protección contra eliminación. Consulte [Eliminación de una instancia de base de datos](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html).
+ **DomainMemberships**: matriz de objetos [DomainMembership](api-datatypes.md#DomainMembership).

  No admitido
+ **EnabledCloudwatchLogsExports**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de tipos de registro para los que esta instancia de base de datos está configurada para exportar a CloudWatch Logs.
+ **Endpoint**: un objeto [Punto de conexión](api-datatypes.md#Endpoint).

  Especifica el punto de conexión.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del motor de base de datos que se va a usar para esta instancia de base de datos.
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica la versión del motor de base de datos.
+ **EnhancedMonitoringResourceArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) del flujo de registros de Amazon CloudWatch Logs que recibe los datos de métricas de monitorización mejorada para la instancia de base de datos.
+ **IAMDatabaseAuthenticationEnabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True si la autenticación de Amazon Identity and Access Management (IAM) está habilitada; de lo contrario, el valor es False.
+ **InstanceCreateTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Proporciona la fecha y hora en que se creó la instancia de base de datos.
+ **Iops**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el valor de las IOPS provisionadas (las operaciones de E/S por segundo).
+ **KmsKeyId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
+ **LatestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **LicenseModel**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Información del modelo de licencias de esta instancia de base de datos.
+ **MonitoringInterval**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El intervalo, en segundos, entre puntos cuando se recopila las métricas de monitorización mejoradas para la instancia de base de datos.
+ **MonitoringRoleArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN del rol de IAM que permite a Neptune enviar métricas de monitorización mejoradas a Amazon CloudWatch Logs.
+ **MultiAZ**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si la instancia de base de datos es una implementación Multi-AZ.
+ **PendingModifiedValues**: un objeto [PendingModifiedValues](#PendingModifiedValues).

  Especifica que los cambios a la instancia de base de datos están pendientes. Este elemento sólo se incluye cuando los cambios están pendientes. Los cambios específicos se identifican por subelementos.
+ **PreferredBackupWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   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`.
+ **PreferredMaintenanceWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
+ **PromotionTier**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Un valor que especifica el orden en que se promueve una réplica de lectura a la instancia principal tras un error de la instancia principal existente. 
+ **PubliclyAccessible**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Hay que dejar de utilizar este marcador.
+ **ReadReplicaDBClusterIdentifiers**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de los clústeres de base de datos que son réplicas de lectura de esta instancia de base de datos.
+ **ReadReplicaDBInstanceIdentifiers**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de las réplicas de lectura asociados con esta instancia de base de datos.
+ **ReadReplicaSourceDBInstanceIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el identificador de la instancia de base de datos de origen si esta instancia de base de datos es una réplica de lectura.
+ **SecondaryAvailabilityZone**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si está presente, especifica el nombre de la zona de disponibilidad secundaria para una instancia de base de datos compatible con Multi-AZ.
+ **StatusInfos**: matriz de objetos [DBInstanceStatusInfo](#DBInstanceStatusInfo).

  El estado de una réplica de lectura. Si la instancia no es una réplica de lectura, está en blanco.
+ **StorageEncrypted**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
+ **StorageType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el tipo de almacenamiento asociado con la instancia de base de datos.
+ **TdeCredentialArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN del almacén de claves con el que se asocia la instancia para el cifrado de TDE.
+ **Timezone**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No admitido.
+ **VpcSecurityGroups**: matriz de objetos [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

  Proporciona una lista de elementos de grupos de seguridad de VPC a la que pertenece la instancia de base de datos.

**Errores**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [InvalidDBInstanceStateFault](api-faults.md#InvalidDBInstanceStateFault)
+ [DBSnapshotAlreadyExistsFault](api-faults.md#DBSnapshotAlreadyExistsFault)
+ [SnapshotQuotaExceededFault](api-faults.md#SnapshotQuotaExceededFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)

## ModifyDBInstance (acción)
<a name="ModifyDBInstance"></a>

         El nombre de la AWS CLI para esta API es: `modify-db-instance`.

Modifica la configuración de una instancia de base de datos. Puede cambiar uno o varios parámetros de configuración de la base de datos mediante la especificación de estos parámetros y los nuevos valores en la solicitud. Para obtener información sobre qué modificaciones puede realizar a su instancia de base de datos, llame a [DescribeValidDBInstanceModifications (acción)](#DescribeValidDBInstanceModifications) antes de llamar a [ModifyDBInstance (acción)](#ModifyDBInstance).

**Solicitud**
+ **AllowMajorVersionUpgrade** (en la CLI: `--allow-major-version-upgrade`): un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Indica que se permiten actualizaciones de la versión principal. El cambio de este parámetro no produce una interrupción y el cambio se aplica de forma asíncrona tan pronto como sea posible.
+ **ApplyImmediately** (en la CLI: `--apply-immediately`): un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si las modificaciones de esta solicitud y todas las modificaciones pendientes se aplican de manera asíncrona en cuanto es posible, independientemente de la configuración de `PreferredMaintenanceWindow` de esta instancia de base de datos.

   Si este parámetro se establece en `false`, los cambios realizados en la instancia de base de datos se aplican durante la siguiente ventana de mantenimiento. Algunos cambios de los parámetros puede causar una interrupción y se aplican en la siguiente llamada a [RebootDBInstance (acción)](#RebootDBInstance), o el siguiente reinicio por error.

  Predeterminado: `false`
+ **AutoMinorVersionUpgrade** (en la CLI: `--auto-minor-version-upgrade`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

   Indica que las actualizaciones de versión secundarias se aplican automáticamente a la instancia de base de datos durante el periodo de mantenimiento. El cambio de este parámetro no produce una interrupción, salvo en el siguiente caso, y el cambio se aplica de forma asíncrona tan pronto como sea posible. Se producirá una interrupción si este parámetro se establece en `true` durante el periodo de mantenimiento, y hay una versión secundaria más nueva disponible y Neptune ha permitido la aplicación de parches automática para esa versión del motor.
+ **BackupRetentionPeriod** (en la CLI: `--backup-retention-period`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  No se usa. El clúster de base de datos administra el periodo de retención de copias de seguridad automatizadas. Para obtener más información, consulte [ModifyDBCluster (acción)](api-clusters.md#ModifyDBCluster).

  Valor predeterminado: Utiliza la configuración existente
+ **CACertificateIdentifier** (en la CLI: `--ca-certificate-identifier`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica el certificado que debe asociarse a la instancia.
+ **CloudwatchLogsExportConfiguration** (en la CLI: `--cloudwatch-logs-export-configuration`): un objeto [CloudwatchLogsExportConfiguration](api-clusters.md#CloudwatchLogsExportConfiguration).

  La opción de configuración para los tipos de registro que se debe habilitar para la exportación a CloudWatch Logs para una instancia de base de datos específica o un clúster de base de datos.
+ **CopyTagsToSnapshot** (en la CLI: `--copy-tags-to-snapshot`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  "True" para copiar todas las etiquetas de la instancia de base de datos a instantáneas de la instancia de base de datos, de lo contrario "false". El valor predeterminado es false.
+ **DBInstanceClass** (en la CLI: `--db-instance-class`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La capacidad nueva de memoria y de cómputo de la instancia de base de datos, por ejemplo, `db.m4.large`. No todas las clases de instancia de base de datos están disponibles en todas las regiones de Amazon.

  Si modifica la clase de la instancia de base de datos se produce una interrupción durante el cambio. El cambio se aplica durante la siguiente ventana de mantenimiento, a menos que `ApplyImmediately` se especifique como `true` para esta solicitud.

  Valor predeterminado: Utiliza la configuración existente
+ **DBInstanceIdentifier** (en la CLI: `--db-instance-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador de instancias de base de datos. Este valor se almacena como una cadena en minúsculas.

  Restricciones:
  + Debe coincidir con el identificador de una DBInstance existente.
+ **DBParameterGroupName** (en la CLI: `--db-parameter-group-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Nombre del grupo de parámetros de base de datos que se va a aplicar a esta instancia de base de datos. Cambiar este ajuste no produce una interrupción. El nombre del grupo de parámetros se modifica inmediatamente, pero los cambios del parámetro no se aplican hasta que se reinicia la instancia sin conmutación por error. La instancia de base de datos NO se reiniciará automáticamente y los cambios de los parámetros NO se aplicarán durante la siguiente ventana de mantenimiento.

  Valor predeterminado: Utiliza la configuración existente

  Restricciones: el grupo de parámetros de base de datos debe estar en la misma familia de grupos de parámetros de base de datos que esta instancia de base de datos.
+ **DBPortNumber** (en la CLI: `--db-port-number`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El número de puerto en el que la base de datos acepta conexiones.

  El valor del parámetro `DBPortNumber` no debe coincidir con ninguno de los valores de puertos especificados para el grupo de opciones para la instancia de base de datos.

  La base de datos se reiniciará si se cambia el valor `DBPortNumber` independientemente del valor del parámetro `ApplyImmediately`.

   Valor predeterminado: `8182`
+ **DBSecurityGroups** (en la CLI: `--db-security-groups`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Lista de grupos de seguridad de base de datos que se van a autorizar en esta instancia de base de datos. El cambio de esta configuración no produce una interrupción y el cambio se aplica de forma asíncrona tan pronto como sea posible.

  Restricciones:
  + Si se suministra, debe coincidir con DBSecurityGroups existentes.
+ **DBSubnetGroupName** (en la CLI: `--db-subnet-group-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El grupo de subredes de base de datos nuevo de la instancia de base de datos. Puede utilizar este parámetro para mover la instancia de base de datos a otra VPC.

  Cambiar el grupo de subredes provoca una interrupción durante el cambio. El cambio se aplica durante la siguiente ventana de mantenimiento, a menos que especifique `true` para el parámetro `ApplyImmediately`.

  Restricciones: si se proporciona, debe coincidir con el nombre de un DBSubnetGroup existente.

  Ejemplo:: `mySubnetGroup`
+ **DeletionProtection** (en la CLI: `--deletion-protection`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Es un valor que indica si la instancia de base de datos tiene habilitada la protección contra eliminación. La base de datos no se puede eliminar cuando está habilitada la protección contra eliminación. La protección contra eliminación está deshabilitada de forma predeterminada. Consulte [Eliminación de una instancia de base de datos](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html).
+ **Domain** (en la CLI: `--domain`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No admitido.
+ **DomainIAMRoleName** (en la CLI: `--domain-iam-role-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No admitido
+ **EnableIAMDatabaseAuthentication** (en la CLI: `--enable-iam-database-authentication`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  True para habilitar el mapeo de cuentas de Amazon Identity and Access Management (IAM) a cuentas de base de datos; de lo contrario, el valor es False.

  Puede utilizar la autenticación de bases de datos de IAM para los siguientes motores de bases de datos

  No se usa. El clúster de base de datos administra el mapeo de cuentas de Amazon IAM a cuentas de base de datos. Para obtener más información, consulte [ModifyDBCluster (acción)](api-clusters.md#ModifyDBCluster).

  Valor predeterminado: `false`
+ **EngineVersion** (en la CLI: `--engine-version`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Número de versión del motor de base de datos al que se va a actualizar. En la actualidad, no tiene ningún efecto establecer este parámetro. Para actualizar el motor de la base de datos a la versión más reciente, utilice la API [ApplyPendingMaintenanceAction (acción)](api-other-apis.md#ApplyPendingMaintenanceAction).
+ **Iops** (en la CLI: `--iops`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El valor nuevo de la IOPS provisionada (operaciones de E/S por segundo) para la instancia.

  El cambio de esta configuración no produce una interrupción y el cambio se aplica durante la siguiente ventana de mantenimiento a menos que el parámetro `ApplyImmediately` se haya establecido en `true` para esta solicitud.

  Valor predeterminado: Utiliza la configuración existente
+ **MonitoringInterval** (en la CLI: `--monitoring-interval`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El intervalo, en segundos, entre puntos cuando se recopila las métricas de monitorización mejoradas para la instancia de base de datos. Para deshabilitar la recopilación de métricas de monitorización mejorada, especifique 0. El valor predeterminado es 0.

  Si se especifica `MonitoringRoleArn`, también debe establecer `MonitoringInterval` en un valor distinto de 0.

  Valores válidos: `0, 1, 5, 10, 15, 30, 60`
+ **MonitoringRoleArn** (en la CLI: `--monitoring-role-arn`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN del rol de IAM que permite a Neptune enviar métricas de monitorización mejoradas a Amazon CloudWatch Logs. Por ejemplo, `arn:aws:iam:123456789012:role/emaccess`.

  Si se establece `MonitoringInterval` en un valor distinto de 0, debe suministrar un valor para `MonitoringRoleArn`.
+ **MultiAZ** (en la CLI: `--multi-az`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si la instancia de base de datos es una implementación Multi-AZ. El cambio de este parámetro no produce una interrupción y el cambio se aplica durante la siguiente ventana de mantenimiento a menos que el parámetro `ApplyImmediately` se haya establecido en `true` para esta solicitud.
+ **NewDBInstanceIdentifier** (en la CLI: `--new-db-instance-identifier`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   El nuevo identificador de instancia de base de datos para la instancia de base de datos cuando se cambia el nombre de una instancia de base de datos. Cuando cambie el identificador de instancia de base de datos, la instancia se reiniciará inmediatamente si establece `Apply Immediately` en "true", o durante la siguiente ventana de mantenimiento si establece `Apply Immediately` en "false". Este valor se almacena como una cadena en minúsculas.

  Restricciones:
  + Deben contener de 1 a 63 caracteres (letras, números o guiones).
  + El primer carácter debe ser una letra.
  + No puede terminar por un guion ni contener dos guiones consecutivos.

  Ejemplo:: `mydbinstance`
+ **PreferredBackupWindow** (en la CLI: `--preferred-backup-window`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   El intervalo de tiempo diario durante el cual se crean copias de seguridad automatizadas si están habilitadas.

  No se usa. El clúster de base de datos administra el intervalo de tiempo diario para la creación de copias de seguridad automatizadas. Para obtener más información, consulte [ModifyDBCluster (acción)](api-clusters.md#ModifyDBCluster).

  Restricciones:
  + Tiene que tener el formato hh24:mi-hh24:mi
  + Debe estar en tiempo universal coordinado (UTC)
  + No debe entrar en conflicto con la ventana de mantenimiento preferida.
  + Debe durar al menos 30 minutos.
+ **PreferredMaintenanceWindow** (en la CLI: `--preferred-maintenance-window`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El intervalo de tiempo semanal (en UTC) durante el cual puede llevarse a cabo el mantenimiento del sistema, que puede producir una interrupción. El cambio de este parámetro no produce una interrupción, salvo en la siguiente situación, y el cambio se aplica de forma asíncrona tan pronto como sea posible. Si hay acciones pendientes que provocan un reinicio, y el periodo de mantenimiento se cambia para incluir la hora actual, cambiar este parámetro provocará un reinicio de la instancia de base de datos. Si cambiar este periodo a la hora actual, debe haber al menos 30 minutos entre la hora actual y el final del periodo, para asegurarse de que se apliquen los cambios pendientes.

  Valor predeterminado: Utiliza la configuración existente

  Formato: ddd:hh24:mi-ddd:hh24:mi

  Días válidos: lunes \$1 martes \$1 miércoles \$1 jueves \$1 viernes \$1 sábado \$1 domingo

  Restricciones: debe durar al menos 30 minutos.
+ **PromotionTier** (en la CLI: `--promotion-tier`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Un valor que especifica el orden en que se promueve una réplica de lectura a la instancia principal tras un error de la instancia principal existente.

  Valor predeterminado: 1

  Valores válidos: 0 - 15
+ **PubliclyAccessible** (en la CLI: `--publicly-accessible`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Hay que dejar de utilizar este marcador.
+ **StorageType** (en la CLI: `--storage-type`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No se usa. En Neptune, el tipo de almacenamiento se administra en el nivel de clúster de base de datos.
+ **TdeCredentialArn** (en la CLI: `--tde-credential-arn`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN del almacén de claves con el que asociar la instancia para el cifrado de TDE.
+ **TdeCredentialPassword** (en la CLI: `--tde-credential-password`): una SensitiveString, del tipo: `string` (una cadena codificada con UTF-8).

  La contraseña del ARN dado del almacén de claves para poder obtener acceso al dispositivo.
+ **VpcSecurityGroupIds** (en la CLI: `--vpc-security-group-ids`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Lista de grupos de seguridad de VPC de EC2 que se van a autorizar en esta instancia de base de datos. Este cambio se aplica de forma asíncrona, tan pronto como sea posible.

  No se usa. La lista asociada de grupos de seguridad de VPC de EC2 administrada por este clúster de base de datos. Para obtener más información, consulte [ModifyDBCluster (acción)](api-clusters.md#ModifyDBCluster).

  Restricciones:
  + Si se suministra, debe coincidir con VpcSecurityGroupIds existentes.

**Respuesta**

Contiene los detalles de una instancia de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBInstances (acción)](#DescribeDBInstances).
+ **AutoMinorVersionUpgrade**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Indica que hay parches de versión secundaria que se aplican automáticamente.
+ **AvailabilityZone**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre de la zona de disponibilidad en la que se encuentra la instancia de base de datos.
+ **BackupRetentionPeriod**: un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
+ **CACertificateIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador del certificado de CA para esta instancia de base de datos.
+ **CopyTagsToSnapshot**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si las etiquetas se copian de la instancia de base de datos a instantáneas de la instancia de base de datos.
+ **DBClusterIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si la instancia de base de datos es miembro de un clúster de base de datos, contiene el nombre del clúster de base de datos del que la instancia de base de datos es miembro.
+ **DBInstanceArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) de la instancia de base de datos.
+ **DBInstanceClass**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el nombre de la clase de capacidad de cómputo y memoria de la instancia de base de datos.
+ **DBInstanceIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene un identificador de bases de datos facilitado por el usuario. Este identificador es la clave única que identifica una instancia de base de datos.
+ **DbInstancePort**: un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto que escucha la instancia de base de datos. Si la instancia de base de datos forma parte de un clúster de base de datos, este puede ser un puerto distinto del puerto del clúster de base de datos.
+ **DBInstanceStatus**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de esta base de datos.
+ **DbiResourceId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador inmutable único de la región de Amazon para la instancia de base de datos. Este identificador se encuentra en entradas de registro de Amazon CloudTrail cuando se accede a la clave de Amazon KMS para la instancia de base de datos.
+ **DBName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la base de datos.
+ **DBParameterGroups**: matriz de objetos [DBParameterGroupStatus](api-parameters.md#DBParameterGroupStatus).

  Proporciona la lista de grupos de parámetros de base de datos que se aplica a esta instancia de base de datos.
+ **DBSecurityGroups**: matriz de objetos [DBSecurityGroupMembership](api-datatypes.md#DBSecurityGroupMembership).

   Proporciona la lista de elementos de grupo de seguridad de base de datos que contiene solo los subelementos `DBSecurityGroup.Name` y `DBSecurityGroup.Status`.
+ **DBSubnetGroup**: un objeto [DBSubnetGroup](api-subnets.md#DBSubnetGroup).

  Especifica información sobre el grupo de subred asociado a la instancia de base de datos, incluido el nombre, la descripción y subredes en el grupo de subred.
+ **DeletionProtection**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si la instancia de base de datos tiene habilitada la protección contra eliminación. La instancia no se puede eliminar cuando está habilitada la protección contra eliminación. Consulte [Eliminación de una instancia de base de datos](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html).
+ **DomainMemberships**: matriz de objetos [DomainMembership](api-datatypes.md#DomainMembership).

  No admitido
+ **EnabledCloudwatchLogsExports**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de tipos de registro para los que esta instancia de base de datos está configurada para exportar a CloudWatch Logs.
+ **Endpoint**: un objeto [Punto de conexión](api-datatypes.md#Endpoint).

  Especifica el punto de conexión.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del motor de base de datos que se va a usar para esta instancia de base de datos.
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica la versión del motor de base de datos.
+ **EnhancedMonitoringResourceArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) del flujo de registros de Amazon CloudWatch Logs que recibe los datos de métricas de monitorización mejorada para la instancia de base de datos.
+ **IAMDatabaseAuthenticationEnabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True si la autenticación de Amazon Identity and Access Management (IAM) está habilitada; de lo contrario, el valor es False.
+ **InstanceCreateTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Proporciona la fecha y hora en que se creó la instancia de base de datos.
+ **Iops**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el valor de las IOPS provisionadas (las operaciones de E/S por segundo).
+ **KmsKeyId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
+ **LatestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **LicenseModel**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Información del modelo de licencias de esta instancia de base de datos.
+ **MonitoringInterval**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El intervalo, en segundos, entre puntos cuando se recopila las métricas de monitorización mejoradas para la instancia de base de datos.
+ **MonitoringRoleArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN del rol de IAM que permite a Neptune enviar métricas de monitorización mejoradas a Amazon CloudWatch Logs.
+ **MultiAZ**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si la instancia de base de datos es una implementación Multi-AZ.
+ **PendingModifiedValues**: un objeto [PendingModifiedValues](#PendingModifiedValues).

  Especifica que los cambios a la instancia de base de datos están pendientes. Este elemento sólo se incluye cuando los cambios están pendientes. Los cambios específicos se identifican por subelementos.
+ **PreferredBackupWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   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`.
+ **PreferredMaintenanceWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
+ **PromotionTier**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Un valor que especifica el orden en que se promueve una réplica de lectura a la instancia principal tras un error de la instancia principal existente. 
+ **PubliclyAccessible**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Hay que dejar de utilizar este marcador.
+ **ReadReplicaDBClusterIdentifiers**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de los clústeres de base de datos que son réplicas de lectura de esta instancia de base de datos.
+ **ReadReplicaDBInstanceIdentifiers**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de las réplicas de lectura asociados con esta instancia de base de datos.
+ **ReadReplicaSourceDBInstanceIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el identificador de la instancia de base de datos de origen si esta instancia de base de datos es una réplica de lectura.
+ **SecondaryAvailabilityZone**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si está presente, especifica el nombre de la zona de disponibilidad secundaria para una instancia de base de datos compatible con Multi-AZ.
+ **StatusInfos**: matriz de objetos [DBInstanceStatusInfo](#DBInstanceStatusInfo).

  El estado de una réplica de lectura. Si la instancia no es una réplica de lectura, está en blanco.
+ **StorageEncrypted**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
+ **StorageType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el tipo de almacenamiento asociado con la instancia de base de datos.
+ **TdeCredentialArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN del almacén de claves con el que se asocia la instancia para el cifrado de TDE.
+ **Timezone**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No admitido.
+ **VpcSecurityGroups**: matriz de objetos [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

  Proporciona una lista de elementos de grupos de seguridad de VPC a la que pertenece la instancia de base de datos.

**Errores**
+ [InvalidDBInstanceStateFault](api-faults.md#InvalidDBInstanceStateFault)
+ [InvalidDBSecurityGroupStateFault](api-faults.md#InvalidDBSecurityGroupStateFault)
+ [DBInstanceAlreadyExistsFault](api-faults.md#DBInstanceAlreadyExistsFault)
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [DBSecurityGroupNotFoundFault](api-faults.md#DBSecurityGroupNotFoundFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [InsufficientDBInstanceCapacityFault](api-faults.md#InsufficientDBInstanceCapacityFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [InvalidVPCNetworkStateFault](api-faults.md#InvalidVPCNetworkStateFault)
+ [ProvisionedIopsNotAvailableInAZFault](api-faults.md#ProvisionedIopsNotAvailableInAZFault)
+ [OptionGroupNotFoundFault](api-faults.md#OptionGroupNotFoundFault)
+ [DBUpgradeDependencyFailureFault](api-faults.md#DBUpgradeDependencyFailureFault)
+ [StorageTypeNotSupportedFault](api-faults.md#StorageTypeNotSupportedFault)
+ [AuthorizationNotFoundFault](api-faults.md#AuthorizationNotFoundFault)
+ [CertificateNotFoundFault](api-faults.md#CertificateNotFoundFault)
+ [DomainNotFoundFault](api-faults.md#DomainNotFoundFault)

## RebootDBInstance (acción)
<a name="RebootDBInstance"></a>

         El nombre de la AWS CLI para esta API es: `reboot-db-instance`.

Es posible que necesite reiniciar su instancia de base de datos, normalmente por razones de mantenimiento. Por ejemplo, si realiza determinadas modificaciones o si cambia el grupo de parámetros de base de datos asociado a la instancia de base de datos, debe reiniciar la instancia para que los cambios surtan efecto.

Cuando se reinicia una instancia de base de datos, se reinicia el servicio del motor de base de datos. Al reiniciar una instancia de base de datos, se produce una interrupción momentánea, durante la cual su estado se establece en rebooting.

**Solicitud**
+ **DBInstanceIdentifier** (en la CLI: `--db-instance-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador de instancias de base de datos. Este parámetro se almacena como una cadena en minúsculas.

  Restricciones:
  + Debe coincidir con el identificador de una DBInstance existente.
+ **ForceFailover** (en la CLI: `--force-failover`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

   Cuando `true`, el reinicio se realiza a través de una conmutación por error Multi-AZ.

  Restricción no se puede especificar `true` si la instancia no se ha configurado para Multi-AZ.

**Respuesta**

Contiene los detalles de una instancia de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBInstances (acción)](#DescribeDBInstances).
+ **AutoMinorVersionUpgrade**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Indica que hay parches de versión secundaria que se aplican automáticamente.
+ **AvailabilityZone**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre de la zona de disponibilidad en la que se encuentra la instancia de base de datos.
+ **BackupRetentionPeriod**: un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
+ **CACertificateIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador del certificado de CA para esta instancia de base de datos.
+ **CopyTagsToSnapshot**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si las etiquetas se copian de la instancia de base de datos a instantáneas de la instancia de base de datos.
+ **DBClusterIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si la instancia de base de datos es miembro de un clúster de base de datos, contiene el nombre del clúster de base de datos del que la instancia de base de datos es miembro.
+ **DBInstanceArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) de la instancia de base de datos.
+ **DBInstanceClass**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el nombre de la clase de capacidad de cómputo y memoria de la instancia de base de datos.
+ **DBInstanceIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene un identificador de bases de datos facilitado por el usuario. Este identificador es la clave única que identifica una instancia de base de datos.
+ **DbInstancePort**: un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto que escucha la instancia de base de datos. Si la instancia de base de datos forma parte de un clúster de base de datos, este puede ser un puerto distinto del puerto del clúster de base de datos.
+ **DBInstanceStatus**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de esta base de datos.
+ **DbiResourceId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador inmutable único de la región de Amazon para la instancia de base de datos. Este identificador se encuentra en entradas de registro de Amazon CloudTrail cuando se accede a la clave de Amazon KMS para la instancia de base de datos.
+ **DBName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la base de datos.
+ **DBParameterGroups**: matriz de objetos [DBParameterGroupStatus](api-parameters.md#DBParameterGroupStatus).

  Proporciona la lista de grupos de parámetros de base de datos que se aplica a esta instancia de base de datos.
+ **DBSecurityGroups**: matriz de objetos [DBSecurityGroupMembership](api-datatypes.md#DBSecurityGroupMembership).

   Proporciona la lista de elementos de grupo de seguridad de base de datos que contiene solo los subelementos `DBSecurityGroup.Name` y `DBSecurityGroup.Status`.
+ **DBSubnetGroup**: un objeto [DBSubnetGroup](api-subnets.md#DBSubnetGroup).

  Especifica información sobre el grupo de subred asociado a la instancia de base de datos, incluido el nombre, la descripción y subredes en el grupo de subred.
+ **DeletionProtection**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si la instancia de base de datos tiene habilitada la protección contra eliminación. La instancia no se puede eliminar cuando está habilitada la protección contra eliminación. Consulte [Eliminación de una instancia de base de datos](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html).
+ **DomainMemberships**: matriz de objetos [DomainMembership](api-datatypes.md#DomainMembership).

  No admitido
+ **EnabledCloudwatchLogsExports**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de tipos de registro para los que esta instancia de base de datos está configurada para exportar a CloudWatch Logs.
+ **Endpoint**: un objeto [Punto de conexión](api-datatypes.md#Endpoint).

  Especifica el punto de conexión.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del motor de base de datos que se va a usar para esta instancia de base de datos.
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica la versión del motor de base de datos.
+ **EnhancedMonitoringResourceArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) del flujo de registros de Amazon CloudWatch Logs que recibe los datos de métricas de monitorización mejorada para la instancia de base de datos.
+ **IAMDatabaseAuthenticationEnabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True si la autenticación de Amazon Identity and Access Management (IAM) está habilitada; de lo contrario, el valor es False.
+ **InstanceCreateTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Proporciona la fecha y hora en que se creó la instancia de base de datos.
+ **Iops**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el valor de las IOPS provisionadas (las operaciones de E/S por segundo).
+ **KmsKeyId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
+ **LatestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **LicenseModel**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Información del modelo de licencias de esta instancia de base de datos.
+ **MonitoringInterval**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El intervalo, en segundos, entre puntos cuando se recopila las métricas de monitorización mejoradas para la instancia de base de datos.
+ **MonitoringRoleArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN del rol de IAM que permite a Neptune enviar métricas de monitorización mejoradas a Amazon CloudWatch Logs.
+ **MultiAZ**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si la instancia de base de datos es una implementación Multi-AZ.
+ **PendingModifiedValues**: un objeto [PendingModifiedValues](#PendingModifiedValues).

  Especifica que los cambios a la instancia de base de datos están pendientes. Este elemento sólo se incluye cuando los cambios están pendientes. Los cambios específicos se identifican por subelementos.
+ **PreferredBackupWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   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`.
+ **PreferredMaintenanceWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
+ **PromotionTier**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Un valor que especifica el orden en que se promueve una réplica de lectura a la instancia principal tras un error de la instancia principal existente. 
+ **PubliclyAccessible**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Hay que dejar de utilizar este marcador.
+ **ReadReplicaDBClusterIdentifiers**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de los clústeres de base de datos que son réplicas de lectura de esta instancia de base de datos.
+ **ReadReplicaDBInstanceIdentifiers**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de las réplicas de lectura asociados con esta instancia de base de datos.
+ **ReadReplicaSourceDBInstanceIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el identificador de la instancia de base de datos de origen si esta instancia de base de datos es una réplica de lectura.
+ **SecondaryAvailabilityZone**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si está presente, especifica el nombre de la zona de disponibilidad secundaria para una instancia de base de datos compatible con Multi-AZ.
+ **StatusInfos**: matriz de objetos [DBInstanceStatusInfo](#DBInstanceStatusInfo).

  El estado de una réplica de lectura. Si la instancia no es una réplica de lectura, está en blanco.
+ **StorageEncrypted**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
+ **StorageType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el tipo de almacenamiento asociado con la instancia de base de datos.
+ **TdeCredentialArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN del almacén de claves con el que se asocia la instancia para el cifrado de TDE.
+ **Timezone**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No admitido.
+ **VpcSecurityGroups**: matriz de objetos [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

  Proporciona una lista de elementos de grupos de seguridad de VPC a la que pertenece la instancia de base de datos.

**Errores**
+ [InvalidDBInstanceStateFault](api-faults.md#InvalidDBInstanceStateFault)
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)

## DescribeDBInstances (acción)
<a name="DescribeDBInstances"></a>

         El nombre de la AWS CLI para esta API es: `describe-db-instances`.

Devuelve información sobre las instancias aprovisionadas y admite la paginación.

**nota**  
Esta operación también puede devolver información para las instancias de Amazon RDS y las instancias de Amazon DocDB.

**Solicitud**
+ **DBInstanceIdentifier** (en la CLI: `--db-instance-identifier`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Identificador de la instancia proporcionado por el usuario. Si se especifica este parámetro, solo se devuelve información de la instancia de base de datos específica. Este parámetro no distingue entre mayúsculas y minúsculas.

  Restricciones:
  + Si se proporciona, debe coincidir con el identificador de una DBInstance existente.
+ **Filters** (en la CLI: `--filters`): una matriz de objetos [Filtro](api-datatypes.md#Filter).

  Un filtro que especifica una o varias instancias de bases de datos para describir.

  Filtros compatibles:
  +  `db-cluster-id`: acepta identificadores de clúster de base de datos y Nombres de recursos de Amazon (ARN). La lista de resultados solo incluirá información sobre las instancias de bases de datos asociadas con los clústeres de base de datos identificados por estos ARN.
  + `engine` - Acepta un nombre de motor (como `neptune`) y restringe la lista de resultados a instancias de base de datos creadas por ese motor.

  Por ejemplo, para invocar esta API desde la CLI de Amazon y filtrar de modo que sólo se devuelvan las instancias de base de datos de Neptune, puede utilizar el siguiente comando:  
**Example**  

  ```
  aws neptune describe-db-instances \
              --filters  Name=engine,Values=neptune
  ```
+ **Marker** (en la CLI: `--marker`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud `DescribeDBInstances` anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.
+ **MaxRecords** (en la CLI: `--max-records`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

   El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación que se conoce como marcador, de modo que se pueda recuperar el resto de resultados.

  Predeterminado: 100

  Restricciones: mínimo 20, máximo 100.

**Respuesta**
+ **DBInstances**: matriz de objetos [DBInstance](#DBInstance).

   Una lista de instancias [DBInstance (estructura)](#DBInstance).
+ **Marker**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords` .

**Errores**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)

## DescribeOrderableDBInstanceOptions (acción)
<a name="DescribeOrderableDBInstanceOptions"></a>

         El nombre de la AWS CLI para esta API es: `describe-orderable-db-instance-options`.

Devuelve una lista de opciones de instancia de base de datos ordenable para el motor especificado.

**Solicitud**
+ **DBInstanceClass** (en la CLI: `--db-instance-class`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El valor del filtro de la clase de instancia de base de datos. Especifique este parámetro para mostrar solo las ofertas disponibles que coinciden con la clase de instancia de base de datos especificada.
+ **Engine** (en la CLI: `--engine`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Nombre del motor para el que recuperar opciones de la instancia de base de datos.
+ **EngineVersion** (en la CLI: `--engine-version`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Valor del filtro de la versión del motor. Especifique este parámetro para mostrar solo las ofertas disponibles que coinciden con la versión del motor especificado.
+ **Filters** (en la CLI: `--filters`): una matriz de objetos [Filtro](api-datatypes.md#Filter).

  Este parámetro es incompatible en estos momentos.
+ **LicenseModel** (en la CLI: `--license-model`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El valor del filtro del modelo de licencia. Especifique este parámetro para mostrar solo las ofertas disponibles que coinciden con el modelo de licencia especificado.
+ **Marker** (en la CLI: `--marker`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud DescribeOrderableDBInstanceOptions anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords` .
+ **MaxRecords** (en la CLI: `--max-records`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

   El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación que se conoce como marcador, de modo que se pueda recuperar el resto de resultados.

  Predeterminado: 100

  Restricciones: mínimo 20, máximo 100.
+ **Vpc** (en la CLI: `--vpc`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  El valor de filtro de VPC. Especifique este parámetro para mostrar solo la disponibilidad de ofertas VPC o no VPC.

**Respuesta**
+ **Marker**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud OrderableDBInstanceOptions anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords` .
+ **OrderableDBInstanceOptions**: matriz de objetos [OrderableDBInstanceOption](#OrderableDBInstanceOption).

  Una estructura [OrderableDBInstanceOption (estructura)](#OrderableDBInstanceOption) que contiene información acerca de opciones ordenables para la instancia de base de datos.

## DescribeValidDBInstanceModifications (acción)
<a name="DescribeValidDBInstanceModifications"></a>

         El nombre de la AWS CLI para esta API es: `describe-valid-db-instance-modifications`.

Puede llamar a [DescribeValidDBInstanceModifications (acción)](#DescribeValidDBInstanceModifications) para obtener información sobre qué modificaciones puede realizar a su instancia de base de datos. Puede utilizar esta información cuando llama a [ModifyDBInstance (acción)](#ModifyDBInstance).

**Solicitud**
+ **DBInstanceIdentifier** (en la CLI: `--db-instance-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador de cliente o el ARN de la instancia de base de datos.

**Respuesta**

Información sobre las modificaciones válidas que puede realizar a la instancia de base de datos. Contiene el resultado de una llamada correcta a la acción [DescribeValidDBInstanceModifications (acción)](#DescribeValidDBInstanceModifications). Puede utilizar esta información cuando llama a [ModifyDBInstance (acción)](#ModifyDBInstance). 
+ **Storage**: matriz de objetos [ValidStorageOptions](#ValidStorageOptions).

  Opciones de almacenamiento válidas para su instancia de base de datos.

**Errores**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [InvalidDBInstanceStateFault](api-faults.md#InvalidDBInstanceStateFault)

## *Estructuras:*
<a name="api-instances-structures-spacer"></a>

## DBInstance (estructura)
<a name="DBInstance"></a>

Contiene los detalles de una instancia de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBInstances (acción)](#DescribeDBInstances).

**Campos**
+ **AutoMinorVersionUpgrade**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Indica que hay parches de versión secundaria que se aplican automáticamente.
+ **AvailabilityZone**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre de la zona de disponibilidad en la que se encuentra la instancia de base de datos.
+ **BackupRetentionPeriod**: se trata de un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
+ **CACertificateIdentifier**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador del certificado de CA para esta instancia de base de datos.
+ **CopyTagsToSnapshot**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si las etiquetas se copian de la instancia de base de datos a instantáneas de la instancia de base de datos.
+ **DBClusterIdentifier**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si la instancia de base de datos es miembro de un clúster de base de datos, contiene el nombre del clúster de base de datos del que la instancia de base de datos es miembro.
+ **DBInstanceArn**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) de la instancia de base de datos.
+ **DBInstanceClass**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el nombre de la clase de capacidad de cómputo y memoria de la instancia de base de datos.
+ **DBInstanceIdentifier**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene un identificador de bases de datos facilitado por el usuario. Este identificador es la clave única que identifica una instancia de base de datos.
+ **DbInstancePort**: se trata de un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto que escucha la instancia de base de datos. Si la instancia de base de datos forma parte de un clúster de base de datos, este puede ser un puerto distinto del puerto del clúster de base de datos.
+ **DBInstanceStatus**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de esta base de datos.
+ **DbiResourceId**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador inmutable único de la región de Amazon para la instancia de base de datos. Este identificador se encuentra en entradas de registro de Amazon CloudTrail cuando se accede a la clave de Amazon KMS para la instancia de base de datos.
+ **DBName**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la base de datos.
+ **DBParameterGroups**: se trata de una matriz de objetos [DBParameterGroupStatus](api-parameters.md#DBParameterGroupStatus).

  Proporciona la lista de grupos de parámetros de base de datos que se aplica a esta instancia de base de datos.
+ **DBSecurityGroups**: se trata de una matriz de objetos [DBSecurityGroupMembership](api-datatypes.md#DBSecurityGroupMembership).

   Proporciona la lista de elementos de grupo de seguridad de base de datos que contiene solo los subelementos `DBSecurityGroup.Name` y `DBSecurityGroup.Status`.
+ **DBSubnetGroup**: se trata de un objeto [DBSubnetGroup](api-subnets.md#DBSubnetGroup).

  Especifica información sobre el grupo de subred asociado a la instancia de base de datos, incluido el nombre, la descripción y subredes en el grupo de subred.
+ **DeletionProtection**: se trata de un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si la instancia de base de datos tiene habilitada la protección contra eliminación. La instancia no se puede eliminar cuando está habilitada la protección contra eliminación. Consulte [Eliminación de una instancia de base de datos](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html).
+ **DomainMemberships**: se trata de una matriz de objetos [DomainMembership](api-datatypes.md#DomainMembership).

  No admitido
+ **EnabledCloudwatchLogsExports**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de tipos de registro para los que esta instancia de base de datos está configurada para exportar a CloudWatch Logs.
+ **Endpoint**: se trata de un objeto [Punto de conexión](api-datatypes.md#Endpoint).

  Especifica el punto de conexión.
+ **Engine**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del motor de base de datos que se va a usar para esta instancia de base de datos.
+ **EngineVersion**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica la versión del motor de base de datos.
+ **EnhancedMonitoringResourceArn**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) del flujo de registros de Amazon CloudWatch Logs que recibe los datos de métricas de monitorización mejorada para la instancia de base de datos.
+ **IAMDatabaseAuthenticationEnabled**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True si la autenticación de Amazon Identity and Access Management (IAM) está habilitada; de lo contrario, el valor es False.
+ **InstanceCreateTime**: se trata de un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Proporciona la fecha y hora en que se creó la instancia de base de datos.
+ **Iops**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el valor de las IOPS provisionadas (las operaciones de E/S por segundo).
+ **KmsKeyId**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
+ **LatestRestorableTime**: se trata de un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **LicenseModel**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Información del modelo de licencias de esta instancia de base de datos.
+ **MonitoringInterval**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El intervalo, en segundos, entre puntos cuando se recopila las métricas de monitorización mejoradas para la instancia de base de datos.
+ **MonitoringRoleArn**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN del rol de IAM que permite a Neptune enviar métricas de monitorización mejoradas a Amazon CloudWatch Logs.
+ **MultiAZ**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si la instancia de base de datos es una implementación Multi-AZ.
+ **PendingModifiedValues**: se trata de un objeto [PendingModifiedValues](#PendingModifiedValues).

  Especifica que los cambios a la instancia de base de datos están pendientes. Este elemento sólo se incluye cuando los cambios están pendientes. Los cambios específicos se identifican por subelementos.
+ **PreferredBackupWindow**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   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`.
+ **PreferredMaintenanceWindow**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
+ **PromotionTier**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Un valor que especifica el orden en que se promueve una réplica de lectura a la instancia principal tras un error de la instancia principal existente. 
+ **PubliclyAccessible**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Hay que dejar de utilizar este marcador.
+ **ReadReplicaDBClusterIdentifiers**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de los clústeres de base de datos que son réplicas de lectura de esta instancia de base de datos.
+ **ReadReplicaDBInstanceIdentifiers**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de las réplicas de lectura asociados con esta instancia de base de datos.
+ **ReadReplicaSourceDBInstanceIdentifier**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el identificador de la instancia de base de datos de origen si esta instancia de base de datos es una réplica de lectura.
+ **SecondaryAvailabilityZone**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si está presente, especifica el nombre de la zona de disponibilidad secundaria para una instancia de base de datos compatible con Multi-AZ.
+ **StatusInfos**: se trata de una matriz de objetos [DBInstanceStatusInfo](#DBInstanceStatusInfo).

  El estado de una réplica de lectura. Si la instancia no es una réplica de lectura, está en blanco.
+ **StorageEncrypted**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  No es compatible: el cifrado para las instancias de base de datos lo administra el clúster de base de datos.
+ **StorageType**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el tipo de almacenamiento asociado con la instancia de base de datos.
+ **TdeCredentialArn**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN del almacén de claves con el que se asocia la instancia para el cifrado de TDE.
+ **Timezone**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No admitido.
+ **VpcSecurityGroups**: se trata de una matriz de objetos [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

  Proporciona una lista de elementos de grupos de seguridad de VPC a la que pertenece la instancia de base de datos.

`DBInstance` se utiliza como el elemento de respuesta para:
+ [CreateDBInstance](#CreateDBInstance)
+ [DeleteDBInstance](#DeleteDBInstance)
+ [ModifyDBInstance](#ModifyDBInstance)
+ [RebootDBInstance](#RebootDBInstance)

## DBInstanceStatusInfo (estructura)
<a name="DBInstanceStatusInfo"></a>

Proporciona una lista de información de estado para una instancia de base de datos.

**Campos**
+ **Message**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Detalles del error si hay un error para la instancia. Si la instancia no se encuentra en un estado de error, este valor aparece en blanco.
+ **Normal**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Valor booleano que es "true" si la instancia funciona con normalidad o "false" si la instancia se encuentra en un estado de error.
+ **Status**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Estado de la instancia de base de datos. Para obtener un StatusType de réplica de lectura, los valores pueden ser replicando, error, detenido o terminado.
+ **StatusType**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Este valor es actualmente una "replicación de lectura".

## OrderableDBInstanceOption (estructura)
<a name="OrderableDBInstanceOption"></a>

Contiene una lista de las opciones disponibles para una instancia de base de datos.

 Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeOrderableDBInstanceOptions (acción)](#DescribeOrderableDBInstanceOptions).

**Campos**
+ **AvailabilityZones**: se trata de una matriz de objetos [AvailabilityZone](api-datatypes.md#AvailabilityZone).

  Una lista de zonas de disponibilidad para una instancia de base de datos.
+ **DBInstanceClass**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La clase de instancia de base de datos de la instancia de base de datos.
+ **Engine**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de motor de una instancia de base de datos.
+ **EngineVersion**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La versión de motor de una instancia de base de datos.
+ **LicenseModel**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El modelo de licencia de la instancia de base de datos.
+ **MaxIopsPerDbInstance**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Máximo total de IOPS provisionadas para una instancia de base de datos.
+ **MaxIopsPerGib**: se trata de un DoubleOptional, del tipo: `double` (un número en coma flotante IEEE 754 de precisión doble).

  Máximo de IOPS provisionadas por GiB para una instancia de base de datos.
+ **MaxStorageSize**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Tamaño máximo de almacenamiento para una instancia de base de datos
+ **MinIopsPerDbInstance**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Mínimo total de IOPS provisionadas para una instancia de base de datos.
+ **MinIopsPerGib**: se trata de un DoubleOptional, del tipo: `double` (un número en coma flotante IEEE 754 de precisión doble).

  Mínimo de IOPS provisionadas por GiB para una instancia de base de datos.
+ **MinStorageSize**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Tamaño mínimo de almacenamiento para una instancia de base de datos
+ **MultiAZCapable**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si una instancia de base de datos admite Multi-AZ.
+ **ReadReplicaCapable**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si una instancia de base de datos puede tener una réplica de lectura.
+ **StorageType**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No se usa. En Neptune, el tipo de almacenamiento se administra en el nivel de clúster de base de datos.
+ **SupportsEnhancedMonitoring**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si una instancia de base de datos admite la monitorización mejorada a intervalos de 1 a 60 segundos.
+ **SupportsGlobalDatabases**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor que indica si puede utilizar las bases de datos globales de Neptune con una combinación específica de otros atributos del motor de base de datos.
+ **SupportsIAMDatabaseAuthentication**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si una instancia de base de datos admite autenticación de base de datos de IAM.
+ **SupportsIops**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si una instancia de base de datos admite IOPS provisionadas.
+ **SupportsStorageEncryption**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si una instancia de base de datos admite almacenamiento cifrado.
+ **Vpc**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si una instancia de base de datos se encuentra en una VPC.

## PendingModifiedValues (estructura)
<a name="PendingModifiedValues"></a>

Este tipo de datos se utiliza como un elemento de respuesta en la acción [ModifyDBInstance (acción)](#ModifyDBInstance).

**Campos**
+ **AllocatedStorage**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

   Contiene el tamaño nuevo de `AllocatedStorage` correspondiente a la instancia de base de datos que se aplicará o que se está aplicando.
+ **BackupRetentionPeriod**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el número de días pendientes durante los que se conservan las copias de seguridad automatizadas.
+ **CACertificateIdentifier**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el identificador del certificado de CA para la instancia de base de datos.
+ **DBInstanceClass**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Contiene la nueva `DBInstanceClass` correspondiente a la instancia de base de datos que se aplicará o que se está aplicando.
+ **DBInstanceIdentifier**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Contiene la nueva `DBInstanceIdentifier` correspondiente a la instancia de base de datos que se aplicará o que se está aplicando.
+ **DBSubnetGroupName**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El grupo de subredes de base de datos nuevo de la instancia de base de datos.
+ **EngineVersion**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica la versión del motor de base de datos.
+ **Iops**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el valor nuevo de IOPS provisionadas correspondiente a la instancia de base de datos que se aplicará o que se está aplicando.
+ **MultiAZ**: se trata de un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Indica que la instancia de base de datos Single-AZ va a cambiar a una implementación Multi-AZ.
+ **PendingCloudwatchLogsExports**: se trata de un objeto [PendingCloudwatchLogsExports](api-clusters.md#PendingCloudwatchLogsExports).

  Esta estructura `PendingCloudwatchLogsExports` especifica los cambios pendientes en los que los registros de CloudWatch están habilitados y cuáles están deshabilitados.
+ **Port**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto pendiente para la instancia de base de datos.
+ **StorageType**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No se usa. En Neptune, el tipo de almacenamiento se administra en el nivel de clúster de base de datos.

## ValidStorageOptions (estructura)
<a name="ValidStorageOptions"></a>

No se usa. En Neptune, el tipo de almacenamiento se administra en el nivel de clúster de base de datos.

**Campos**
+ **IopsToStorageRatio**: se trata de una matriz de objetos [DoubleRange](api-datatypes.md#DoubleRange).

  No se usa. En Neptune, el tipo de almacenamiento se administra en el nivel de clúster de base de datos.
+ **ProvisionedIops**: se trata de una matriz de objetos [Range](api-datatypes.md#Range).

  No se usa. En Neptune, el tipo de almacenamiento se administra en el nivel de clúster de base de datos.
+ **StorageSize**: se trata de una matriz de objetos [Range](api-datatypes.md#Range).

  No se usa. En Neptune, el tipo de almacenamiento se administra en el nivel de clúster de base de datos.
+ **StorageType**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No se usa. En Neptune, el tipo de almacenamiento se administra en el nivel de clúster de base de datos.

## ValidDBInstanceModificationsMessage (estructura)
<a name="ValidDBInstanceModificationsMessage"></a>

Información sobre las modificaciones válidas que puede realizar a la instancia de base de datos. Contiene el resultado de una llamada correcta a la acción [DescribeValidDBInstanceModifications (acción)](#DescribeValidDBInstanceModifications). Puede utilizar esta información cuando llama a [ModifyDBInstance (acción)](#ModifyDBInstance). 

**Campos**
+ **Storage**: se trata de una matriz de objetos [ValidStorageOptions](#ValidStorageOptions).

  Opciones de almacenamiento válidas para su instancia de base de datos.

`ValidDBInstanceModificationsMessage` se utiliza como el elemento de respuesta para:
+ [DescribeValidDBInstanceModifications](#DescribeValidDBInstanceModifications)

# API de parámetros de Neptune
<a name="api-parameters"></a>

**Acciones:**
+ [CopyDBParameterGroup (acción)](#CopyDBParameterGroup)
+ [CopyDBClusterParameterGroup (acción)](#CopyDBClusterParameterGroup)
+ [CreateDBParameterGroup (acción)](#CreateDBParameterGroup)
+ [CreateDBClusterParameterGroup (acción)](#CreateDBClusterParameterGroup)
+ [DeleteDBParameterGroup (acción)](#DeleteDBParameterGroup)
+ [DeleteDBClusterParameterGroup (acción)](#DeleteDBClusterParameterGroup)
+ [ModifyDBParameterGroup (acción)](#ModifyDBParameterGroup)
+ [ModifyDBClusterParameterGroup (acción)](#ModifyDBClusterParameterGroup)
+ [ResetDBParameterGroup (acción)](#ResetDBParameterGroup)
+ [ResetDBClusterParameterGroup (acción)](#ResetDBClusterParameterGroup)
+ [DescribeDBParameters (acción)](#DescribeDBParameters)
+ [DescribeDBParameterGroups (acción)](#DescribeDBParameterGroups)
+ [DescribeDBClusterParameters (acción)](#DescribeDBClusterParameters)
+ [DescribeDBClusterParameterGroups (acción)](#DescribeDBClusterParameterGroups)
+ [DescribeEngineDefaultParameters (acción)](#DescribeEngineDefaultParameters)
+ [DescribeEngineDefaultClusterParameters (acción)](#DescribeEngineDefaultClusterParameters)

**Estructuras:**
+ [Parameter (estructura)](#Parameter)
+ [DBParameterGroup (estructura)](#DBParameterGroup)
+ [DBClusterParameterGroup (estructura)](#DBClusterParameterGroup)
+ [DBParameterGroupStatus (estructura)](#DBParameterGroupStatus)

## CopyDBParameterGroup (acción)
<a name="CopyDBParameterGroup"></a>

         El nombre de la AWS CLI para esta API es: `copy-db-parameter-group`.

Copia el grupo de parámetros de base de datos especificado.

**Solicitud**
+ **SourceDBParameterGroupIdentifier** (en la CLI: `--source-db-parameter-group-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador o ARN para el grupo de parámetros de base de datos de origen. Para obtener más información acerca de cómo crear un ARN, consulte [ Creación de un nombre de recurso de Amazon (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing).

  Restricciones:
  + Debe especificar un grupo de parámetros de base de datos válido.
  + Debe especificar un identificador de grupo de parámetros de base de datos válido, por ejemplo `my-db-param-group`, o un ARN válido.
+ **Tags** (en la CLI: `--tags`): una matriz de objetos [Tag](api-other-apis.md#Tag).

  Las etiquetas que se van a asignar al grupo de parámetros de base de datos copiado.
+ **TargetDBParameterGroupDescription** (en la CLI: `--target-db-parameter-group-description`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Descripción del grupo de parámetros de base de datos copiado.
+ **TargetDBParameterGroupIdentifier** (en la CLI: `--target-db-parameter-group-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador para el grupo de parámetros de base de datos copiado.

  Restricciones:
  + No puede ser nulo ni estar vacío o en blanco.
  + Deben contener de 1 a 255 caracteres (letras, números o guiones).
  + El primer carácter debe ser una letra.
  + No puede terminar por un guion ni contener dos guiones consecutivos.

  Ejemplo:: `my-db-parameter-group`

**Respuesta**

Contiene los detalles de un grupo de parámetros de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBParameterGroups (acción)](#DescribeDBParameterGroups).
+ **DBParameterGroupArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el grupo de parámetros de base de datos.
+ **DBParameterGroupFamily**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre de la familia del grupo de parámetros de base de datos con el que este grupo de parámetros de base de datos es compatible.
+ **DBParameterGroupName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del grupo de parámetros de base de datos.
+ **Description**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la descripción especificada por el usuario para este grupo de parámetros de base de datos.

**Errores**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)

## CopyDBClusterParameterGroup (acción)
<a name="CopyDBClusterParameterGroup"></a>

         El nombre de la AWS CLI para esta API es: `copy-db-cluster-parameter-group`.

Copia el grupo de parámetros de clúster de base de datos especificado.

**Solicitud**
+ **SourceDBClusterParameterGroupIdentifier** (en la CLI: `--source-db-cluster-parameter-group-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador o Nombre de recurso de Amazon (ARN) para el grupo de parámetros de clúster de base de datos de origen. Para obtener más información acerca de cómo crear un ARN, consulte [ Creación de un nombre de recurso de Amazon (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing).

  Restricciones:
  + Debe especificar un grupo de parámetros de clúster de base de datos válido.
  + Si el grupo de parámetros de clúster de base de datos de origen está en la misma región de Amazon que la copia, especifique un identificador de grupos de parámetros de base de datos válido, por ejemplo `my-db-cluster-param-group`, o un ARN válido.
  + Si el grupo de parámetros de base de datos de origen está en una región de Amazon diferente a la de la copia, especifique un ARN de grupo de parámetros de clúster de base de datos válido, por ejemplo `arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1`.
+ **Tags** (en la CLI: `--tags`): una matriz de objetos [Tag](api-other-apis.md#Tag).

  Las etiquetas que se van a asignar al grupo de parámetros de clúster de base de datos copiado.
+ **TargetDBClusterParameterGroupDescription** (en la CLI: `--target-db-cluster-parameter-group-description`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Descripción del grupo de parámetros de clúster de base de datos copiado.
+ **TargetDBClusterParameterGroupIdentifier** (en la CLI: `--target-db-cluster-parameter-group-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador para el grupo de parámetros de clúster de base de datos copiado.

  Restricciones:
  + No puede ser nulo ni estar vacío o en blanco
  + Deben contener de 1 a 255 caracteres (letras, números o guiones).
  + El primer carácter debe ser una letra
  + No puede terminar por un guion ni contener dos guiones consecutivos

  Ejemplo:: `my-cluster-param-group1`

**Respuesta**

Contiene los detalles de un grupo de parámetros de clúster de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBClusterParameterGroups (acción)](#DescribeDBClusterParameterGroups).
+ **DBClusterParameterGroupArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el grupo de parámetros de clúster de base de datos.
+ **DBClusterParameterGroupName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del grupo de parámetros de clúster de base de datos.
+ **DBParameterGroupFamily**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre de la familia del grupo de parámetros de base de datos con el que este grupo de parámetros de clúster de base de datos es compatible.
+ **Description**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la descripción especificada por el usuario para este grupo de parámetros de clúster de base de datos.

**Errores**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)

## CreateDBParameterGroup (acción)
<a name="CreateDBParameterGroup"></a>

         El nombre de la AWS CLI para esta API es: `create-db-parameter-group`.

Crea un nuevo grupo de parámetros de base de datos.

Un grupo de parámetros de base de datos se crea inicialmente con los parámetros predeterminados para el motor de base de datos utilizado por la instancia de base de datos. Para proporcionar valores personalizados para cualquiera de los parámetros, debe modificar el grupo después de haberlo creado mediante *ModifyDBParameterGroup*. Una vez que haya creado un grupo de parámetros de base de datos, tiene que asociarlo a su instancia de base de datos mediante *ModifyDBInstance*. Al asociar un nuevo grupo de parámetros de base de datos con una instancia de base de datos en ejecución, debe reiniciar la instancia de base de datos sin conmutación por error para el nuevo grupo de parámetros de base de datos y la configuración asociada para que surta efecto.

**importante**  
Después de crear un grupo de parámetros de base de datos, debe esperar al menos 5 minutos antes de crear la primera instancia de base de datos que utilice ese grupo de parámetros de base de datos como grupo de parámetros predeterminado. Esto permite a Amazon Neptune finalizar por completo la acción de creación antes de que el grupo de parámetros se use de forma predeterminada para una instancia de base de datos nueva. Esto es especialmente importante para los parámetros que son críticos al crear la base de datos predeterminada de una instancia de base de datos, como el conjunto de caracteres de la base de datos predeterminada, definido por el parámetro `character_set_database`. Puede utilizar la opción *Parameter Groups (Grupos de parámetros)* de la consola de Amazon Neptune o el comando *DescribeDBParameters* para comprobar que se ha creado o modificado el grupo de parámetros de base de datos.

**Solicitud**
+ **DBParameterGroupFamily** (en la CLI: `--db-parameter-group-family`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la familia del grupo de parámetros de base de datos. Un grupo de parámetros de base de datos puede asociarse exclusivamente con una familia de grupos de parámetros de base de datos y solo puede aplicarse a una instancia de base de datos que ejecuta un motor de base de datos y la versión del motor que es compatible con esa familia de grupos de parámetros de base de datos.
+ **DBParameterGroupName** (en la CLI: `--db-parameter-group-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del grupo de parámetros de base de datos.

  Restricciones:
  + Debe tener de 1 a 255 letras, números o guiones.
  + El primer carácter debe ser una letra
  + No puede terminar por un guion ni contener dos guiones consecutivos
**nota**  
Este valor se almacena como una cadena en minúsculas.
+ **Description** (en la CLI: `--description`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Descripción del grupo de parámetros de base de datos.
+ **Tags** (en la CLI: `--tags`): una matriz de objetos [Tag](api-other-apis.md#Tag).

  Las etiquetas que se van a asignar al grupo de parámetros de base de datos nuevo.

**Respuesta**

Contiene los detalles de un grupo de parámetros de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBParameterGroups (acción)](#DescribeDBParameterGroups).
+ **DBParameterGroupArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el grupo de parámetros de base de datos.
+ **DBParameterGroupFamily**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre de la familia del grupo de parámetros de base de datos con el que este grupo de parámetros de base de datos es compatible.
+ **DBParameterGroupName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del grupo de parámetros de base de datos.
+ **Description**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la descripción especificada por el usuario para este grupo de parámetros de base de datos.

**Errores**
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)

## CreateDBClusterParameterGroup (acción)
<a name="CreateDBClusterParameterGroup"></a>

         El nombre de la AWS CLI para esta API es: `create-db-cluster-parameter-group`.

Crear un nuevo grupo de parámetros del clúster de base de datos.

Los parámetros de un grupo de parámetros de clúster de base de datos se aplican a todas las instancias de un clúster de base de datos.

 Un grupo de parámetros de clúster de base de datos se crea inicialmente con los parámetros predeterminados para el motor de base de datos utilizado por las instancias del clúster de base de datos. Para proporcionar valores personalizados para cualquiera de los parámetros, debe modificar el grupo después de haberlo creado mediante [ModifyDBClusterParameterGroup (acción)](#ModifyDBClusterParameterGroup). Una vez que haya creado un grupo de parámetros de clúster de base de datos, tiene que asociarlo a su clúster de base de datos mediante [ModifyDBCluster (acción)](api-clusters.md#ModifyDBCluster). Al asociar un nuevo grupo de parámetros de clúster de base de datos con un clúster de base de datos en ejecución, debe reiniciar las instancias de base de datos en el clúster de base de datos sin conmutación por error para el nuevo grupo de parámetros del clúster de base de datos y la configuración asociada para que surta efecto.

**importante**  
Después de crear un grupo de parámetros de clúster de base de datos, debe esperar al menos 5 minutos antes de crear el primer clúster de base de datos que utilice ese grupo de parámetros de clúster de base de datos como grupo de parámetros predeterminado. Esto permite a Amazon Neptune finalizar por completo la acción de creación antes de que el grupo de parámetros de clúster de base de datos se use de forma predeterminada para un clúster de base de datos nuevo. Esto es especialmente importante para los parámetros que son críticos al crear la base de datos predeterminada de un clúster de base de datos, como el conjunto de caracteres de la base de datos predeterminada, definido por el parámetro `character_set_database`. Puede utilizar la opción *Parameter Groups (Grupos de parámetros)* de la [consola de Amazon Neptune](https://console.aws.amazon.com/rds/) o el comando [DescribeDBClusterParameters (acción)](#DescribeDBClusterParameters) para comprobar que se ha creado o modificado el grupo de parámetros de clúster de base de datos.

**Solicitud**
+ **DBClusterParameterGroupName** (en la CLI: `--db-cluster-parameter-group-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

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

  Restricciones:
  + Debe coincidir con el nombre de un DBClusterParameterGroup existente.
**nota**  
Este valor se almacena como una cadena en minúsculas.
+ **DBParameterGroupFamily** (en la CLI: `--db-parameter-group-family`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la familia del grupo de parámetros de clúster de base de datos. Un grupo de parámetros de clúster de base de datos puede asociarse exclusivamente con una familia de grupos de parámetros de clúster de base de datos y solo puede aplicarse a un clúster de base de datos que ejecuta un motor de base de datos y la versión del motor que es compatible con esa familia de grupos de parámetros de clúster de base de datos.
+ **Description** (en la CLI: `--description`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Descripción del grupo de parámetros de clúster de base de datos.
+ **Tags** (en la CLI: `--tags`): una matriz de objetos [Tag](api-other-apis.md#Tag).

  Las etiquetas que se van a asignar al grupo de parámetros de clúster de base de datos nuevo.

**Respuesta**

Contiene los detalles de un grupo de parámetros de clúster de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBClusterParameterGroups (acción)](#DescribeDBClusterParameterGroups).
+ **DBClusterParameterGroupArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el grupo de parámetros de clúster de base de datos.
+ **DBClusterParameterGroupName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del grupo de parámetros de clúster de base de datos.
+ **DBParameterGroupFamily**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre de la familia del grupo de parámetros de base de datos con el que este grupo de parámetros de clúster de base de datos es compatible.
+ **Description**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la descripción especificada por el usuario para este grupo de parámetros de clúster de base de datos.

**Errores**
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)

## DeleteDBParameterGroup (acción)
<a name="DeleteDBParameterGroup"></a>

         El nombre de la AWS CLI para esta API es: `delete-db-parameter-group`.

Elimina un determinado DBParameterGroup. El DBParameterGroup que se va a eliminar no puede asociarse a cualquier instancia de base de datos.

**Solicitud**
+ **DBParameterGroupName** (en la CLI: `--db-parameter-group-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del grupo de parámetros de base de datos.

  Restricciones:
  + Debe ser el nombre de un grupo de parámetros de base de datos existente.
  + No puede eliminar un grupo de parámetros de base de datos predeterminado.
  + No se puede asociar con cualquier instancia de base de datos

**Respuesta**
+ *Sin parámetros de respuesta.*

**Errores**
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)

## DeleteDBClusterParameterGroup (acción)
<a name="DeleteDBClusterParameterGroup"></a>

         El nombre de la AWS CLI para esta API es: `delete-db-cluster-parameter-group`.

Elimina un determinado grupo de parámetros del clúster de base de datos. El grupo de parámetros de clúster de base de datos que se va a eliminar no puede asociarse a cualquier clúster de base de datos.

**Solicitud**
+ **DBClusterParameterGroupName** (en la CLI: `--db-cluster-parameter-group-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

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

  Restricciones:
  + Debe ser el nombre de un grupo de parámetros de clúster de base de datos existente.
  + No puede eliminar un grupo de parámetros de clúster de base de datos predeterminado.
  + No se puede asociar con cualquier clúster de base de datos.

**Respuesta**
+ *Sin parámetros de respuesta.*

**Errores**
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)

## ModifyDBParameterGroup (acción)
<a name="ModifyDBParameterGroup"></a>

         El nombre de la AWS CLI para esta API es: `modify-db-parameter-group`.

Modifica los parámetros de un grupo de parámetros de base de datos. Para modificar más de un parámetro, envíe una lista de los siguientes: `ParameterName`, `ParameterValue` y `ApplyMethod`. Se pueden modificar un máximo de 20 parámetros en una única solicitud.

**nota**  
Los cambios realizados en los parámetros dinámicos se aplican inmediatamente. Los cambios en los parámetros estáticos requieren un reinicio sin conmutación por error en la instancia de base de datos asociada con el grupo de parámetros antes de que el cambio surta efecto.

**importante**  
Después de modificar un grupo de parámetros de base de datos, debe esperar al menos 5 minutos antes de crear la primera instancia de base de datos que utilice ese grupo de parámetros de base de datos como grupo de parámetros predeterminado. Esto permite a Amazon Neptune finalizar por completo la acción de modificación antes de que el grupo de parámetros se use de forma predeterminada para una instancia de base de datos nueva. Esto es especialmente importante para los parámetros que son críticos al crear la base de datos predeterminada de una instancia de base de datos, como el conjunto de caracteres de la base de datos predeterminada, definido por el parámetro `character_set_database`. Puede utilizar la opción *Parameter Groups (Grupos de parámetros)* de la consola de Amazon Neptune o el comando *DescribeDBParameters* para comprobar que se ha creado o modificado el grupo de parámetros de base de datos.

**Solicitud**
+ **DBParameterGroupName** (en la CLI: `--db-parameter-group-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del grupo de parámetros de base de datos.

  Restricciones:
  + Si se proporciona, debe coincidir con el nombre de un DBParameterGroup existente.
+ **Parameters** (en la CLI: `--parameters`) *obligatorio:* una matriz de objetos [Parámetro](#Parameter).

  Una matriz de los nombres de parámetros, valores y el método de aplicación para la actualización del parámetro. Deben proporcionarse al menos un nombre de parámetro, valor y método de aplicación; los argumentos subsiguientes son opcionales. Se pueden modificar un máximo de 20 parámetros en una única solicitud.

  Valores válidos (para el método de aplicación): `immediate | pending-reboot`
**nota**  
Puede utilizar el valor inmediato solo con parámetros dinámicos. Puede utilizar el valor pendiente de reinicio para parámetros dinámicos y estáticos, los cambios se aplican al reiniciar la instancia de base de datos sin conmutación por error.

**Respuesta**
+ **DBParameterGroupName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

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

**Errores**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)

## ModifyDBClusterParameterGroup (acción)
<a name="ModifyDBClusterParameterGroup"></a>

         El nombre de la AWS CLI para esta API es: `modify-db-cluster-parameter-group`.

 Modifica los parámetros de un grupo de parámetros del clúster de base de datos. Para modificar más de un parámetro, envíe una lista de los siguientes: `ParameterName`, `ParameterValue` y `ApplyMethod`. Se pueden modificar un máximo de 20 parámetros en una única solicitud.

**nota**  
Los cambios realizados en los parámetros dinámicos se aplican inmediatamente. Los cambios en los parámetros estáticos requieren un reinicio sin conmutación por error en el clúster de base de datos asociado con el grupo de parámetros antes de que el cambio surta efecto.

**importante**  
Después de crear un grupo de parámetros de clúster de base de datos, debe esperar al menos 5 minutos antes de crear el primer clúster de base de datos que utilice ese grupo de parámetros de clúster de base de datos como grupo de parámetros predeterminado. Esto permite a Amazon Neptune finalizar por completo la acción de creación antes de que el grupo de parámetros se use de forma predeterminada para un nuevo clúster de base de datos. Esto es especialmente importante para los parámetros que son críticos al crear la base de datos predeterminada de un clúster de base de datos, como el conjunto de caracteres de la base de datos predeterminada, definido por el parámetro `character_set_database`. Puede utilizar la opción *Parameter Groups (Grupos de parámetros)* de la consola de Amazon Neptune o el comando [DescribeDBClusterParameters (acción)](#DescribeDBClusterParameters) para comprobar que se ha creado o modificado el grupo de parámetros de clúster de base de datos.

**Solicitud**
+ **DBClusterParameterGroupName** (en la CLI: `--db-cluster-parameter-group-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del grupo de parámetros de clúster de base de datos que se va a modificar.
+ **Parameters** (en la CLI: `--parameters`) *obligatorio:* una matriz de objetos [Parámetro](#Parameter).

  Un lista de parámetros en el grupo de parámetros de clúster de base de datos que se va a modificar.

**Respuesta**
+ **DBClusterParameterGroupName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

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

  Restricciones:
  + Debe tener de 1 a 255 letras o números.
  + El primer carácter debe ser una letra
  + No puede terminar por un guion ni contener dos guiones consecutivos
**nota**  
Este valor se almacena como una cadena en minúsculas.

**Errores**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)

## ResetDBParameterGroup (acción)
<a name="ResetDBParameterGroup"></a>

         El nombre de la AWS CLI para esta API es: `reset-db-parameter-group`.

Modifica los parámetros de un grupo de parámetros de base de datos al valor predeterminado del motor/sistema. Para restablecer parámetros específicos, proporcione una lista de lo siguiente: `ParameterName` y `ApplyMethod`. Para restablecer el grupo de parámetros de base datos completo, especifique el nombre de `DBParameterGroup` y los parámetros de `ResetAllParameters`. Cuando restablece todo el grupo, los parámetros dinámicos se actualizan de forma inmediata y los parámetros estáticos se establecen en `pending-reboot` para su aplicación la próxima vez que se reinicie la instancia de base de datos o en la siguiente solicitud `RebootDBInstance`.

**Solicitud**
+ **DBParameterGroupName** (en la CLI: `--db-parameter-group-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del grupo de parámetros de base de datos.

  Restricciones:
  + Debe coincidir con el nombre de un DBParameterGroup existente.
+ **Parameters** (en la CLI: `--parameters`): una matriz de objetos [Parámetro](#Parameter).

  Para restablecer el grupo de parámetros de base datos completo, especifique el nombre de `DBParameterGroup` y los parámetros de `ResetAllParameters`. Para restablecer parámetros específicos, proporcione una lista de lo siguiente: `ParameterName` y `ApplyMethod`. Se pueden modificar un máximo de 20 parámetros en una única solicitud.

  Valores válidos (para Aplique el método): `pending-reboot`
+ **ResetAllParameters** (en la CLI: `--reset-all-parameters`): un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si se deben restablecer todos los parámetros (`true`) o no (`false`) del grupo de parámetros de base de datos a sus valores predeterminados.

  Valor predeterminado: `true`

**Respuesta**
+ **DBParameterGroupName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

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

**Errores**
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)

## ResetDBClusterParameterGroup (acción)
<a name="ResetDBClusterParameterGroup"></a>

         El nombre de la AWS CLI para esta API es: `reset-db-cluster-parameter-group`.

 Modifica los parámetros de un grupo de parámetros del clúster de base de datos al valor predeterminado. Para restablecer parámetros específicos, envíe una lista de lo siguiente: `ParameterName` y `ApplyMethod`. Para restablecer el grupo de parámetros de clúster de base datos completo, especifique el `DBClusterParameterGroupName` y los parámetros de `ResetAllParameters`.

 Cuando restablece todo el grupo, los parámetros dinámicos se actualizan de forma inmediata y los parámetros estáticos se establecen en `pending-reboot` para su aplicación la próxima vez que se reinicie la instancia de base de datos o en la siguiente solicitud [RebootDBInstance (acción)](api-instances.md#RebootDBInstance). Debe llamar a [RebootDBInstance (acción)](api-instances.md#RebootDBInstance) para cada instancia de base de datos en el clúster de base de datos al que desee aplicar el parámetro estático actualizado.

**Solicitud**
+ **DBClusterParameterGroupName** (en la CLI: `--db-cluster-parameter-group-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del grupo de parámetros de clúster de base de datos que se va a restablecer.
+ **Parameters** (en la CLI: `--parameters`): una matriz de objetos [Parámetro](#Parameter).

  Una lista de nombres de parámetros en el grupo de parámetros de clúster de base de datos que se va a restablecer a los valores predeterminados. No puede utilizar este parámetro si el parámetro `ResetAllParameters` está establecido en `true`.
+ **ResetAllParameters** (en la CLI: `--reset-all-parameters`): un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor que se establece en `true` para restablecer todos los parámetros en el grupo de parámetros de clúster de base de datos a sus valores predeterminados, y en `false` en caso contrario. No puede utilizar este parámetro si hay una lista de nombres de parámetros especificados para el parámetro `Parameters`.

**Respuesta**
+ **DBClusterParameterGroupName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

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

  Restricciones:
  + Debe tener de 1 a 255 letras o números.
  + El primer carácter debe ser una letra
  + No puede terminar por un guion ni contener dos guiones consecutivos
**nota**  
Este valor se almacena como una cadena en minúsculas.

**Errores**
+ [InvalidDBParameterGroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)

## DescribeDBParameters (acción)
<a name="DescribeDBParameters"></a>

         El nombre de la AWS CLI para esta API es: `describe-db-parameters`.

Devuelve la lista detallada de parámetros para un grupo de parámetros de base de datos determinado.

**Solicitud**
+ **DBParameterGroupName** (en la CLI: `--db-parameter-group-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de un grupo de parámetros de base de datos específico para el que devolver detalles.

  Restricciones:
  + Si se proporciona, debe coincidir con el nombre de un DBParameterGroup existente.
+ **Filters** (en la CLI: `--filters`): una matriz de objetos [Filtro](api-datatypes.md#Filter).

  Este parámetro es incompatible en estos momentos.
+ **Marker** (en la CLI: `--marker`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Un token de paginación opcional proporcionado por una solicitud `DescribeDBParameters` anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.
+ **MaxRecords** (en la CLI: `--max-records`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación que se conoce como marcador, de modo que se pueda recuperar el resto de resultados.

  Predeterminado: 100

  Restricciones: mínimo 20, máximo 100.
+ **Source** (en la CLI: `--source`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Los tipos de parámetros que se devuelven.

  De forma predeterminada: se devuelven todos los tipos de parámetros

  Valores válidos: `user | system | engine-default`

**Respuesta**
+ **Marker**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.
+ **Parameters**: matriz de objetos [Parámetro](#Parameter).

  Una lista de valores de [Parameter (estructura)](#Parameter).

**Errores**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)

## DescribeDBParameterGroups (acción)
<a name="DescribeDBParameterGroups"></a>

         El nombre de la AWS CLI para esta API es: `describe-db-parameter-groups`.

Devuelve una lista de descripciones de `DBParameterGroup`. Si se especifica un `DBParameterGroupName`, la lista contendrá únicamente la descripción del grupo de parámetros de base de datos especificado.

**Solicitud**
+ **DBParameterGroupName** (en la CLI: `--db-parameter-group-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de un grupo de parámetros de base de datos específico para el que devolver detalles.

  Restricciones:
  + Si se suministra, debe coincidir con el nombre de un DBClusterParameterGroup existente.
+ **Filters** (en la CLI: `--filters`): una matriz de objetos [Filtro](api-datatypes.md#Filter).

  Este parámetro es incompatible en estos momentos.
+ **Marker** (en la CLI: `--marker`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Un token de paginación opcional proporcionado por una solicitud `DescribeDBParameterGroups` anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.
+ **MaxRecords** (en la CLI: `--max-records`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación que se conoce como marcador, de modo que se pueda recuperar el resto de resultados.

  Predeterminado: 100

  Restricciones: mínimo 20, máximo 100.

**Respuesta**
+ **DBParameterGroups**: matriz de objetos [DBParameterGroup](#DBParameterGroup).

  Una lista de instancias [DBParameterGroup (estructura)](#DBParameterGroup).
+ **Marker**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.

**Errores**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)

## DescribeDBClusterParameters (acción)
<a name="DescribeDBClusterParameters"></a>

         El nombre de la AWS CLI para esta API es: `describe-db-cluster-parameters`.

Devuelve la lista detallada de parámetros para un grupo de parámetros de clúster de base de datos en particular.

**Solicitud**
+ **DBClusterParameterGroupName** (en la CLI: `--db-cluster-parameter-group-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de un grupo de parámetros de clúster de base de datos específico para el que devolver detalles de parámetros.

  Restricciones:
  + Si se suministra, debe coincidir con el nombre de un DBClusterParameterGroup existente.
+ **Filters** (en la CLI: `--filters`): una matriz de objetos [Filtro](api-datatypes.md#Filter).

  Este parámetro es incompatible en estos momentos.
+ **Marker** (en la CLI: `--marker`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud `DescribeDBClusterParameters` anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`. 
+ **MaxRecords** (en la CLI: `--max-records`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

   El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación que se conoce como marcador, de modo que se pueda recuperar el resto de resultados.

  Predeterminado: 100

  Restricciones: mínimo 20, máximo 100.
+ **Source** (en la CLI: `--source`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un valor que indica devolver solo parámetros de un origen específico. Los orígenes de parámetros pueden ser `engine`, `service` o `customer`.

**Respuesta**
+ **Marker**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud DescribeDBClusterParameters anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords` .
+ **Parameters**: matriz de objetos [Parámetro](#Parameter).

  Proporciona una lista de parámetros para el grupo de parámetros de clúster de base de datos.

**Errores**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)

## DescribeDBClusterParameterGroups (acción)
<a name="DescribeDBClusterParameterGroups"></a>

         El nombre de la AWS CLI para esta API es: `describe-db-cluster-parameter-groups`.

 Devuelve una lista de descripciones de `DBClusterParameterGroup`. Si se especifica un parámetro `DBClusterParameterGroupName`, la lista contendrá únicamente la descripción del grupo de parámetros de clúster de base de datos especificado.

**Solicitud**
+ **DBClusterParameterGroupName** (en la CLI: `--db-cluster-parameter-group-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de un grupo de parámetros de clúster de base de datos específico para el que devolver detalles.

  Restricciones:
  + Si se suministra, debe coincidir con el nombre de un DBClusterParameterGroup existente.
+ **Filters** (en la CLI: `--filters`): una matriz de objetos [Filtro](api-datatypes.md#Filter).

  Este parámetro es incompatible en estos momentos.
+ **Marker** (en la CLI: `--marker`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud `DescribeDBClusterParameterGroups` anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.
+ **MaxRecords** (en la CLI: `--max-records`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

   El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación que se conoce como marcador, de modo que se pueda recuperar el resto de resultados.

  Predeterminado: 100

  Restricciones: mínimo 20, máximo 100.

**Respuesta**
+ **DBClusterParameterGroups**: matriz de objetos [DBClusterParameterGroup](#DBClusterParameterGroup).

  Lista de grupos de parámetros de clúster de base de datos.
+ **Marker**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud `DescribeDBClusterParameterGroups` anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.

**Errores**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)

## DescribeEngineDefaultParameters (acción)
<a name="DescribeEngineDefaultParameters"></a>

         El nombre de la AWS CLI para esta API es: `describe-engine-default-parameters`.

Devuelve la información de parámetros del sistema y del motor predeterminada para el motor de base de datos especificado.

**Solicitud**
+ **DBParameterGroupFamily** (en la CLI: `--db-parameter-group-family`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la familia del grupo de parámetros de base de datos.
+ **Filters** (en la CLI: `--filters`): una matriz de objetos [Filtro](api-datatypes.md#Filter).

  No se admite actualmente.
+ **Marker** (en la CLI: `--marker`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud `DescribeEngineDefaultParameters` anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.
+ **MaxRecords** (en la CLI: `--max-records`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

   El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación que se conoce como marcador, de modo que se pueda recuperar el resto de resultados.

  Predeterminado: 100

  Restricciones: mínimo 20, máximo 100.

**Respuesta**

 Contiene el resultado de una invocación correcta de la acción [DescribeEngineDefaultParameters (acción)](#DescribeEngineDefaultParameters).
+ **DBParameterGroupFamily**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre de la familia del grupo de parámetros de base de datos a los que se aplican los parámetros predeterminados del motor.
+ **Marker**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud EngineDefaults anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords` .
+ **Parameters**: matriz de objetos [Parámetro](#Parameter).

  Contiene una lista de los parámetros predeterminados del motor.

## DescribeEngineDefaultClusterParameters (acción)
<a name="DescribeEngineDefaultClusterParameters"></a>

         El nombre de la AWS CLI para esta API es: `describe-engine-default-cluster-parameters`.

Devuelve la información de los parámetros del sistema y del motor predeterminados para el motor de base de datos del clúster.

**Solicitud**
+ **DBParameterGroupFamily** (en la CLI: `--db-parameter-group-family`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la familia del grupo de parámetros de clúster de base de datos para la que devolver información de los parámetros del motor.
+ **Filters** (en la CLI: `--filters`): una matriz de objetos [Filtro](api-datatypes.md#Filter).

  Este parámetro es incompatible en estos momentos.
+ **Marker** (en la CLI: `--marker`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud `DescribeEngineDefaultClusterParameters` anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.
+ **MaxRecords** (en la CLI: `--max-records`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

   El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación que se conoce como marcador, de modo que se pueda recuperar el resto de resultados.

  Predeterminado: 100

  Restricciones: mínimo 20, máximo 100.

**Respuesta**

 Contiene el resultado de una invocación correcta de la acción [DescribeEngineDefaultParameters (acción)](#DescribeEngineDefaultParameters).
+ **DBParameterGroupFamily**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre de la familia del grupo de parámetros de base de datos a los que se aplican los parámetros predeterminados del motor.
+ **Marker**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud EngineDefaults anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords` .
+ **Parameters**: matriz de objetos [Parámetro](#Parameter).

  Contiene una lista de los parámetros predeterminados del motor.

## *Estructuras:*
<a name="api-parameters-structures-spacer"></a>

## Parameter (estructura)
<a name="Parameter"></a>

Especifica un parámetro.

**Campos**
+ **AllowedValues**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el rango de valores válido del parámetro.
+ **ApplyMethod**: se trata de un ApplyMethod, del tipo `string`: (una cadena codificada con UTF-8).

  Indica cuándo deben aplicarse actualizaciones de parámetros.
+ **ApplyType**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el tipo de parámetros específicos del motor.
+ **DataType**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el tipo de datos válidos para el parámetro.
+ **Description**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona una descripción del parámetro.
+ **IsModifiable**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

   Indica si el parámetro se puede modificar (`true`) o no (`false`). Algunos parámetros tienen implicaciones de seguridad u operativas que impiden que puedan cambiarse.
+ **MinimumEngineVersion**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La versión del motor más antigua al que se puede aplicar el parámetro.
+ **ParameterName**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre del parámetro.
+ **ParameterValue**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el valor del parámetro.
+ **Source**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica el origen del valor del parámetro.

## DBParameterGroup (estructura)
<a name="DBParameterGroup"></a>

Contiene los detalles de un grupo de parámetros de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBParameterGroups (acción)](#DescribeDBParameterGroups).

**Campos**
+ **DBParameterGroupArn**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el grupo de parámetros de base de datos.
+ **DBParameterGroupFamily**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre de la familia del grupo de parámetros de base de datos con el que este grupo de parámetros de base de datos es compatible.
+ **DBParameterGroupName**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del grupo de parámetros de base de datos.
+ **Description**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la descripción especificada por el usuario para este grupo de parámetros de base de datos.

`DBParameterGroup` se utiliza como el elemento de respuesta para:
+ [CopyDBParameterGroup](#CopyDBParameterGroup)
+ [CreateDBParameterGroup](#CreateDBParameterGroup)

## DBClusterParameterGroup (estructura)
<a name="DBClusterParameterGroup"></a>

Contiene los detalles de un grupo de parámetros de clúster de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBClusterParameterGroups (acción)](#DescribeDBClusterParameterGroups).

**Campos**
+ **DBClusterParameterGroupArn**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el grupo de parámetros de clúster de base de datos.
+ **DBClusterParameterGroupName**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del grupo de parámetros de clúster de base de datos.
+ **DBParameterGroupFamily**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre de la familia del grupo de parámetros de base de datos con el que este grupo de parámetros de clúster de base de datos es compatible.
+ **Description**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la descripción especificada por el usuario para este grupo de parámetros de clúster de base de datos.

`DBClusterParameterGroup` se utiliza como el elemento de respuesta para:
+ [CopyDBClusterParameterGroup](#CopyDBClusterParameterGroup)
+ [CreateDBClusterParameterGroup](#CreateDBClusterParameterGroup)

## DBParameterGroupStatus (estructura)
<a name="DBParameterGroupStatus"></a>

El estado del grupo de parámetros de base de datos.

Este tipo de datos se usa como elemento de respuesta en las siguientes acciones:
+ [CreateDBInstance (acción)](api-instances.md#CreateDBInstance)
+ [DeleteDBInstance (acción)](api-instances.md#DeleteDBInstance)
+ [ModifyDBInstance (acción)](api-instances.md#ModifyDBInstance)
+ [RebootDBInstance (acción)](api-instances.md#RebootDBInstance)

**Campos**
+ **DBParameterGroupName**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del grupo de parámetros de base de datos.
+ **ParameterApplyStatus**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El estado de las actualizaciones de parámetros.

# API de subred de Neptune
<a name="api-subnets"></a>

**Acciones:**
+ [CreateDBSubnetGroup (acción)](#CreateDBSubnetGroup)
+ [DeleteDBSubnetGroup (acción)](#DeleteDBSubnetGroup)
+ [ModifyDBSubnetGroup (acción)](#ModifyDBSubnetGroup)
+ [DescribeDBSubnetGroups (acción)](#DescribeDBSubnetGroups)

**Estructuras:**
+ [Subred (estructura)](#Subnet)
+ [DBSubnetGroup (estructura)](#DBSubnetGroup)

## CreateDBSubnetGroup (acción)
<a name="CreateDBSubnetGroup"></a>

         El nombre de la AWS CLI para esta API es: `create-db-subnet-group`.

Crea un nuevo grupo de subred de base de datos. Los grupos de subred de base de datos deben incluir al menos una subred en al menos dos zonas de disponibilidad de la región de Amazon.

**Solicitud**
+ **DBSubnetGroupDescription** (en la CLI: `--db-subnet-group-description`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Descripción para el grupo de subredes de base de datos.
+ **DBSubnetGroupName** (en la CLI: `--db-subnet-group-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del grupo de subredes de base de datos. Este valor se almacena como una cadena en minúsculas.

  Restricciones: debe contener un máximo de 255 letras, números, puntos, guiones bajos, espacios o guiones. No debe ser predeterminado.

  Ejemplo:: `mySubnetgroup`
+ **SubnetIds** (en la CLI: `--subnet-ids`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  ID de subredes de EC2 para el grupo de subred de base de datos.
+ **Tags** (en la CLI: `--tags`): una matriz de objetos [Tag](api-other-apis.md#Tag).

  Las etiquetas que se van a asignar al grupo de subred de base de datos nuevo.

**Respuesta**

Contiene los detalles de un grupo de subred de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBSubnetGroups (acción)](#DescribeDBSubnetGroups).
+ **DBSubnetGroupArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el grupo de subred de base de datos.
+ **DBSubnetGroupDescription**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la descripción del grupo de subred de base de datos.
+ **DBSubnetGroupName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Nombre del grupo de subred de base de datos.
+ **SubnetGroupStatus**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el estado del grupo de subred de base de datos.
+ **Subnets**: matriz de objetos [Subred](#Subnet).

   Contiene una lista de elementos [Subred (estructura)](#Subnet).
+ **VpcId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el ID de VPC del grupo de subred de base de datos.

**Errores**
+ [DBSubnetGroupAlreadyExistsFault](api-faults.md#DBSubnetGroupAlreadyExistsFault)
+ [DBSubnetGroupQuotaExceededFault](api-faults.md#DBSubnetGroupQuotaExceededFault)
+ [DBSubnetQuotaExceededFault](api-faults.md#DBSubnetQuotaExceededFault)
+ [DBSubnetGroupDoesNotCoverEnoughAZs](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)

## DeleteDBSubnetGroup (acción)
<a name="DeleteDBSubnetGroup"></a>

         El nombre de la AWS CLI para esta API es: `delete-db-subnet-group`.

Elimina un grupo de subred de base de datos.

**nota**  
El grupo de subred de base de datos especificado no debe estar asociado a cualquier instancia de base de datos.

**Solicitud**
+ **DBSubnetGroupName** (en la CLI: `--db-subnet-group-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del grupo de subred de base de datos que se va a eliminar.
**nota**  
El grupo de subred predeterminado no se puede eliminar.

  Restricciones:

  Limitaciones: debe coincidir con el nombre de un DBSubnetGroup existente. No debe ser predeterminado.

  Ejemplo:: `mySubnetgroup`

**Respuesta**
+ *Sin parámetros de respuesta.*

**Errores**
+ [InvalidDBSubnetGroupStateFault](api-faults.md#InvalidDBSubnetGroupStateFault)
+ [InvalidDBSubnetStateFault](api-faults.md#InvalidDBSubnetStateFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)

## ModifyDBSubnetGroup (acción)
<a name="ModifyDBSubnetGroup"></a>

         El nombre de la AWS CLI para esta API es: `modify-db-subnet-group`.

Modifica un grupo de subred de base de datos existente. Los grupos de subred de base de datos deben incluir al menos una subred en al menos dos zonas de disponibilidad de la región de Amazon.

**Solicitud**
+ **DBSubnetGroupDescription** (en la CLI: `--db-subnet-group-description`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Descripción para el grupo de subredes de base de datos.
+ **DBSubnetGroupName** (en la CLI: `--db-subnet-group-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del grupo de subredes de base de datos. Este valor se almacena como una cadena en minúsculas. El grupo de subred predeterminado no se puede modificar.

  Limitaciones: debe coincidir con el nombre de un DBSubnetGroup existente. No debe ser predeterminado.

  Ejemplo:: `mySubnetgroup`
+ **SubnetIds** (en la CLI: `--subnet-ids`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  ID de subredes de EC2 para el grupo de subred de base de datos.

**Respuesta**

Contiene los detalles de un grupo de subred de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBSubnetGroups (acción)](#DescribeDBSubnetGroups).
+ **DBSubnetGroupArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el grupo de subred de base de datos.
+ **DBSubnetGroupDescription**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la descripción del grupo de subred de base de datos.
+ **DBSubnetGroupName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Nombre del grupo de subred de base de datos.
+ **SubnetGroupStatus**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el estado del grupo de subred de base de datos.
+ **Subnets**: matriz de objetos [Subred](#Subnet).

   Contiene una lista de elementos [Subred (estructura)](#Subnet).
+ **VpcId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el ID de VPC del grupo de subred de base de datos.

**Errores**
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [DBSubnetQuotaExceededFault](api-faults.md#DBSubnetQuotaExceededFault)
+ [SubnetAlreadyInUse](api-faults.md#SubnetAlreadyInUse)
+ [DBSubnetGroupDoesNotCoverEnoughAZs](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)

## DescribeDBSubnetGroups (acción)
<a name="DescribeDBSubnetGroups"></a>

         El nombre de la AWS CLI para esta API es: `describe-db-subnet-groups`.

Devuelve una lista de descripciones de DBSubnetGroup. Si se especifica un DBSubnetGroupName, la lista contendrá únicamente las descripciones del DBSubnetGroup especificado.

Para obtener información general de los rangos de CIDR, visite el [Tutorial de Wikipedia](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).

**Solicitud**
+ **DBSubnetGroupName** (en la CLI: `--db-subnet-group-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del grupo de subred de base de datos del que desea consultar los detalles.
+ **Filters** (en la CLI: `--filters`): una matriz de objetos [Filtro](api-datatypes.md#Filter).

  Este parámetro es incompatible en estos momentos.
+ **Marker** (en la CLI: `--marker`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud DescribeDBSubnetGroups anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.
+ **MaxRecords** (en la CLI: `--max-records`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

   El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación que se conoce como marcador, de modo que se pueda recuperar el resto de resultados.

  Predeterminado: 100

  Restricciones: mínimo 20, máximo 100.

**Respuesta**
+ **DBSubnetGroups**: matriz de objetos [DBSubnetGroup](#DBSubnetGroup).

   Una lista de instancias [DBSubnetGroup (estructura)](#DBSubnetGroup).
+ **Marker**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.

**Errores**
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)

## *Estructuras:*
<a name="api-subnets-structures-spacer"></a>

## Subred (estructura)
<a name="Subnet"></a>

Especifica una subred.

 Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBSubnetGroups (acción)](#DescribeDBSubnetGroups).

**Campos**
+ **SubnetAvailabilityZone**: se trata de un objeto [AvailabilityZone](api-datatypes.md#AvailabilityZone).

  Especifica la zona de disponibilidad de EC2 donde se encuentra la subred.
+ **SubnetIdentifier**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el identificador de la subred.
+ **SubnetStatus**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado de la subred.

## DBSubnetGroup (estructura)
<a name="DBSubnetGroup"></a>

Contiene los detalles de un grupo de subred de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBSubnetGroups (acción)](#DescribeDBSubnetGroups).

**Campos**
+ **DBSubnetGroupArn**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el grupo de subred de base de datos.
+ **DBSubnetGroupDescription**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la descripción del grupo de subred de base de datos.
+ **DBSubnetGroupName**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Nombre del grupo de subred de base de datos.
+ **SubnetGroupStatus**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el estado del grupo de subred de base de datos.
+ **Subnets**: se trata de una matriz de objetos [Subred](#Subnet).

   Contiene una lista de elementos [Subred (estructura)](#Subnet).
+ **VpcId**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el ID de VPC del grupo de subred de base de datos.

`DBSubnetGroup` se utiliza como el elemento de respuesta para:
+ [CreateDBSubnetGroup](#CreateDBSubnetGroup)
+ [ModifyDBSubnetGroup](#ModifyDBSubnetGroup)

# API de instantáneas de Neptune
<a name="api-snapshots"></a>

**Acciones:**
+ [CreateDBClusterSnapshot (acción)](#CreateDBClusterSnapshot)
+ [DeleteDBClusterSnapshot (acción)](#DeleteDBClusterSnapshot)
+ [CopyDBClusterSnapshot (acción)](#CopyDBClusterSnapshot)
+ [ModifyDBClusterSnapshotAttribute (acción)](#ModifyDBClusterSnapshotAttribute)
+ [RestoreDBClusterFromSnapshot (acción)](#RestoreDBClusterFromSnapshot)
+ [RestoreDBClusterToPointInTime (acción)](#RestoreDBClusterToPointInTime)
+ [DescribeDBClusterSnapshots (acción)](#DescribeDBClusterSnapshots)
+ [DescribeDBClusterSnapshotAttributes (acción)](#DescribeDBClusterSnapshotAttributes)

**Estructuras:**
+ [DBClusterSnapshot (estructura)](#DBClusterSnapshot)
+ [DBClusterSnapshotAttribute (estructura)](#DBClusterSnapshotAttribute)
+ [DBClusterSnapshotAttributesResult (estructura)](#DBClusterSnapshotAttributesResult)

## CreateDBClusterSnapshot (acción)
<a name="CreateDBClusterSnapshot"></a>

         El nombre de la AWS CLI para esta API es: `create-db-cluster-snapshot`.

Crea una instantánea de un clúster de base de datos.

**Solicitud**
+ **DBClusterIdentifier** (en la CLI: `--db-cluster-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador de la instantánea del clúster de base de datos para el que se va a crear una instantánea. Este parámetro no distingue entre mayúsculas y minúsculas.

  Restricciones:
  + Debe coincidir con el identificador de un DBCluster existente.

  Ejemplo:: `my-cluster1`
+ **DBClusterSnapshotIdentifier** (en la CLI: `--db-cluster-snapshot-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador de la instantánea del clúster de base de datos. Este parámetro se almacena como una cadena en minúsculas.

  Restricciones:
  + Deben contener de 1 a 63 caracteres (letras, números o guiones).
  + El primer carácter debe ser una letra.
  + No puede terminar por un guion ni contener dos guiones consecutivos.

  Ejemplo:: `my-cluster1-snapshot1`
+ **Tags** (en la CLI: `--tags`): una matriz de objetos [Tag](api-other-apis.md#Tag).

  Las etiquetas que se van a asignar a la instantánea del clúster de base de datos.

**Respuesta**

Contiene los detalles para una instantánea de clúster de base de datos de Amazon Neptune

Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBClusterSnapshots (acción)](#DescribeDBClusterSnapshots).
+ **AllocatedStorage**: un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el tamaño de almacenamiento asignado en gibibytes (GiB).
+ **AvailabilityZones**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la lista de zonas de disponibilidad de EC2 donde se pueden restaurar las instancias de la instantánea del clúster de base de datos.
+ **ClusterCreateTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la hora a la que se creó el clúster de base de datos, en tiempo universal coordinado (UTC).
+ **DBClusterIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el identificador del clúster de base de datos del clúster de base de datos a partir del cual se creó esta instantánea del clúster de base de datos.
+ **DBClusterSnapshotArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) de la instantánea del clúster de base de datos.
+ **DBClusterSnapshotIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el identificador de una instantánea de clúster de base de datos. Debe coincidir con el identificador de una instantánea existente.

  Después de restaurar un clúster de base de datos con un `DBClusterSnapshotIdentifier`, debe especificar el mismo `DBClusterSnapshotIdentifier` para cualquier actualización futura del clúster de base de datos. Cuando especifica esta propiedad para una actualización, el clúster de base de datos no se restaura de nuevo a partir de la instantánea de base de datos y los datos de la base de datos no se modifican.

  Sin embargo, si no especifica `DBClusterSnapshotIdentifier`, se crea un clúster de base de datos vacío y se elimina el clúster de base de datos original. Si especifica una propiedad diferente de la propiedad de restauración de la instantánea anterior, el clúster de base de datos se restaura a partir de la instantánea especificada por `DBClusterSnapshotIdentifier` y se elimina el clúster de base de datos original.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre del motor de base de datos.
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la versión del motor de base de datos para esta instantánea del clúster de base de datos.
+ **IAMDatabaseAuthenticationEnabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True (Verdadero) si la asignación de cuentas de Amazon Identity and Access Management (IAM) a cuentas de base de datos está habilitada; de lo contrario, el valor es false (falso).
+ **KmsKeyId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si el valor de `StorageEncrypted` es true, el identificador de la clave de Amazon KMS para la instantánea de clúster de base de datos cifrada.
+ **LicenseModel**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la información del modelo de licencia para esta instantánea del clúster de base de datos.
+ **PercentProgress**: un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el porcentaje de la estimación de los datos que se han transferido.
+ **Port**: un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto que el clúster de base de datos estaba escuchando en el momento de la instantánea.
+ **SnapshotCreateTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Proporciona la hora a la que se tomó la instantánea, en tiempo universal coordinado (UTC).
+ **SnapshotType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el tipo de instantánea del clúster de base de datos.
+ **SourceDBClusterSnapshotArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si la instantánea del clúster de base de datos se ha copiado de una instantánea de clúster de base de datos de origen, el Nombre de recurso de Amazon (ARN) para la instantánea del clúster de base de datos de origen, de lo contrario, un valor nulo.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado de esta instantánea del clúster de base de datos.
+ **StorageEncrypted**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si la instantánea del clúster de base de datos está cifrado.
+ **StorageType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de almacenamiento asociado a la instantánea del clúster de base de datos.
+ **VpcId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el ID de la VPC asociado a la instantánea de clúster de base de datos.

**Errores**
+ [DBClusterSnapshotAlreadyExistsFault](api-faults.md#DBClusterSnapshotAlreadyExistsFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [SnapshotQuotaExceededFault](api-faults.md#SnapshotQuotaExceededFault)
+ [InvalidDBClusterSnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)

## DeleteDBClusterSnapshot (acción)
<a name="DeleteDBClusterSnapshot"></a>

         El nombre de la AWS CLI para esta API es: `delete-db-cluster-snapshot`.

Elimina una instantánea de clúster de base de datos. Si se está copiando la instantánea, se termina la operación de copiado.

**nota**  
La instantánea del clúster de base de datos debe encontrarse en el estado `available` para su eliminación.

**Solicitud**
+ **DBClusterSnapshotIdentifier** (en la CLI: `--db-cluster-snapshot-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador de la instantánea del clúster de base de datos que se va a eliminar.

  Restricciones: debe ser el nombre de una instantánea del clúster de base de datos existente en el estado `available`.

**Respuesta**

Contiene los detalles para una instantánea de clúster de base de datos de Amazon Neptune

Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBClusterSnapshots (acción)](#DescribeDBClusterSnapshots).
+ **AllocatedStorage**: un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el tamaño de almacenamiento asignado en gibibytes (GiB).
+ **AvailabilityZones**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la lista de zonas de disponibilidad de EC2 donde se pueden restaurar las instancias de la instantánea del clúster de base de datos.
+ **ClusterCreateTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la hora a la que se creó el clúster de base de datos, en tiempo universal coordinado (UTC).
+ **DBClusterIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el identificador del clúster de base de datos del clúster de base de datos a partir del cual se creó esta instantánea del clúster de base de datos.
+ **DBClusterSnapshotArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) de la instantánea del clúster de base de datos.
+ **DBClusterSnapshotIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el identificador de una instantánea de clúster de base de datos. Debe coincidir con el identificador de una instantánea existente.

  Después de restaurar un clúster de base de datos con un `DBClusterSnapshotIdentifier`, debe especificar el mismo `DBClusterSnapshotIdentifier` para cualquier actualización futura del clúster de base de datos. Cuando especifica esta propiedad para una actualización, el clúster de base de datos no se restaura de nuevo a partir de la instantánea de base de datos y los datos de la base de datos no se modifican.

  Sin embargo, si no especifica `DBClusterSnapshotIdentifier`, se crea un clúster de base de datos vacío y se elimina el clúster de base de datos original. Si especifica una propiedad diferente de la propiedad de restauración de la instantánea anterior, el clúster de base de datos se restaura a partir de la instantánea especificada por `DBClusterSnapshotIdentifier` y se elimina el clúster de base de datos original.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre del motor de base de datos.
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la versión del motor de base de datos para esta instantánea del clúster de base de datos.
+ **IAMDatabaseAuthenticationEnabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True (Verdadero) si la asignación de cuentas de Amazon Identity and Access Management (IAM) a cuentas de base de datos está habilitada; de lo contrario, el valor es false (falso).
+ **KmsKeyId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si el valor de `StorageEncrypted` es true, el identificador de la clave de Amazon KMS para la instantánea de clúster de base de datos cifrada.
+ **LicenseModel**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la información del modelo de licencia para esta instantánea del clúster de base de datos.
+ **PercentProgress**: un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el porcentaje de la estimación de los datos que se han transferido.
+ **Port**: un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto que el clúster de base de datos estaba escuchando en el momento de la instantánea.
+ **SnapshotCreateTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Proporciona la hora a la que se tomó la instantánea, en tiempo universal coordinado (UTC).
+ **SnapshotType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el tipo de instantánea del clúster de base de datos.
+ **SourceDBClusterSnapshotArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si la instantánea del clúster de base de datos se ha copiado de una instantánea de clúster de base de datos de origen, el Nombre de recurso de Amazon (ARN) para la instantánea del clúster de base de datos de origen, de lo contrario, un valor nulo.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado de esta instantánea del clúster de base de datos.
+ **StorageEncrypted**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si la instantánea del clúster de base de datos está cifrado.
+ **StorageType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de almacenamiento asociado a la instantánea del clúster de base de datos.
+ **VpcId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el ID de la VPC asociado a la instantánea de clúster de base de datos.

**Errores**
+ [InvalidDBClusterSnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)

## CopyDBClusterSnapshot (acción)
<a name="CopyDBClusterSnapshot"></a>

         El nombre de la AWS CLI para esta API es: `copy-db-cluster-snapshot`.

Copia una instantánea de un clúster de base de datos.

Para copiar una instantánea del clúster de base de datos de una instantánea manual del clúster de base de datos compartida, `SourceDBClusterSnapshotIdentifier` debe ser el Nombre de recurso de Amazon (ARN) de la instantánea del clúster de base de datos compartida.

**Solicitud**
+ **CopyTags** (en la CLI: `--copy-tags`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  "True" para copiar todas las etiquetas de la instantánea del clúster de base de datos de origen a la instantánea del clúster de base de datos de destino, de lo contrario "false". El valor predeterminado es false.
+ **KmsKeyId** (en la CLI: `--kms-key-id`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  ID de la clave de Amazon KMS de una instantánea del clúster de base de datos cifrada. El ID de la clave de KMS es el Nombre de recurso de Amazon (ARN), el identificador de la clave de KMS o el alias de la clave de KMS de la clave de cifrado de KMS.

  Si copia una instantánea del clúster de base de datos cifrada desde la cuenta de Amazon, puede especificar un valor para `KmsKeyId` para cifrar la copia con una nueva clave de cifrado de KMS. Si no especifica ningún valor para `KmsKeyId`, la copia de la instantánea del clúster de base de datos se cifra con la misma clave de KMS que la instantánea del clúster de base de datos de origen.

  Si copia una instantánea del clúster de base de datos cifrada que se ha compartido desde otra cuenta de Amazon, debe especificar un valor para `KmsKeyId`.

   Las claves de cifrado KMS son específicas de la región de Amazon en la que se han creado y no se pueden utilizar las claves de cifrado de una región de Amazon en otra región de Amazon.

  No se puede cifrar un snapshot de clúster de base de datos sin cifrar durante el proceso de copia. Si intenta copiar un snapshot de clúster de base de datos sin cifrar y especificar un valor para el parámetro KmsKeyId, se devuelve un error.
+ **PreSignedUrl** (en la CLI: `--pre-signed-url`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No se admite actualmente.
+ **SourceDBClusterSnapshotIdentifier** (en la CLI: `--source-db-cluster-snapshot-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador de la instantánea del clúster de base de datos que se va a copiar. Este parámetro no distingue entre mayúsculas y minúsculas.

  Restricciones:
  + Se debe especificar una instantánea del sistema válida cuyo estado sea "available" (disponible).
  + Especifique un identificador de instantánea de base de datos válido.

  Ejemplo:: `my-cluster-snapshot1`
+ **Tags** (en la CLI: `--tags`): una matriz de objetos [Tag](api-other-apis.md#Tag).

  Las etiquetas que se van a asignar a la copia de la instantánea del clúster de base de datos nueva.
+ **TargetDBClusterSnapshotIdentifier** (en la CLI: `--target-db-cluster-snapshot-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador de la nueva instantánea del clúster de base de datos que se va a crear a partir de la instantánea del clúster de base de datos de origen. Este parámetro no distingue entre mayúsculas y minúsculas.

  Restricciones:
  + Deben contener de 1 a 63 caracteres (letras, números o guiones).
  + El primer carácter debe ser una letra.
  + No puede terminar por un guion ni contener dos guiones consecutivos.

  Ejemplo:: `my-cluster-snapshot2`

**Respuesta**

Contiene los detalles para una instantánea de clúster de base de datos de Amazon Neptune

Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBClusterSnapshots (acción)](#DescribeDBClusterSnapshots).
+ **AllocatedStorage**: un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el tamaño de almacenamiento asignado en gibibytes (GiB).
+ **AvailabilityZones**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la lista de zonas de disponibilidad de EC2 donde se pueden restaurar las instancias de la instantánea del clúster de base de datos.
+ **ClusterCreateTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la hora a la que se creó el clúster de base de datos, en tiempo universal coordinado (UTC).
+ **DBClusterIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el identificador del clúster de base de datos del clúster de base de datos a partir del cual se creó esta instantánea del clúster de base de datos.
+ **DBClusterSnapshotArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) de la instantánea del clúster de base de datos.
+ **DBClusterSnapshotIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el identificador de una instantánea de clúster de base de datos. Debe coincidir con el identificador de una instantánea existente.

  Después de restaurar un clúster de base de datos con un `DBClusterSnapshotIdentifier`, debe especificar el mismo `DBClusterSnapshotIdentifier` para cualquier actualización futura del clúster de base de datos. Cuando especifica esta propiedad para una actualización, el clúster de base de datos no se restaura de nuevo a partir de la instantánea de base de datos y los datos de la base de datos no se modifican.

  Sin embargo, si no especifica `DBClusterSnapshotIdentifier`, se crea un clúster de base de datos vacío y se elimina el clúster de base de datos original. Si especifica una propiedad diferente de la propiedad de restauración de la instantánea anterior, el clúster de base de datos se restaura a partir de la instantánea especificada por `DBClusterSnapshotIdentifier` y se elimina el clúster de base de datos original.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre del motor de base de datos.
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la versión del motor de base de datos para esta instantánea del clúster de base de datos.
+ **IAMDatabaseAuthenticationEnabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True (Verdadero) si la asignación de cuentas de Amazon Identity and Access Management (IAM) a cuentas de base de datos está habilitada; de lo contrario, el valor es false (falso).
+ **KmsKeyId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si el valor de `StorageEncrypted` es true, el identificador de la clave de Amazon KMS para la instantánea de clúster de base de datos cifrada.
+ **LicenseModel**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la información del modelo de licencia para esta instantánea del clúster de base de datos.
+ **PercentProgress**: un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el porcentaje de la estimación de los datos que se han transferido.
+ **Port**: un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto que el clúster de base de datos estaba escuchando en el momento de la instantánea.
+ **SnapshotCreateTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Proporciona la hora a la que se tomó la instantánea, en tiempo universal coordinado (UTC).
+ **SnapshotType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el tipo de instantánea del clúster de base de datos.
+ **SourceDBClusterSnapshotArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si la instantánea del clúster de base de datos se ha copiado de una instantánea de clúster de base de datos de origen, el Nombre de recurso de Amazon (ARN) para la instantánea del clúster de base de datos de origen, de lo contrario, un valor nulo.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado de esta instantánea del clúster de base de datos.
+ **StorageEncrypted**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si la instantánea del clúster de base de datos está cifrado.
+ **StorageType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de almacenamiento asociado a la instantánea del clúster de base de datos.
+ **VpcId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el ID de la VPC asociado a la instantánea de clúster de base de datos.

**Errores**
+ [DBClusterSnapshotAlreadyExistsFault](api-faults.md#DBClusterSnapshotAlreadyExistsFault)
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [InvalidDBClusterSnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)
+ [SnapshotQuotaExceededFault](api-faults.md#SnapshotQuotaExceededFault)
+ [KMSKeyNotAccessibleFault](api-faults.md#KMSKeyNotAccessibleFault)

## ModifyDBClusterSnapshotAttribute (acción)
<a name="ModifyDBClusterSnapshotAttribute"></a>

         El nombre de la AWS CLI para esta API es: `modify-db-cluster-snapshot-attribute`.

Añade un atributo y valores a una instantánea manual del clúster de base de datos o los elimina.

Para compartir una instantánea manual del clúster de base de datos con otras cuentas de Amazon, especifique `restore` como `AttributeName` y utilice el parámetro `ValuesToAdd` para añadir una lista de ID de las cuentas de Amazon autorizadas a restaurar la instantánea manual del clúster de base de datos. Utilice el valor `all` para convertir la instantánea manual del clúster de base de datos en pública, lo que significa que todas las cuentas de Amazon la pueden copiar o restaurar. No añada el valor `all` a ninguna instantánea manual del clúster de base de datos que incluya información privada que no quiera que esté disponible para todas las cuentas de Amazon. Si una instantánea manual del clúster de base de datos está cifrada, se podrá compartir, pero solo especificando una lista de ID de cuenta de Amazon autorizados para el parámetro `ValuesToAdd`. No se puede utilizar `all` como valor para ese parámetro en este caso.

Para ver qué cuentas de Amazon tienen acceso a la copia o restauración de una instantánea manual del clúster de base de datos o si una instantánea manual del clúster de base de datos es pública o privada, utilice la acción de la API [DescribeDBClusterSnapshotAttributes (acción)](#DescribeDBClusterSnapshotAttributes).

**Solicitud**
+ **AttributeName** (en la CLI: `--attribute-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del atributo de la instantánea del clúster de base de datos que se va a modificar.

  Para administrar la autorización para otras cuentas de Amazon para copiar o restaurar una instantánea manual del clúster de base de datos, establezca este valor en `restore`.
+ **DBClusterSnapshotIdentifier** (en la CLI: `--db-cluster-snapshot-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador para la instantánea del clúster de base de datos para el que se modifican los atributos.
+ **ValuesToAdd** (en la CLI: `--values-to-add`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de atributos de la instantánea del clúster de base de datos que desea añadir al atributo especificado por `AttributeName`.

  Para autorizar que otras cuentas de Amazon copien o restauren una instantánea manual del clúster de base de datos, establezca esta lista para incluir uno o varios identificadores de cuentas de Amazon, o `all` para que cualquier cuenta de Amazon pueda restaurar la instantánea manual del clúster de base de datos. No añada el valor `all` a ninguna instantánea manual del clúster de base de datos que incluya información privada que no quiera que esté disponible para todas las cuentas de Amazon.
+ **ValuesToRemove** (en la CLI: `--values-to-remove`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de atributos de la instantánea del clúster de base de datos que desea eliminar del atributo especificado por `AttributeName`.

  Para eliminar la autorización para que otras cuentas de Amazon copien o restauren una instantánea manual del clúster de base de datos, establezca esta lista para incluir uno o varios identificadores de cuentas de Amazon, o `all` para eliminar la autorización para que cualquier cuenta de Amazon pueda copiar o restaurar la instantánea del clúster de base de datos. Si especifica `all`, una cuenta de Amazon cuyo ID de cuenta se añade explícitamente al atributo `restore` puede seguir copiando o restaurando una instantánea manual del clúster de base de datos.

**Respuesta**

Contiene los resultados de una llamada realizada correctamente a la acción de la API [DescribeDBClusterSnapshotAttributes (acción)](#DescribeDBClusterSnapshotAttributes).

Los atributos de la instantánea manual del clúster de base de datos se utilizan para autorizar a otras cuentas de Amazon la copia o la restauración de una instantánea de clúster de base de datos manual. Para obtener más información, consulte la acción de la API [ModifyDBClusterSnapshotAttribute (acción)](#ModifyDBClusterSnapshotAttribute).
+ **DBClusterSnapshotAttributes**: matriz de objetos [DBClusterSnapshotAttribute](#DBClusterSnapshotAttribute).

  La lista de atributos y valores para la instantánea manual del clúster de base de datos.
+ **DBClusterSnapshotIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador de la instantánea manual del clúster de base de datos al que se aplican los atributos.

**Errores**
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)
+ [InvalidDBClusterSnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)
+ [SharedSnapshotQuotaExceededFault](api-faults.md#SharedSnapshotQuotaExceededFault)

## RestoreDBClusterFromSnapshot (acción)
<a name="RestoreDBClusterFromSnapshot"></a>

         El nombre de la AWS CLI para esta API es: `restore-db-cluster-from-snapshot`.

Crea un nuevo clúster de base de datos desde una instantánea de base de datos o una instantánea del clúster de base de datos.

Si se especifica una instantánea de base de datos, el clúster de base de datos de destino se crea a partir de la instantánea de base de datos de origen con una configuración predeterminada y grupo de seguridad predeterminado.

Si se especifica una instantánea del clúster de base de datos, el clúster de base de datos de destino se crea a partir del clúster de base de datos de origen con la misma configuración que el clúster de base de datos de origen original, salvo que el nuevo clúster de base de datos se crea con el grupo de seguridad predeterminado.

**Solicitud**
+ **AvailabilityZones** (en la CLI: `--availability-zones`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la lista de zonas de disponibilidad de EC2 donde se pueden crear las instancias del clúster de base de datos.
+ **CopyTagsToSnapshot** (en la CLI: `--copy-tags-to-snapshot`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  *Si se establece en `true`, las etiquetas se copian en cualquier instantánea del clúster restaurado de base de datos que se cree.*
+ **DatabaseName** (en la CLI: `--database-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No admitido.
+ **DBClusterIdentifier** (en la CLI: `--db-cluster-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del clúster de base de datos que se va a crear a partir de la instantánea de base de datos o de la instantánea del clúster de base de datos. Este parámetro no distingue entre mayúsculas y minúsculas.

  Restricciones:
  + Deben contener de 1 a 63 caracteres (letras, números o guiones).
  + El primer carácter debe ser una letra
  + No puede terminar por un guion ni contener dos guiones consecutivos

  Ejemplo:: `my-snapshot-id`
+ **DBClusterParameterGroupName** (en la CLI: `--db-cluster-parameter-group-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del grupo de parámetros del clúster de base de datos que desea asociar a este nuevo clúster de base de datos.

  Restricciones:
  + Si se suministra, debe coincidir con el nombre de un DBClusterParameterGroup existente.
+ **DBSubnetGroupName** (en la CLI: `--db-subnet-group-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del grupo de subredes de base de datos que se va a usar para el clúster de base de datos nuevo.

  Restricciones: si se proporciona, debe coincidir con el nombre de un DBSubnetGroup existente.

  Ejemplo:: `mySubnetgroup`
+ **DeletionProtection** (en la CLI: `--deletion-protection`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor que indica si el clúster de base de datos tiene habilitada la protección contra eliminación. La base de datos no se puede eliminar cuando está habilitada la protección contra eliminación. La protección contra eliminación está deshabilitada de forma predeterminada. 
+ **EnableCloudwatchLogsExports** (en la CLI: `--enable-cloudwatch-logs-exports`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La lista de registros que el clúster de base de datos restaurado debe exportar a Amazon CloudWatch logs.
+ **EnableIAMDatabaseAuthentication** (en la CLI: `--enable-iam-database-authentication`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  True para habilitar el mapeo de cuentas de Amazon Identity and Access Management (IAM) a cuentas de base de datos; de lo contrario, el valor es False.

  Predeterminado: `false`
+ **Engine** (en la CLI: `--engine`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Motor de base de datos que se va a usar para el clúster de base de datos nuevo.

  Predeterminado: igual que el de origen

  Restricción: debe ser compatible con el motor del origen
+ **EngineVersion** (en la CLI: `--engine-version`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La versión del motor de base de datos que se va a usar para el clúster de base de datos nuevo.
+ **KmsKeyId** (en la CLI: `--kms-key-id`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador de la clave de Amazon KMS que se utiliza para restaurar un clúster de base de datos cifrado a partir de una instantánea de base de datos o de clúster de base de datos.

  El identificador de la clave de KMS es el Nombre de recurso de Amazon (ARN) de la clave de cifrado de KMS. Si está restaurando un clúster de base de datos con la misma cuenta de Amazon a la que pertenece la clave de cifrado de KMS utilizada para cifrar el nuevo clúster de base de datos, puede utilizar el alias de la clave de KMS en lugar del ARN de la clave de cifrado de KMS.

  Si no se especifica un valor para el parámetro `KmsKeyId`, ocurrirá lo siguiente:
  + Si se cifra la instantánea de base de datos o de clúster de base de datos `SnapshotIdentifier`, se cifra el clúster de base de datos restaurado con la clave de KMS que se utilizó para cifrar la instantánea de base de datos o de clúster de base de datos.
  + Si la instantánea de base de datos o del clúster de base de datos de `SnapshotIdentifier` no está cifrada, el clúster de base de datos restaurado no está cifrado.
+ **Port** (en la CLI: `--port`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El número de puerto en el que el clúster de base de datos nuevo acepta las conexiones.

  Limitaciones: el valor debe ser `1150-65535`

  Valor predeterminado: el mismo puerto que el clúster de base de datos original.
+ **ServerlessV2ScalingConfiguration** (en la CLI: `--serverless-v2-scaling-configuration`): un objeto [ServerlessV2ScalingConfiguration](api-datatypes.md#ServerlessV2ScalingConfiguration).

  Incluye la configuración de escalado de un clúster de base de datos de Neptune sin servidor.

  Para obtener más información, consulte [Uso de Amazon Neptune sin servidor](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) en la *Guía del usuario de Amazon Neptune*.
+ **SnapshotIdentifier** (en la CLI: `--snapshot-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Identificador de la instantánea de base de datos o instantánea del clúster de base de datos desde la que se debe realizar la restauración.

  Puede utilizar el nombre o el Nombre de recurso de Amazon (ARN) para especificar una instantánea del clúster de base de datos. Sin embargo, puede utilizar únicamente el ARN para especificar una instantánea de base de datos.

  Restricciones:
  + Debe coincidir con el identificador de una instantánea existente.
+ **StorageType** (en la CLI: `--storage-type`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el tipo de almacenamiento que se va a asociar al clúster de base de datos.

  Valores válidos: `standard`, `iopt1`

  Valor predeterminado: `standard`
+ **Tags** (en la CLI: `--tags`): una matriz de objetos [Tag](api-other-apis.md#Tag).

  Las etiquetas que se van a asignar al clúster de base de datos restaurado.
+ **VpcSecurityGroupIds** (en la CLI: `--vpc-security-group-ids`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de grupos de seguridad de VPC a los que va a pertenecer el clúster de base de datos nuevo.

**Respuesta**

Contiene los detalles de un clúster de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en [DescribeDBClusters (acción)](api-clusters.md#DescribeDBClusters).
+ **AllocatedStorage**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  `AllocatedStorage` siempre devuelve 1, ya que el tamaño de almacenamiento del clúster de base de datos de Neptune no es fijo, sino que se ajusta automáticamente según sea necesario.
+ **AssociatedRoles**: matriz de objetos [DBClusterRole](api-clusters.md#DBClusterRole).

  Proporciona una lista de los roles de Amazon Identity and Access Management (IAM) que están asociados con el clúster de base de datos. Los roles de IAM que están asociados a un clúster de base de datos conceden permiso para que este obtenga acceso a otros servicios de Amazon en su nombre.
+ **AutomaticRestartTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Hora en la que el clúster de base de datos se reiniciará automáticamente.
+ **AvailabilityZones**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la lista de zonas de disponibilidad de EC2 en las que se pueden crear instancias en el clúster de base de datos.
+ **BacktrackConsumedChangeRecords**: un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BacktrackWindow**: un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BackupRetentionPeriod**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
+ **Capacity**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  No es compatible con Neptune.
+ **CloneGroupId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Identifica el grupo de clones al que está asociado el clúster de base de datos.
+ **ClusterCreateTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la hora a la que se creó el clúster de base de datos, en tiempo universal coordinado (UTC).
+ **CopyTagsToSnapshot**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  *Si se establece en `true`, las etiquetas se copian en cualquier instantánea del clúster de base de datos que se cree.*
+ **CrossAccountClone**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Si se establece en `true`, el clúster de base de datos se puede clonar en todas las cuentas.
+ **DatabaseName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el nombre de la base de datos inicial de este clúster de base de datos que se proporcionó en el momento de la creación, si se especificó uno cuando se creó el clúster de base de datos. Este mismo nombre se devuelve durante el tiempo que dura el clúster de base de datos.
+ **DBClusterArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el clúster de base de datos.
+ **DBClusterIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DBClusterMembers**: matriz de objetos [DBClusterMember](api-clusters.md#DBClusterMember).

  Proporciona la lista de instancias que componen el clúster de base de datos.
+ **DBClusterParameterGroup**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre del grupo de parámetros del clúster de base de datos para el clúster de base de datos.
+ **DbClusterResourceId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador inmutable único de la región de Amazon para el clúster de base de datos. Este identificador se encuentra en las entradas de registro de Amazon CloudTrail siempre que se accede a la clave de Amazon KMS para el clúster de base de datos.
+ **DBSubnetGroup**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DeletionProtection**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si el clúster de base de datos tiene habilitada la protección contra eliminación o no. La base de datos no se puede eliminar cuando está habilitada la protección contra eliminación.
+ **EarliestBacktrackTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  No es compatible con Neptune.
+ **EarliestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **EnabledCloudwatchLogsExports**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de tipos de registro para los que este clúster de base de datos está configurado para exportar a los registros de CloudWatch. Los tipos de registro válidos son: `audit` (para publicar registros de auditoría en CloudWatch) y slowquery (para publicar registros de consultas lentas en CloudWatch). Consulte [Publicación de registros de Neptune en Registros de Amazon CloudWatch](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el punto de enlace de conexión para la instancia principal del clúster de base de datos.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del motor de base de datos que se debe utilizar para este clúster de base de datos.
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica la versión del motor de base de datos.
+ **GlobalClusterIdentifier**: un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  Incluye un identificador de clúster de base de datos global facilitado por el usuario. Este identificador es la clave única que identifica una base de datos global.
+ **HostedZoneId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el ID que Amazon Route 53 asigna al crear una zona alojada.
+ **IAMDatabaseAuthenticationEnabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True (Verdadero) si la asignación de cuentas de Amazon Identity and Access Management (IAM) a cuentas de base de datos está habilitada; de lo contrario, el valor es false (falso).
+ **IOOptimizedNextAllowedModificationTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  La próxima vez, podrá modificar el clúster de base de datos para utilizar el tipo de almacenamiento `iopt1`.
+ **KmsKeyId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si el valor de `StorageEncrypted` es true (verdadero), el identificador de la clave de Amazon KMS para el clúster de base de datos cifrado.
+ **LatestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **MultiAZ**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos tiene instancias en varias zonas de disponibilidad.
+ **PendingModifiedValues**: un objeto [ClusterPendingModifiedValues](api-clusters.md#ClusterPendingModifiedValues).

  Este tipo de datos se utiliza como un elemento de respuesta en la operación `ModifyDBCluster` e incluye cambios que se aplicarán durante el siguiente periodo de mantenimiento.
+ **PercentProgress**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el progreso de la operación como porcentaje.
+ **Port**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto en el que escucha el motor de la base de datos.
+ **PreferredBackupWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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`.
+ **PreferredMaintenanceWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
+ **ReaderEndpoint**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El punto de enlace del lector para el clúster de base de datos. El punto de enlace del lector de un clúster de base de datos equilibra la carga de las conexiones entre las réplicas de lectura que están disponibles en un clúster de base de datos. A medida que los clientes solicitan nuevas conexiones al punto de enlace del lector, Neptune distribuye las solicitudes de conexión entre las réplicas de lectura del clúster de base de datos. Esta funcionalidad puede ayudar a equilibrar la carga de trabajo de lectura entre las distintas réplicas de lectura en el clúster de base de datos.

  Si se produce una conmutación por error y la réplica de lectura a la que está conectado se convierte en la nueva instancia principal, la conexión se interrumpe. Para seguir enviando la carga de trabajo de lectura a otras réplicas de lectura del clúster, puede volver a conectarse al punto de enlace del lector.
+ **ReadReplicaIdentifiers**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de las réplicas de lectura asociados con este clúster de base de datos.
+ **ReplicationSourceIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ReplicationType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ServerlessV2ScalingConfiguration**: un objeto [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

  Muestra la configuración de escalado de un clúster de base de datos de Neptune sin servidor.

  Para obtener más información, consulte [Uso de Amazon Neptune sin servidor](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) en la *Guía del usuario de Amazon Neptune*.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de este clúster de base de datos.
+ **StorageEncrypted**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos está cifrado.
+ **StorageType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de almacenamiento que se utiliza para el clúster de base de datos.

  Valores válidos:
  + **`standard`**: (*predeterminado*) proporciona un almacenamiento de bases de datos rentable para aplicaciones con un uso de E/S de moderado a pequeño.
  + **`iopt1`**: habilita el [almacenamiento optimizado para E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage) que está diseñado para satisfacer las necesidades de las cargas de trabajo de gráficos con uso intensivo de operaciones de E/S que requieren precios predecibles con una latencia de E/S baja y un rendimiento de E/S constante.

    El almacenamiento optimizado para E/S de Neptune solo está disponible a partir de la versión 1.3.0.0 del motor.
+ **VpcSecurityGroups**: matriz de objetos [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Errores**
+ [DBClusterAlreadyExistsFault](api-faults.md#DBClusterAlreadyExistsFault)
+ [DBClusterQuotaExceededFault](api-faults.md#DBClusterQuotaExceededFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [DBSnapshotNotFoundFault](api-faults.md#DBSnapshotNotFoundFault)
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)
+ [InsufficientDBClusterCapacityFault](api-faults.md#InsufficientDBClusterCapacityFault)
+ [InsufficientStorageClusterCapacityFault](api-faults.md#InsufficientStorageClusterCapacityFault)
+ [InvalidDBSnapshotStateFault](api-faults.md#InvalidDBSnapshotStateFault)
+ [InvalidDBClusterSnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [InvalidVPCNetworkStateFault](api-faults.md#InvalidVPCNetworkStateFault)
+ [InvalidRestoreFault](api-faults.md#InvalidRestoreFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)
+ [OptionGroupNotFoundFault](api-faults.md#OptionGroupNotFoundFault)
+ [KMSKeyNotAccessibleFault](api-faults.md#KMSKeyNotAccessibleFault)
+ [DBClusterParameterGroupNotFoundFault](api-faults.md#DBClusterParameterGroupNotFoundFault)

## RestoreDBClusterToPointInTime (acción)
<a name="RestoreDBClusterToPointInTime"></a>

         El nombre de la AWS CLI para esta API es: `restore-db-cluster-to-point-in-time`.

Restaura un clúster de base de datos a un punto arbitrario en el tiempo. Los usuarios pueden restaurar a cualquier punto en el tiempo antes de `LatestRestorableTime` durante un máximo de `BackupRetentionPeriod` días. El clúster de base de datos de destino se crea a partir del clúster de base de datos de origen con la misma configuración que el clúster de base de datos de origen original, salvo que el nuevo clúster de base de datos se crea con el grupo de seguridad de base de datos predeterminado.

**nota**  
Esta acción solo restaura el clúster de base de datos, no las instancias de base de datos de ese clúster de base de datos. Debe invocar la acción [CreateDBInstance (acción)](api-instances.md#CreateDBInstance) para crear instancias de base de datos para el clúster de base de datos restaurado, especificando el identificador de dicho clúster de base de datos restaurado en `DBClusterIdentifier`. Solo puede crear instancias de base de datos después de que se haya completado la acción `RestoreDBClusterToPointInTime` y de que el clúster de base de datos esté disponible.

**Solicitud**
+ **DBClusterIdentifier** (en la CLI: `--db-cluster-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Nombre del nuevo clúster de base de datos que se va a crear.

  Restricciones:
  + Deben contener de 1 a 63 caracteres (letras, números o guiones).
  + El primer carácter debe ser una letra
  + No puede terminar por un guion ni contener dos guiones consecutivos
+ **DBClusterParameterGroupName** (en la CLI: `--db-cluster-parameter-group-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del grupo de parámetros del clúster de base de datos que desea asociar a este nuevo clúster de base de datos.

  Restricciones:
  + Si se suministra, debe coincidir con el nombre de un DBClusterParameterGroup existente.
+ **DBSubnetGroupName** (en la CLI: `--db-subnet-group-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del grupo de subredes de base de datos que se debe utilizar para el clúster de base de datos nuevo.

  Restricciones: si se proporciona, debe coincidir con el nombre de un DBSubnetGroup existente.

  Ejemplo:: `mySubnetgroup`
+ **DeletionProtection** (en la CLI: `--deletion-protection`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor que indica si el clúster de base de datos tiene habilitada la protección contra eliminación. La base de datos no se puede eliminar cuando está habilitada la protección contra eliminación. La protección contra eliminación está deshabilitada de forma predeterminada. 
+ **EnableCloudwatchLogsExports** (en la CLI: `--enable-cloudwatch-logs-exports`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La lista de registros que el clúster de base de datos restaurado debe exportar a CloudWatch Logs.
+ **EnableIAMDatabaseAuthentication** (en la CLI: `--enable-iam-database-authentication`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  True para habilitar el mapeo de cuentas de Amazon Identity and Access Management (IAM) a cuentas de base de datos; de lo contrario, el valor es False.

  Predeterminado: `false`
+ **KmsKeyId** (en la CLI: `--kms-key-id`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador de la clave de Amazon KMS que se utiliza para restaurar un clúster de base de datos cifrado a partir de un clúster de base de datos cifrado.

  El identificador de la clave de KMS es el Nombre de recurso de Amazon (ARN) de la clave de cifrado de KMS. Si está restaurando un clúster de base de datos con la misma cuenta de Amazon a la que pertenece la clave de cifrado de KMS utilizada para cifrar el nuevo clúster de base de datos, puede utilizar el alias de la clave de KMS en lugar del ARN de la clave de cifrado de KMS.

  Puede restaurar a un nuevo clúster de base de datos y cifrar el nuevo clúster de base de datos con una clave de KMS que es diferente de la clave de KMS utilizada para cifrar el clúster de base de datos de origen. El nuevo clúster de base de datos se cifra con la clave de KMS identificada por el parámetro `KmsKeyId`.

  Si no se especifica un valor para el parámetro `KmsKeyId`, ocurrirá lo siguiente:
  + Si el clúster de base de datos está cifrado, el clúster de base de datos restaurado se cifra usando la misma clave de KMS que se usó para cifrar el clúster de base de datos de origen.
  + Si el clúster de base de datos no está cifrado, el clúster de base de datos restaurado no está cifrado.

  Si `DBClusterIdentifier` se refiere a un clúster de base de datos que no está cifrada, se rechaza la solicitud de restauración.
+ **Port** (en la CLI: `--port`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El número de puerto en el que el clúster de base de datos nuevo acepta las conexiones.

  Limitaciones: el valor debe ser `1150-65535`

  Valor predeterminado: el mismo puerto que el clúster de base de datos original.
+ **RestoreToTime** (en la CLI: `--restore-to-time`): un TStamp, del tipo: `timestamp` (un punto en el tiempo, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  La fecha y la hora a la que se va a restaurar el clúster de base de datos.

  Valores válidos: el valor debe ser una hora en formato de tiempo universal coordinado (UTC)

  Restricciones:
  + Debe ser anterior a la última hora restaurable de la instancia de base de datos
  + Debe especificarse si no se proporciona el parámetro `UseLatestRestorableTime`
  + No se puede especificar si el parámetro `UseLatestRestorableTime` es "true"
  + No se puede especificar si el parámetro `RestoreType` es `copy-on-write`

  Ejemplo:: `2015-03-07T23:45:00Z`
+ **RestoreType** (en la CLI: `--restore-type`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de restauración que se va a realizar. Puede especificar uno de los siguientes valores:
  +  `full-copy`: el nuevo clúster de base de datos se restaura como una copia completa del clúster de la base de datos de origen.
  +  `copy-on-write`: el nuevo clúster de base de datos se restaura como un clon del clúster de la base de datos de origen.

  Si no especifica un valor `RestoreType`, el nuevo clúster de base de datos se restaura como una copia completa del clúster de la base de datos de origen.
+ **ServerlessV2ScalingConfiguration** (en la CLI: `--serverless-v2-scaling-configuration`): un objeto [ServerlessV2ScalingConfiguration](api-datatypes.md#ServerlessV2ScalingConfiguration).

  Incluye la configuración de escalado de un clúster de base de datos de Neptune sin servidor.

  Para obtener más información, consulte [Uso de Amazon Neptune sin servidor](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) en la *Guía del usuario de Amazon Neptune*.
+ **SourceDBClusterIdentifier** (en la CLI: `--source-db-cluster-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Identificador del clúster de base de datos de origen desde la que se va a restaurar el clúster.

  Restricciones:
  + Debe coincidir con el identificador de un DBCluster existente.
+ **StorageType** (en la CLI: `--storage-type`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el tipo de almacenamiento que se va a asociar al clúster de base de datos.

  Valores válidos: `standard`, `iopt1`

  Valor predeterminado: `standard`
+ **Tags** (en la CLI: `--tags`): una matriz de objetos [Tag](api-other-apis.md#Tag).

  Las etiquetas que se van a aplicar al clúster de base de datos restaurado.
+ **UseLatestRestorableTime** (en la CLI: `--use-latest-restorable-time`): un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor que se establece en `true` para restaurar el clúster de base de datos a la hora de la última copia de seguridad restaurable y `false` en caso contrario.

  Predeterminado: `false`

  Restricciones: no se pueden especificar si se proporciona el parámetro `RestoreToTime`.
+ **VpcSecurityGroupIds** (en la CLI: `--vpc-security-group-ids`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

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

**Respuesta**

Contiene los detalles de un clúster de base de datos de Amazon Neptune.

Este tipo de datos se utiliza como un elemento de respuesta en [DescribeDBClusters (acción)](api-clusters.md#DescribeDBClusters).
+ **AllocatedStorage**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  `AllocatedStorage` siempre devuelve 1, ya que el tamaño de almacenamiento del clúster de base de datos de Neptune no es fijo, sino que se ajusta automáticamente según sea necesario.
+ **AssociatedRoles**: matriz de objetos [DBClusterRole](api-clusters.md#DBClusterRole).

  Proporciona una lista de los roles de Amazon Identity and Access Management (IAM) que están asociados con el clúster de base de datos. Los roles de IAM que están asociados a un clúster de base de datos conceden permiso para que este obtenga acceso a otros servicios de Amazon en su nombre.
+ **AutomaticRestartTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Hora en la que el clúster de base de datos se reiniciará automáticamente.
+ **AvailabilityZones**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la lista de zonas de disponibilidad de EC2 en las que se pueden crear instancias en el clúster de base de datos.
+ **BacktrackConsumedChangeRecords**: un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BacktrackWindow**: un valor LongOptional, del tipo: `long` (valor entero firmado de 64 bits).

  No es compatible con Neptune.
+ **BackupRetentionPeriod**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el número de días durante los que se conservan las instantáneas de base de datos automáticas.
+ **Capacity**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  No es compatible con Neptune.
+ **CloneGroupId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Identifica el grupo de clones al que está asociado el clúster de base de datos.
+ **ClusterCreateTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la hora a la que se creó el clúster de base de datos, en tiempo universal coordinado (UTC).
+ **CopyTagsToSnapshot**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  *Si se establece en `true`, las etiquetas se copian en cualquier instantánea del clúster de base de datos que se cree.*
+ **CrossAccountClone**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Si se establece en `true`, el clúster de base de datos se puede clonar en todas las cuentas.
+ **DatabaseName**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene el nombre de la base de datos inicial de este clúster de base de datos que se proporcionó en el momento de la creación, si se especificó uno cuando se creó el clúster de base de datos. Este mismo nombre se devuelve durante el tiempo que dura el clúster de base de datos.
+ **DBClusterArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el clúster de base de datos.
+ **DBClusterIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DBClusterMembers**: matriz de objetos [DBClusterMember](api-clusters.md#DBClusterMember).

  Proporciona la lista de instancias que componen el clúster de base de datos.
+ **DBClusterParameterGroup**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre del grupo de parámetros del clúster de base de datos para el clúster de base de datos.
+ **DbClusterResourceId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador inmutable único de la región de Amazon para el clúster de base de datos. Este identificador se encuentra en las entradas de registro de Amazon CloudTrail siempre que se accede a la clave de Amazon KMS para el clúster de base de datos.
+ **DBSubnetGroup**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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.
+ **DeletionProtection**: un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si el clúster de base de datos tiene habilitada la protección contra eliminación o no. La base de datos no se puede eliminar cuando está habilitada la protección contra eliminación.
+ **EarliestBacktrackTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  No es compatible con Neptune.
+ **EarliestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **EnabledCloudwatchLogsExports**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de tipos de registro para los que este clúster de base de datos está configurado para exportar a los registros de CloudWatch. Los tipos de registro válidos son: `audit` (para publicar registros de auditoría en CloudWatch) y slowquery (para publicar registros de consultas lentas en CloudWatch). Consulte [Publicación de registros de Neptune en Registros de Amazon CloudWatch](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el punto de enlace de conexión para la instancia principal del clúster de base de datos.
+ **Engine**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el nombre del motor de base de datos que se debe utilizar para este clúster de base de datos.
+ **EngineVersion**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica la versión del motor de base de datos.
+ **GlobalClusterIdentifier**: un GlobalClusterIdentifier, del tipo: `string` (una cadena codificada con UTF-8), no menos de 1 ni superior a 255 ¿st?s, que coincide con esta expresión regular: `[A-Za-z][0-9A-Za-z-:._]*`.

  Incluye un identificador de clúster de base de datos global facilitado por el usuario. Este identificador es la clave única que identifica una base de datos global.
+ **HostedZoneId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el ID que Amazon Route 53 asigna al crear una zona alojada.
+ **IAMDatabaseAuthenticationEnabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True (Verdadero) si la asignación de cuentas de Amazon Identity and Access Management (IAM) a cuentas de base de datos está habilitada; de lo contrario, el valor es false (falso).
+ **IOOptimizedNextAllowedModificationTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  La próxima vez, podrá modificar el clúster de base de datos para utilizar el tipo de almacenamiento `iopt1`.
+ **KmsKeyId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si el valor de `StorageEncrypted` es true (verdadero), el identificador de la clave de Amazon KMS para el clúster de base de datos cifrado.
+ **LatestRestorableTime**: un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
+ **MultiAZ**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos tiene instancias en varias zonas de disponibilidad.
+ **PendingModifiedValues**: un objeto [ClusterPendingModifiedValues](api-clusters.md#ClusterPendingModifiedValues).

  Este tipo de datos se utiliza como un elemento de respuesta en la operación `ModifyDBCluster` e incluye cambios que se aplicarán durante el siguiente periodo de mantenimiento.
+ **PercentProgress**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el progreso de la operación como porcentaje.
+ **Port**: un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto en el que escucha el motor de la base de datos.
+ **PreferredBackupWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  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`.
+ **PreferredMaintenanceWindow**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
+ **ReaderEndpoint**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El punto de enlace del lector para el clúster de base de datos. El punto de enlace del lector de un clúster de base de datos equilibra la carga de las conexiones entre las réplicas de lectura que están disponibles en un clúster de base de datos. A medida que los clientes solicitan nuevas conexiones al punto de enlace del lector, Neptune distribuye las solicitudes de conexión entre las réplicas de lectura del clúster de base de datos. Esta funcionalidad puede ayudar a equilibrar la carga de trabajo de lectura entre las distintas réplicas de lectura en el clúster de base de datos.

  Si se produce una conmutación por error y la réplica de lectura a la que está conectado se convierte en la nueva instancia principal, la conexión se interrumpe. Para seguir enviando la carga de trabajo de lectura a otras réplicas de lectura del clúster, puede volver a conectarse al punto de enlace del lector.
+ **ReadReplicaIdentifiers**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Contiene uno o varios identificadores de las réplicas de lectura asociados con este clúster de base de datos.
+ **ReplicationSourceIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ReplicationType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  No es compatible con Neptune.
+ **ServerlessV2ScalingConfiguration**: un objeto [ServerlessV2ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

  Muestra la configuración de escalado de un clúster de base de datos de Neptune sin servidor.

  Para obtener más información, consulte [Uso de Amazon Neptune sin servidor](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) en la *Guía del usuario de Amazon Neptune*.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado actual de este clúster de base de datos.
+ **StorageEncrypted**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si el clúster de base de datos está cifrado.
+ **StorageType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de almacenamiento que se utiliza para el clúster de base de datos.

  Valores válidos:
  + **`standard`**: (*predeterminado*) proporciona un almacenamiento de bases de datos rentable para aplicaciones con un uso de E/S de moderado a pequeño.
  + **`iopt1`**: habilita el [almacenamiento optimizado para E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage) que está diseñado para satisfacer las necesidades de las cargas de trabajo de gráficos con uso intensivo de operaciones de E/S que requieren precios predecibles con una latencia de E/S baja y un rendimiento de E/S constante.

    El almacenamiento optimizado para E/S de Neptune solo está disponible a partir de la versión 1.3.0.0 del motor.
+ **VpcSecurityGroups**: matriz de objetos [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Errores**
+ [DBClusterAlreadyExistsFault](api-faults.md#DBClusterAlreadyExistsFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [DBClusterQuotaExceededFault](api-faults.md#DBClusterQuotaExceededFault)
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [InsufficientDBClusterCapacityFault](api-faults.md#InsufficientDBClusterCapacityFault)
+ [InsufficientStorageClusterCapacityFault](api-faults.md#InsufficientStorageClusterCapacityFault)
+ [InvalidDBClusterSnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)
+ [InvalidDBClusterStateFault](api-faults.md#InvalidDBClusterStateFault)
+ [InvalidDBSnapshotStateFault](api-faults.md#InvalidDBSnapshotStateFault)
+ [InvalidRestoreFault](api-faults.md#InvalidRestoreFault)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)
+ [InvalidVPCNetworkStateFault](api-faults.md#InvalidVPCNetworkStateFault)
+ [KMSKeyNotAccessibleFault](api-faults.md#KMSKeyNotAccessibleFault)
+ [OptionGroupNotFoundFault](api-faults.md#OptionGroupNotFoundFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [DBClusterParameterGroupNotFoundFault](api-faults.md#DBClusterParameterGroupNotFoundFault)

## DescribeDBClusterSnapshots (acción)
<a name="DescribeDBClusterSnapshots"></a>

         El nombre de la AWS CLI para esta API es: `describe-db-cluster-snapshots`.

Devuelve información acerca de instantáneas del clúster de base de datos. Esta acción de la API admite la paginación.

**Solicitud**
+ **DBClusterIdentifier** (en la CLI: `--db-cluster-identifier`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ID del clúster de base de datos para recuperar la lista de instantáneas del clúster de base de datos. Este parámetro no puede usarse en combinación con el parámetro `DBClusterSnapshotIdentifier`. Este parámetro no distingue entre mayúsculas y minúsculas.

  Restricciones:
  + Si se proporciona, debe coincidir con el identificador de un DBCluster existente.
+ **DBClusterSnapshotIdentifier** (en la CLI: `--db-cluster-snapshot-identifier`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Un identificador de instantánea de clúster de base de datos específica para describir. Este parámetro no puede usarse en combinación con el parámetro `DBClusterIdentifier`. Este valor se almacena como una cadena en minúsculas.

  Restricciones:
  + Si se proporciona, debe coincidir con el identificador de una DBClusterSnapshot existente.
  + Si este identificador es para una instantánea automatizada, también se debe especificar el parámetro `SnapshotType`.
+ **Filters** (en la CLI: `--filters`): una matriz de objetos [Filtro](api-datatypes.md#Filter).

  Este parámetro es incompatible en estos momentos.
+ **IncludePublic** (en la CLI: `--include-public`): un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True para incluir instantáneas del clúster de base de datos manuales que son públicas y que cualquier cuenta de Amazon puede copiar o restaurar; de lo contrario, el valor es False. El valor predeterminado es `false`. El valor predeterminado es false.

  Con la acción de la API [ModifyDBClusterSnapshotAttribute (acción)](#ModifyDBClusterSnapshotAttribute), es posible compartir una instantánea manual del clúster de base de datos:
+ **IncludeShared** (en la CLI: `--include-shared`): un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True para incluir instantáneas del clúster de base de datos manual compartidas de otras cuentas de Amazon a las que esta cuenta de Amazon ha dado permiso para copiar o restaurar; de lo contrario, el valor es False. El valor predeterminado es `false`.

  Puede dar permiso a una cuenta de Amazon para restaurar una instantánea manual del clúster de base de datos desde otra cuenta de Amazon mediante la acción [ModifyDBClusterSnapshotAttribute (acción)](#ModifyDBClusterSnapshotAttribute) de la API.
+ **Marker** (en la CLI: `--marker`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Un token de paginación opcional proporcionado por una solicitud `DescribeDBClusterSnapshots` anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`. 
+ **MaxRecords** (en la CLI: `--max-records`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación que se conoce como marcador, de modo que se pueda recuperar el resto de resultados.

  Predeterminado: 100

  Restricciones: mínimo 20, máximo 100.
+ **SnapshotType** (en la CLI: `--snapshot-type`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de instantáneas del clúster de base de datos que se van a devolver. Puede especificar uno de los siguientes valores:
  +  `automated`: permite devolver todas las instantáneas del clúster de base de datos que ha tomado automáticamente Amazon Neptune para mi cuenta de Amazon.
  +  `manual`: permite devolver todas las instantáneas del clúster de base de datos tomadas por mi cuenta de Amazon.
  +  `shared`: permite devolver todas las instantáneas del clúster de base de datos manual que se han compartido a mi cuenta de Amazon.
  +  `public`: devolver todas las instantáneas del clúster de base de datos que se han marcado como públicas.

  Si no se especifica ningún valor para `SnapshotType`, se devuelve las instantáneas del clúster de base de datos automatizadas y manuales. Puede incluir instantáneas del clúster de base de datos compartidas con estos resultados estableciendo el parámetro `IncludeShared` en `true`. Puede incluir instantáneas del clúster de base de datos públicas con estos resultados estableciendo el parámetro `IncludePublic` en `true`.

  Los parámetros `IncludeShared` y `IncludePublic` no se aplican para los valores de `SnapshotType` de `manual` o `automated`. El parámetro `IncludePublic` no se aplica cuando se establece `SnapshotType` en `shared`. El parámetro `IncludeShared` no se aplica cuando se establece `SnapshotType` en `public`.

**Respuesta**
+ **DBClusterSnapshots**: matriz de objetos [DBClusterSnapshot](#DBClusterSnapshot).

  Proporciona una lista de instantáneas del clúster de base de datos para el usuario.
+ **Marker**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud [DescribeDBClusterSnapshots (acción)](#DescribeDBClusterSnapshots) anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`. 

**Errores**
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)

## DescribeDBClusterSnapshotAttributes (acción)
<a name="DescribeDBClusterSnapshotAttributes"></a>

         El nombre de la AWS CLI para esta API es: `describe-db-cluster-snapshot-attributes`.

Devuelve una lista de nombres y valores de atributos de instantáneas de clúster de base de datos y valores para una instantánea manual del clúster de base de datos.

Cuando se comparten instantáneas con otras cuentas de Amazon, `DescribeDBClusterSnapshotAttributes` devuelve el atributo `restore` y una lista de ID de las cuentas de Amazon que tienen autorización para copiar o restaurar la instantánea manual del clúster de base de datos. Si `all` se incluye en la lista de valores para el atributo `restore`, la instantánea manual del clúster de base de datos es pública y todas las cuentas de Amazon pueden copiarla o restaurarla.

Para añadir o eliminar el acceso a una cuenta de Amazon para la copia o restauración de una instantánea manual del clúster de base de datos o para convertir la instantánea manual del clúster de base de datos en pública o privada, utilice la acción de la API [ModifyDBClusterSnapshotAttribute (acción)](#ModifyDBClusterSnapshotAttribute).

**Solicitud**
+ **DBClusterSnapshotIdentifier** (en la CLI: `--db-cluster-snapshot-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador para la instantánea del clúster de base de datos para el que describir los atributos.

**Respuesta**

Contiene los resultados de una llamada realizada correctamente a la acción de la API [DescribeDBClusterSnapshotAttributes (acción)](#DescribeDBClusterSnapshotAttributes).

Los atributos de la instantánea manual del clúster de base de datos se utilizan para autorizar a otras cuentas de Amazon la copia o la restauración de una instantánea de clúster de base de datos manual. Para obtener más información, consulte la acción de la API [ModifyDBClusterSnapshotAttribute (acción)](#ModifyDBClusterSnapshotAttribute).
+ **DBClusterSnapshotAttributes**: matriz de objetos [DBClusterSnapshotAttribute](#DBClusterSnapshotAttribute).

  La lista de atributos y valores para la instantánea manual del clúster de base de datos.
+ **DBClusterSnapshotIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador de la instantánea manual del clúster de base de datos al que se aplican los atributos.

**Errores**
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)

## *Estructuras:*
<a name="api-snapshots-structures-spacer"></a>

## DBClusterSnapshot (estructura)
<a name="DBClusterSnapshot"></a>

Contiene los detalles para una instantánea de clúster de base de datos de Amazon Neptune

Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBClusterSnapshots (acción)](#DescribeDBClusterSnapshots).

**Campos**
+ **AllocatedStorage**: se trata de un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el tamaño de almacenamiento asignado en gibibytes (GiB).
+ **AvailabilityZones**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la lista de zonas de disponibilidad de EC2 donde se pueden restaurar las instancias de la instantánea del clúster de base de datos.
+ **ClusterCreateTime**: se trata de un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la hora a la que se creó el clúster de base de datos, en tiempo universal coordinado (UTC).
+ **DBClusterIdentifier**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el identificador del clúster de base de datos del clúster de base de datos a partir del cual se creó esta instantánea del clúster de base de datos.
+ **DBClusterSnapshotArn**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) de la instantánea del clúster de base de datos.
+ **DBClusterSnapshotIdentifier**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el identificador de una instantánea de clúster de base de datos. Debe coincidir con el identificador de una instantánea existente.

  Después de restaurar un clúster de base de datos con un `DBClusterSnapshotIdentifier`, debe especificar el mismo `DBClusterSnapshotIdentifier` para cualquier actualización futura del clúster de base de datos. Cuando especifica esta propiedad para una actualización, el clúster de base de datos no se restaura de nuevo a partir de la instantánea de base de datos y los datos de la base de datos no se modifican.

  Sin embargo, si no especifica `DBClusterSnapshotIdentifier`, se crea un clúster de base de datos vacío y se elimina el clúster de base de datos original. Si especifica una propiedad diferente de la propiedad de restauración de la instantánea anterior, el clúster de base de datos se restaura a partir de la instantánea especificada por `DBClusterSnapshotIdentifier` y se elimina el clúster de base de datos original.
+ **Engine**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre del motor de base de datos.
+ **EngineVersion**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la versión del motor de base de datos para esta instantánea del clúster de base de datos.
+ **IAMDatabaseAuthenticationEnabled**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  True (Verdadero) si la asignación de cuentas de Amazon Identity and Access Management (IAM) a cuentas de base de datos está habilitada; de lo contrario, el valor es false (falso).
+ **KmsKeyId**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si el valor de `StorageEncrypted` es true, el identificador de la clave de Amazon KMS para la instantánea de clúster de base de datos cifrada.
+ **LicenseModel**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona la información del modelo de licencia para esta instantánea del clúster de base de datos.
+ **PercentProgress**: se trata de un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el porcentaje de la estimación de los datos que se han transferido.
+ **Port**: se trata de un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  Especifica el puerto que el clúster de base de datos estaba escuchando en el momento de la instantánea.
+ **SnapshotCreateTime**: se trata de un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Proporciona la hora a la que se tomó la instantánea, en tiempo universal coordinado (UTC).
+ **SnapshotType**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el tipo de instantánea del clúster de base de datos.
+ **SourceDBClusterSnapshotArn**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Si la instantánea del clúster de base de datos se ha copiado de una instantánea de clúster de base de datos de origen, el Nombre de recurso de Amazon (ARN) para la instantánea del clúster de base de datos de origen, de lo contrario, un valor nulo.
+ **Status**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el estado de esta instantánea del clúster de base de datos.
+ **StorageEncrypted**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Especifica si la instantánea del clúster de base de datos está cifrado.
+ **StorageType**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de almacenamiento asociado a la instantánea del clúster de base de datos.
+ **VpcId**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el ID de la VPC asociado a la instantánea de clúster de base de datos.

`DBClusterSnapshot` se utiliza como el elemento de respuesta para:
+ [CreateDBClusterSnapshot](#CreateDBClusterSnapshot)
+ [CopyDBClusterSnapshot](#CopyDBClusterSnapshot)
+ [DeleteDBClusterSnapshot](#DeleteDBClusterSnapshot)

## DBClusterSnapshotAttribute (estructura)
<a name="DBClusterSnapshotAttribute"></a>

Contiene el nombre y los valores de un atributo de instantánea manual del clúster de base de datos.

Los atributos de la instantánea manual del clúster de base de datos se utilizan para autorizar a otras cuentas de Amazon la restauración de una instantánea de clúster de base de datos manual. Para obtener más información, consulte la acción de la API [ModifyDBClusterSnapshotAttribute (acción)](#ModifyDBClusterSnapshotAttribute).

**Campos**
+ **AttributeName**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del atributo de la instantánea manual del clúster de base de datos.

  El atributo denominado `restore` se refiere a la lista de cuentas de Amazon que tienen permiso para copiar o restaurar la instantánea manual del clúster de base de datos. Para obtener más información, consulte la acción de la API [ModifyDBClusterSnapshotAttribute (acción)](#ModifyDBClusterSnapshotAttribute).
+ **AttributeValues**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Los valores del atributo de la instantánea manual del clúster de base de datos.

  Si el campo `AttributeName` se establece en `restore`, este elemento devuelve una lista de ID de las cuentas de Amazon con autorización para copiar o restaurar la instantánea manual del clúster de base de datos. Si el valor `all` está en la lista, la instantánea manual del clúster de base de datos es pública y está disponible para cualquier cuenta de Amazon para su copia o restauración.

## DBClusterSnapshotAttributesResult (estructura)
<a name="DBClusterSnapshotAttributesResult"></a>

Contiene los resultados de una llamada realizada correctamente a la acción de la API [DescribeDBClusterSnapshotAttributes (acción)](#DescribeDBClusterSnapshotAttributes).

Los atributos de la instantánea manual del clúster de base de datos se utilizan para autorizar a otras cuentas de Amazon la copia o la restauración de una instantánea de clúster de base de datos manual. Para obtener más información, consulte la acción de la API [ModifyDBClusterSnapshotAttribute (acción)](#ModifyDBClusterSnapshotAttribute).

**Campos**
+ **DBClusterSnapshotAttributes**: se trata de una matriz de objetos [DBClusterSnapshotAttribute](#DBClusterSnapshotAttribute).

  La lista de atributos y valores para la instantánea manual del clúster de base de datos.
+ **DBClusterSnapshotIdentifier**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador de la instantánea manual del clúster de base de datos al que se aplican los atributos.

`DBClusterSnapshotAttributesResult` se utiliza como el elemento de respuesta para:
+ [DescribeDBClusterSnapshotAttributes](#DescribeDBClusterSnapshotAttributes)
+ [ModifyDBClusterSnapshotAttribute](#ModifyDBClusterSnapshotAttribute)

# API de eventos de Neptune
<a name="api-events"></a>

**Acciones:**
+ [CreateEventSubscription (acción)](#CreateEventSubscription)
+ [DeleteEventSubscription (acción)](#DeleteEventSubscription)
+ [ModifyEventSubscription (acción)](#ModifyEventSubscription)
+ [DescribeEventSubscriptions (acción)](#DescribeEventSubscriptions)
+ [AddSourceIdentifierToSubscription (acción)](#AddSourceIdentifierToSubscription)
+ [RemoveSourceIdentifierFromSubscription (acción)](#RemoveSourceIdentifierFromSubscription)
+ [DescribeEvents (acción)](#DescribeEvents)
+ [DescribeEventCategories (acción)](#DescribeEventCategories)

**Estructuras:**
+ [Event (estructura)](#Event)
+ [EventCategoriesMap (estructura)](#EventCategoriesMap)
+ [EventSubscription (estructura)](#EventSubscription)

## CreateEventSubscription (acción)
<a name="CreateEventSubscription"></a>

         El nombre de la AWS CLI para esta API es: `create-event-subscription`.

Crea una suscripción a notificaciones de eventos. Esta acción requiere un Nombre de recurso de Amazon (ARN) de tema creado por la consola Neptune, la consola de SNS, o la API de SNS. Para obtener un ARN con SNS, debe crear un tema en Amazon SNS y suscribirse al tema. El ARN se muestra en la consola de SNS.

Puede especificar el tipo de origen (SourceType) del que desea recibir notificaciones, proporcione una lista de fuentes Neptune (SourceIds) que desencadena los eventos, y proporcione una lista de las categorías de eventos (EventCategories) de eventos de los que desea recibir notificaciones. Por ejemplo, puede especificar, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 y EventCategories = Availability, Backup.

Si especifica SourceType y SourceIds, como por ejemplo SourceType = db-instance y SourceIdentifier = myDBInstance1, recibirá notificaciones de todos los eventos db-instance para el origen especificado. Si especifica SourceType, pero no especifica SourceIdentifier, recibirá notificaciones de los eventos de ese tipo de origen para todos sus orígenes de Neptune. Si no especifica ni SourceType ni SourceIdentifier, recibe notificaciones de los eventos generados desde todos los orígenes de Neptune que pertenezcan a su cuenta de cliente.

**Solicitud**
+ **Enabled** (en la CLI: `--enabled`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

   Un valor booleano; establecido en **true** para activar la suscripción, establézcalo en **false** para crear la suscripción, pero no la active.
+ **EventCategories** (en la CLI: `--event-categories`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Una lista de las categorías de eventos para un SourceType a los que desea suscribirse. Puede ver una lista de las categorías para un SourceType determinado mediante la acción **DescribeEventCategories**.
+ **SnsTopicArn** (en la CLI: `--sns-topic-arn`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) del tema SNS creado para la notificación de eventos. El ARN es creado por Amazon SNS al crear un tema y suscribirse a él.
+ **SourceIds** (en la CLI: `--source-ids`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La lista de identificadores de los orígenes de eventos para los que se devuelven eventos. Si no se especifica, se incluyen todos los orígenes en la respuesta. Un identificador debe comenzar por una letra y solo deben contener letras ASCII, números y guiones; y no pueden terminar con un guion o contener dos guiones consecutivos.

  Restricciones:
  + Si se proporciona SourceIds, también debe proporcionarse SourceType.
  + Si el tipo de origen es una instancia de base de datos, debe proporcionarse un `DBInstanceIdentifier`.
  + Si el tipo de origen es un grupo de seguridad de base de datos, debe proporcionarse un `DBSecurityGroupName`.
  + Si el tipo de origen es un grupo de parámetros de base de datos, debe proporcionarse un `DBParameterGroupName`.
  + Si el tipo de origen es una instantánea de base de datos, debe proporcionarse un `DBSnapshotIdentifier`.
+ **SourceType** (en la CLI: `--source-type`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de origen que está generando los eventos. Por ejemplo, si desea recibir una notificación de eventos generados por una instancia de base de datos, establecería este parámetro para db-instance. Si no se especifica este valor, se devuelven todos los eventos.

  Valores válidos: `db-instance` \$1 `db-cluster` \$1 `db-parameter-group` \$1 `db-security-group` \$1 `db-snapshot` \$1 `db-cluster-snapshot`
+ **SubscriptionName** (en la CLI: `--subscription-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la suscripción.

  Restricciones: el nombre debe tener menos de 255 caracteres.
+ **Tags** (en la CLI: `--tags`): una matriz de objetos [Tag](api-other-apis.md#Tag).

  Las etiquetas que deben aplicarse a la nueva suscripción de eventos.

**Respuesta**

Contiene los resultados de una invocación correcta de la acción [DescribeEventSubscriptions (acción)](#DescribeEventSubscriptions).
+ **CustomerAwsId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La cuenta de cliente de Amazon asociada a la suscripción a notificaciones de eventos.
+ **CustSubscriptionId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ID de suscripción a notificaciones de eventos.
+ **Enabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor booleano que indica si la suscripción está habilitada. "True" indica que la suscripción está habilitada.
+ **EventCategoriesList**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de categorías de eventos para la suscripción a notificaciones de eventos.
+ **EventSubscriptionArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para la suscripción de eventos.
+ **SnsTopicArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN de temas de la suscripción a notificaciones de eventos.
+ **SourceIdsList**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de ID de origen para la suscripción a notificaciones de eventos.
+ **SourceType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de origen para la suscripción a notificaciones de eventos.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El estado de la suscripción a notificaciones de eventos de .

  Restricciones:

  Puede ser uno de los siguientes: creating \$1 modifying \$1 deleting \$1 active \$1 no-permission \$1 topic-not-exist

  El estado "no-permission" indica que Neptune ya no tiene permiso para publicar en el tema de SNS. El estado “topic-not-exist” indica que el tema se eliminó después de crear la suscripción.
+ **SubscriptionCreationTime**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La hora a la que se creó la suscripción a notificaciones de eventos.

**Errores**
+ [EventSubscriptionQuotaExceededFault](api-faults.md#EventSubscriptionQuotaExceededFault)
+ [SubscriptionAlreadyExistFault](api-faults.md#SubscriptionAlreadyExistFault)
+ [SNSInvalidTopicFault](api-faults.md#SNSInvalidTopicFault)
+ [SNSNoAuthorizationFault](api-faults.md#SNSNoAuthorizationFault)
+ [SNSTopicArnNotFoundFault](api-faults.md#SNSTopicArnNotFoundFault)
+ [SubscriptionCategoryNotFoundFault](api-faults.md#SubscriptionCategoryNotFoundFault)
+ [SourceNotFoundFault](api-faults.md#SourceNotFoundFault)

## DeleteEventSubscription (acción)
<a name="DeleteEventSubscription"></a>

         El nombre de la AWS CLI para esta API es: `delete-event-subscription`.

Elimina una suscripción a notificaciones de eventos.

**Solicitud**
+ **SubscriptionName** (en la CLI: `--subscription-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la suscripción a notificaciones de eventos que desea eliminar.

**Respuesta**

Contiene los resultados de una invocación correcta de la acción [DescribeEventSubscriptions (acción)](#DescribeEventSubscriptions).
+ **CustomerAwsId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La cuenta de cliente de Amazon asociada a la suscripción a notificaciones de eventos.
+ **CustSubscriptionId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ID de suscripción a notificaciones de eventos.
+ **Enabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor booleano que indica si la suscripción está habilitada. "True" indica que la suscripción está habilitada.
+ **EventCategoriesList**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de categorías de eventos para la suscripción a notificaciones de eventos.
+ **EventSubscriptionArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para la suscripción de eventos.
+ **SnsTopicArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN de temas de la suscripción a notificaciones de eventos.
+ **SourceIdsList**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de ID de origen para la suscripción a notificaciones de eventos.
+ **SourceType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de origen para la suscripción a notificaciones de eventos.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El estado de la suscripción a notificaciones de eventos de .

  Restricciones:

  Puede ser uno de los siguientes: creating \$1 modifying \$1 deleting \$1 active \$1 no-permission \$1 topic-not-exist

  El estado "no-permission" indica que Neptune ya no tiene permiso para publicar en el tema de SNS. El estado “topic-not-exist” indica que el tema se eliminó después de crear la suscripción.
+ **SubscriptionCreationTime**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La hora a la que se creó la suscripción a notificaciones de eventos.

**Errores**
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)
+ [InvalidEventSubscriptionStateFault](api-faults.md#InvalidEventSubscriptionStateFault)

## ModifyEventSubscription (acción)
<a name="ModifyEventSubscription"></a>

         El nombre de la AWS CLI para esta API es: `modify-event-subscription`.

Modifica una suscripción a notificaciones de eventos existente. Tenga en cuenta que no puede modificar los identificadores de origen mediante esta llamada; para cambiar identificadores de origen de una suscripción, utilice las llamadas [AddSourceIdentifierToSubscription (acción)](#AddSourceIdentifierToSubscription) y [RemoveSourceIdentifierFromSubscription (acción)](#RemoveSourceIdentifierFromSubscription).

Puede ver una lista de las categorías de eventos para un SourceType determinado mediante la acción **DescribeEventCategories**.

**Solicitud**
+ **Enabled** (en la CLI: `--enabled`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

   Un valor booleano; establecida en **true** para activar la suscripción.
+ **EventCategories** (en la CLI: `--event-categories`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Una lista de las categorías de eventos para un SourceType a los que desea suscribirse. Puede ver una lista de las categorías para un SourceType determinado mediante la acción **DescribeEventCategories**.
+ **SnsTopicArn** (en la CLI: `--sns-topic-arn`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) del tema SNS creado para la notificación de eventos. El ARN es creado por Amazon SNS al crear un tema y suscribirse a él.
+ **SourceType** (en la CLI: `--source-type`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de origen que está generando los eventos. Por ejemplo, si desea recibir una notificación de eventos generados por una instancia de base de datos, establecería este parámetro para db-instance. Si no se especifica este valor, se devuelven todos los eventos.

  Valores válidos: db-instance \$1 db-parameter-group \$1 db-security-group \$1 db-snapshot
+ **SubscriptionName** (en la CLI: `--subscription-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la suscripción a notificaciones de eventos.

**Respuesta**

Contiene los resultados de una invocación correcta de la acción [DescribeEventSubscriptions (acción)](#DescribeEventSubscriptions).
+ **CustomerAwsId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La cuenta de cliente de Amazon asociada a la suscripción a notificaciones de eventos.
+ **CustSubscriptionId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ID de suscripción a notificaciones de eventos.
+ **Enabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor booleano que indica si la suscripción está habilitada. "True" indica que la suscripción está habilitada.
+ **EventCategoriesList**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de categorías de eventos para la suscripción a notificaciones de eventos.
+ **EventSubscriptionArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para la suscripción de eventos.
+ **SnsTopicArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN de temas de la suscripción a notificaciones de eventos.
+ **SourceIdsList**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de ID de origen para la suscripción a notificaciones de eventos.
+ **SourceType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de origen para la suscripción a notificaciones de eventos.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El estado de la suscripción a notificaciones de eventos de .

  Restricciones:

  Puede ser uno de los siguientes: creating \$1 modifying \$1 deleting \$1 active \$1 no-permission \$1 topic-not-exist

  El estado "no-permission" indica que Neptune ya no tiene permiso para publicar en el tema de SNS. El estado “topic-not-exist” indica que el tema se eliminó después de crear la suscripción.
+ **SubscriptionCreationTime**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La hora a la que se creó la suscripción a notificaciones de eventos.

**Errores**
+ [EventSubscriptionQuotaExceededFault](api-faults.md#EventSubscriptionQuotaExceededFault)
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)
+ [SNSInvalidTopicFault](api-faults.md#SNSInvalidTopicFault)
+ [SNSNoAuthorizationFault](api-faults.md#SNSNoAuthorizationFault)
+ [SNSTopicArnNotFoundFault](api-faults.md#SNSTopicArnNotFoundFault)
+ [SubscriptionCategoryNotFoundFault](api-faults.md#SubscriptionCategoryNotFoundFault)

## DescribeEventSubscriptions (acción)
<a name="DescribeEventSubscriptions"></a>

         El nombre de la AWS CLI para esta API es: `describe-event-subscriptions`.

Muestra todas las descripciones de la suscripción para una cuenta de cliente. La descripción de una suscripción incluye SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime y Status.

Si especifica un SubscriptionName, muestra la descripción de dicha suscripción.

**Solicitud**
+ **Filters** (en la CLI: `--filters`): una matriz de objetos [Filtro](api-datatypes.md#Filter).

  Este parámetro es incompatible en estos momentos.
+ **Marker** (en la CLI: `--marker`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud DescribeOrderableDBInstanceOptions anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords` .
+ **MaxRecords** (en la CLI: `--max-records`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

   El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación que se conoce como marcador, de modo que se pueda recuperar el resto de resultados.

  Predeterminado: 100

  Restricciones: mínimo 20, máximo 100.
+ **SubscriptionName** (en la CLI: `--subscription-name`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la suscripción a notificaciones de eventos que desea describir.

**Respuesta**
+ **EventSubscriptionsList**: matriz de objetos [EventSubscription](#EventSubscription).

  Una lista de tipos de datos EventSubscriptions.
+ **Marker**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud DescribeOrderableDBInstanceOptions anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.

**Errores**
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)

## AddSourceIdentifierToSubscription (acción)
<a name="AddSourceIdentifierToSubscription"></a>

         El nombre de la AWS CLI para esta API es: `add-source-identifier-to-subscription`.

Agrega un identificador de origen a una suscripción de notificación de eventos existente.

**Solicitud**
+ **SourceIdentifier** (en la CLI: `--source-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador del origen de eventos que se va a añadir.

  Restricciones:
  + Si el tipo de origen es una instancia de base de datos, debe proporcionarse un `DBInstanceIdentifier`.
  + Si el tipo de origen es un grupo de seguridad de base de datos, debe proporcionarse un `DBSecurityGroupName`.
  + Si el tipo de origen es un grupo de parámetros de base de datos, debe proporcionarse un `DBParameterGroupName`.
  + Si el tipo de origen es una instantánea de base de datos, debe proporcionarse un `DBSnapshotIdentifier`.
+ **SubscriptionName** (en la CLI: `--subscription-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la suscripción a notificaciones de eventos al que desea añadir un identificador de origen.

**Respuesta**

Contiene los resultados de una invocación correcta de la acción [DescribeEventSubscriptions (acción)](#DescribeEventSubscriptions).
+ **CustomerAwsId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La cuenta de cliente de Amazon asociada a la suscripción a notificaciones de eventos.
+ **CustSubscriptionId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ID de suscripción a notificaciones de eventos.
+ **Enabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor booleano que indica si la suscripción está habilitada. "True" indica que la suscripción está habilitada.
+ **EventCategoriesList**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de categorías de eventos para la suscripción a notificaciones de eventos.
+ **EventSubscriptionArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para la suscripción de eventos.
+ **SnsTopicArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN de temas de la suscripción a notificaciones de eventos.
+ **SourceIdsList**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de ID de origen para la suscripción a notificaciones de eventos.
+ **SourceType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de origen para la suscripción a notificaciones de eventos.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El estado de la suscripción a notificaciones de eventos de .

  Restricciones:

  Puede ser uno de los siguientes: creating \$1 modifying \$1 deleting \$1 active \$1 no-permission \$1 topic-not-exist

  El estado "no-permission" indica que Neptune ya no tiene permiso para publicar en el tema de SNS. El estado “topic-not-exist” indica que el tema se eliminó después de crear la suscripción.
+ **SubscriptionCreationTime**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La hora a la que se creó la suscripción a notificaciones de eventos.

**Errores**
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)
+ [SourceNotFoundFault](api-faults.md#SourceNotFoundFault)

## RemoveSourceIdentifierFromSubscription (acción)
<a name="RemoveSourceIdentifierFromSubscription"></a>

         El nombre de la AWS CLI para esta API es: `remove-source-identifier-from-subscription`.

Elimina un identificador de origen de una suscripción a notificaciones de eventos existente.

**Solicitud**
+ **SourceIdentifier** (en la CLI: `--source-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   El identificador de origen que se va a eliminar de la suscripción, como, por ejemplo, el **identificador de instancias de bases de datos** para una instancia de base de datos o el nombre de un grupo de seguridad.
+ **SubscriptionName** (en la CLI: `--subscription-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la suscripción a notificaciones de eventos del que desea eliminar un identificador de origen.

**Respuesta**

Contiene los resultados de una invocación correcta de la acción [DescribeEventSubscriptions (acción)](#DescribeEventSubscriptions).
+ **CustomerAwsId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La cuenta de cliente de Amazon asociada a la suscripción a notificaciones de eventos.
+ **CustSubscriptionId**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ID de suscripción a notificaciones de eventos.
+ **Enabled**: un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor booleano que indica si la suscripción está habilitada. "True" indica que la suscripción está habilitada.
+ **EventCategoriesList**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de categorías de eventos para la suscripción a notificaciones de eventos.
+ **EventSubscriptionArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para la suscripción de eventos.
+ **SnsTopicArn**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN de temas de la suscripción a notificaciones de eventos.
+ **SourceIdsList**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de ID de origen para la suscripción a notificaciones de eventos.
+ **SourceType**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de origen para la suscripción a notificaciones de eventos.
+ **Status**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El estado de la suscripción a notificaciones de eventos de .

  Restricciones:

  Puede ser uno de los siguientes: creating \$1 modifying \$1 deleting \$1 active \$1 no-permission \$1 topic-not-exist

  El estado "no-permission" indica que Neptune ya no tiene permiso para publicar en el tema de SNS. El estado “topic-not-exist” indica que el tema se eliminó después de crear la suscripción.
+ **SubscriptionCreationTime**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La hora a la que se creó la suscripción a notificaciones de eventos.

**Errores**
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)
+ [SourceNotFoundFault](api-faults.md#SourceNotFoundFault)

## DescribeEvents (acción)
<a name="DescribeEvents"></a>

         El nombre de la AWS CLI para esta API es: `describe-events`.

Devuelve eventos relacionados con las instancias de base de datos, grupos de seguridad de base de datos, instantáneas de base de datos y grupos de parámetros de base de datos para los últimos 14 días. Los eventos específicos de una instancia de base de datos concreta, grupo de seguridad de base de datos, instantánea de base de datos o grupo de parámetros de base de datos se pueden obtener proporcionando el nombre como parámetro. De forma predeterminada, se devuelven los eventos de la última hora.

**Solicitud**
+ **Duration** (en la CLI: `--duration`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El número de minutos para los que recuperar eventos.

  Predeterminado: 60
+ **EndTime** (en la CLI: `--end-time`): un TStamp, del tipo: `timestamp` (un punto en el tiempo, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

   El final del intervalo de tiempo para el que recuperar eventos, especificado en formato ISO 8601. Para obtener más información acerca de ISO 8601, consulte la página [página de Wikipedia ISO8601](http://en.wikipedia.org/wiki/ISO_8601).

  Ejemplo: 2009-07-08T18:00Z
+ **EventCategories** (en la CLI: `--event-categories`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de categorías de eventos que desencadena notificaciones para la suscripción a notificaciones de eventos.
+ **Filters** (en la CLI: `--filters`): una matriz de objetos [Filtro](api-datatypes.md#Filter).

  Este parámetro es incompatible en estos momentos.
+ **Marker** (en la CLI: `--marker`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud DescribeEvents anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.
+ **MaxRecords** (en la CLI: `--max-records`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

   El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación que se conoce como marcador, de modo que se pueda recuperar el resto de resultados.

  Predeterminado: 100

  Restricciones: mínimo 20, máximo 100.
+ **SourceIdentifier** (en la CLI: `--source-identifier`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador del origen de eventos para el que se devuelven eventos. Si no se especifica, se incluyen todos los orígenes en la respuesta.

  Restricciones:
  + Si se proporciona SourceIdentifier, también debe proporcionarse SourceType.
  + Si el tipo de origen es `DBInstance`, debe proporcionarse un `DBInstanceIdentifier`.
  + Si el tipo de origen es `DBSecurityGroup`, debe suministrarse `DBSecurityGroupName`.
  + Si el tipo de origen es `DBParameterGroup`, debe suministrarse `DBParameterGroupName`.
  + Si el tipo de origen es `DBSnapshot`, debe suministrarse `DBSnapshotIdentifier`.
  + No puede terminar por un guion ni contener dos guiones consecutivos.
+ **SourceType** (en la CLI: `--source-type`): un SourceType, del tipo: `string` (una cadena codificada con UTF-8).

  El origen del evento para el que recuperar eventos. Si no se especifica ningún valor, se devuelven todos los eventos.
+ **StartTime** (en la CLI: `--start-time`): un TStamp, del tipo: `timestamp` (un punto en el tiempo, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

   El principio del intervalo de tiempo para el que recuperar eventos, especificado en formato ISO 8601. Para obtener más información acerca de ISO 8601, consulte la página [página de Wikipedia ISO8601](http://en.wikipedia.org/wiki/ISO_8601).

  Ejemplo: 2009-07-08T18:00Z

**Respuesta**
+ **Events**: matriz de objetos [Evento](#Event).

   Una lista de instancias [Event (estructura)](#Event).
+ **Marker**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud Events anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords` .

## DescribeEventCategories (acción)
<a name="DescribeEventCategories"></a>

         El nombre de la AWS CLI para esta API es: `describe-event-categories`.

Muestra una lista de categorías de todos los tipos de origen de eventos o, si se especifica, para un tipo de origen especificado.

**Solicitud**
+ **Filters** (en la CLI: `--filters`): una matriz de objetos [Filtro](api-datatypes.md#Filter).

  Este parámetro es incompatible en estos momentos.
+ **SourceType** (en la CLI: `--source-type`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de origen que está generando los eventos.

  Valores válidos: db-instance \$1 db-parameter-group \$1 db-security-group \$1 db-snapshot

**Respuesta**
+ **EventCategoriesMapList**: matriz de objetos [EventCategoriesMap](#EventCategoriesMap).

  Una lista de tipos de datos EventCategoriesMap.

## *Estructuras:*
<a name="api-events-structures-spacer"></a>

## Event (estructura)
<a name="Event"></a>

 Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeEvents (acción)](#DescribeEvents).

**Campos**
+ **Date**: se trata de un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  Especifica la fecha y la hora del evento.
+ **EventCategories**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica la categoría para el evento.
+ **Message**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el texto de este evento.
+ **SourceArn**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para el evento.
+ **SourceIdentifier**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Proporciona el identificador del origen del evento.
+ **SourceType**: se trata de un SourceType, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el tipo de origen para este evento.

## EventCategoriesMap (estructura)
<a name="EventCategoriesMap"></a>

Contiene los resultados de una invocación correcta de la acción [DescribeEventCategories (acción)](#DescribeEventCategories).

**Campos**
+ **EventCategories**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Las categorías de eventos para el tipo de origen especificado
+ **SourceType**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de origen al que pertenecen las categorías devueltas

## EventSubscription (estructura)
<a name="EventSubscription"></a>

Contiene los resultados de una invocación correcta de la acción [DescribeEventSubscriptions (acción)](#DescribeEventSubscriptions).

**Campos**
+ **CustomerAwsId**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La cuenta de cliente de Amazon asociada a la suscripción a notificaciones de eventos.
+ **CustSubscriptionId**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ID de suscripción a notificaciones de eventos.
+ **Enabled**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor booleano que indica si la suscripción está habilitada. "True" indica que la suscripción está habilitada.
+ **EventCategoriesList**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de categorías de eventos para la suscripción a notificaciones de eventos.
+ **EventSubscriptionArn**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) para la suscripción de eventos.
+ **SnsTopicArn**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN de temas de la suscripción a notificaciones de eventos.
+ **SourceIdsList**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una lista de ID de origen para la suscripción a notificaciones de eventos.
+ **SourceType**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de origen para la suscripción a notificaciones de eventos.
+ **Status**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El estado de la suscripción a notificaciones de eventos de .

  Restricciones:

  Puede ser uno de los siguientes: creating \$1 modifying \$1 deleting \$1 active \$1 no-permission \$1 topic-not-exist

  El estado "no-permission" indica que Neptune ya no tiene permiso para publicar en el tema de SNS. El estado “topic-not-exist” indica que el tema se eliminó después de crear la suscripción.
+ **SubscriptionCreationTime**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La hora a la que se creó la suscripción a notificaciones de eventos.

`EventSubscription` se utiliza como el elemento de respuesta para:
+ [CreateEventSubscription](#CreateEventSubscription)
+ [ModifyEventSubscription](#ModifyEventSubscription)
+ [AddSourceIdentifierToSubscription](#AddSourceIdentifierToSubscription)
+ [RemoveSourceIdentifierFromSubscription](#RemoveSourceIdentifierFromSubscription)
+ [DeleteEventSubscription](#DeleteEventSubscription)

# Otras API de Neptune
<a name="api-other-apis"></a>

**Acciones:**
+ [AddTagsToResource (acción)](#AddTagsToResource)
+ [ListTagsForResource (acción)](#ListTagsForResource)
+ [RemoveTagsFromResource (acción)](#RemoveTagsFromResource)
+ [ApplyPendingMaintenanceAction (acción)](#ApplyPendingMaintenanceAction)
+ [DescribePendingMaintenanceActions (acción)](#DescribePendingMaintenanceActions)
+ [DescribeDBEngineVersions (acción)](#DescribeDBEngineVersions)

**Estructuras:**
+ [DBEngineVersion (estructura)](#DBEngineVersion)
+ [EngineDefaults (estructura)](#EngineDefaults)
+ [PendingMaintenanceAction (estructura)](#PendingMaintenanceAction)
+ [ResourcePendingMaintenanceActions (estructura)](#ResourcePendingMaintenanceActions)
+ [UpgradeTarget (estructura)](#UpgradeTarget)
+ [Tag (estructura)](#Tag)

## AddTagsToResource (acción)
<a name="AddTagsToResource"></a>

         El nombre de la AWS CLI para esta API es: `add-tags-to-resource`.

Añade etiquetas de metadatos a un recurso de Amazon Neptune. Estas etiquetas también se pueden utilizar con los informes de asignación de costos para realizar un seguimiento de los costos asociados con los recursos de Amazon Neptune o se utilizan en una Declaración de condición en una política de IAM para Amazon Neptune.

**Solicitud**
+ **ResourceName** (en la CLI: `--resource-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El recurso de Amazon Neptune al que se añaden las etiquetas. Este valor es un Nombre de recurso de Amazon (ARN). Para obtener más información acerca de cómo crear un ARN, consulte [ Creación de un nombre de recurso de Amazon (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing).
+ **Tags** (en la CLI: `--tags`) *obligatorio:* una matriz de objetos [Tag](#Tag).

  Las etiquetas que se van a asignar al recurso de Amazon Neptune.

**Respuesta**
+ *Sin parámetros de respuesta.*

**Errores**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [DBSnapshotNotFoundFault](api-faults.md#DBSnapshotNotFoundFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

## ListTagsForResource (acción)
<a name="ListTagsForResource"></a>

         El nombre de la AWS CLI para esta API es: `list-tags-for-resource`.

Enumera todas las etiquetas en un recurso de Amazon Neptune.

**Solicitud**
+ **Filters** (en la CLI: `--filters`): una matriz de objetos [Filtro](api-datatypes.md#Filter).

  Este parámetro es incompatible en estos momentos.
+ **ResourceName** (en la CLI: `--resource-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El recurso de Amazon Neptune con las etiquetas que se van a incluir en la lista. Este valor es un Nombre de recurso de Amazon (ARN). Para obtener más información acerca de cómo crear un ARN, consulte [ Creación de un nombre de recurso de Amazon (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing).

**Respuesta**
+ **TagList**: matriz de objetos [Tag](#Tag).

  Lista de etiquetas devueltas por la operación ListTagsForResource.

**Errores**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [DBSnapshotNotFoundFault](api-faults.md#DBSnapshotNotFoundFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

## RemoveTagsFromResource (acción)
<a name="RemoveTagsFromResource"></a>

         El nombre de la AWS CLI para esta API es: `remove-tags-from-resource`.

Elimina etiquetas de metadatos de un recurso de Amazon Neptune.

**Solicitud**
+ **ResourceName** (en la CLI: `--resource-name`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El recurso de Amazon Neptune del que se eliminan las etiquetas. Este valor es un Nombre de recurso de Amazon (ARN). Para obtener más información acerca de cómo crear un ARN, consulte [ Creación de un nombre de recurso de Amazon (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing).
+ **TagKeys** (en la CLI: `--tag-keys`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La clave de la etiqueta (nombre) de la etiqueta que se va a eliminar.

**Respuesta**
+ *Sin parámetros de respuesta.*

**Errores**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [DBSnapshotNotFoundFault](api-faults.md#DBSnapshotNotFoundFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

## ApplyPendingMaintenanceAction (acción)
<a name="ApplyPendingMaintenanceAction"></a>

         El nombre de la AWS CLI para esta API es: `apply-pending-maintenance-action`.

Aplica una acción de mantenimiento pendiente a un recurso (por ejemplo, a una instancia de base de datos).

**Solicitud**
+ **ApplyAction** (en la CLI: `--apply-action`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La acción de mantenimiento pendiente que se aplica a este recurso.

  Valores válidos: `system-update`, `db-upgrade`
+ **OptInType** (en la CLI: `--opt-in-type`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Un valor que indica el tipo de solicitud de alta o deshace una solicitud de alta. Una solicitud de alta de tipo `immediate` no se puede deshacer.

  Valores válidos:
  + `immediate`: aplicar inmediatamente la acción de mantenimiento.
  + `next-maintenance`: aplicar la acción de mantenimiento durante la siguiente ventana de mantenimiento del recurso.
  + `undo-opt-in`: cancelar todas las solicitudes de alta `next-maintenance` existentes.
+ **ResourceIdentifier** (en la CLI: `--resource-identifier`): *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El Nombre de recurso de Amazon (ARN) del recurso al que se aplica la acción de mantenimiento pendiente. Para obtener más información acerca de cómo crear un ARN, consulte [ Creación de un nombre de recurso de Amazon (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing).

**Respuesta**

Describe las acciones de mantenimiento pendientes para un recurso.
+ **PendingMaintenanceActionDetails**: matriz de objetos [PendingMaintenanceAction](#PendingMaintenanceAction).

  Una lista que proporciona detalles sobre las acciones de mantenimiento pendientes para el recurso.
+ **ResourceIdentifier**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN del recurso que tiene acciones de mantenimiento pendientes.

**Errores**
+ [ResourceNotFoundFault](api-faults.md#ResourceNotFoundFault)

## DescribePendingMaintenanceActions (acción)
<a name="DescribePendingMaintenanceActions"></a>

         El nombre de la AWS CLI para esta API es: `describe-pending-maintenance-actions`.

Devuelve una lista de recursos (por ejemplo, instancias de base de datos) que tienen al menos una acción de mantenimiento pendiente.

**Solicitud**
+ **Filters** (en la CLI: `--filters`): una matriz de objetos [Filtro](api-datatypes.md#Filter).

  Un filtro que especifica uno o más recursos para devolver acciones de mantenimiento pendientes.

  Filtros compatibles:
  +  `db-cluster-id`: acepta identificadores de clúster de base de datos y Nombres de recursos de Amazon (ARN). La lista de resultados solo incluirá las acciones de mantenimiento pendientes para los clústeres de base de datos identificados por estos ARN.
  +  `db-instance-id`: admite identificadores de instancia de base de datos y ARN de instancia de base de datos. La lista de resultados solo incluirá las acciones de mantenimiento pendientes para las instancias de base de datos identificadas por estos ARN.
+ **Marker** (en la CLI: `--marker`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud `DescribePendingMaintenanceActions` anterior. Si se especifica este parámetro, la respuesta incluye solo los registros más allá del marcador, hasta un número de registros especificado por `MaxRecords`.
+ **MaxRecords** (en la CLI: `--max-records`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

   El número máximo de registros que se deben incluir en la respuesta. Si el número de registros es superior al valor `MaxRecords` especificado, se incluye en la respuesta un token de paginación que se conoce como marcador, de modo que se pueda recuperar el resto de resultados.

  Predeterminado: 100

  Restricciones: mínimo 20, máximo 100.
+ **ResourceIdentifier** (en la CLI: `--resource-identifier`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN de un recuerdo para el que devolver acciones de mantenimiento pendientes.

**Respuesta**
+ **Marker**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud `DescribePendingMaintenanceActions` anterior. Si se especifica este parámetro, la respuesta incluye solo los registros más allá del marcador, hasta un número de registros especificado por `MaxRecords`.
+ **PendingMaintenanceActions**: matriz de objetos [ResourcePendingMaintenanceActions](#ResourcePendingMaintenanceActions).

  La lista de acciones de mantenimiento pendientes para el recurso.

**Errores**
+ [ResourceNotFoundFault](api-faults.md#ResourceNotFoundFault)

## DescribeDBEngineVersions (acción)
<a name="DescribeDBEngineVersions"></a>

         El nombre de la AWS CLI para esta API es: `describe-db-engine-versions`.

Devuelve una lista con los motores de base de datos disponibles.

**Solicitud**
+ **DBParameterGroupFamily** (en la CLI: `--db-parameter-group-family`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de una familia de grupos de parámetros de base de datos específicos para los que devolver detalles.

  Restricciones:
  + Si se suministran, debe coincidir con una DBParameterGroupFamily existente.
+ **DefaultOnly** (en la CLI: `--default-only`): un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Indica que solo se devuelve la versión predeterminada del motor especificado o motor y combinación de la versión principal.
+ **Engine** (en la CLI: `--engine`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El motor de base de datos que se debe devolver.
+ **EngineVersion** (en la CLI: `--engine-version`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La versión del motor de base de datos que se debe devolver.

  Ejemplo:: `5.1.49`
+ **Filters** (en la CLI: `--filters`): una matriz de objetos [Filtro](api-datatypes.md#Filter).

  No se admite actualmente.
+ **ListSupportedCharacterSets** (en la CLI: `--list-supported-character-sets`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Si se especifica este parámetro y el motor solicitado es compatible con el parámetro `CharacterSetName` para `CreateDBInstance`, la respuesta incluye una lista de conjuntos de caracteres admitidos para cada versión del motor.
+ **ListSupportedTimezones** (en la CLI: `--list-supported-timezones`): un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Si se especifica este parámetro y el motor solicitado es compatible con el parámetro `TimeZone` para `CreateDBInstance`, la respuesta incluye una lista de zonas horarias admitidas para cada versión del motor.
+ **Marker** (en la CLI: `--marker`): una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.
+ **MaxRecords** (en la CLI: `--max-records`): un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

   El número máximo de registros que se deben incluir en la respuesta. Si hay más de un valor `MaxRecords` disponible, se incluye un token de paginación que se conoce como marcador en la respuesta para poder recuperar los siguientes resultados.

  Predeterminado: 100

  Restricciones: mínimo 20, máximo 100.

**Respuesta**
+ **DBEngineVersions**: matriz de objetos [DBEngineVersion](#DBEngineVersion).

   Una lista de elementos `DBEngineVersion`
+ **Marker**: una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords`.

## *Estructuras:*
<a name="api-other-apis-structures-spacer"></a>

## DBEngineVersion (estructura)
<a name="DBEngineVersion"></a>

 Este tipo de datos se utiliza como un elemento de respuesta en la acción [DescribeDBEngineVersions (acción)](#DescribeDBEngineVersions).

**Campos**
+ **DBEngineDescription**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La descripción del motor de base de datos.
+ **DBEngineVersionDescription**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La descripción de la versión del motor de base de datos.
+ **DBParameterGroupFamily**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la familia de grupos de parámetros de base de datos para el motor de base de datos.
+ **Engine**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del motor de base de datos.
+ **EngineVersion**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Número de versión del motor de base de datos.
+ **ExportableLogTypes**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Los tipos de registros que el motor de base de datos tiene disponibles para la exportación a CloudWatch Logs.
+ **SupportedTimezones**: se trata de una matriz de objetos [Zona horaria](api-datatypes.md#Timezone).

  Una lista de las zonas horarias admitidas por este motor para el parámetro `Timezone` de la acción `CreateDBInstance`.
+ **SupportsGlobalDatabases**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor que indica si puede utilizar las bases de datos globales de Aurora con una determinada versión de motor de base de datos.
+ **SupportsLogExportsToCloudwatchLogs**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor que indica si la versión del motor admite la exportación de tipos de registro especificados por ExportableLogTypes a CloudWatch Logs.
+ **SupportsReadReplica**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Indica si la versión del motor de base de datos admite réplicas de lectura.
+ **ValidUpgradeTarget**: se trata de una matriz de objetos [UpgradeTarget](#UpgradeTarget).

  Una lista de versiones de motor a la que esta versión del motor de base de datos se puede actualizar.

## EngineDefaults (estructura)
<a name="EngineDefaults"></a>

 Contiene el resultado de una invocación correcta de la acción [DescribeEngineDefaultParameters (acción)](api-parameters.md#DescribeEngineDefaultParameters).

**Campos**
+ **DBParameterGroupFamily**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el nombre de la familia del grupo de parámetros de base de datos a los que se aplican los parámetros predeterminados del motor.
+ **Marker**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

   Un token de paginación opcional proporcionado por una solicitud EngineDefaults anterior. Si se especifica este parámetro, la respuesta solo incluye registros más allá del marcador, hasta el valor especificado por `MaxRecords` .
+ **Parameters**: se trata de una matriz de objetos [Parámetro](api-parameters.md#Parameter).

  Contiene una lista de los parámetros predeterminados del motor.

`EngineDefaults` se utiliza como el elemento de respuesta para:
+ [DescribeEngineDefaultParameters](api-parameters.md#DescribeEngineDefaultParameters)
+ [DescribeEngineDefaultClusterParameters](api-parameters.md#DescribeEngineDefaultClusterParameters)

## PendingMaintenanceAction (estructura)
<a name="PendingMaintenanceAction"></a>

Proporciona información acerca de una acción de mantenimiento pendiente para un recurso.

**Campos**
+ **Action**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El tipo de acción de mantenimiento pendiente disponible para el recurso.
+ **AutoAppliedAfterDate**: se trata de un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  La fecha del periodo de mantenimiento cuando se aplica la acción. La acción de mantenimiento se aplica al recurso durante su primer periodo de mantenimiento después de esta fecha. Si se especifica esta fecha, se omite cualquier solicitud de alta `next-maintenance`.
+ **CurrentApplyDate**: se trata de un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  La fecha de entrada en vigor en que se aplica la acción de mantenimiento pendiente al recurso. Esta fecha tiene en cuenta las solicitudes de alta recibidas de la API [ApplyPendingMaintenanceAction (acción)](#ApplyPendingMaintenanceAction), la `AutoAppliedAfterDate` y la `ForcedApplyDate`. Este valor está en blanco si no se ha recibido una solicitud de alta y no se ha especificado nada como `AutoAppliedAfterDate` o `ForcedApplyDate`.
+ **Description**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Una descripción que proporciona información más detallada sobre la acción de mantenimiento.
+ **ForcedApplyDate**: se trata de un TStamp, del tipo: `timestamp` (un momento específico, generalmente definido como un desplazamiento desde la medianoche del 1 de enero de 1970).

  La fecha en que se aplica automáticamente la acción de mantenimiento. La acción de mantenimiento se aplica al recurso en esta fecha independientemente del periodo de mantenimiento para el recurso. Si se especifica esta fecha, se omite cualquier solicitud de alta `immediate`.
+ **OptInStatus**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Indica el tipo de solicitud de alta que se ha recibido para el recurso.

## ResourcePendingMaintenanceActions (estructura)
<a name="ResourcePendingMaintenanceActions"></a>

Describe las acciones de mantenimiento pendientes para un recurso.

**Campos**
+ **PendingMaintenanceActionDetails**: se trata de una matriz de objetos [PendingMaintenanceAction](#PendingMaintenanceAction).

  Una lista que proporciona detalles sobre las acciones de mantenimiento pendientes para el recurso.
+ **ResourceIdentifier**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El ARN del recurso que tiene acciones de mantenimiento pendientes.

`ResourcePendingMaintenanceActions` se utiliza como el elemento de respuesta para:
+ [ApplyPendingMaintenanceAction](#ApplyPendingMaintenanceAction)

## UpgradeTarget (estructura)
<a name="UpgradeTarget"></a>

La versión del motor de base de datos a la que puede actualizarse una instancia de base de datos.

**Campos**
+ **AutoUpgrade**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor que indica si la versión de destino se aplica a cualquier instancia de base de datos de origen que tiene AutoMinorVersionUpgrade establecido en "true·.
+ **Description**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La versión del motor de base de datos a la que puede actualizarse una instancia de base de datos.
+ **Engine**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del motor de base de datos de destino de actualización.
+ **EngineVersion**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El número de versión del motor de base de datos de destino de actualización.
+ **IsMajorVersionUpgrade**: se trata de un booleano, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor que indica si un motor de base de datos se actualiza a una versión principal.
+ **SupportsGlobalDatabases**: se trata de un BooleanOptional, del tipo: `boolean` (un valor booleano [true o false]).

  Un valor que indica si puede utilizar las bases de datos globales de Neptune con una determinada versión de motor de destino.

## Tag (estructura)
<a name="Tag"></a>

Metadatos asignados a un recurso de Amazon Neptune que consta de un par clave-valor.

**Campos**
+ **Key**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  La clave es el nombre obligatorio de la etiqueta. El valor de la cadena puede tener una longitud de entre 1 y 128 caracteres Unicode y no puede llevar el prefijo `aws:` ni `rds:`. La cadena puede incluir únicamente el conjunto de letras de Unicode, dígitos y espacio en blanco, “\$1”, “.”, “/”, “=”, “\$1”, “-” (Java regex: “^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1”).
+ **Value**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El valor es la parte opcional de la etiqueta. El valor de la cadena puede tener una longitud de entre 1 y 256 caracteres Unicode y no puede llevar el prefijo `aws:` ni `rds:`. La cadena puede incluir únicamente el conjunto de letras de Unicode, dígitos y espacio en blanco, “\$1”, “.”, “/”, “=”, “\$1”, “-” (Java regex: “^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1”).

# Tipos de datos comunes de Neptune
<a name="api-datatypes"></a>

**Estructuras:**
+ [AvailabilityZone (estructura)](#AvailabilityZone)
+ [DBSecurityGroupMembership (estructura)](#DBSecurityGroupMembership)
+ [DomainMembership (estructura)](#DomainMembership)
+ [DoubleRange (estructura)](#DoubleRange)
+ [Endpoint (estructura)](#Endpoint)
+ [Filter (estructura)](#Filter)
+ [Range (estructura)](#Range)
+ [ServerlessV2ScalingConfiguration (estructura)](#ServerlessV2ScalingConfiguration)
+ [ServerlessV2ScalingConfigurationInfo (estructura)](#ServerlessV2ScalingConfigurationInfo)
+ [Zona horaria (estructura)](#Timezone)
+ [VpcSecurityGroupMembership (estructura)](#VpcSecurityGroupMembership)

## AvailabilityZone (estructura)
<a name="AvailabilityZone"></a>

Especifica una zona de disponibilidad.

**Campos**
+ **Name**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la zona de disponibilidad.

## DBSecurityGroupMembership (estructura)
<a name="DBSecurityGroupMembership"></a>

Especifica la membresía en un grupo de seguridad de base de datos designado.

**Campos**
+ **DBSecurityGroupName**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del grupo de seguridad de base de datos.
+ **Status**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El estado del grupo de seguridad de base de datos.

## DomainMembership (estructura)
<a name="DomainMembership"></a>

Un registro de pertenencia de dominio de Active Directory asociado a una instancia de base de datos.

**Campos**
+ **Domain**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El identificador del dominio de Active Directory.
+ **FQDN**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de dominio completo del dominio de Active Directory.
+ **IAMRoleName**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del rol de IAM que se utilizará al realizar llamadas a la API al Directory Service.
+ **Status**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El estado de la pertenencia al dominio de Active Directory de la instancia de base de datos, como, por ejemplo, "joined", "pending-join", "failed", etc.

## DoubleRange (estructura)
<a name="DoubleRange"></a>

Un rango de valores dobles.

**Campos**
+ **From**: se trata de un doble, del tipo: `double` (un número en coma flotante IEEE 754 de precisión doble).

  El valor mínimo del rango.
+ **To**: se trata de un doble, del tipo: `double` (un número en coma flotante IEEE 754 de precisión doble).

  El valor máximo del rango.

## Endpoint (estructura)
<a name="Endpoint"></a>

Especifica el punto de enlace de una conexión.

Para ver la estructura de datos que representa los puntos de conexión del clúster de base de datos de Amazon Neptune, consulte `DBClusterEndpoint`.

**Campos**
+ **Address**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica la dirección DNS de la instancia de base de datos.
+ **HostedZoneId**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Especifica el ID que Amazon Route 53 asigna al crear una zona alojada.
+ **Port**: se trata de un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

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

## Filter (estructura)
<a name="Filter"></a>

Este tipo no se admite en la actualidad.

**Campos**
+ **Name**: esto es *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Este parámetro es incompatible en estos momentos.
+ **Values**: esto es *obligatorio:* una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  Este parámetro es incompatible en estos momentos.

## Range (estructura)
<a name="Range"></a>

Un rango de valores enteros.

**Campos**
+ **From**: se trata de un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  El valor mínimo del rango.
+ **Step**: se trata de un IntegerOptional, del tipo: `integer` (un valor entero firmado de 32 bits).

  El valor de incremento para el rango. Por ejemplo, si tiene un rango de 5000 a 10 000, con un valor de incremento de 1000, los valores válidos comienzan a partir de 5000 e incrementan en 1000. Aunque 7500 se encuentra dentro del rango, no es un valor válido para el rango. Los valores válidos son 5000, 6000, 7000, 8000...
+ **To**: se trata de un valor entero, del tipo: `integer` (un valor entero firmado de 32 bits).

  El valor máximo del rango.

## ServerlessV2ScalingConfiguration (estructura)
<a name="ServerlessV2ScalingConfiguration"></a>

Incluye la configuración de escalado de un clúster de base de datos de Neptune sin servidor.

Para obtener más información, consulte [Uso de Amazon Neptune sin servidor](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) en la *Guía del usuario de Amazon Neptune*.

**Campos**
+ **MaxCapacity**: se trata de un DoubleOptional, del tipo: `double` (un número en coma flotante IEEE 754 de precisión doble).

  La cantidad máxima de unidades de capacidad de Neptune (NCU) para una instancia de base de datos en un clúster de Neptune sin servidor. Puede especificar los valores de la NCU en incrementos de medio punto, como 40; 40,5; 41; etc.
+ **MinCapacity**: se trata de un DoubleOptional, del tipo: `double` (un número en coma flotante IEEE 754 de precisión doble).

  La cantidad mínima de unidades de capacidad de Neptune (NCU) para una instancia de base de datos en un clúster de Neptune sin servidor. Puede especificar los valores de la NCU en incrementos de medio punto, como 8, 8,5, 9, etc.

## ServerlessV2ScalingConfigurationInfo (estructura)
<a name="ServerlessV2ScalingConfigurationInfo"></a>

Muestra la configuración de escalado de un clúster de base de datos de Neptune sin servidor.

Para obtener más información, consulte [Uso de Amazon Neptune sin servidor](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) en la *Guía del usuario de Amazon Neptune*.

**Campos**
+ **MaxCapacity**: se trata de un DoubleOptional, del tipo: `double` (un número en coma flotante IEEE 754 de precisión doble).

  La cantidad máxima de unidades de capacidad de Neptune (NCU) para una instancia de base de datos en un clúster de Neptune sin servidor. Puede especificar los valores de la NCU en incrementos de medio punto, como 40; 40,5; 41; etc.
+ **MinCapacity**: se trata de un DoubleOptional, del tipo: `double` (un número en coma flotante IEEE 754 de precisión doble).

  La cantidad mínima de unidades de capacidad de Neptune (NCU) para una instancia de base de datos en un clúster de Neptune sin servidor. Puede especificar los valores de la NCU en incrementos de medio punto, como 8, 8,5, 9, etc.

## Zona horaria (estructura)
<a name="Timezone"></a>

Una zona horaria asociada a una [DBInstance (estructura)](api-instances.md#DBInstance).

**Campos**
+ **TimezoneName**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre de la zona horaria.

## VpcSecurityGroupMembership (estructura)
<a name="VpcSecurityGroupMembership"></a>

Este tipo de datos se utiliza como elemento de respuesta para las consultas de pertenencia al grupo de seguridad de VPC.

**Campos**
+ **Status**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El estado del grupo de seguridad de VPC.
+ **VpcSecurityGroupId**: se trata de una cadena, del tipo: `string` (una cadena codificada con UTF-8).

  El nombre del grupo de seguridad de VPC.

# Excepciones de Neptune específicas de API individuales
<a name="api-faults"></a>

**Excepciones:**
+ [AuthorizationAlreadyExistsFault (estructura)](#AuthorizationAlreadyExistsFault)
+ [AuthorizationNotFoundFault (estructura)](#AuthorizationNotFoundFault)
+ [AuthorizationQuotaExceededFault (estructura)](#AuthorizationQuotaExceededFault)
+ [CertificateNotFoundFault (estructura)](#CertificateNotFoundFault)
+ [DBClusterAlreadyExistsFault (estructura)](#DBClusterAlreadyExistsFault)
+ [DBClusterNotFoundFault (estructura)](#DBClusterNotFoundFault)
+ [DBClusterParameterGroupNotFoundFault (estructura)](#DBClusterParameterGroupNotFoundFault)
+ [DBClusterQuotaExceededFault (estructura)](#DBClusterQuotaExceededFault)
+ [DBClusterRoleAlreadyExistsFault (estructura)](#DBClusterRoleAlreadyExistsFault)
+ [DBClusterRoleNotFoundFault (estructura)](#DBClusterRoleNotFoundFault)
+ [DBClusterRoleQuotaExceededFault (estructura)](#DBClusterRoleQuotaExceededFault)
+ [DBClusterSnapshotAlreadyExistsFault (estructura)](#DBClusterSnapshotAlreadyExistsFault)
+ [DBClusterSnapshotNotFoundFault (estructura)](#DBClusterSnapshotNotFoundFault)
+ [DBInstanceAlreadyExistsFault (estructura)](#DBInstanceAlreadyExistsFault)
+ [DBInstanceNotFoundFault (estructura)](#DBInstanceNotFoundFault)
+ [DBLogFileNotFoundFault (estructura)](#DBLogFileNotFoundFault)
+ [DBParameterGroupAlreadyExistsFault (estructura)](#DBParameterGroupAlreadyExistsFault)
+ [DBParameterGroupNotFoundFault (estructura)](#DBParameterGroupNotFoundFault)
+ [DBParameterGroupQuotaExceededFault (estructura)](#DBParameterGroupQuotaExceededFault)
+ [DBSecurityGroupAlreadyExistsFault (estructura)](#DBSecurityGroupAlreadyExistsFault)
+ [DBSecurityGroupNotFoundFault (estructura)](#DBSecurityGroupNotFoundFault)
+ [DBSecurityGroupNotSupportedFault (estructura)](#DBSecurityGroupNotSupportedFault)
+ [DBSecurityGroupQuotaExceededFault (estructura)](#DBSecurityGroupQuotaExceededFault)
+ [DBSnapshotAlreadyExistsFault (estructura)](#DBSnapshotAlreadyExistsFault)
+ [DBSnapshotNotFoundFault (estructura)](#DBSnapshotNotFoundFault)
+ [DBSubnetGroupAlreadyExistsFault (estructura)](#DBSubnetGroupAlreadyExistsFault)
+ [DBSubnetGroupDoesNotCoverEnoughAZs (estructura)](#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [DBSubnetGroupNotAllowedFault (estructura)](#DBSubnetGroupNotAllowedFault)
+ [DBSubnetGroupNotFoundFault (estructura)](#DBSubnetGroupNotFoundFault)
+ [DBSubnetGroupQuotaExceededFault (estructura)](#DBSubnetGroupQuotaExceededFault)
+ [DBSubnetQuotaExceededFault (estructura)](#DBSubnetQuotaExceededFault)
+ [DBUpgradeDependencyFailureFault (estructura)](#DBUpgradeDependencyFailureFault)
+ [DomainNotFoundFault (estructura)](#DomainNotFoundFault)
+ [EventSubscriptionQuotaExceededFault (estructura)](#EventSubscriptionQuotaExceededFault)
+ [GlobalClusterAlreadyExistsFault (estructura)](#GlobalClusterAlreadyExistsFault)
+ [GlobalClusterNotFoundFault (estructura)](#GlobalClusterNotFoundFault)
+ [GlobalClusterQuotaExceededFault (estructura)](#GlobalClusterQuotaExceededFault)
+ [InstanceQuotaExceededFault (estructura)](#InstanceQuotaExceededFault)
+ [InsufficientDBClusterCapacityFault (estructura)](#InsufficientDBClusterCapacityFault)
+ [InsufficientDBInstanceCapacityFault (estructura)](#InsufficientDBInstanceCapacityFault)
+ [InsufficientStorageClusterCapacityFault (estructura)](#InsufficientStorageClusterCapacityFault)
+ [InvalidDBClusterEndpointStateFault (estructura)](#InvalidDBClusterEndpointStateFault)
+ [InvalidDBClusterSnapshotStateFault (estructura)](#InvalidDBClusterSnapshotStateFault)
+ [InvalidDBClusterStateFault (estructura)](#InvalidDBClusterStateFault)
+ [InvalidDBInstanceStateFault (estructura)](#InvalidDBInstanceStateFault)
+ [InvalidDBParameterGroupStateFault (estructura)](#InvalidDBParameterGroupStateFault)
+ [InvalidDBSecurityGroupStateFault (estructura)](#InvalidDBSecurityGroupStateFault)
+ [InvalidDBSnapshotStateFault (estructura)](#InvalidDBSnapshotStateFault)
+ [InvalidDBSubnetGroupFault (estructura)](#InvalidDBSubnetGroupFault)
+ [InvalidDBSubnetGroupStateFault (estructura)](#InvalidDBSubnetGroupStateFault)
+ [InvalidDBSubnetStateFault (estructura)](#InvalidDBSubnetStateFault)
+ [InvalidEventSubscriptionStateFault (estructura)](#InvalidEventSubscriptionStateFault)
+ [InvalidGlobalClusterStateFault (estructura)](#InvalidGlobalClusterStateFault)
+ [InvalidOptionGroupStateFault (estructura)](#InvalidOptionGroupStateFault)
+ [InvalidRestoreFault (estructura)](#InvalidRestoreFault)
+ [InvalidSubnet (estructura)](#InvalidSubnet)
+ [InvalidVPCNetworkStateFault (estructura)](#InvalidVPCNetworkStateFault)
+ [KMSKeyNotAccessibleFault (estructura)](#KMSKeyNotAccessibleFault)
+ [OptionGroupNotFoundFault (estructura)](#OptionGroupNotFoundFault)
+ [PointInTimeRestoreNotEnabledFault (estructura)](#PointInTimeRestoreNotEnabledFault)
+ [ProvisionedIopsNotAvailableInAZFault (estructura)](#ProvisionedIopsNotAvailableInAZFault)
+ [ResourceNotFoundFault (estructura)](#ResourceNotFoundFault)
+ [SNSInvalidTopicFault (estructura)](#SNSInvalidTopicFault)
+ [SNSNoAuthorizationFault (estructura)](#SNSNoAuthorizationFault)
+ [SNSTopicArnNotFoundFault (estructura)](#SNSTopicArnNotFoundFault)
+ [SharedSnapshotQuotaExceededFault (estructura)](#SharedSnapshotQuotaExceededFault)
+ [SnapshotQuotaExceededFault (estructura)](#SnapshotQuotaExceededFault)
+ [SourceNotFoundFault (estructura)](#SourceNotFoundFault)
+ [StorageQuotaExceededFault (estructura)](#StorageQuotaExceededFault)
+ [StorageTypeNotSupportedFault (estructura)](#StorageTypeNotSupportedFault)
+ [SubnetAlreadyInUse (estructura)](#SubnetAlreadyInUse)
+ [SubscriptionAlreadyExistFault (estructura)](#SubscriptionAlreadyExistFault)
+ [SubscriptionCategoryNotFoundFault (estructura)](#SubscriptionCategoryNotFoundFault)
+ [SubscriptionNotFoundFault (estructura)](#SubscriptionNotFoundFault)

## AuthorizationAlreadyExistsFault (estructura)
<a name="AuthorizationAlreadyExistsFault"></a>

**Código de estado HTTP devuelto:  ** 400.

El CIDRIP especificado o grupo de seguridad de EC2 especificado ya se ha autorizado para el grupo de seguridad de base de datos especificado.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## AuthorizationNotFoundFault (estructura)
<a name="AuthorizationNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

El CIDRIP especificado o grupo de seguridad de EC2 especificado no está autorizado para el grupo de seguridad de base de datos especificado.

Neptune puede no recibir la autorización mediante IAM para realizar acciones necesarias en su nombre.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## AuthorizationQuotaExceededFault (estructura)
<a name="AuthorizationQuotaExceededFault"></a>

**Código de estado HTTP devuelto:  ** 400.

Se ha alcanzado la cuota de autorizaciones del grupo de seguridad de base de datos.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## CertificateNotFoundFault (estructura)
<a name="CertificateNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

*CertificateIdentifier* no hace referencia a un certificado existente.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBClusterAlreadyExistsFault (estructura)
<a name="DBClusterAlreadyExistsFault"></a>

**Código de estado HTTP devuelto:  ** 400.

El usuario ya tiene un clúster de base de datos con el identificador concreto.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBClusterNotFoundFault (estructura)
<a name="DBClusterNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

*DBClusterIdentifier* no hace referencia a un clúster de base de datos existente.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBClusterParameterGroupNotFoundFault (estructura)
<a name="DBClusterParameterGroupNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

*DBClusterParameterGroupName* no hace referencia a un grupo de parámetros de clúster de base de datos existente.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBClusterQuotaExceededFault (estructura)
<a name="DBClusterQuotaExceededFault"></a>

**Código de estado HTTP devuelto:  ** 403.

El usuario intentó crear un nuevo clúster de base de datos y el usuario ya ha alcanzado la cuota máxima permitida de clústeres de bases de datos.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBClusterRoleAlreadyExistsFault (estructura)
<a name="DBClusterRoleAlreadyExistsFault"></a>

**Código de estado HTTP devuelto:  ** 400.

El Nombre de recurso de Amazon (ARN) del rol de IAM especificado ya está asociado con el clúster de base de datos especificado.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBClusterRoleNotFoundFault (estructura)
<a name="DBClusterRoleNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

El Nombre de recurso de Amazon (ARN) del rol de IAM especificado no está asociado con el clúster de base de datos especificado.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBClusterRoleQuotaExceededFault (estructura)
<a name="DBClusterRoleQuotaExceededFault"></a>

**Código de estado HTTP devuelto:  ** 400.

Ha superado el número máximo de roles de IAM que se pueden asociar con el clúster de base de datos especificado.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBClusterSnapshotAlreadyExistsFault (estructura)
<a name="DBClusterSnapshotAlreadyExistsFault"></a>

**Código de estado HTTP devuelto:  ** 400.

El usuario ya tiene una instantánea del clúster de base de datos con el identificador concreto.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBClusterSnapshotNotFoundFault (estructura)
<a name="DBClusterSnapshotNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

*DBClusterSnapshotIdentifier* no hace referencia a una instantánea del clúster de base de datos existente.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBInstanceAlreadyExistsFault (estructura)
<a name="DBInstanceAlreadyExistsFault"></a>

**Código de estado HTTP devuelto:  ** 400.

El usuario ya tiene una instancia de base de datos con el identificador concreto.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBInstanceNotFoundFault (estructura)
<a name="DBInstanceNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

*DBInstanceIdentifier* no hace referencia a una instancia de base de datos existente.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBLogFileNotFoundFault (estructura)
<a name="DBLogFileNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

 *LogFileName* no hace referencia a un archivo de registro de base de datos existente.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBParameterGroupAlreadyExistsFault (estructura)
<a name="DBParameterGroupAlreadyExistsFault"></a>

**Código de estado HTTP devuelto:  ** 400.

Existe un grupo de parámetros de base de datos con el mismo nombre.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBParameterGroupNotFoundFault (estructura)
<a name="DBParameterGroupNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

*DBParameterGroupName* no hace referencia a un grupo de parámetros de base de datos existente.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBParameterGroupQuotaExceededFault (estructura)
<a name="DBParameterGroupQuotaExceededFault"></a>

**Código de estado HTTP devuelto:  ** 400.

La solicitud daría lugar a que el usuario superara el número permitido de grupos de parámetros de base de datos.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBSecurityGroupAlreadyExistsFault (estructura)
<a name="DBSecurityGroupAlreadyExistsFault"></a>

**Código de estado HTTP devuelto:  ** 400.

Ya existe un grupo de seguridad de base de datos con el nombre especificado en *DBSecurityGroupName*.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBSecurityGroupNotFoundFault (estructura)
<a name="DBSecurityGroupNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

*DBSecurityGroupName* no hace referencia a un grupo de seguridad de base de datos existente.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBSecurityGroupNotSupportedFault (estructura)
<a name="DBSecurityGroupNotSupportedFault"></a>

**Código de estado HTTP devuelto:  ** 400.

Un grupo de seguridad de base de datos no está permitido para esta acción.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBSecurityGroupQuotaExceededFault (estructura)
<a name="DBSecurityGroupQuotaExceededFault"></a>

**Código de estado HTTP devuelto:  ** 400.

La solicitud daría lugar a que el usuario superara el número permitido de grupos de seguridad de base de datos.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBSnapshotAlreadyExistsFault (estructura)
<a name="DBSnapshotAlreadyExistsFault"></a>

**Código de estado HTTP devuelto:  ** 400.

*DBSnapshotIdentifier* ya lo utiliza una instantánea existente.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBSnapshotNotFoundFault (estructura)
<a name="DBSnapshotNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

*DBSnapshotIdentifier* no hace referencia a una instantánea de base de datos existente.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBSubnetGroupAlreadyExistsFault (estructura)
<a name="DBSubnetGroupAlreadyExistsFault"></a>

**Código de estado HTTP devuelto:  ** 400.

*DBSubnetGroupName* ya lo utiliza un grupo de subred de base de datos existente.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBSubnetGroupDoesNotCoverEnoughAZs (estructura)
<a name="DBSubnetGroupDoesNotCoverEnoughAZs"></a>

**Código de estado HTTP devuelto:  ** 400.

Las subredes del grupo de subredes de base de datos deben incluir al menos dos zonas de disponibilidad a menos que solo haya una zona de disponibilidad.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBSubnetGroupNotAllowedFault (estructura)
<a name="DBSubnetGroupNotAllowedFault"></a>

**Código de estado HTTP devuelto:  ** 400.

Indica que no debe especificarse el DBSubnetGroup al crear réplicas de lectura que están en la misma región que la instancia de origen.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBSubnetGroupNotFoundFault (estructura)
<a name="DBSubnetGroupNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

*DBSubnetGroupName* no hace referencia a un grupo de subred de base de datos existente.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBSubnetGroupQuotaExceededFault (estructura)
<a name="DBSubnetGroupQuotaExceededFault"></a>

**Código de estado HTTP devuelto:  ** 400.

La solicitud daría lugar a que el usuario superara el número permitido de grupos de subred de base de datos.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBSubnetQuotaExceededFault (estructura)
<a name="DBSubnetQuotaExceededFault"></a>

**Código de estado HTTP devuelto:  ** 400.

La solicitud daría lugar a que el usuario superara el número permitido de subredes en un grupo de subredes de base de datos.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DBUpgradeDependencyFailureFault (estructura)
<a name="DBUpgradeDependencyFailureFault"></a>

**Código de estado HTTP devuelto:  ** 400.

Se ha producido un error en la actualización de la base de datos porque no se ha podido modificar un recurso del que depende la base de datos.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## DomainNotFoundFault (estructura)
<a name="DomainNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

*Domain* no hace referencia a un dominio de Active Directory existente.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## EventSubscriptionQuotaExceededFault (estructura)
<a name="EventSubscriptionQuotaExceededFault"></a>

**Código de estado HTTP devuelto:  ** 400.

Ha superado el número de eventos al que puede suscribirse.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## GlobalClusterAlreadyExistsFault (estructura)
<a name="GlobalClusterAlreadyExistsFault"></a>

**Código de estado HTTP devuelto:  ** 400.

El `GlobalClusterIdentifier` ya existe. Elija un nuevo identificador de base de datos global (nombre único) para crear un nuevo clúster de base de datos global.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## GlobalClusterNotFoundFault (estructura)
<a name="GlobalClusterNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

El `GlobalClusterIdentifier` no hace referencia a un clúster de base de datos global existente. 

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## GlobalClusterQuotaExceededFault (estructura)
<a name="GlobalClusterQuotaExceededFault"></a>

**Código de estado HTTP devuelto:  ** 400.

El número de clústeres de bases de datos globales para esta cuenta ya está en el máximo permitido.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InstanceQuotaExceededFault (estructura)
<a name="InstanceQuotaExceededFault"></a>

**Código de estado HTTP devuelto:  ** 400.

La solicitud daría lugar a que el usuario superara el número permitido de instancias de base de datos.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InsufficientDBClusterCapacityFault (estructura)
<a name="InsufficientDBClusterCapacityFault"></a>

**Código de estado HTTP devuelto:  ** 403.

El clúster de base de datos no tiene capacidad suficiente para la operación actual.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InsufficientDBInstanceCapacityFault (estructura)
<a name="InsufficientDBInstanceCapacityFault"></a>

**Código de estado HTTP devuelto:  ** 400.

La clase de instancia de base de datos especificada no está disponible en la zona de disponibilidad especificada.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InsufficientStorageClusterCapacityFault (estructura)
<a name="InsufficientStorageClusterCapacityFault"></a>

**Código de estado HTTP devuelto:  ** 400.

Existe insuficiente almacenamiento disponible para la acción en curso. Es posible que pueda resolver este error mediante la actualización de su grupo de subredes para utilizar diferentes zonas de disponibilidad que tienen más almacenamiento disponible.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InvalidDBClusterEndpointStateFault (estructura)
<a name="InvalidDBClusterEndpointStateFault"></a>

**Código de estado HTTP devuelto:  ** 400.

La operación solicitada no se puede realizar en el punto de conexión mientras este se encuentre en este estado.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InvalidDBClusterSnapshotStateFault (estructura)
<a name="InvalidDBClusterSnapshotStateFault"></a>

**Código de estado HTTP devuelto:  ** 400.

El valor suministrado no es un estado válido de instantánea de clúster de base de datos.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InvalidDBClusterStateFault (estructura)
<a name="InvalidDBClusterStateFault"></a>

**Código de estado HTTP devuelto:  ** 400.

El clúster de la base de datos no se encuentra en un estado válido.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InvalidDBInstanceStateFault (estructura)
<a name="InvalidDBInstanceStateFault"></a>

**Código de estado HTTP devuelto:  ** 400.

La instancia de base de datos especificada no se encuentra en el estado *disponible*.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InvalidDBParameterGroupStateFault (estructura)
<a name="InvalidDBParameterGroupStateFault"></a>

**Código de estado HTTP devuelto:  ** 400.

El grupo de parámetros de base de datos está en uso o está en un estado no válido. Si intenta eliminar el grupo de parámetros, no puede eliminarlo cuando el grupo de parámetros se encuentra en este estado.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InvalidDBSecurityGroupStateFault (estructura)
<a name="InvalidDBSecurityGroupStateFault"></a>

**Código de estado HTTP devuelto:  ** 400.

El estado del grupo de seguridad de base de datos no permite la eliminación.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InvalidDBSnapshotStateFault (estructura)
<a name="InvalidDBSnapshotStateFault"></a>

**Código de estado HTTP devuelto:  ** 400.

El estado de la instantánea de base de datos no permite la eliminación.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InvalidDBSubnetGroupFault (estructura)
<a name="InvalidDBSubnetGroupFault"></a>

**Código de estado HTTP devuelto:  ** 400.

Indica que el DBSubnetGroup no pertenece a la misma VPC que una réplica de lectura entre regiones existente de la misma instancia de origen.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InvalidDBSubnetGroupStateFault (estructura)
<a name="InvalidDBSubnetGroupStateFault"></a>

**Código de estado HTTP devuelto:  ** 400.

El grupo de subredes de base de datos no se puede eliminar porque está en uso.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InvalidDBSubnetStateFault (estructura)
<a name="InvalidDBSubnetStateFault"></a>

**Código de estado HTTP devuelto:  ** 400.

La subred de base de datos no se encuentra en el estado *disponible*.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InvalidEventSubscriptionStateFault (estructura)
<a name="InvalidEventSubscriptionStateFault"></a>

**Código de estado HTTP devuelto:  ** 400.

La suscripción a eventos se encuentra en un estado no válido.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InvalidGlobalClusterStateFault (estructura)
<a name="InvalidGlobalClusterStateFault"></a>

**Código de estado HTTP devuelto:  ** 400.

El estado del clúster global no es válido y no puede realizar la operación solicitada. 

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InvalidOptionGroupStateFault (estructura)
<a name="InvalidOptionGroupStateFault"></a>

**Código de estado HTTP devuelto:  ** 400.

El grupo de opciones no se encuentra en el estado *disponible*.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InvalidRestoreFault (estructura)
<a name="InvalidRestoreFault"></a>

**Código de estado HTTP devuelto:  ** 400.

No se puede restaurar desde la copia de seguridad de VPC a una instancia de base de datos no VPC.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InvalidSubnet (estructura)
<a name="InvalidSubnet"></a>

**Código de estado HTTP devuelto:  ** 400.

La subred solicitada no es válida o se solicitaron varias subredes que no están en la misma VPC.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## InvalidVPCNetworkStateFault (estructura)
<a name="InvalidVPCNetworkStateFault"></a>

**Código de estado HTTP devuelto:  ** 400.

El grupo de subredes de base de datos no cubre todas las zonas de disponibilidad después de crearla ya que los usuarios cambian.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## KMSKeyNotAccessibleFault (estructura)
<a name="KMSKeyNotAccessibleFault"></a>

**Código de estado HTTP devuelto:  ** 400.

Error al obtener acceso a la clave de KMS.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## OptionGroupNotFoundFault (estructura)
<a name="OptionGroupNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

No se encuentra el grupo de opciones designadas.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## PointInTimeRestoreNotEnabledFault (estructura)
<a name="PointInTimeRestoreNotEnabledFault"></a>

**Código de estado HTTP devuelto:  ** 400.

*SourceDBInstanceIdentifier* hace referencia a una instancia de base de datos con *BackupRetentionPeriod* igual a 0.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## ProvisionedIopsNotAvailableInAZFault (estructura)
<a name="ProvisionedIopsNotAvailableInAZFault"></a>

**Código de estado HTTP devuelto:  ** 400.

Las IOPS provisionadas no están disponibles en la zona de disponibilidad especificada.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## ResourceNotFoundFault (estructura)
<a name="ResourceNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

No se ha encontrado el ID del recurso especificado.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## SNSInvalidTopicFault (estructura)
<a name="SNSInvalidTopicFault"></a>

**Código de estado HTTP devuelto:  ** 400.

El tema de SNS no es válido.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## SNSNoAuthorizationFault (estructura)
<a name="SNSNoAuthorizationFault"></a>

**Código de estado HTTP devuelto:  ** 400.

No hay autorización de SNS.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## SNSTopicArnNotFoundFault (estructura)
<a name="SNSTopicArnNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

El ARN del tema de SNS no se puede encontrar.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## SharedSnapshotQuotaExceededFault (estructura)
<a name="SharedSnapshotQuotaExceededFault"></a>

**Código de estado HTTP devuelto:  ** 400.

Ha superado el número máximo de cuentas con las que puede compartir una instantánea manual de base de datos.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## SnapshotQuotaExceededFault (estructura)
<a name="SnapshotQuotaExceededFault"></a>

**Código de estado HTTP devuelto:  ** 400.

La solicitud daría lugar a que el usuario superara el número permitido de instantáneas de base de datos.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## SourceNotFoundFault (estructura)
<a name="SourceNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

No se encuentra el origen.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## StorageQuotaExceededFault (estructura)
<a name="StorageQuotaExceededFault"></a>

**Código de estado HTTP devuelto:  ** 400.

La solicitud daría lugar a que el usuario superara la cantidad permitida de almacenamiento disponible a través de todas las instancias de base de datos.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## StorageTypeNotSupportedFault (estructura)
<a name="StorageTypeNotSupportedFault"></a>

**Código de estado HTTP devuelto:  ** 400.

El *StorageType* especificado no se puede asociar a la instancia de base de datos.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## SubnetAlreadyInUse (estructura)
<a name="SubnetAlreadyInUse"></a>

**Código de estado HTTP devuelto:  ** 400.

La subred de base de datos ya está en uso en la zona de disponibilidad.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## SubscriptionAlreadyExistFault (estructura)
<a name="SubscriptionAlreadyExistFault"></a>

**Código de estado HTTP devuelto:  ** 400.

Esta suscripción ya existe.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## SubscriptionCategoryNotFoundFault (estructura)
<a name="SubscriptionCategoryNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

No se ha encontrado la categoría de suscripción designada.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.

## SubscriptionNotFoundFault (estructura)
<a name="SubscriptionNotFoundFault"></a>

**Código de estado HTTP devuelto:  ** 404.

No se encuentra la suscripción designada.

**Campos**
+ **message**: se trata de un ExceptionMessage, del tipo: `string` (una cadena codificada con UTF-8).

  Mensaje que describe los detalles del problema.