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.
# Data Types
Los siguientes tipos de datos son compatibles con Amazon DocumentDB (with MongoDB compatibility):
+ [AvailabilityZone](API_AvailabilityZone.md)
+ [Certificate](API_Certificate.md)
+ [CertificateDetails](API_CertificateDetails.md)
+ [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md)
+ [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md)
+ [DBCluster](API_DBCluster.md)
+ [DBClusterMember](API_DBClusterMember.md)
+ [DBClusterParameterGroup](API_DBClusterParameterGroup.md)
+ [DBClusterRole](API_DBClusterRole.md)
+ [DBClusterSnapshot](API_DBClusterSnapshot.md)
+ [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md)
+ [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md)
+ [DBEngineVersion](API_DBEngineVersion.md)
+ [DBInstance](API_DBInstance.md)
+ [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md)
+ [DBSubnetGroup](API_DBSubnetGroup.md)
+ [Endpoint](API_Endpoint.md)
+ [EngineDefaults](API_EngineDefaults.md)
+ [Event](API_Event.md)
+ [EventCategoriesMap](API_EventCategoriesMap.md)
+ [EventSubscription](API_EventSubscription.md)
+ [FailoverState](API_FailoverState.md)
+ [Filter](API_Filter.md)
+ [GlobalCluster](API_GlobalCluster.md)
+ [GlobalClusterMember](API_GlobalClusterMember.md)
+ [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md)
+ [Parameter](API_Parameter.md)
+ [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md)
+ [PendingMaintenanceAction](API_PendingMaintenanceAction.md)
+ [PendingModifiedValues](API_PendingModifiedValues.md)
+ [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md)
+ [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md)
+ [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)
+ [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md)
+ [Subnet](API_Subnet.md)
+ [Tag](API_Tag.md)
+ [UpgradeTarget](API_UpgradeTarget.md)
+ [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md)
Los siguientes tipos de datos son compatibles con los clústeres elásticos de Amazon DocumentDB:
+ [Cluster](API_elastic_Cluster.md)
+ [ClusterInList](API_elastic_ClusterInList.md)
+ [ClusterSnapshot](API_elastic_ClusterSnapshot.md)
+ [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md)
+ [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md)
+ [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)
+ [Shard](API_elastic_Shard.md)
+ [ValidationExceptionField](API_elastic_ValidationExceptionField.md)
# Amazon DocumentDB (with MongoDB compatibility)
Los siguientes tipos de datos son compatibles con Amazon DocumentDB (with MongoDB compatibility):
+ [AvailabilityZone](API_AvailabilityZone.md)
+ [Certificate](API_Certificate.md)
+ [CertificateDetails](API_CertificateDetails.md)
+ [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md)
+ [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md)
+ [DBCluster](API_DBCluster.md)
+ [DBClusterMember](API_DBClusterMember.md)
+ [DBClusterParameterGroup](API_DBClusterParameterGroup.md)
+ [DBClusterRole](API_DBClusterRole.md)
+ [DBClusterSnapshot](API_DBClusterSnapshot.md)
+ [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md)
+ [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md)
+ [DBEngineVersion](API_DBEngineVersion.md)
+ [DBInstance](API_DBInstance.md)
+ [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md)
+ [DBSubnetGroup](API_DBSubnetGroup.md)
+ [Endpoint](API_Endpoint.md)
+ [EngineDefaults](API_EngineDefaults.md)
+ [Event](API_Event.md)
+ [EventCategoriesMap](API_EventCategoriesMap.md)
+ [EventSubscription](API_EventSubscription.md)
+ [FailoverState](API_FailoverState.md)
+ [Filter](API_Filter.md)
+ [GlobalCluster](API_GlobalCluster.md)
+ [GlobalClusterMember](API_GlobalClusterMember.md)
+ [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md)
+ [Parameter](API_Parameter.md)
+ [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md)
+ [PendingMaintenanceAction](API_PendingMaintenanceAction.md)
+ [PendingModifiedValues](API_PendingModifiedValues.md)
+ [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md)
+ [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md)
+ [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)
+ [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md)
+ [Subnet](API_Subnet.md)
+ [Tag](API_Tag.md)
+ [UpgradeTarget](API_UpgradeTarget.md)
+ [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md)
# AvailabilityZone
Información sobre una zona de disponibilidad.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** Name **
El nombre de la zona de disponibilidad.
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AvailabilityZone)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AvailabilityZone)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AvailabilityZone)
# Certificate
Certificado de una entidad de certificación (CA) para una Cuenta de AWS.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** CertificateArn **
El nombre de recurso de Amazon (ARN) para el certificado.
Ejemplo:: `arn:aws:rds:us-east-1::cert:rds-ca-2019`
Tipo: cadena
Requerido: no
** CertificateIdentifier **
La clave única que identifica un certificado.
Ejemplo:: `rds-ca-2019`
Tipo: cadena
Requerido: no
** CertificateType **
Escriba el nombre del certificado.
Ejemplo:: `CA`
Tipo: cadena
Requerido: no
** Thumbprint **
La huella digital del certificado.
Tipo: cadena
Requerido: no
** ValidFrom **
La fecha y hora de inicio a partir de la cual el certificado es válido.
Ejemplo:: `2019-07-31T17:57:09Z`
Tipo: marca temporal
Obligatorio: no
** ValidTill **
La fecha y hora después de la cual el certificado no es válido.
Ejemplo:: `2024-07-31T17:57:09Z`
Tipo: marca temporal
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Certificate)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Certificate)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Certificate)
# CertificateDetails
Devuelve los detalles del certificado de servidor de la instancia de base de datos.
Para obtener más información, consulte [Cómo actualizar los certificados TLS de Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) y [Cómo cifrar datos en tránsito](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) en la *Guía para desarrolladores de Amazon DocumentDB*.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** CAIdentifier **
El identificador CA del certificado de CA que usado para el certificado de servidor de la instancia de base de datos.
Tipo: cadena
Requerido: no
** ValidTill **
La fecha de vencimiento del certificado de servidor de la instancia de base de datos.
Tipo: marca temporal
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CertificateDetails)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CertificateDetails)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CertificateDetails)
# CloudwatchLogsExportConfiguration
La opción de configuración para los tipos de registro que se debe habilitar para la exportación a Registros de Amazon CloudWatch para una instancia o un clúster específico.
Las matrices `EnableLogTypes` y `DisableLogTypes` determinan qué registros se exportarán (o no) a CloudWatch Logs. Los valores de estas matrices dependen del motor que se utilice.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** DisableLogTypes.member.N **
La lista de tipos de registros que desea deshabilitar.
Tipo: matriz de cadenas
Obligatorio: no
** EnableLogTypes.member.N **
La lista de tipos de registros que desea habilitar.
Tipo: matriz de cadenas
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CloudwatchLogsExportConfiguration)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CloudwatchLogsExportConfiguration)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CloudwatchLogsExportConfiguration)
# ClusterMasterUserSecret
Contiene el secreto administrado por Amazon DocumentDB en Secrets Manager de AWS para la contraseña del usuario maestro.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** KmsKeyId **
El identificador de la clave de AWS KMS que se utiliza para cifrar el secreto.
Tipo: cadena
Requerido: no
** SecretArn **
El nombre de recurso de Amazon (ARN) del secreto.
Tipo: cadena
Requerido: no
** SecretStatus **
El estado del secreto.
Otros valores de estado posibles son:
+ en creación: se está creando el secreto.
+ activo: el secreto está disponible para su uso y rotación normales.
+ en rotación: se está rotando el secreto.
+ dañado: el secreto se puede usar para acceder a las credenciales de la base de datos, pero no se puede rotar. Un secreto puede tener este estado si, por ejemplo, se cambian los permisos para que Amazon DocumentDB ya no pueda acceder al secreto ni a la clave de KMS del secreto.
Cuando un secreto tiene este estado, puede corregir la condición que provocó el estado. De forma alternativa, modifique la instancia para desactivar la administración automática de las credenciales de la base de datos y, a continuación, modifique la instancia para activar la administración automática de las credenciales de la base de datos.
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ClusterMasterUserSecret)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ClusterMasterUserSecret)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ClusterMasterUserSecret)
# DBCluster
Información detallada sobre un clúster.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** AssociatedRoles.DBClusterRole.N **
Proporciona una lista de los roles AWS Identity and Access Management (IAM) que están asociados con un clúster de base de datos. Los roles de IAM asociados a un clúster conceden permisos para que dicho clúster acceda a otros servicios de AWS en su nombre.
Tipo: matriz de objetos [DBClusterRole](API_DBClusterRole.md)
Obligatorio: no
** AvailabilityZones.AvailabilityZone.N **
Proporciona la lista de zonas de disponibilidad de Amazon EC2 en las que se pueden crear instancias en el clúster.
Tipo: matriz de cadenas
Obligatorio: no
** BackupRetentionPeriod **
Especifica el número de días durante los que se retienen las instantáneas automáticas.
Tipo: entero
Obligatorio: no
** CloneGroupId **
Identifica el grupo de clones al que está asociado el clúster de base de datos.
Tipo: cadena
Requerido: no
** ClusterCreateTime **
Especifica la hora a la que se creó el clúster, en tiempo universal coordinado (UTC).
Tipo: marca temporal
Obligatorio: no
** DBClusterArn **
El Nombre de recurso de Amazon (ARN) para el clúster.
Tipo: cadena
Requerido: no
** DBClusterIdentifier **
Contiene un identificador de clúster suministrado por el usuario. Este identificador es la clave única que identifica un clúster.
Tipo: cadena
Requerido: no
** DBClusterMembers.DBClusterMember.N **
Proporciona la lista de instancias que componen el clúster.
Tipo: matriz de objetos [DBClusterMember](API_DBClusterMember.md)
Obligatorio: no
** DBClusterParameterGroup **
Especifica el nombre del grupo de parámetros de clúster para el clúster.
Tipo: cadena
Requerido: no
** DbClusterResourceId **
El identificador inmutable único de Región de AWS para el clúster. Este identificador se encuentra en las entradas de registro de AWS CloudTrail cada vez que se accede a la clave de AWS KMS del clúster.
Tipo: cadena
Requerido: no
** DBSubnetGroup **
Especifica información sobre el grupo de subred asociado con el clúster, incluido el nombre, la descripción y subredes en el grupo de subred.
Tipo: cadena
Requerido: no
** DeletionProtection **
Especifica si se puede eliminar este clúster. Si `DeletionProtection` está habilitado, no se puede eliminar el clúster a menos que se modifique y `DeletionProtection` esté deshabilitado. `DeletionProtection` protege los clústeres de una eliminación accidental.
Tipo: Booleano
Obligatorio: no
** EarliestRestorableTime **
Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
Tipo: marca temporal
Obligatorio: no
** EnabledCloudwatchLogsExports.member.N **
Una lista de tipos de registro para los que este clúster está configurado para exportar a los Registros de Amazon CloudWatch.
Tipo: matriz de cadenas
Obligatorio: no
** Endpoint **
Especifica el punto de conexión para la instancia principal del clúster.
Tipo: cadena
Requerido: no
** Engine **
Proporciona el nombre del motor de base de datos que se debe utilizar para este clúster.
Tipo: cadena
Requerido: no
** EngineVersion **
Indica la versión del motor de base de datos.
Tipo: cadena
Requerido: no
** HostedZoneId **
Especifica el ID que Amazon Route 53 asigna al crear una zona alojada.
Tipo: cadena
Requerido: no
** IOOptimizedNextAllowedModificationTime **
La próxima vez, podrá modificar el clúster de Amazon DocumentDB para utilizar el tipo de almacenamiento iopt1.
Tipo: marca temporal
Obligatorio: no
** KmsKeyId **
Si `StorageEncrypted` es `true`, el identificador de la clave de AWS KMS para el clúster cifrado.
Tipo: cadena
Requerido: no
** LatestRestorableTime **
Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
Tipo: marca temporal
Obligatorio: no
** MasterUsername **
Contiene el nombre de usuario maestro para el clúster.
Tipo: cadena
Requerido: no
** MasterUserSecret **
El secreto administrado por Amazon DocumentDB en Secrets Manager de AWS para la contraseña del usuario maestro.
Tipo: objeto [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md)
Obligatorio: no
** MultiAZ **
Especifica si el clúster tiene instancias en varias zonas de disponibilidad.
Tipo: Booleano
Obligatorio: no
** NetworkType **
El tipo de red del clúster.
El tipo de red viene determinado por el `DBSubnetGroup` especificado para el clúster. Un `DBSubnetGroup` admite solamente el protocolo IPv4 o los protocolos IPv4 e IPv6 (`DUAL`).
Para obtener más información, consulte [Clústeres de DocumentDB en una VPC](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) en la Guía para desarrolladores de Amazon DocumentDB.
Valores válidos: `IPV4` \$1 `DUAL`
Tipo: cadena
Requerido: no
** PercentProgress **
Especifica el progreso de la operación como porcentaje.
Tipo: cadena
Requerido: no
** Port **
Especifica el puerto en el que escucha el motor de la base de datos.
Tipo: entero
Obligatorio: no
** PreferredBackupWindow **
Especifica el intervalo de tiempo diario durante el cual se crean copias de seguridad automatizadas si las copias de seguridad automatizadas están habilitadas, de acuerdo con la propiedad `BackupRetentionPeriod`.
Tipo: cadena
Requerido: no
** PreferredMaintenanceWindow **
Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
Tipo: cadena
Requerido: no
** ReaderEndpoint **
El punto de conexión del lector para el clúster. El punto de conexión del lector de un clúster equilibra la carga de las conexiones entre las réplicas de Amazon DocumentDB que están disponibles en un clúster. A medida que los clientes solicitan nuevas conexiones al punto de conexión del lector, Amazon DocumentDB distribuye las solicitudes de conexión entre las réplicas de Amazon DocumentDB del clúster. Esta funcionalidad puede ayudar a equilibrar la carga de trabajo de lectura entre las distintas réplicas de Amazon DocumentDB del clúster.
Si se produce una conmutación por error y la réplica de Amazon DocumentDB 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 Amazon DocumentDB del clúster, puede volver a conectarse al punto de conexión del lector.
Tipo: cadena
Requerido: no
** ReadReplicaIdentifiers.ReadReplicaIdentifier.N **
Contiene uno o más identificadores de los clústeres secundarios asociados a este clúster.
Tipo: matriz de cadenas
Obligatorio: no
** ReplicationSourceIdentifier **
Contiene el identificador del clúster de origen si este clúster es secundario.
Tipo: cadena
Requerido: no
** ServerlessV2ScalingConfiguration **
La configuración de escalado de un clúster de Amazon DocumentDB sin servidor.
Tipo: objeto [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md)
Obligatorio: no
** Status **
Especifica el estado actual de este clúster de base de datos.
Tipo: cadena
Requerido: no
** StorageEncrypted **
Especifica si el clúster está cifrado.
Tipo: Booleano
Obligatorio: no
** StorageType **
Tipo de almacenamiento asociado al clúster
Para obtener información sobre los tipos de almacenamiento de los clústeres de Amazon DocumentDB, consulte Cluster storage configurations en la *Guía para desarrolladores de Amazon DocumentDB*.
Valores válidos para el tipo de almacenamiento: `standard | iopt1`
El valor predeterminado es `standard `
Tipo: cadena
Requerido: no
** VpcSecurityGroups.VpcSecurityGroupMembership.N **
Una lista de grupos de seguridad de la nube privada virtual (VPC) a las que pertenece el clúster.
Tipo: matriz de objetos [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md)
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBCluster)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBCluster)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBCluster)
# DBClusterMember
Contiene información sobre una instancia que forma parte de un clúster de base de datos.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** DBClusterParameterGroupStatus **
Especifica el estado del grupo de parámetros de clúster de base de datos para este miembro del clúster de base de datos.
Tipo: cadena
Requerido: no
** DBInstanceIdentifier **
Especifica el identificador de la instancia de este miembro del clúster.
Tipo: cadena
Requerido: no
** IsClusterWriter **
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.
Tipo: Booleano
Obligatorio: no
** PromotionTier **
Valor que especifica el orden en el que se promueve una réplica de Amazon DocumentDB a la instancia primaria tras un fallo de la instancia primaria existente.
Tipo: entero
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterMember)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterMember)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterMember)
# DBClusterParameterGroup
Información detallada sobre un grupo de parámetros de clúster.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** DBClusterParameterGroupArn **
El Nombre de recurso de Amazon (ARN) para el grupo de parámetros de clúster.
Tipo: cadena
Requerido: no
** DBClusterParameterGroupName **
Proporciona el nombre del grupo de parámetros de clúster.
Tipo: cadena
Requerido: no
** DBParameterGroupFamily **
Proporciona el nombre de la familia del grupo de parámetros con el que este grupo de parámetros de clúster es compatible.
Tipo: cadena
Requerido: no
** Description **
Proporciona la descripción especificada por el usuario para este grupo de parámetros de clúster.
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterParameterGroup)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterParameterGroup)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterParameterGroup)
# DBClusterRole
Describe un rol de AWS Identity and Access Management (IAM)que está asociado con un clúster de base de datos.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** RoleArn **
El Nombre de recurso de Amazon (ARN) del rol de IAM asociado al clúster de base de datos.
Tipo: cadena
Requerido: no
** Status **
Describe el estado de asociación entre el rol de IAM y el clúster. La propiedad del `Status` 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 AWS en su nombre.
+ `PENDING`: el ARN del rol de IAM se está asociando al clúster.
+ `INVALID`: el ARN del rol de IAM se asocia con el clúster, pero el clúster no puede asumir el rol de IAM para acceder a otros servicios de AWS en su nombre.
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterRole)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterRole)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterRole)
# DBClusterSnapshot
Información detallada sobre una instantánea de un clúster.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** AvailabilityZones.AvailabilityZone.N **
Proporciona la lista de zonas de disponibilidad del EC2 de Amazon donde se pueden restaurar las instancias de la instantánea del clúster.
Tipo: matriz de cadenas
Obligatorio: no
** ClusterCreateTime **
Especifica la hora a la que se creó el clúster, en tiempo universal coordinado (UTC).
Tipo: marca temporal
Obligatorio: no
** DBClusterIdentifier **
Especifica el identificador del clúster, del clúster a partir del cual se creó esta instantánea del clúster.
Tipo: cadena
Requerido: no
** DBClusterSnapshotArn **
El Nombre de recurso de Amazon (ARN) de la instantánea del clúster.
Tipo: cadena
Requerido: no
** DBClusterSnapshotIdentifier **
Especifica el identificador de la instantánea del clúster.
Tipo: cadena
Requerido: no
** Engine **
Especifica el nombre del motor de base de datos.
Tipo: cadena
Requerido: no
** EngineVersion **
Proporciona la versión del motor de base de datos para esta instantánea del clúster.
Tipo: cadena
Requerido: no
** KmsKeyId **
Si `StorageEncrypted` es `true`, el identificador de la clave de AWS KMS para la instantánea del clúster de base de datos cifrada.
Tipo: cadena
Requerido: no
** MasterUsername **
Proporciona el nombre de usuario maestro para la instantánea del clúster.
Tipo: cadena
Requerido: no
** PercentProgress **
Especifica el porcentaje de la estimación de los datos que se han transferido.
Tipo: entero
Obligatorio: no
** Port **
Especifica el puerto que el clúster estaba escuchando en el momento de la instantánea.
Tipo: entero
Obligatorio: no
** SnapshotCreateTime **
Proporciona la hora a la que se tomó la instantánea, en UTC.
Tipo: marca temporal
Obligatorio: no
** SnapshotType **
Proporciona el tipo de instantánea del clúster.
Tipo: cadena
Requerido: no
** SourceDBClusterSnapshotArn **
Si la instantánea del clúster se ha copiado de una instantánea de clúster de origen, el ARN para la instantánea del clúster de origen; de lo contrario, es un valor nulo.
Tipo: cadena
Requerido: no
** Status **
Especifica el estado de esta instantánea del clúster.
Tipo: cadena
Requerido: no
** StorageEncrypted **
Especifica si la instantánea del clúster está cifrada.
Tipo: Booleano
Obligatorio: no
** StorageType **
Tipo de almacenamiento asociado a la instantánea del clúster
Para obtener información sobre los tipos de almacenamiento de los clústeres de Amazon DocumentDB, consulte Cluster storage configurations en la *Guía para desarrolladores de Amazon DocumentDB*.
Valores válidos para el tipo de almacenamiento: `standard | iopt1`
El valor predeterminado es `standard `
Tipo: cadena
Requerido: no
** VpcId **
Otorga el ID de la nube privada virtual (VPC) asociado a la instantánea del clúster.
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshot)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshot)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshot)
# DBClusterSnapshotAttribute
Contiene el nombre y los valores de un atributo de instantánea del clúster manual.
Los atributos de la instantánea del clúster manual se utilizan para autorizar a otras Cuentas de AWS la restauración de una instantánea de clúster manual.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** AttributeName **
El nombre del atributo de la instantánea del clúster manual.
El atributo llamado `restore` se refiere a la lista de Cuentas de AWS que tienen permiso para copiar o restaurar la instantánea del clúster manual.
Tipo: cadena
Requerido: no
** AttributeValues.AttributeValue.N **
Los valores del atributo de la instantánea del clúster manual.
Si el campo `AttributeName` se establece en `restore`, este elemento devuelve una lista de ID de Cuentas de AWS con autorización para copiar o restaurar la instantánea del clúster manual. Si el valor de `all` está en la lista, la instantánea del clúster manual es pública y está disponible para cualquier Cuenta de AWS para su copia o restauración.
Tipo: matriz de cadenas
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttribute)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttribute)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshotAttribute)
# DBClusterSnapshotAttributesResult
Información detallada sobre los atributos asociados a una instantánea de clúster.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** DBClusterSnapshotAttributes.DBClusterSnapshotAttribute.N **
La lista de atributos y valores para la instantánea del clúster.
Tipo: matriz de objetos [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md)
Obligatorio: no
** DBClusterSnapshotIdentifier **
El identificador de la instantánea del clúster al que se aplican los atributos.
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttributesResult)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttributesResult)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshotAttributesResult)
# DBEngineVersion
Información detallada sobre la versión de un motor.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** DBEngineDescription **
La descripción del motor de base de datos.
Tipo: cadena
Requerido: no
** DBEngineVersionDescription **
La descripción de la versión del motor de base de datos.
Tipo: cadena
Requerido: no
** DBParameterGroupFamily **
El nombre de la familia de grupos de parámetros para el motor de base de datos.
Tipo: cadena
Requerido: no
** Engine **
El nombre del motor de base de datos.
Tipo: cadena
Requerido: no
** EngineVersion **
Número de versión del motor de base de datos.
Tipo: cadena
Requerido: no
** ExportableLogTypes.member.N **
Los tipos de registros que el motor de base de datos tiene disponibles para la exportación a Registros de Amazon CloudWatch.
Tipo: matriz de cadenas
Obligatorio: no
** ServerlessV2FeaturesSupport **
Especifica cualquier propiedad o límite de Amazon DocumentDB sin servidor que difiera entre las versiones del motor de Amazon DocumentDB. Puede probar los valores de este atributo cuando decide qué versión de Amazon DocumentDB va a utilizar en un clúster nuevo o actualizado. También puede recuperar la versión de un clúster existente y comprobar si esa versión admite determinadas características de Amazon DocumentDB sin servidor antes de intentar utilizarlas.
Tipo: objeto [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md)
Obligatorio: no
** SupportedCACertificateIdentifiers.member.N **
Una lista de los identificadores de certificados de CA compatibles.
Para obtener más información, consulte [Cómo actualizar los certificados TLS de Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) y [Cómo cifrar datos en tránsito](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) en la *Guía para desarrolladores de Amazon DocumentDB*.
Tipo: matriz de cadenas
Obligatorio: no
** SupportsCertificateRotationWithoutRestart **
Indica si la versión del motor admite la rotación del certificado del servidor sin reiniciar la instancia de la base de datos.
Tipo: Booleano
Obligatorio: no
** SupportsLogExportsToCloudwatchLogs **
Un valor que indica si la versión del motor admite la exportación de los tipos de registro especificados por `ExportableLogTypes` a CloudWatch Logs.
Tipo: Booleano
Obligatorio: no
** ValidUpgradeTarget.UpgradeTarget.N **
Una lista de versiones de motor a la que esta versión del motor de base de datos se puede actualizar.
Tipo: matriz de objetos [UpgradeTarget](API_UpgradeTarget.md)
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBEngineVersion)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBEngineVersion)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBEngineVersion)
# DBInstance
Información detallada sobre una instancia.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** AutoMinorVersionUpgrade **
No se aplica. Este parámetro no se aplica a Amazon DocumentDB. Amazon DocumentDB no actualiza versiones secundarias, independientemente del valor establecido.
Tipo: Booleano
Obligatorio: no
** AvailabilityZone **
Especifica el nombre de la Zona de Disponibilidad en la que se encuentra la instancia.
Tipo: cadena
Requerido: no
** BackupRetentionPeriod **
Especifica el número de días durante los que se retienen las instantáneas automáticas.
Tipo: entero
Obligatorio: no
** CACertificateIdentifier **
El identificador del certificado de CA para esta instancia de base de datos.
Tipo: cadena
Requerido: no
** CertificateDetails **
Los detalles del certificado de servidor de la instancia de base de datos.
Tipo: objeto [CertificateDetails](API_CertificateDetails.md)
Obligatorio: no
** CopyTagsToSnapshot **
Es un valor que indica si se deben copiar las etiquetas de la instancia de base de datos en instantáneas de la instancia de base de datos. Las etiquetas no se copian de forma predeterminada.
Tipo: Booleano
Obligatorio: no
** DBClusterIdentifier **
Contiene el nombre del clúster al que pertenece la instancia si ésta es miembro de un clúster.
Tipo: cadena
Requerido: no
** DBInstanceArn **
El nombre de recurso de Amazon (ARN) de la instancia.
Tipo: cadena
Requerido: no
** DBInstanceClass **
Contiene el nombre de la clase de capacidad de cómputo y memoria de la instancia.
Tipo: cadena
Requerido: no
** DBInstanceIdentifier **
Contiene un identificador de base de datos proporcionado por el usuario. Este identificador es la clave única que identifica una instancia.
Tipo: cadena
Requerido: no
** DBInstanceStatus **
Especifica el estado actual de esta base de datos.
Tipo: cadena
Requerido: no
** DbiResourceId **
El identificador inmutable único de la Región de AWS para la instancia. Este identificador se encuentra en las entradas de registro de AWS CloudTrail cada vez que se accede a la clave de AWS KMS para la instancia.
Tipo: cadena
Requerido: no
** DBSubnetGroup **
Especifica información sobre el grupo de subred asociado a la instancia, incluido el nombre, la descripción y subredes en el grupo de subred.
Tipo: objeto [DBSubnetGroup](API_DBSubnetGroup.md)
Obligatorio: no
** EnabledCloudwatchLogsExports.member.N **
Una lista de tipos de registro para los que esta instancia está configurada para exportar a CloudWatch Logs.
Tipo: matriz de cadenas
Obligatorio: no
** Endpoint **
Especifica el punto de conexión.
Tipo: objeto [Endpoint](API_Endpoint.md)
Obligatorio: no
** Engine **
Proporciona el nombre del motor de base de datos que se va a usar para esta instancia.
Tipo: cadena
Requerido: no
** EngineVersion **
Indica la versión del motor de base de datos.
Tipo: cadena
Requerido: no
** InstanceCreateTime **
Proporciona la fecha y hora en que se creó la instancia.
Tipo: marca temporal
Obligatorio: no
** KmsKeyId **
Si `StorageEncrypted` es `true`, el identificador de clave AWS KMS para la instancia encriptada.
Tipo: cadena
Requerido: no
** LatestRestorableTime **
Especifica la última hora a la que se puede restaurar una base de datos con la restauración de un punto en el tiempo.
Tipo: marca temporal
Obligatorio: no
** PendingModifiedValues **
Especifica que los cambios a la instancia están pendientes. Este elemento solo se incluye cuando los cambios están pendientes. Los cambios específicos se identifican por subelementos.
Tipo: objeto [PendingModifiedValues](API_PendingModifiedValues.md)
Obligatorio: no
** PerformanceInsightsEnabled **
Establézcalo en `true` si la Información de rendimiento de Amazon RDS está habilitada para la instancia de base de datos; de lo contrario, el valor es `false`.
Tipo: Booleano
Obligatorio: no
** PerformanceInsightsKMSKeyId **
El identificador de la clave de AWS KMS para el cifrado de datos de Performance Insights. El ID de clave de AWS KMS es el nombre de recurso de Amazon (ARN), el identificador de clave de AWS KMS o el alias de clave de AWS KMS de la clave de cifrado de AWS KMS.
Tipo: cadena
Requerido: no
** PreferredBackupWindow **
Especifica el intervalo de tiempo diario durante el cual se crean copias de seguridad automatizadas si las copias de seguridad automatizadas están habilitadas, de acuerdo con la propiedad `BackupRetentionPeriod`.
Tipo: cadena
Requerido: no
** PreferredMaintenanceWindow **
Especifica el intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en el horario universal coordinado (UTC).
Tipo: cadena
Requerido: no
** PromotionTier **
Valor que especifica el orden en el que se promueve una réplica de Amazon DocumentDB a la instancia primaria tras un fallo de la instancia primaria existente.
Tipo: entero
Obligatorio: no
** PubliclyAccessible **
No admitido. Actualmente, Amazon DocumentDB no admite puntos de conexión públicos. El valor de `PubliclyAccessible` es siempre `false`.
Tipo: Booleano
Obligatorio: no
** StatusInfos.DBInstanceStatusInfo.N **
El estado de una réplica de lectura. Si la instancia no es una réplica de lectura, está en blanco.
Tipo: matriz de objetos [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md)
Obligatorio: no
** StorageEncrypted **
Especifica si la instancia está encriptada o no.
Tipo: Booleano
Obligatorio: no
** VpcSecurityGroups.VpcSecurityGroupMembership.N **
Proporciona una lista de elementos de grupos de seguridad de VPC a la que pertenece la instancia.
Tipo: matriz de objetos [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md)
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstance)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstance)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBInstance)
# DBInstanceStatusInfo
Proporciona una lista de información de estado para una instancia.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** Message **
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.
Tipo: cadena
Requerido: no
** Normal **
Un valor booleano que es `true` si la instancia funciona con normalidad o `false` si la instancia se encuentra en un estado de error.
Tipo: Booleano
Obligatorio: no
** Status **
Estado de la instancia. Para una réplica `StatusType` de lectura, los valores pueden ser `replicating`, error, `stopped` o `terminated`.
Tipo: cadena
Requerido: no
** StatusType **
Actualmente, este valor es “`read replication`”.
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstanceStatusInfo)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstanceStatusInfo)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBInstanceStatusInfo)
# DBSubnetGroup
Información detallada sobre un grupo de subredes.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** DBSubnetGroupArn **
El Nombre de recurso de Amazon (ARN) para el grupo de subred de base de datos.
Tipo: cadena
Requerido: no
** DBSubnetGroupDescription **
Proporciona la descripción del grupo de subred.
Tipo: cadena
Requerido: no
** DBSubnetGroupName **
El nombre del grupo de subred.
Tipo: cadena
Requerido: no
** SubnetGroupStatus **
Proporciona el estado del grupo de subred.
Tipo: cadena
Requerido: no
** Subnets.Subnet.N **
Información detallada sobre una o varias subredes dentro de un grupo de subredes.
Tipo: matriz de objetos [Subnet](API_Subnet.md)
Obligatorio: no
** SupportedNetworkTypes.member.N **
El tipo de red del grupo de subredes de base de datos.
Valores válidos: `IPV4` \$1 `DUAL`
Un `DBSubnetGroup` admite solamente el protocolo IPv4 o los protocolos IPv4 e IPv6 (DOBLE).
Tipo: matriz de cadenas
Obligatorio: no
** VpcId **
Proporciona el ID de la nube privada virtual (VPC) del grupo de subredes.
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBSubnetGroup)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBSubnetGroup)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBSubnetGroup)
# Endpoint
Información de red para acceder a un clúster o a una instancia. Los programas cliente deben especificar un punto de conexión válido para acceder a estos recursos de Amazon DocumentDB.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** Address **
Especifica la dirección DNS de la instancia.
Tipo: cadena
Requerido: no
** HostedZoneId **
Especifica el ID que Amazon Route 53 asigna al crear una zona alojada.
Tipo: cadena
Requerido: no
** Port **
Especifica el puerto en el que escucha el motor de la base de datos.
Tipo: entero
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Endpoint)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Endpoint)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Endpoint)
# EngineDefaults
Contiene el resultado de una invocación correcta de la operación `DescribeEngineDefaultClusterParameters`.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** DBParameterGroupFamily **
El nombre de la familia del grupo de parámetros de clúster para la que devolver información de los parámetros del motor.
Tipo: cadena
Requerido: no
** Marker **
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`.
Tipo: cadena
Requerido: no
** Parameters.Parameter.N **
Los parámetros de una familia de grupos de parámetros de clúster concreta.
Tipo: matriz de objetos [Parameter](API_Parameter.md)
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EngineDefaults)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EngineDefaults)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EngineDefaults)
# Event
Información detallada sobre un evento.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** Date **
Especifica la fecha y la hora del evento.
Tipo: marca temporal
Obligatorio: no
** EventCategories.EventCategory.N **
Especifica la categoría para el evento.
Tipo: matriz de cadenas
Obligatorio: no
** Message **
Proporciona el texto de este evento.
Tipo: cadena
Requerido: no
** SourceArn **
El Nombre de recurso de Amazon (ARN) para el evento.
Tipo: cadena
Requerido: no
** SourceIdentifier **
Proporciona el identificador del origen del evento.
Tipo: cadena
Requerido: no
** SourceType **
Especifica el tipo de origen para este evento.
Tipo: cadena
Valores válidos: `db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot`
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Event)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Event)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Event)
# EventCategoriesMap
Un tipo de fuente de eventos, acompañado de uno o más nombres de categorías de eventos.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** EventCategories.EventCategory.N **
Las categorías de eventos para el tipo de origen especificado.
Tipo: matriz de cadenas
Obligatorio: no
** SourceType **
El tipo de origen al que pertenecen las categorías devueltas.
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventCategoriesMap)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventCategoriesMap)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EventCategoriesMap)
# EventSubscription
Información detallada sobre un evento al que se ha suscrito.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** CustomerAwsId **
La cuenta de cliente de AWS asociada a la suscripción a notificaciones de eventos de Amazon DocumentDB.
Tipo: cadena
Requerido: no
** CustSubscriptionId **
El ID de la suscripción a notificaciones de eventos de Amazon DocumentDB.
Tipo: cadena
Requerido: no
** Enabled **
Un valor booleano que indica si la suscripción está habilitada. Un valor de `true` indica que se ha activado la suscripción.
Tipo: Booleano
Obligatorio: no
** EventCategoriesList.EventCategory.N **
Una lista de categorías de eventos para la suscripción a notificaciones de eventos de Amazon DocumentDB.
Tipo: matriz de cadenas
Obligatorio: no
** EventSubscriptionArn **
El Nombre de recurso de Amazon (ARN) para la suscripción de eventos.
Tipo: cadena
Requerido: no
** SnsTopicArn **
El ARN del tema de la suscripción a notificaciones de eventos de Amazon DocumentDB.
Tipo: cadena
Requerido: no
** SourceIdsList.SourceId.N **
Una lista de ID de origen para la suscripción a notificaciones de eventos de Amazon DocumentDB.
Tipo: matriz de cadenas
Obligatorio: no
** SourceType **
El tipo de origen para la suscripción a notificaciones de eventos de Amazon DocumentDB.
Tipo: cadena
Requerido: no
** Status **
El estado de la suscripción a notificaciones de eventos de Amazon DocumentDB.
Restricciones:
Puede ser uno de los siguientes: `creating`, `modifying`, `deleting`, `active`, `no-permission`, `topic-not-exist`
El estado `no-permission` indica que Amazon DocumentDB 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.
Tipo: cadena
Requerido: no
** SubscriptionCreationTime **
La hora a la que se creó la suscripción a notificaciones de eventos de Amazon DocumentDB.
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventSubscription)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventSubscription)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EventSubscription)
# FailoverState
Contiene el estado de las operaciones programadas o en proceso en un clúster global de Amazon DocumentDB. Este tipo de datos está vacío a menos que se haya programado o esté en curso una operación de conmutación o conmutación por error en el clúster global.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** FromDbClusterArn **
El nombre de recurso de Amazon (ARN) del clúster de Amazon DocumentDB que se está degradando actualmente y que está asociado a este estado.
Tipo: cadena
Requerido: no
** IsDataLossAllowed **
Indica si la operación es una conmutación global o una conmutación por error global. Si se permite la pérdida de datos, la operación es una conmutación por error global. De lo contrario, se trata de una conmutación.
Tipo: Booleano
Obligatorio: no
** Status **
El estado actual del clúster global. Los valores posibles son los siguientes:
+ **pendiente**: el servicio recibió una solicitud de conmutación o conmutación por error del clúster global. El clúster principal del clúster global y el clúster secundario especificado se están verificando antes de que comience la operación.
+ **conmutación por error**: el clúster secundario elegido pasa a ser el nuevo clúster principal para realizar la conmutación por error del clúster global.
+ **cancelación: se canceló** la solicitud de conmutación o conmutación por error del clúster global y el clúster principal y el clúster secundario seleccionado vuelven a sus estados anteriores.
Tipo: cadena
Valores válidos: `pending | failing-over | cancelling`
Obligatorio: no
** ToDbClusterArn **
El nombre de recurso de Amazon (ARN) del clúster de Amazon DocumentDB que se está promocionando actualmente y que está asociado a este estado.
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverState)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverState)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverState)
# Filter
Un conjunto de valores de filtro con nombre, que se utiliza para devolver una lista de resultados más específica. Puede usar un filtro que coincida con un conjunto de recursos según criterios específicos, como los ID.
No se admite el uso de comodines en los filtros.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** Name **
El nombre del filtro. Los nombres de filtros distinguen entre mayúsculas y minúsculas.
Tipo: cadena
Obligatorio: sí
** Values.Value.N **
Uno o varios valores de filtros. Los valores de filtro distinguen entre mayúsculas y minúsculas.
Tipo: matriz de cadenas
Obligatorio: sí
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Filter)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Filter)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Filter)
# GlobalCluster
Tipo de datos que representa un clúster global de Amazon DocumentDB.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** DatabaseName **
El nombre predeterminado de la base de datos del nuevo clúster global.
Tipo: cadena
Requerido: no
** DeletionProtection **
La configuración de protección contra eliminación para el nuevo clúster global.
Tipo: Booleano
Obligatorio: no
** Engine **
El motor de base de datos Amazon DocumentDB utilizado por el clúster global.
Tipo: cadena
Requerido: no
** EngineVersion **
Indica la versión del motor de base de datos.
Tipo: cadena
Requerido: no
** FailoverState **
Objeto de datos que contiene todas las propiedades del estado actual de un proceso de conmutación o conmutación por error en curso o pendiente para este clúster global. Este objeto está vacío a menos que se haya llamado a la `FailoverGlobalCluster` operación `SwitchoverGlobalCluster` o en este clúster global.
Tipo: objeto [FailoverState](API_FailoverState.md)
Obligatorio: no
** GlobalClusterArn **
El Nombre de recurso de Amazon (ARN) para el clúster global.
Tipo: cadena
Requerido: no
** GlobalClusterIdentifier **
Contiene un identificador de clúster global suministrado por el usuario. Este identificador es la clave única que identifica un clúster global.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 255 caracteres.
Patrón: `[A-Za-z][0-9A-Za-z-:._]*`
Obligatorio: no
** GlobalClusterMembers.GlobalClusterMember.N **
La lista de clústeres IDs para los clústeres secundarios del clúster global. Actualmente está limitada a un elemento.
Tipo: matriz de objetos [GlobalClusterMember](API_GlobalClusterMember.md)
Obligatorio: no
** GlobalClusterResourceId **
El identificador inmutable Región de AWS y único de la región para el clúster de bases de datos global. Este identificador se encuentra en las entradas de AWS CloudTrail registro siempre que se accede a la clave maestra AWS KMS del cliente (CMK) del clúster.
Tipo: cadena
Requerido: no
** Status **
Especifica el estado actual de este clúster global.
Tipo: cadena
Requerido: no
** StorageEncrypted **
Configuración de cifrado de almacenamiento para el clúster global.
Tipo: Booleano
Obligatorio: no
** TagList.Tag.N **
Una lista de etiquetas de clúster globales.
Tipo: matriz de objetos [Tag](API_Tag.md)
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulta lo siguiente:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalCluster)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/GlobalCluster)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/GlobalCluster)
# GlobalClusterMember
Estructura de datos con información sobre cualquier clúster primario y secundario asociado a un clúster global de Amazon DocumentDB.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** DBClusterArn **
El Nombre de recurso de Amazon (ARN) para cada clúster de Amazon DocumentDB.
Tipo: cadena
Requerido: no
** IsWriter **
Especifica si el clúster de Amazon DocumentDB es el clúster primario (es decir, tiene capacidad de lectura y escritura) para el clúster global de Amazon DocumentDB al que está asociado.
Tipo: Booleano
Obligatorio: no
** Readers.member.N **
El Nombre de recurso de Amazon (ARN) para cada clúster secundario de solo lectura asociado al clúster global de Amazon DocumentDB.
Tipo: matriz de cadenas
Obligatorio: no
** SynchronizationStatus **
El estado de sincronización de cada clúster de Amazon DocumentDB del clúster global.
Tipo: cadena
Valores válidos: `connected | pending-resync`
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en uno de los idiomas específicos AWS SDKs, consulte lo siguiente:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalClusterMember)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/GlobalClusterMember)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/GlobalClusterMember)
# OrderableDBInstanceOption
Las opciones disponibles para una instancia.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** AvailabilityZones.AvailabilityZone.N **
Una lista de zonas de disponibilidad para una instancia.
Tipo: matriz de objetos [AvailabilityZone](API_AvailabilityZone.md)
Obligatorio: no
** DBInstanceClass **
La clase de instancia de una instancia.
Tipo: cadena
Requerido: no
** Engine **
El tipo de motor de una instancia.
Tipo: cadena
Requerido: no
** EngineVersion **
La versión de motor de una instancia.
Tipo: cadena
Requerido: no
** LicenseModel **
El modelo de licencia de una instancia.
Tipo: cadena
Requerido: no
** StorageType **
El tipo de almacenamiento que se va a asociar al clúster de base de datos
Tipo: cadena
Requerido: no
** Vpc **
Indica si una instancia es una nube privada virtual (VPC).
Tipo: Booleano
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/OrderableDBInstanceOption)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/OrderableDBInstanceOption)
+ [SDK de AWS para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/OrderableDBInstanceOption)
# Parameter
Información detallada sobre un parámetro individual.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** AllowedValues **
Especifica el rango de valores válido del parámetro.
Tipo: cadena
Requerido: no
** ApplyMethod **
Indica cuándo deben aplicarse actualizaciones de parámetros.
Tipo: cadena
Valores válidos: `immediate | pending-reboot`
Obligatorio: no
** ApplyType **
Especifica el tipo de parámetros específicos del motor.
Tipo: cadena
Requerido: no
** DataType **
Especifica el tipo de datos válidos para el parámetro.
Tipo: cadena
Requerido: no
** Description **
Proporciona una descripción del parámetro.
Tipo: cadena
Requerido: no
** IsModifiable **
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.
Tipo: Booleano
Obligatorio: no
** MinimumEngineVersion **
La versión del motor más antigua al que se puede aplicar el parámetro.
Tipo: cadena
Requerido: no
** ParameterName **
Especifica el nombre del parámetro.
Tipo: cadena
Requerido: no
** ParameterValue **
Especifica el valor del parámetro. Debe ser uno o más de los `AllowedValues` para los parámetros del clúster en formato CSV:
Los valores válidos son:
+ `enabled`: el clúster acepta conexiones seguras mediante TLS, versión 1.0 a 1.3.
+ `disabled`: el clúster no acepta conexiones seguras mediante TLS.
+ `fips-140-3`: el clúster solo acepta conexiones seguras según los requisitos de la publicación 140-3 de las Normas Federales de Procesamiento de la Información (FIPS). Esto solamente se admite a partir de los clústeres de Amazon DocumentDB 5.0 (versión del motor 3.0.3727) en las siguientes regiones: ca-central-1, us-west-2, us-east-1, us-east-2, us-gov-east-1, us-gov-west-1.
+ `tls1.2+`: el clúster acepta conexiones seguras mediante TLS, versión 1.2 y superiores. Solo se admite a partir de Amazon DocumentDB 4.0 (versión de motor 2.0.10980) y Amazon DocumentDB 5.0 (versión de motor 3.0.11051).
+ `tls1.3+`: el clúster acepta conexiones seguras mediante TLS, versión 1.3 y superiores. Solo se admite a partir de Amazon DocumentDB 4.0 (versión de motor 2.0.10980) y Amazon DocumentDB 5.0 (versión de motor 3.0.11051).
Tipo: cadena
Requerido: no
** Source **
Indica el origen del valor del parámetro.
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Parameter)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Parameter)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Parameter)
# PendingCloudwatchLogsExports
Una lista de los tipos de registro cuya configuración sigue pendiente. Estos tipos de registro están en proceso de activación o desactivación.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** LogTypesToDisable.member.N **
Tipos de registro que están en proceso de habilitarse. Una vez habilitados, estos tipos de logs se exportan a Registros de Amazon CloudWatch.
Tipo: matriz de cadenas
Obligatorio: no
** LogTypesToEnable.member.N **
Tipos de registro que están en proceso de desactivación. Una vez desactivados, estos tipos de registro no se exportan a CloudWatch Logs.
Tipo: matriz de cadenas
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingCloudwatchLogsExports)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingCloudwatchLogsExports)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingCloudwatchLogsExports)
# PendingMaintenanceAction
Proporciona información acerca de una acción de mantenimiento pendiente para un recurso.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** Action **
El tipo de acción de mantenimiento pendiente disponible para el recurso.
Tipo: cadena
Requerido: no
** AutoAppliedAfterDate **
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`.
Tipo: marca temporal
Obligatorio: no
** CurrentApplyDate **
La fecha de entrada en vigor en que se aplica la acción de mantenimiento pendiente al recurso.
Tipo: marca temporal
Obligatorio: no
** Description **
Una descripción que proporciona información más detallada sobre la acción de mantenimiento.
Tipo: cadena
Requerido: no
** ForcedApplyDate **
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`.
Tipo: marca temporal
Obligatorio: no
** OptInStatus **
Indica el tipo de solicitud de alta que se ha recibido para el recurso.
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingMaintenanceAction)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingMaintenanceAction)
+ [AWS SDK de para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingMaintenanceAction)
# PendingModifiedValues
Uno o más ajustes modificados para una instancia. Estos ajustes modificados se han solicitado, pero aún no se han aplicado.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** AllocatedStorage **
Contiene el tamaño nuevo de `AllocatedStorage` correspondiente a la instancia que se aplicará o que se está aplicando.
Tipo: entero
Obligatorio: no
** BackupRetentionPeriod **
Especifica el número de días pendientes durante los que se conservan las copias de seguridad automatizadas.
Tipo: entero
Obligatorio: no
** CACertificateIdentifier **
Especifica el identificador del certificado de CA para la instancia de base de datos.
Tipo: cadena
Requerido: no
** DBInstanceClass **
Contiene la nueva `DBInstanceClass` correspondiente a la instancia de base de datos que se aplicará o que se está aplicando.
Tipo: cadena
Requerido: no
** DBInstanceIdentifier **
Contiene la nueva `DBInstanceIdentifier` correspondiente a la instancia de base de datos que se aplicará o que se está aplicando.
Tipo: cadena
Requerido: no
** DBSubnetGroupName **
El nuevo grupo de subredes de la instancia.
Tipo: cadena
Requerido: no
** EngineVersion **
Indica la versión del motor de base de datos.
Tipo: cadena
Requerido: no
** Iops **
Especifica el nuevo valor de IOPS aprovisionadas correspondiente a la instancia de base de datos que se aplicará o que se está aplicando.
Tipo: entero
Obligatorio: no
** LicenseModel **
El modelo de licencia para la instancia.
Valores válidos: `license-included`, `bring-your-own-license`, `general-public-license`
Tipo: cadena
Requerido: no
** MasterUserPassword **
Contiene el cambio pendiente o actualmente en curso de las credenciales maestras para la instancia.
Tipo: cadena
Requerido: no
** MultiAZ **
Indica que la instancia Single-AZ va a cambiar a una implementación Multi-AZ.
Tipo: Booleano
Obligatorio: no
** PendingCloudwatchLogsExports **
Una lista de los tipos de registro cuya configuración sigue pendiente. Estos tipos de registro están en proceso de activación o desactivación.
Tipo: objeto [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md)
Obligatorio: no
** Port **
Especifica el puerto pendiente para la instancia.
Tipo: entero
Obligatorio: no
** StorageType **
Especifica el tipo de almacenamiento que se va a asociar con la instancia.
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingModifiedValues)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingModifiedValues)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingModifiedValues)
# ResourcePendingMaintenanceActions
Representa la salida de [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md).
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** PendingMaintenanceActionDetails.PendingMaintenanceAction.N **
Una lista que proporciona detalles sobre las acciones de mantenimiento pendientes para el recurso.
Tipo: matriz de objetos [PendingMaintenanceAction](API_PendingMaintenanceAction.md)
Obligatorio: no
** ResourceIdentifier **
El Nombre de recurso de Amazon (ARN) del recurso que tiene acciones de mantenimiento pendiente.
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ResourcePendingMaintenanceActions)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ResourcePendingMaintenanceActions)
+ [AWS SDK de para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ResourcePendingMaintenanceActions)
# ServerlessV2FeaturesSupport
Especifica cualquier propiedad o límite de Amazon DocumentDB sin servidor que difiera entre las versiones del motor de Amazon DocumentDB. Puede probar los valores de este atributo cuando decide qué versión de Amazon DocumentDB va a utilizar en un clúster nuevo o actualizado. También puede recuperar la versión de un clúster existente y comprobar si esa versión admite determinadas características de Amazon DocumentDB sin servidor antes de intentar utilizarlas.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** MaxCapacity **
El número máximo de unidades de capacidad de Amazon DocumentDB (DCU) para una instancia en un clúster de Amazon DocumentDB sin servidor. Puede especificar los valores de la DCU en incrementos de medio punto, como 32; 32,5; 33; etc.
Tipo: Doble
Obligatorio: no
** MinCapacity **
El número mínimo de unidades de capacidad de Amazon DocumentDB (DCU) para una instancia en un clúster de Amazon DocumentDB sin servidor. Puede especificar los valores de la DCU en incrementos de medio punto, como 8; 8,5; 9; etc.
Tipo: Doble
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2FeaturesSupport)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2FeaturesSupport)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2FeaturesSupport)
# ServerlessV2ScalingConfiguration
Establece la configuración de escalado del clúster de Amazon DocumentDB sin servidor.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** MaxCapacity **
El número máximo de unidades de capacidad de Amazon DocumentDB (DCU) para una instancia en un clúster de Amazon DocumentDB sin servidor. Puede especificar los valores de la DCU en incrementos de medio punto, como 32; 32,5; 33; etc.
Tipo: Doble
Obligatorio: no
** MinCapacity **
El número mínimo de unidades de capacidad de Amazon DocumentDB (DCU) para una instancia en un clúster de Amazon DocumentDB sin servidor. Puede especificar los valores de la DCU en incrementos de medio punto, como 8; 8,5; 9; etc.
Tipo: Doble
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfiguration)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfiguration)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2ScalingConfiguration)
# ServerlessV2ScalingConfigurationInfo
Recupera la configuración de escalado de un clúster de Amazon DocumentDB sin servidor.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** MaxCapacity **
El número máximo de unidades de capacidad de Amazon DocumentDB (DCU) para una instancia en un clúster de Amazon DocumentDB sin servidor. Puede especificar los valores de la DCU en incrementos de medio punto, como 32; 32,5; 33; etc.
Tipo: Doble
Obligatorio: no
** MinCapacity **
El número mínimo de unidades de capacidad de Amazon DocumentDB (DCU) para una instancia en un clúster de Amazon DocumentDB sin servidor. Puede especificar los valores de la DCU en incrementos de medio punto, como 8; 8,5; 9; etc.
Tipo: Doble
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo)
# Subnet
Información detallada sobre una subred.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** SubnetAvailabilityZone **
Especifica la Zona de Disponibilidad para la subred.
Tipo: objeto [AvailabilityZone](API_AvailabilityZone.md)
Obligatorio: no
** SubnetIdentifier **
Especifica el identificador de la subred.
Tipo: cadena
Requerido: no
** SubnetStatus **
Especifica el estado de la subred.
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Subnet)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Subnet)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Subnet)
# Tag
Metadatos asignados a un recurso de Amazon DocumentDB que consta de un par clave-valor.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** Key **
El nombre obligatorio de la etiqueta. El valor de cadena puede tener una longitud de entre 1 y 128 caracteres Unicode y no puede llevar el prefijo “`aws:`“ ni “`rds:`“. La cadena puede contener únicamente el conjunto de letras, 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”).
Tipo: cadena
Requerido: no
** Value **
Valor de cadena opcional de la etiqueta. El valor de cadena puede tener una longitud de entre 1 y 256 caracteres Unicode y no puede llevar el prefijo “`aws:`“ ni “`rds:`“. La cadena puede contener únicamente el conjunto de letras, 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”).
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Tag)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Tag)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Tag)
# UpgradeTarget
La versión del motor de base de datos a la que puede actualizarse una instancia.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** AutoUpgrade **
Un valor que indica si la versión de destino se aplica a cualquier instancia de la base de datos de origen que se haya establecido `AutoMinorVersionUpgrade` en `true`.
Tipo: Booleano
Obligatorio: no
** Description **
La versión del motor de base de datos a la que puede actualizarse una instancia.
Tipo: cadena
Requerido: no
** Engine **
El nombre del motor de base de datos de destino de actualización.
Tipo: cadena
Requerido: no
** EngineVersion **
El número de versión del motor de base de datos de destino de actualización.
Tipo: cadena
Requerido: no
** IsMajorVersionUpgrade **
Un valor que indica si un motor de base de datos se actualiza a una versión principal.
Tipo: Booleano
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/UpgradeTarget)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/UpgradeTarget)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/UpgradeTarget)
# VpcSecurityGroupMembership
Se utiliza como elemento de respuesta para consultas sobre la pertenencia a grupos de seguridad de la nube privada virtual (VPC).
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** Status **
El estado del grupo de seguridad de VPC.
Tipo: cadena
Requerido: no
** VpcSecurityGroupId **
El nombre del grupo de seguridad de VPC.
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/VpcSecurityGroupMembership)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/VpcSecurityGroupMembership)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/VpcSecurityGroupMembership)
# Amazon DocumentDB Elastic Clusters
Los siguientes tipos de datos son compatibles con los clústeres elásticos de Amazon DocumentDB:
+ [Cluster](API_elastic_Cluster.md)
+ [ClusterInList](API_elastic_ClusterInList.md)
+ [ClusterSnapshot](API_elastic_ClusterSnapshot.md)
+ [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md)
+ [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md)
+ [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)
+ [Shard](API_elastic_Shard.md)
+ [ValidationExceptionField](API_elastic_ValidationExceptionField.md)
# Cluster
Devuelve información sobre un clúster elástico específico.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** adminUserName **
El nombre del administrador de los clústeres elásticos.
Tipo: cadena
Obligatorio: sí
** authType **
El tipo de autenticación del clúster elástico.
Tipo: cadena
Valores válidos: `PLAIN_TEXT | SECRET_ARN`
Obligatorio: sí
** clusterArn **
El identificador ARN del clúster elástico.
Tipo: cadena
Obligatorio: sí
** clusterEndpoint **
La URL que se usa para conectarse al clúster elástico.
Tipo: cadena
Obligatorio: sí
** clusterName **
El nombre del clúster elástico.
Tipo: cadena
Obligatorio: sí
** createTime **
La hora a la que se creó el clúster elástico, en tiempo universal coordinado (UTC).
Tipo: cadena
Obligatorio: sí
** kmsKeyId **
El identificador de clave de KMS que se debe utilizar para cifrar el clúster elástico.
Tipo: cadena
Obligatorio: sí
** preferredMaintenanceWindow **
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`
Tipo: cadena
Obligatorio: sí
** shardCapacity **
La cantidad de vCPU asignadas a cada partición de clúster elástico. El máximo es 64. Los valores permitidos son 2, 4, 8, 16, 32, 64.
Tipo: número entero
Obligatorio: sí
** shardCount **
El número de particiones asignadas al clúster elástico. El máximo es 32.
Tipo: número entero
Obligatorio: sí
** status **
Estado del clúster elástico.
Tipo: cadena
Valores válidos: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE`
Obligatorio: sí
** subnetIds **
Los ID de subredes de Amazon EC2 para el clúster elástico.
Tipo: matriz de cadenas
Obligatorio: sí
** vpcSecurityGroupIds **
Una lista de grupos de seguridad de VPC de EC2 para asociar a este clúster elástico.
Tipo: matriz de cadenas
Obligatorio: sí
** backupRetentionPeriod **
El número de días durante los que se conservan las instantáneas de base de datos automáticas.
Tipo: entero
Obligatorio: no
** preferredBackupWindow **
El intervalo de tiempo diario durante el que se crean las copias de seguridad automatizadas si las copias de seguridad automatizadas están habilitadas según lo determina `backupRetentionPeriod`.
Tipo: cadena
Requerido: no
** shardInstanceCount **
El número de instancias de réplica que se aplica a todas las particiones del clúster. Un valor de `shardInstanceCount` igual a 1 significa que hay una instancia de escritura y las instancias adicionales son réplicas que se pueden usar para llevar a cabo lecturas y mejorar la disponibilidad.
Tipo: entero
Obligatorio: no
** shards **
El número total de particiones en el clúster.
Tipo: matriz de objetos [Shard](API_elastic_Shard.md)
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Cluster)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Cluster)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Cluster)
# ClusterInList
Lista de clústeres elásticos de Amazon DocumentDB.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** clusterArn **
El identificador ARN del clúster elástico.
Tipo: cadena
Obligatorio: sí
** clusterName **
El nombre del clúster elástico.
Tipo: cadena
Obligatorio: sí
** status **
Estado del clúster elástico.
Tipo: cadena
Valores válidos: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE`
Obligatorio: sí
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterInList)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterInList)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterInList)
# ClusterSnapshot
Devuelve información sobre una instantánea específica del clúster elástico.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** adminUserName **
El nombre del administrador de los clústeres elásticos.
Tipo: cadena
Obligatorio: sí
** clusterArn **
El identificador ARN del clúster elástico.
Tipo: cadena
Obligatorio: sí
** clusterCreationTime **
La hora a la que se creó el clúster elástico, en tiempo universal coordinado (UTC).
Tipo: cadena
Obligatorio: sí
** kmsKeyId **
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 con la misma cuenta de Amazon a la que pertenece esta clave de cifrado de KMS, puede utilizar el alias de la clave de KMS en lugar del ARN como clave de cifrado de KMS. Si no se especifica una clave de cifrado, Amazon DocumentDB utiliza la clave de cifrado predeterminada que KMS crea para la cuenta. Su cuenta dispone de una clave de cifrado predeterminada diferente para cada región de Amazon.
Tipo: cadena
Obligatorio: sí
** snapshotArn **
El identificador ARN de la instantánea del clúster elástico.
Tipo: cadena
Obligatorio: sí
** snapshotCreationTime **
La hora a la que se creó la instantánea del clúster elástico en Tiempo Universal Coordinado (UTC).
Tipo: cadena
Obligatorio: sí
** snapshotName **
Nombre de la instantánea del clúster elástico.
Tipo: cadena
Obligatorio: sí
** status **
Estado de la instantánea del clúster elástico.
Tipo: cadena
Valores válidos: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE`
Obligatorio: sí
** subnetIds **
Los ID de subredes de Amazon EC2 para el clúster elástico.
Tipo: matriz de cadenas
Obligatorio: sí
** vpcSecurityGroupIds **
Una lista de grupos de seguridad de VPC de EC2 para asociar al clúster elástico.
Tipo: matriz de cadenas
Obligatorio: sí
** snapshotType **
El tipo de instantáneas del clúster que se van a devolver. Puede especificar uno de los siguientes valores:
+ `automated`: devuelve todas las instantáneas del clúster que Amazon DocumentDB haya creado automáticamente para su cuenta de AWS.
+ `manual`: devuelve todas las instantáneas del clúster que haya creado manualmente para su cuenta de AWS.
Tipo: cadena
Valores válidos: `MANUAL | AUTOMATED`
Obligatorio: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshot)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshot)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterSnapshot)
# ClusterSnapshotInList
Lista de instantáneas de un clúster elástico.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** clusterArn **
El identificador ARN del clúster elástico.
Tipo: cadena
Obligatorio: sí
** snapshotArn **
El identificador ARN de la instantánea del clúster elástico.
Tipo: cadena
Obligatorio: sí
** snapshotCreationTime **
La hora a la que se creó la instantánea del clúster elástico en Tiempo Universal Coordinado (UTC).
Tipo: cadena
Obligatorio: sí
** snapshotName **
Nombre de la instantánea del clúster elástico.
Tipo: cadena
Obligatorio: sí
** status **
Estado de la instantánea del clúster elástico.
Tipo: cadena
Valores válidos: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE`
Obligatorio: sí
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshotInList)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshotInList)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterSnapshotInList)
# PendingMaintenanceActionDetails
Recupera los detalles de las acciones de mantenimiento pendientes.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** action **
Muestra la acción específica de una acción de mantenimiento pendiente.
Tipo: cadena
Obligatorio: sí
** autoAppliedAfterDate **
Muestra la fecha del período 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 `optInType` de `NEXT_MAINTENANCE`.
Tipo: cadena
Requerido: no
** currentApplyDate **
Muestra la fecha de entrada en vigor en que se aplica la acción de mantenimiento pendiente al recurso.
Tipo: cadena
Requerido: no
** description **
Muestra una descripción que proporciona información más detallada sobre la acción de mantenimiento.
Tipo: cadena
Requerido: no
** forcedApplyDate **
Muestra 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 `optInType` de `IMMEDIATE`.
Tipo: cadena
Requerido: no
** optInStatus **
Muestra el tipo de solicitud de `optInType` que se ha recibido para el recurso.
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails)
# ResourcePendingMaintenanceAction
Proporciona información acerca de una acción de mantenimiento pendiente para un recurso.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** pendingMaintenanceActionDetails **
Proporciona información acerca de una acción de mantenimiento pendiente para un recurso.
Tipo: matriz de objetos [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md)
Obligatorio: no
** resourceArn **
El Nombre de recurso de Amazon (ARN) Amazon DocumentDB del recurso al que se aplica la acción de mantenimiento pendiente.
Tipo: cadena
Requerido: no
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction)
# Shard
El nombre de la partición.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** createTime **
La hora a la que se creó la partición, en tiempo universal coordinado (UTC).
Tipo: cadena
Obligatorio: sí
** shardId **
El ID de la partición.
Tipo: cadena
Obligatorio: sí
** status **
El estado actual de la partición.
Tipo: cadena
Valores válidos: `CREATING | ACTIVE | DELETING | UPDATING | VPC_ENDPOINT_LIMIT_EXCEEDED | IP_ADDRESS_LIMIT_EXCEEDED | INVALID_SECURITY_GROUP_ID | INVALID_SUBNET_ID | INACCESSIBLE_ENCRYPTION_CREDS | INACCESSIBLE_SECRET_ARN | INACCESSIBLE_VPC_ENDPOINT | INCOMPATIBLE_NETWORK | MERGING | MODIFYING | SPLITTING | COPYING | STARTING | STOPPING | STOPPED | MAINTENANCE | INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE`
Obligatorio: sí
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Shard)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Shard)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Shard)
# ValidationExceptionField
Un campo específico en el que se produjo una excepción de validación determinada.
## Contenido
**nota**
Los parámetros obligatorios se describen primero en la siguiente tabla.
** message **
Un mensaje de error que describe la excepción de validación en este campo.
Tipo: cadena
Obligatorio: sí
** name **
El nombre del campo en el que se produjo la excepción de validación.
Tipo: cadena
Obligatorio: sí
## Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte:
+ [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ValidationExceptionField)
+ [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ValidationExceptionField)
+ [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ValidationExceptionField)