Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# Types de données
<a name="API_Types"></a>

Les types de données suivants sont pris en charge par 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) 

Les types de données suivants sont pris en charge par Amazon DocumentDB Elastic Clusters :
+  [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)
<a name="API_Types_Amazon_DocumentDB_with_MongoDB_compatibility"></a>

Les types de données suivants sont pris en charge par 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
<a name="API_AvailabilityZone"></a>

Informations sur une zone de disponibilité.

## Table des matières
<a name="API_AvailabilityZone_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** Name **   
Nom de la zone de disponibilité.  
Type : chaîne  
Obligatoire : non

## consultez aussi
<a name="API_AvailabilityZone_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AvailabilityZone) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AvailabilityZone) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AvailabilityZone) 

# Certificate
<a name="API_Certificate"></a>

Un certificat d'autorité de certification (CA) pour un Compte AWS.

## Table des matières
<a name="API_Certificate_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** CertificateArn **   
L'Amazon Resource Name (ARN) du certificat.  
Exemple : `arn:aws:rds:us-east-1::cert:rds-ca-2019`   
Type : chaîne  
Obligatoire : non

 ** CertificateIdentifier **   
La clé unique qui identifie un certificat.  
Exemple : `rds-ca-2019`   
Type : chaîne  
Obligatoire : non

 ** CertificateType **   
Type du certificat.  
Exemple : `CA`   
Type : chaîne  
Obligatoire : non

 ** Thumbprint **   
Empreinte numérique du certificat.  
Type : chaîne  
Obligatoire : non

 ** ValidFrom **   
Date-heure de début à partir de laquelle le certificat est valide.  
Exemple : `2019-07-31T17:57:09Z`   
Type : Timestamp  
Obligatoire : non

 ** ValidTill **   
Date-heure après laquelle le certificat n'est plus valide.  
Exemple : `2024-07-31T17:57:09Z`   
Type : Timestamp  
Obligatoire : non

## consultez aussi
<a name="API_Certificate_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Certificate) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Certificate) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Certificate) 

# CertificateDetails
<a name="API_CertificateDetails"></a>

Renvoie les détails du certificat de serveur de l'instance de base de données.

*Pour plus d'informations, consultez la section [Mise à jour de vos certificats TLS Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) et [chiffrement des données en transit dans le](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) guide du développeur Amazon DocumentDB.*

## Table des matières
<a name="API_CertificateDetails_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** CAIdentifier **   
L'identifiant CA du certificat CA utilisé pour le certificat de serveur de l'instance de base de données.  
Type : chaîne  
Obligatoire : non

 ** ValidTill **   
Date d'expiration du certificat de serveur de l'instance de base de données.  
Type : Timestamp  
Obligatoire : non

## consultez aussi
<a name="API_CertificateDetails_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CertificateDetails) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CertificateDetails) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CertificateDetails) 

# CloudwatchLogsExportConfiguration
<a name="API_CloudwatchLogsExportConfiguration"></a>

Le paramètre de configuration des types de journaux à activer pour l'exportation vers Amazon CloudWatch Logs pour une instance ou un cluster spécifique.

Les `DisableLogTypes` tableaux `EnableLogTypes` et déterminent quels journaux sont exportés (ou non exportés) vers CloudWatch Logs. Les valeurs de ces tableaux dépendent du moteur utilisé.

## Table des matières
<a name="API_CloudwatchLogsExportConfiguration_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** DisableLogTypes.member.N **   
Liste des types de journaux à désactiver.  
Type : tableau de chaînes  
Obligatoire : non

 ** EnableLogTypes.member.N **   
Liste des types de journaux à activer.  
Type : tableau de chaînes  
Obligatoire : non

## consultez aussi
<a name="API_CloudwatchLogsExportConfiguration_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CloudwatchLogsExportConfiguration) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CloudwatchLogsExportConfiguration) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CloudwatchLogsExportConfiguration) 

# ClusterMasterUserSecret
<a name="API_ClusterMasterUserSecret"></a>

Contient le secret géré par Amazon DocumentDB dans AWS Secrets Manager pour le mot de passe de l'utilisateur principal.

## Table des matières
<a name="API_ClusterMasterUserSecret_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** KmsKeyId **   
Identifiant de clé AWS KMS utilisé pour chiffrer le secret.  
Type : chaîne  
Obligatoire : non

 ** SecretArn **   
Amazon Resource Name (ARN) du secret.  
Type : chaîne  
Obligatoire : non

 ** SecretStatus **   
Le statut du secret.  
Les valeurs de statut possibles incluent les suivantes :  
+ création - Le secret est en cours de création.
+ actif - Le secret est disponible pour une utilisation normale et une rotation.
+ rotation - Le secret est en cours de rotation.
+ altéré - Le secret peut être utilisé pour accéder aux informations d'identification de la base de données, mais il ne peut pas être modifié. Un secret peut avoir ce statut si, par exemple, les autorisations sont modifiées afin qu'Amazon DocumentDB ne puisse plus accéder ni au secret ni à la clé KMS du secret.

  Lorsqu'un secret possède ce statut, vous pouvez corriger la condition à l'origine de ce statut. Vous pouvez également modifier l'instance pour désactiver la gestion automatique des informations d'identification de base de données, puis modifier à nouveau l'instance pour activer la gestion automatique des informations d'identification de base de données.
Type : chaîne  
Obligatoire : non

## consultez aussi
<a name="API_ClusterMasterUserSecret_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ClusterMasterUserSecret) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ClusterMasterUserSecret) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ClusterMasterUserSecret) 

# DBCluster
<a name="API_DBCluster"></a>

Informations détaillées sur un cluster. 

## Table des matières
<a name="API_DBCluster_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** AssociatedRoles.DBClusterRole.N **   
Fournit une liste des rôles Gestion des identités et des accès AWS (IAM) associés au cluster. Les rôles (IAM) associés à un cluster autorisent le cluster à accéder à d'autres AWS services en votre nom.  
Type : tableau d’objets [DBClusterRole](API_DBClusterRole.md)  
Obligatoire : non

 ** AvailabilityZones.AvailabilityZone.N **   
Fournit la liste des zones de EC2 disponibilité Amazon dans lesquelles les instances du cluster peuvent être créées.  
Type : tableau de chaînes  
Obligatoire : non

 ** BackupRetentionPeriod **   
Spécifie le nombre de jours pendant lesquels les instantanés automatiques sont conservés.  
Type : entier  
Obligatoire : non

 ** CloneGroupId **   
Identifie le groupe de clones auquel est associé le cluster de bases de données.  
Type : chaîne  
Obligatoire : non

 ** ClusterCreateTime **   
Spécifie l'heure à laquelle le cluster a été créé, en temps universel coordonné (UTC).  
Type : Timestamp  
Obligatoire : non

 ** DBClusterArn **   
Le nom de ressource Amazon (ARN) du cluster.  
Type : chaîne  
Obligatoire : non

 ** DBClusterIdentifier **   
Contient un identifiant de cluster fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie un cluster.  
Type : chaîne  
Obligatoire : non

 ** DBClusterMembers.DBClusterMember.N **   
Fournit la liste des instances qui constituent le cluster.  
Type : tableau d’objets [DBClusterMember](API_DBClusterMember.md)  
Obligatoire : non

 ** DBClusterParameterGroup **   
Spécifie le nom du groupe de paramètres de cluster pour le cluster.  
Type : chaîne  
Obligatoire : non

 ** DbClusterResourceId **   
L'identifiant Région AWS unique et immuable du cluster. Cet identifiant se trouve dans les entrées du AWS CloudTrail journal chaque fois que l'on accède à la AWS KMS clé du cluster.  
Type : chaîne  
Obligatoire : non

 ** DBSubnetGroup **   
Spécifie des informations sur le groupe de sous-réseaux associé au cluster, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.  
Type : chaîne  
Obligatoire : non

 ** DeletionProtection **   
Spécifie si ce cluster peut être supprimé. Si cette option `DeletionProtection` est activée, le cluster ne peut pas être supprimé sauf s'il `DeletionProtection` est modifié et désactivé. `DeletionProtection`protège les clusters contre la suppression accidentelle.  
Type : booléen  
Obligatoire : non

 ** EarliestRestorableTime **   
Heure la plus proche à laquelle une base de données peut être restaurée par point-in-time restauration.  
Type : Timestamp  
Obligatoire : non

 ** EnabledCloudwatchLogsExports.member.N **   
Liste des types de journaux que ce cluster est configuré pour exporter vers Amazon CloudWatch Logs.  
Type : tableau de chaînes  
Obligatoire : non

 ** Endpoint **   
Spécifie le point de terminaison de connexion pour l'instance principale du cluster.  
Type : chaîne  
Obligatoire : non

 ** Engine **   
Fournit le nom du moteur de base de données à utiliser pour ce cluster.  
Type : chaîne  
Obligatoire : non

 ** EngineVersion **   
Indique la version du moteur de base de données.  
Type : chaîne  
Obligatoire : non

 ** HostedZoneId **   
Spécifie l'ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.  
Type : chaîne  
Obligatoire : non

 ** IOOptimizedNextAllowedModificationTime **   
La prochaine fois, vous pourrez modifier le cluster Amazon DocumentDB pour utiliser le type de stockage iopt1.  
Type : Timestamp  
Obligatoire : non

 ** KmsKeyId **   
Si tel `StorageEncrypted` est le cas`true`, l'identifiant de AWS KMS clé du cluster chiffré.  
Type : chaîne  
Obligatoire : non

 ** LatestRestorableTime **   
Spécifie l'heure limite à laquelle une base de données peut être restaurée par point-in-time restauration.  
Type : Timestamp  
Obligatoire : non

 ** MasterUsername **   
Contient le nom d'utilisateur principal du cluster.  
Type : chaîne  
Obligatoire : non

 ** MasterUserSecret **   
Le secret géré par Amazon DocumentDB dans AWS Secrets Manager pour le mot de passe de l'utilisateur principal.  
Type : objet [ClusterMasterUserSecret](API_ClusterMasterUserSecret.md)  
Obligatoire : non

 ** MultiAZ **   
Spécifie si le cluster possède des instances dans plusieurs zones de disponibilité.  
Type : booléen  
Obligatoire : non

 ** NetworkType **   
Type de réseau du cluster.  
Le type de réseau est déterminé par le type `DBSubnetGroup` spécifié pour le cluster. A ne `DBSubnetGroup` peut prendre en charge que le IPv4 protocole ou les IPv6 protocoles IPv4 et (`DUAL`).  
Pour plus d'informations, consultez la section [Clusters DocumentDB dans un VPC dans le](https://docs.aws.amazon.com/documentdb/latest/developerguide/vpc-clusters.html) manuel Amazon DocumentDB Developer Guide.  
Valeurs valides : `IPV4` \$1 `DUAL`   
Type : chaîne  
Obligatoire : non

 ** PercentProgress **   
Spécifie la progression de l'opération sous forme de pourcentage.  
Type : chaîne  
Obligatoire : non

 ** Port **   
Spécifie le port sur lequel le moteur de base de données est à l'écoute.  
Type : entier  
Obligatoire : non

 ** PreferredBackupWindow **   
Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété `BackupRetentionPeriod`.   
Type : chaîne  
Obligatoire : non

 ** PreferredMaintenanceWindow **   
Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.  
Type : chaîne  
Obligatoire : non

 ** ReaderEndpoint **   
Point de terminaison du lecteur pour le cluster. Le point de terminaison du lecteur d'un cluster équilibre la charge des connexions entre les répliques Amazon DocumentDB disponibles dans un cluster. Lorsque les clients demandent de nouvelles connexions au point de terminaison du lecteur, Amazon DocumentDB distribue les demandes de connexion entre les répliques Amazon DocumentDB du cluster. Cette fonctionnalité permet d'équilibrer votre charge de travail de lecture sur plusieurs répliques Amazon DocumentDB de votre cluster.   
Si un basculement se produit et que la réplique Amazon DocumentDB à laquelle vous êtes connecté est promue instance principale, votre connexion est interrompue. Pour continuer à envoyer votre charge de travail de lecture à d'autres répliques Amazon DocumentDB du cluster, vous pouvez ensuite vous reconnecter au point de terminaison du lecteur.  
Type : chaîne  
Obligatoire : non

 ** ReadReplicaIdentifiers.ReadReplicaIdentifier.N **   
Contient un ou plusieurs identifiants des clusters secondaires associés à ce cluster.  
Type : tableau de chaînes  
Obligatoire : non

 ** ReplicationSourceIdentifier **   
Contient l'identifiant du cluster source s'il s'agit d'un cluster secondaire.  
Type : chaîne  
Obligatoire : non

 ** ServerlessV2ScalingConfiguration **   
Configuration de dimensionnement d'un cluster Amazon DocumentDB Serverless.  
Type : objet [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md)  
Obligatoire : non

 ** Status **   
Spécifie l'état actuel de ce cluster.  
Type : chaîne  
Obligatoire : non

 ** StorageEncrypted **   
Indique si le cluster est chiffré.  
Type : booléen  
Obligatoire : non

 ** StorageType **   
Type de stockage associé à votre cluster  
Pour plus d'informations sur les types de stockage pour les clusters Amazon DocumentDB, consultez la section Configurations de stockage des clusters dans le manuel *Amazon DocumentDB Developer Guide*.  
Valeurs valides pour le type de stockage - `standard | iopt1`   
La valeur par défaut est `standard `   
Type : chaîne  
Obligatoire : non

 ** VpcSecurityGroups.VpcSecurityGroupMembership.N **   
Fournit une liste des groupes de sécurité du cloud privé virtuel (VPC) auxquels appartient le cluster.  
Type : tableau d’objets [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md)  
Obligatoire : non

## consultez aussi
<a name="API_DBCluster_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBCluster) 

# DBClusterMember
<a name="API_DBClusterMember"></a>

Contient des informations sur une instance faisant partie d'un cluster.

## Table des matières
<a name="API_DBClusterMember_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** DBClusterParameterGroupStatus **   
Spécifie l'état du groupe de paramètres de cluster pour ce membre du cluster de base de données.  
Type : chaîne  
Obligatoire : non

 ** DBInstanceIdentifier **   
Spécifie l'identifiant d'instance pour ce membre du cluster.  
Type : chaîne  
Obligatoire : non

 ** IsClusterWriter **   
Une valeur indiquant `true` si le membre du cluster est l'instance principale du cluster `false` ou non.  
Type : booléen  
Obligatoire : non

 ** PromotionTier **   
Valeur qui indique l'ordre dans lequel une réplique Amazon DocumentDB est promue vers l'instance principale après une défaillance de l'instance principale existante.   
Type : entier  
Obligatoire : non

## consultez aussi
<a name="API_DBClusterMember_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterMember) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterMember) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterMember) 

# DBClusterParameterGroup
<a name="API_DBClusterParameterGroup"></a>

Informations détaillées sur un groupe de paramètres de cluster. 

## Table des matières
<a name="API_DBClusterParameterGroup_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** DBClusterParameterGroupArn **   
Amazon Resource Name (ARN) pour le groupe de paramètres du cluster.  
Type : chaîne  
Obligatoire : non

 ** DBClusterParameterGroupName **   
Fournit le nom du groupe de paramètres du cluster.  
Type : chaîne  
Obligatoire : non

 ** DBParameterGroupFamily **   
Fournit le nom de la famille de groupes de paramètres avec laquelle ce groupe de paramètres de cluster est compatible.  
Type : chaîne  
Obligatoire : non

 ** Description **   
Fournit la description spécifiée par le client pour ce groupe de paramètres de cluster.  
Type : chaîne  
Obligatoire : non

## consultez aussi
<a name="API_DBClusterParameterGroup_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterParameterGroup) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterParameterGroup) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterParameterGroup) 

# DBClusterRole
<a name="API_DBClusterRole"></a>

Décrit un rôle Gestion des identités et des accès AWS (IAM) associé à un cluster.

## Table des matières
<a name="API_DBClusterRole_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** RoleArn **   
Le nom de ressource Amazon (ARN) associé au cluster de base de données. IAMrole   
Type : chaîne  
Obligatoire : non

 ** Status **   
Décrit l'état de l'association entre le IAMrole et le cluster. La `Status` propriété renvoie l'une des valeurs suivantes :  
+  `ACTIVE`- L' IAMrole ARN est associé au cluster et peut être utilisé pour accéder à d'autres AWS services en votre nom.
+  `PENDING`- L' IAMrole ARN est associé au cluster.
+  `INVALID`- L' IAMrole ARN est associé au cluster, mais celui-ci ne peut pas le prendre IAMrole pour accéder à d'autres AWS services en votre nom.
Type : chaîne  
Obligatoire : non

## consultez aussi
<a name="API_DBClusterRole_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterRole) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterRole) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterRole) 

# DBClusterSnapshot
<a name="API_DBClusterSnapshot"></a>

Informations détaillées sur un instantané de cluster. 

## Table des matières
<a name="API_DBClusterSnapshot_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** AvailabilityZones.AvailabilityZone.N **   
Fournit la liste des zones de EC2 disponibilité Amazon dans lesquelles les instances du snapshot du cluster peuvent être restaurées.  
Type : tableau de chaînes  
Obligatoire : non

 ** ClusterCreateTime **   
Spécifie l'heure à laquelle le cluster a été créé, en temps universel coordonné (UTC).  
Type : Timestamp  
Obligatoire : non

 ** DBClusterIdentifier **   
Spécifie l'identifiant du cluster à partir duquel ce cliché de cluster a été créé.  
Type : chaîne  
Obligatoire : non

 ** DBClusterSnapshotArn **   
Le nom de ressource Amazon (ARN) pour l'instantané du cluster.  
Type : chaîne  
Obligatoire : non

 ** DBClusterSnapshotIdentifier **   
Spécifie l'identifiant du cliché du cluster.  
Type : chaîne  
Obligatoire : non

 ** Engine **   
Spécifie le nom du moteur de base de données.  
Type : chaîne  
Obligatoire : non

 ** EngineVersion **   
Fournit la version du moteur de base de données pour cet instantané de cluster.  
Type : chaîne  
Obligatoire : non

 ** KmsKeyId **   
Si tel `StorageEncrypted` est le cas`true`, l'identifiant de AWS KMS clé pour le snapshot du cluster chiffré.  
Type : chaîne  
Obligatoire : non

 ** MasterUsername **   
Fournit le nom d'utilisateur principal pour le snapshot du cluster.  
Type : chaîne  
Obligatoire : non

 ** PercentProgress **   
Spécifie une estimation du pourcentage de données transférées.  
Type : entier  
Obligatoire : non

 ** Port **   
Spécifie le port sur lequel le cluster écoutait au moment de la capture instantanée.  
Type : entier  
Obligatoire : non

 ** SnapshotCreateTime **   
Indique l'heure à laquelle le cliché a été pris, en UTC.  
Type : Timestamp  
Obligatoire : non

 ** SnapshotType **   
Fournit le type de capture instantanée du cluster.  
Type : chaîne  
Obligatoire : non

 ** SourceDBClusterSnapshotArn **   
Si le cliché de cluster a été copié à partir d'un instantané de cluster source, l'ARN de l'instantané de cluster source ; sinon, une valeur nulle.  
Type : chaîne  
Obligatoire : non

 ** Status **   
Spécifie l'état de ce cliché de cluster.  
Type : chaîne  
Obligatoire : non

 ** StorageEncrypted **   
Spécifie si le snapshot du cluster est chiffré.  
Type : booléen  
Obligatoire : non

 ** StorageType **   
Type de stockage associé à votre instantané de cluster  
Pour plus d'informations sur les types de stockage pour les clusters Amazon DocumentDB, consultez la section Configurations de stockage des clusters dans le manuel *Amazon DocumentDB Developer Guide*.  
Valeurs valides pour le type de stockage - `standard | iopt1`   
La valeur par défaut est `standard `   
Type : chaîne  
Obligatoire : non

 ** VpcId **   
Fournit l'ID de cloud privé virtuel (VPC) associé au snapshot du cluster.  
Type : chaîne  
Obligatoire : non

## consultez aussi
<a name="API_DBClusterSnapshot_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshot) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshot) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshot) 

# DBClusterSnapshotAttribute
<a name="API_DBClusterSnapshotAttribute"></a>

Contient le nom et les valeurs d'un attribut de capture d'écran de cluster manuel.

Les attributs de capture d'écran de cluster manuels sont utilisés pour autoriser d'autres personnes Comptes AWS à restaurer un instantané de cluster manuel.

## Table des matières
<a name="API_DBClusterSnapshotAttribute_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** AttributeName **   
Nom de l'attribut de capture d'écran manuel du cluster.  
L'attribut nommé `restore` fait référence à la liste Comptes AWS des personnes autorisées à copier ou à restaurer l'instantané manuel du cluster.  
Type : chaîne  
Obligatoire : non

 ** AttributeValues.AttributeValue.N **   
Les valeurs de l'attribut de capture d'écran manuel du cluster.  
Si le `AttributeName` champ est défini sur`restore`, cet élément renvoie une liste IDs des Comptes AWS personnes autorisées à copier ou à restaurer l'instantané manuel du cluster. Si la valeur de `all` figure dans la liste, l'instantané manuel du cluster est public et peut être copié ou restauré par tout Compte AWS le monde.  
Type : tableau de chaînes  
Obligatoire : non

## consultez aussi
<a name="API_DBClusterSnapshotAttribute_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttribute) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttribute) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshotAttribute) 

# DBClusterSnapshotAttributesResult
<a name="API_DBClusterSnapshotAttributesResult"></a>

Informations détaillées sur les attributs associés à un instantané de cluster.

## Table des matières
<a name="API_DBClusterSnapshotAttributesResult_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** DBClusterSnapshotAttributes.DBClusterSnapshotAttribute.N **   
La liste des attributs et des valeurs de l'instantané du cluster.  
Type : tableau d’objets [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md)  
Obligatoire : non

 ** DBClusterSnapshotIdentifier **   
Identifiant du cliché du cluster auquel les attributs s'appliquent.  
Type : chaîne  
Obligatoire : non

## consultez aussi
<a name="API_DBClusterSnapshotAttributesResult_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBClusterSnapshotAttributesResult) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBClusterSnapshotAttributesResult) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBClusterSnapshotAttributesResult) 

# DBEngineVersion
<a name="API_DBEngineVersion"></a>

 Informations détaillées sur une version du moteur. 

## Table des matières
<a name="API_DBEngineVersion_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** DBEngineDescription **   
Description du moteur de base de données.  
Type : chaîne  
Obligatoire : non

 ** DBEngineVersionDescription **   
Description de la version du moteur de base de données.  
Type : chaîne  
Obligatoire : non

 ** DBParameterGroupFamily **   
Nom de la famille de groupes de paramètres pour le moteur de base de données.  
Type : chaîne  
Obligatoire : non

 ** Engine **   
Nom du moteur de base de données.  
Type : chaîne  
Obligatoire : non

 ** EngineVersion **   
Le numéro de version du moteur de base de données.  
Type : chaîne  
Obligatoire : non

 ** ExportableLogTypes.member.N **   
Les types de journaux que le moteur de base de données met à disposition pour exportation vers Amazon CloudWatch Logs.  
Type : tableau de chaînes  
Obligatoire : non

 ** ServerlessV2FeaturesSupport **   
Spécifie toutes les propriétés ou limites Amazon DocumentDB Serverless qui diffèrent selon les versions du moteur Amazon DocumentDB. Vous pouvez tester les valeurs de cet attribut lorsque vous décidez quelle version d'Amazon DocumentDB utiliser dans un cluster nouveau ou mis à niveau. Vous pouvez également récupérer la version d'un cluster existant et vérifier si cette version prend en charge certaines fonctionnalités d'Amazon DocumentDB Serverless avant de tenter de les utiliser.  
Type : objet [ServerlessV2FeaturesSupport](API_ServerlessV2FeaturesSupport.md)  
Obligatoire : non

 ** SupportedCACertificateIdentifiers.member.N **   
Liste des identifiants de certificats CA pris en charge.  
*Pour plus d'informations, consultez la section [Mise à jour de vos certificats TLS Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) et [chiffrement des données en transit dans le](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) guide du développeur Amazon DocumentDB.*  
Type : tableau de chaînes  
Obligatoire : non

 ** SupportsCertificateRotationWithoutRestart **   
Indique si la version du moteur prend en charge la rotation du certificat de serveur sans redémarrer l'instance de base de données.  
Type : booléen  
Obligatoire : non

 ** SupportsLogExportsToCloudwatchLogs **   
Une valeur qui indique si la version du moteur prend en charge l'exportation des types de journaux spécifiés par `ExportableLogTypes` to CloudWatch Logs.  
Type : booléen  
Obligatoire : non

 ** ValidUpgradeTarget.UpgradeTarget.N **   
Liste des versions de moteur vers lesquelles cette version du moteur de base de données peut être mise à niveau.  
Type : tableau d’objets [UpgradeTarget](API_UpgradeTarget.md)  
Obligatoire : non

## consultez aussi
<a name="API_DBEngineVersion_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBEngineVersion) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBEngineVersion) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBEngineVersion) 

# DBInstance
<a name="API_DBInstance"></a>

Informations détaillées sur une instance. 

## Table des matières
<a name="API_DBInstance_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** AutoMinorVersionUpgrade **   
Ne s'applique pas Ce paramètre ne s'applique pas à Amazon DocumentDB. Amazon DocumentDB n'effectue pas de mises à niveau mineures de version, quelle que soit la valeur définie.  
Type : booléen  
Obligatoire : non

 ** AvailabilityZone **   
Spécifie le nom de la zone de disponibilité dans laquelle se trouve l'instance.  
Type : chaîne  
Obligatoire : non

 ** BackupRetentionPeriod **   
Spécifie le nombre de jours pendant lesquels les instantanés automatiques sont conservés.  
Type : entier  
Obligatoire : non

 ** CACertificateIdentifier **   
Identifiant du certificat CA de cette instance de base de données.  
Type : chaîne  
Obligatoire : non

 ** CertificateDetails **   
Les détails du certificat de serveur de l'instance de base de données.  
Type : objet [CertificateDetails](API_CertificateDetails.md)  
Obligatoire : non

 ** CopyTagsToSnapshot **   
Une valeur qui indique si vous voulez copier toutes les balises à partir de l'instance de base de données pour les instantanés de l'instance de base de données. Par défaut, les balises ne sont pas copiées.  
Type : booléen  
Obligatoire : non

 ** DBClusterIdentifier **   
Contient le nom du cluster dont l'instance est membre si l'instance est membre d'un cluster.  
Type : chaîne  
Obligatoire : non

 ** DBInstanceArn **   
L'Amazon Resource Name (ARN) de l'instance.  
Type : chaîne  
Obligatoire : non

 ** DBInstanceClass **   
Contient le nom de la classe de capacité de calcul et de mémoire de l'instance.  
Type : chaîne  
Obligatoire : non

 ** DBInstanceIdentifier **   
Contient un identifiant de base de données fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une instance.  
Type : chaîne  
Obligatoire : non

 ** DBInstanceStatus **   
Indique l'état actuel de cette base de données.  
Type : chaîne  
Obligatoire : non

 ** DbiResourceId **   
L'identifiant Région AWS unique et immuable de l'instance. Cet identifiant se trouve dans les entrées du AWS CloudTrail journal chaque fois que l'on accède à la AWS KMS clé de l'instance.  
Type : chaîne  
Obligatoire : non

 ** DBSubnetGroup **   
Spécifie des informations sur le groupe de sous-réseaux associé à l'instance, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.  
Type : objet [DBSubnetGroup](API_DBSubnetGroup.md)  
Obligatoire : non

 ** EnabledCloudwatchLogsExports.member.N **   
Liste des types de journaux que cette instance est configurée pour exporter vers CloudWatch Logs.  
Type : tableau de chaînes  
Obligatoire : non

 ** Endpoint **   
Spécifie le point de terminaison de la connexion.  
Type : objet [Endpoint](API_Endpoint.md)  
Obligatoire : non

 ** Engine **   
Fournit le nom du moteur de base de données à utiliser pour cette instance.  
Type : chaîne  
Obligatoire : non

 ** EngineVersion **   
Indique la version du moteur de base de données.  
Type : chaîne  
Obligatoire : non

 ** InstanceCreateTime **   
Indique la date et l'heure de création de l'instance.  
Type : Timestamp  
Obligatoire : non

 ** KmsKeyId **   
 Si tel `StorageEncrypted` est le cas`true`, l'identifiant de AWS KMS clé de l'instance chiffrée.   
Type : chaîne  
Obligatoire : non

 ** LatestRestorableTime **   
Spécifie l'heure limite à laquelle une base de données peut être restaurée à l'aide de la fonction de point-in-time restauration.  
Type : Timestamp  
Obligatoire : non

 ** PendingModifiedValues **   
Spécifie que les modifications apportées à l'instance sont en attente. Cet élément est inclus uniquement lorsque des modifications sont en attente. Des modifications spécifiques sont identifiées par sous-éléments.  
Type : objet [PendingModifiedValues](API_PendingModifiedValues.md)  
Obligatoire : non

 ** PerformanceInsightsEnabled **   
Définissez `true` si Amazon RDS Performance Insights est activé pour l'instance de base de données, et sinon`false`.  
Type : booléen  
Obligatoire : non

 ** PerformanceInsightsKMSKeyId **   
Identifiant AWS KMS clé pour le chiffrement des données Performance Insights. L'ID de AWS KMS clé est le Amazon Resource Name (ARN), AWS KMS l'identifiant de AWS KMS clé ou l'alias de clé de AWS KMS chiffrement.  
Type : chaîne  
Obligatoire : non

 ** PreferredBackupWindow **   
 Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété `BackupRetentionPeriod`.   
Type : chaîne  
Obligatoire : non

 ** PreferredMaintenanceWindow **   
Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.  
Type : chaîne  
Obligatoire : non

 ** PromotionTier **   
Valeur qui indique l'ordre dans lequel une réplique Amazon DocumentDB est promue vers l'instance principale après une défaillance de l'instance principale existante.  
Type : entier  
Obligatoire : non

 ** PubliclyAccessible **   
Non pris en charge. Amazon DocumentDB ne prend actuellement pas en charge les points de terminaison publics. La valeur de `PubliclyAccessible` est toujours`false`.  
Type : booléen  
Obligatoire : non

 ** StatusInfos.DBInstanceStatusInfo.N **   
État d'une réplique lue. Si l'instance n'est pas une réplique lue, ce champ est vide.  
Type : tableau d’objets [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md)  
Obligatoire : non

 ** StorageEncrypted **   
Spécifie si l'instance est chiffrée ou non.  
Type : booléen  
Obligatoire : non

 ** VpcSecurityGroups.VpcSecurityGroupMembership.N **   
Fournit une liste des éléments du groupe de sécurité VPC auxquels appartient l'instance.  
Type : tableau d’objets [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md)  
Obligatoire : non

## consultez aussi
<a name="API_DBInstance_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstance) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstance) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBInstance) 

# DBInstanceStatusInfo
<a name="API_DBInstanceStatusInfo"></a>

Fournit une liste d'informations d'état pour une instance.

## Table des matières
<a name="API_DBInstanceStatusInfo_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** Message **   
Détails de l'erreur en cas d'erreur de l'instance. Si l'instance n'est pas dans un état d'erreur, cette valeur est vide.  
Type : chaîne  
Obligatoire : non

 ** Normal **   
Une valeur booléenne indiquant `true` si l'instance fonctionne normalement ou `false` si l'instance est en état d'erreur.  
Type : booléen  
Obligatoire : non

 ** Status **   
État de l'instance. Pour `StatusType` une réplique en lecture, les valeurs peuvent être `replicating``stopped`, error ou`terminated`.  
Type : chaîne  
Obligatoire : non

 ** StatusType **   
Cette valeur est actuellement « »`read replication`.  
Type : chaîne  
Obligatoire : non

## consultez aussi
<a name="API_DBInstanceStatusInfo_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstanceStatusInfo) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstanceStatusInfo) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBInstanceStatusInfo) 

# DBSubnetGroup
<a name="API_DBSubnetGroup"></a>

Informations détaillées sur un groupe de sous-réseaux. 

## Table des matières
<a name="API_DBSubnetGroup_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** DBSubnetGroupArn **   
Amazon Resource Name (ARN) du groupe de sous-réseaux de base de données.  
Type : chaîne  
Obligatoire : non

 ** DBSubnetGroupDescription **   
Fournit la description du groupe de sous-réseaux.  
Type : chaîne  
Obligatoire : non

 ** DBSubnetGroupName **   
Le nom du groupe de sous-réseau.  
Type : chaîne  
Obligatoire : non

 ** SubnetGroupStatus **   
Indique le statut du groupe de sous-réseaux.  
Type : chaîne  
Obligatoire : non

 ** Subnets.Subnet.N **   
Informations détaillées sur un ou plusieurs sous-réseaux au sein d'un groupe de sous-réseaux.  
Type : tableau d’objets [Subnet](API_Subnet.md)  
Obligatoire : non

 ** SupportedNetworkTypes.member.N **   
Type de réseau du groupe de sous-réseaux de base de données.  
Valeurs valides : `IPV4` \$1 `DUAL`   
A ne `DBSubnetGroup` peut prendre en charge que le IPv4 protocole ou les IPv6 protocoles IPv4 et (DUAL).  
Type : tableau de chaînes  
Obligatoire : non

 ** VpcId **   
Fournit l'ID de cloud privé virtuel (VPC) du groupe de sous-réseaux.  
Type : chaîne  
Obligatoire : non

## consultez aussi
<a name="API_DBSubnetGroup_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBSubnetGroup) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBSubnetGroup) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBSubnetGroup) 

# Endpoint
<a name="API_Endpoint"></a>

Informations réseau pour accéder à un cluster ou à une instance. Les programmes clients doivent spécifier un point de terminaison valide pour accéder à ces ressources Amazon DocumentDB.

## Table des matières
<a name="API_Endpoint_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** Address **   
Spécifie l'adresse DNS de l'instance.  
Type : chaîne  
Obligatoire : non

 ** HostedZoneId **   
Spécifie l'ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.  
Type : chaîne  
Obligatoire : non

 ** Port **   
Spécifie le port sur lequel le moteur de base de données est à l'écoute.  
Type : entier  
Obligatoire : non

## consultez aussi
<a name="API_Endpoint_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Endpoint) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Endpoint) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Endpoint) 

# EngineDefaults
<a name="API_EngineDefaults"></a>

Contient le résultat d'une invocation réussie de l'`DescribeEngineDefaultClusterParameters`opération. 

## Table des matières
<a name="API_EngineDefaults_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** DBParameterGroupFamily **   
Nom de la famille de groupes de paramètres du cluster pour laquelle les informations sur les paramètres du moteur doivent être renvoyées.  
Type : chaîne  
Obligatoire : non

 ** Marker **   
Jeton de pagination facultatif fourni par une demande précédente. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à la valeur spécifiée par `MaxRecords`.  
Type : chaîne  
Obligatoire : non

 ** Parameters.Parameter.N **   
Les paramètres d'une famille de groupes de paramètres de cluster particulière.  
Type : tableau d’objets [Parameter](API_Parameter.md)  
Obligatoire : non

## consultez aussi
<a name="API_EngineDefaults_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EngineDefaults) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EngineDefaults) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EngineDefaults) 

# Event
<a name="API_Event"></a>

Informations détaillées sur un événement.

## Table des matières
<a name="API_Event_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** Date **   
Spécifie la date et l'heure de l'événement.  
Type : Timestamp  
Obligatoire : non

 ** EventCategories.EventCategory.N **   
Spécifie la catégorie pour l'événement.  
Type : tableau de chaînes  
Obligatoire : non

 ** Message **   
Fournit le texte de cet événement.  
Type : chaîne  
Obligatoire : non

 ** SourceArn **   
ARN (Amazon Resource Name) de l'événement.  
Type : chaîne  
Obligatoire : non

 ** SourceIdentifier **   
Fournit l'identifiant de la source de l'événement.  
Type : chaîne  
Obligatoire : non

 ** SourceType **   
Spécifie le type de source pour cet événement.  
Type : String  
Valeurs valides : `db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot`   
Obligatoire : non

## consultez aussi
<a name="API_Event_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Event) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Event) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Event) 

# EventCategoriesMap
<a name="API_EventCategoriesMap"></a>

Type de source d'événement, accompagné d'un ou de plusieurs noms de catégories d'événements.

## Table des matières
<a name="API_EventCategoriesMap_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** EventCategories.EventCategory.N **   
Catégories d'événements pour le type de source spécifié.  
Type : tableau de chaînes  
Obligatoire : non

 ** SourceType **   
Type de source auquel appartiennent les catégories renvoyées.  
Type : chaîne  
Obligatoire : non

## consultez aussi
<a name="API_EventCategoriesMap_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventCategoriesMap) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventCategoriesMap) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EventCategoriesMap) 

# EventSubscription
<a name="API_EventSubscription"></a>

Informations détaillées sur un événement auquel vous vous êtes inscrit.

## Table des matières
<a name="API_EventSubscription_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** CustomerAwsId **   
Le compte AWS client associé à l'abonnement aux notifications d'événements Amazon DocumentDB.  
Type : chaîne  
Obligatoire : non

 ** CustSubscriptionId **   
L'ID d'abonnement aux notifications d'événements Amazon DocumentDB.  
Type : chaîne  
Obligatoire : non

 ** Enabled **   
Valeur booléenne indiquant si l'abonnement est activé. La valeur de `true` indique que l'abonnement est activé.  
Type : booléen  
Obligatoire : non

 ** EventCategoriesList.EventCategory.N **   
Liste des catégories d'événements pour l'abonnement aux notifications d'événements Amazon DocumentDB.  
Type : tableau de chaînes  
Obligatoire : non

 ** EventSubscriptionArn **   
Amazon Resource Name (ARN) de l'abonnement aux événements.  
Type : chaîne  
Obligatoire : non

 ** SnsTopicArn **   
L'ARN du sujet de l'abonnement aux notifications d'événements Amazon DocumentDB.  
Type : chaîne  
Obligatoire : non

 ** SourceIdsList.SourceId.N **   
Liste des sources IDs pour l'abonnement aux notifications d'événements Amazon DocumentDB.  
Type : tableau de chaînes  
Obligatoire : non

 ** SourceType **   
Type de source pour l'abonnement aux notifications d'événements Amazon DocumentDB.  
Type : chaîne  
Obligatoire : non

 ** Status **   
État de l'abonnement aux notifications d'événements Amazon DocumentDB.  
Contraintes :  
Il peut s'agir de l'une des options suivantes : `creating` `modifying``deleting`,,`active`,`no-permission`, `topic-not-exist`   
Le `no-permission` statut indique qu'Amazon DocumentDB n'est plus autorisé à publier sur le sujet SNS. Le `topic-not-exist` statut indique que le sujet a été supprimé après la création de l'abonnement.  
Type : chaîne  
Obligatoire : non

 ** SubscriptionCreationTime **   
Heure à laquelle l'abonnement aux notifications d'événements Amazon DocumentDB a été créé.  
Type : chaîne  
Obligatoire : non

## consultez aussi
<a name="API_EventSubscription_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/EventSubscription) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/EventSubscription) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/EventSubscription) 

# FailoverState
<a name="API_FailoverState"></a>

Contient l'état des opérations planifiées ou en cours sur un cluster global Amazon DocumentDB. Ce type de données est vide sauf si une opération de basculement ou de basculement est planifiée ou en cours sur le cluster global.

## Table des matières
<a name="API_FailoverState_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** FromDbClusterArn **   
Le nom de ressource Amazon (ARN) du cluster Amazon DocumentDB actuellement rétrogradé et qui est associé à cet état.  
Type : chaîne  
Obligatoire : non

 ** IsDataLossAllowed **   
Indique s'il s'agit d'un basculement global ou d'un basculement global. Si la perte de données est autorisée, l'opération est un basculement global. Sinon, il s'agit d'une transition.  
Type : booléen  
Obligatoire : non

 ** Status **   
État actuel du cluster mondial. Les valeurs possibles sont les suivantes :  
+  **en attente** — Le service a reçu une demande de basculement ou de basculement sur le cluster global. Le cluster principal du cluster global et le cluster secondaire spécifié sont en cours de vérification avant le début de l'opération.
+  **basculement** — Le cluster secondaire choisi est promu pour devenir le nouveau cluster principal à basculer sur le cluster global.
+  **annulation — La demande de basculement** ou de basculement du cluster global a été annulée et le cluster principal et le cluster secondaire sélectionné retrouvent leur état antérieur.
Type : Chaîne  
Valeurs valides : `pending | failing-over | cancelling`   
Obligatoire : non

 ** ToDbClusterArn **   
Nom de ressource Amazon (ARN) du cluster Amazon DocumentDB actuellement promu et associé à cet état.  
Type : chaîne  
Obligatoire : non

## Voir aussi
<a name="API_FailoverState_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverState) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverState) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverState) 

# Filter
<a name="API_Filter"></a>

Ensemble nommé de valeurs de filtre, utilisé pour renvoyer une liste de résultats plus spécifique. Vous pouvez utiliser un filtre pour faire correspondre un ensemble de ressources selon des critères spécifiques, tels que IDs.

Les caractères génériques ne sont pas pris en charge dans les filtres.

## Table des matières
<a name="API_Filter_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** Name **   
Nom du filtre. Les noms des filtres distinguent les majuscules et minuscules.  
Type : String  
Obligatoire : oui

 ** Values.Value.N **   
Une ou plusieurs valeurs de filtre. Les valeurs de filtre sont sensibles à la casse.  
Type : tableau de chaînes  
Obligatoire : oui

## consultez aussi
<a name="API_Filter_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Filter) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Filter) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Filter) 

# GlobalCluster
<a name="API_GlobalCluster"></a>

Type de données représentant un cluster global Amazon DocumentDB.

## Table des matières
<a name="API_GlobalCluster_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** DatabaseName **   
Nom de base de données par défaut au sein du nouveau cluster global.  
Type : chaîne  
Obligatoire : non

 ** DeletionProtection **   
Le paramètre de protection contre la suppression pour le nouveau cluster global.  
Type : booléen  
Obligatoire : non

 ** Engine **   
Le moteur de base de données Amazon DocumentDB utilisé par le cluster mondial.   
Type : chaîne  
Obligatoire : non

 ** EngineVersion **   
Indique la version du moteur de base de données.  
Type : chaîne  
Obligatoire : non

 ** FailoverState **   
Objet de données contenant toutes les propriétés relatives à l'état actuel d'un processus de basculement ou de basculement en cours ou en attente pour ce cluster global. Cet objet est vide sauf si l'`FailoverGlobalCluster`opération `SwitchoverGlobalCluster` or a été appelée sur ce cluster global.  
Type : objet [FailoverState](API_FailoverState.md)  
Obligatoire : non

 ** GlobalClusterArn **   
Le nom de ressource Amazon (ARN) du cluster mondial.  
Type : chaîne  
Obligatoire : non

 ** GlobalClusterIdentifier **   
Contient un identifiant de cluster global fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie un cluster mondial.   
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 255 caractères.  
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`   
Obligatoire : non

 ** GlobalClusterMembers.GlobalClusterMember.N **   
La liste des clusters IDs pour les clusters secondaires au sein du cluster global. Limité à un article pour le moment.   
Type : tableau d’objets [GlobalClusterMember](API_GlobalClusterMember.md)  
Obligatoire : non

 ** GlobalClusterResourceId **   
Identifiant immuable Région AWS unique à la région pour le cluster de bases de données mondial. Cet identifiant se trouve dans les entrées du AWS CloudTrail journal chaque fois que l'on accède à la clé principale du AWS KMS client (CMK) du cluster.   
Type : chaîne  
Obligatoire : non

 ** Status **   
Spécifie l'état actuel de ce cluster global.  
Type : chaîne  
Obligatoire : non

 ** StorageEncrypted **   
Le paramètre de chiffrement du stockage pour le cluster global.  
Type : booléen  
Obligatoire : non

 ** TagList.Tag.N **   
Liste des balises de cluster globales.  
Type : tableau d’objets [Tag](API_Tag.md)  
Obligatoire : non

## Voir aussi
<a name="API_GlobalCluster_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalCluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/GlobalCluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/GlobalCluster) 

# GlobalClusterMember
<a name="API_GlobalClusterMember"></a>

Structure de données contenant des informations sur les clusters principaux et secondaires associés à un cluster global Amazon DocumentDB. 

## Table des matières
<a name="API_GlobalClusterMember_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** DBClusterArn **   
Le nom de ressource Amazon (ARN) pour chaque cluster Amazon DocumentDB.  
Type : chaîne  
Obligatoire : non

 ** IsWriter **   
 Spécifie si le cluster Amazon DocumentDB est le cluster principal (c'est-à-dire s'il possède une capacité de lecture-écriture) du cluster global Amazon DocumentDB auquel il est associé.   
Type : booléen  
Obligatoire : non

 ** Readers.member.N **   
Le nom de ressource Amazon (ARN) pour chaque cluster secondaire en lecture seule associé au cluster global Amazon DocumentDB.  
Type : tableau de chaînes  
Obligatoire : non

 ** SynchronizationStatus **   
État de synchronisation de chaque cluster Amazon DocumentDB dans le cluster global.  
Type : Chaîne  
Valeurs valides : `connected | pending-resync`   
Obligatoire : non

## Voir aussi
<a name="API_GlobalClusterMember_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/GlobalClusterMember) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/GlobalClusterMember) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/GlobalClusterMember) 

# OrderableDBInstanceOption
<a name="API_OrderableDBInstanceOption"></a>

Les options disponibles pour une instance.

## Table des matières
<a name="API_OrderableDBInstanceOption_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** AvailabilityZones.AvailabilityZone.N **   
Liste des zones de disponibilité pour une instance.  
Type : tableau d’objets [AvailabilityZone](API_AvailabilityZone.md)  
Obligatoire : non

 ** DBInstanceClass **   
La classe d'instance d'une instance.  
Type : chaîne  
Obligatoire : non

 ** Engine **   
Type de moteur d'une instance.  
Type : chaîne  
Obligatoire : non

 ** EngineVersion **   
Version du moteur d'une instance.  
Type : chaîne  
Obligatoire : non

 ** LicenseModel **   
Le modèle de licence d'une instance.  
Type : chaîne  
Obligatoire : non

 ** StorageType **   
Type de stockage à associer au cluster de base de données  
Type : chaîne  
Obligatoire : non

 ** Vpc **   
Indique si une instance se trouve dans un cloud privé virtuel (VPC).  
Type : booléen  
Obligatoire : non

## consultez aussi
<a name="API_OrderableDBInstanceOption_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/OrderableDBInstanceOption) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/OrderableDBInstanceOption) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/OrderableDBInstanceOption) 

# Parameter
<a name="API_Parameter"></a>

Informations détaillées sur un paramètre individuel.

## Table des matières
<a name="API_Parameter_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** AllowedValues **   
Spécifie la plage de valeurs valide pour le paramètre.  
Type : chaîne  
Obligatoire : non

 ** ApplyMethod **   
Indique quand appliquer les mises à jour de paramètres.  
Type : String  
Valeurs valides : `immediate | pending-reboot`   
Obligatoire : non

 ** ApplyType **   
Spécifie le type de paramètres spécifiques au moteur.  
Type : chaîne  
Obligatoire : non

 ** DataType **   
Spécifie le type de données valide pour le paramètre.  
Type : chaîne  
Obligatoire : non

 ** Description **   
Fournit une description du paramètre.  
Type : chaîne  
Obligatoire : non

 ** IsModifiable **   
 Indique si le paramètre peut être (`true`) ou non (`false`) modifié. Certains paramètres ont des implications en terme de sécurité ou de fonctionnement qui les empêchent d'être modifiés.   
Type : booléen  
Obligatoire : non

 ** MinimumEngineVersion **   
Première version de moteur à laquelle le paramètre peut s'appliquer.  
Type : chaîne  
Obligatoire : non

 ** ParameterName **   
Spécifie le nom du paramètre.  
Type : chaîne  
Obligatoire : non

 ** ParameterValue **   
Spécifie la valeur du paramètre. Il doit s'agir d'un ou de plusieurs paramètres du `AllowedValues` cluster au format CSV :  
Les valeurs valides sont :  
+  `enabled`: Le cluster accepte les connexions sécurisées utilisant les versions TLS 1.0 à 1.3. 
+  `disabled`: le cluster n'accepte pas les connexions sécurisées utilisant le protocole TLS. 
+  `fips-140-3`: Le cluster accepte uniquement les connexions sécurisées conformément aux exigences de la publication 140-3 des Federal Information Processing Standards (FIPS). Supporté uniquement à partir des clusters Amazon DocumentDB 5.0 (moteur version 3.0.3727) dans les régions suivantes : ca-central-1, us-west-2, us-east-1, us-east-2, -1, -1. us-gov-east us-gov-west
+  `tls1.2+`: Le cluster accepte les connexions sécurisées utilisant le protocole TLS version 1.2 ou ultérieure. Supporté uniquement à partir d'Amazon DocumentDB 4.0 (version du moteur 2.0.10980) et Amazon DocumentDB 5.0 (version du moteur 3.0.11051).
+  `tls1.3+`: Le cluster accepte les connexions sécurisées utilisant le protocole TLS version 1.3 ou ultérieure. Supporté uniquement à partir d'Amazon DocumentDB 4.0 (version du moteur 2.0.10980) et Amazon DocumentDB 5.0 (version du moteur 3.0.11051).
Type : chaîne  
Obligatoire : non

 ** Source **   
Indique la source de la valeur du paramètre.  
Type : chaîne  
Obligatoire : non

## consultez aussi
<a name="API_Parameter_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Parameter) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Parameter) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Parameter) 

# PendingCloudwatchLogsExports
<a name="API_PendingCloudwatchLogsExports"></a>

Liste des types de journaux dont la configuration est toujours en attente. Ces types de journaux sont en cours d'activation ou de désactivation.

## Table des matières
<a name="API_PendingCloudwatchLogsExports_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** LogTypesToDisable.member.N **   
Types de journaux en cours d'activation. Une fois activés, ces types de journaux sont exportés vers Amazon CloudWatch Logs.  
Type : tableau de chaînes  
Obligatoire : non

 ** LogTypesToEnable.member.N **   
Types de journaux en cours de désactivation. Une fois désactivés, ces types de journaux ne sont pas exportés vers CloudWatch Logs.  
Type : tableau de chaînes  
Obligatoire : non

## consultez aussi
<a name="API_PendingCloudwatchLogsExports_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingCloudwatchLogsExports) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingCloudwatchLogsExports) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingCloudwatchLogsExports) 

# PendingMaintenanceAction
<a name="API_PendingMaintenanceAction"></a>

Fournit des informations sur une action de maintenance en attente pour une ressource.

## Table des matières
<a name="API_PendingMaintenanceAction_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** Action **   
Type d'action de maintenance en attente disponible pour la ressource.  
Type : chaîne  
Obligatoire : non

 ** AutoAppliedAfterDate **   
Date de la fenêtre de maintenance lorsque l'action est appliquée. L'action de maintenance est appliquée à la ressource lors de sa première fenêtre de maintenance après cette date. Si cette date est spécifiée, toutes les demandes de confirmation de l'acceptation `next-maintenance` sont ignorées.  
Type : Timestamp  
Obligatoire : non

 ** CurrentApplyDate **   
Date effective d'application de l'action de maintenance en attente à la ressource.  
Type : Timestamp  
Obligatoire : non

 ** Description **   
Description fournissant plus de détails sur l'action de maintenance.  
Type : chaîne  
Obligatoire : non

 ** ForcedApplyDate **   
Date à laquelle l'action de maintenance est automatiquement appliquée. L'action de maintenance est appliquée à la ressource à cette date indépendamment de la fenêtre de maintenance de la ressource. Si cette date est spécifiée, toutes les demandes de confirmation de l'acceptation `immediate` sont ignorées.  
Type : Timestamp  
Obligatoire : non

 ** OptInStatus **   
Indique le type de demande de confirmation de l'acceptation reçue pour la ressource.  
Type : chaîne  
Obligatoire : non

## consultez aussi
<a name="API_PendingMaintenanceAction_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingMaintenanceAction) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingMaintenanceAction) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingMaintenanceAction) 

# PendingModifiedValues
<a name="API_PendingModifiedValues"></a>

 Un ou plusieurs paramètres modifiés pour une instance. Ces paramètres modifiés ont été demandés, mais n'ont pas encore été appliqués.

## Table des matières
<a name="API_PendingModifiedValues_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** AllocatedStorage **   
 Contient la nouvelle `AllocatedStorage` taille de l'instance qui sera appliquée ou qui est en cours d'application.   
Type : entier  
Obligatoire : non

 ** BackupRetentionPeriod **   
Spécifie le nombre de jours en attente pour lesquels des sauvegardes automatiques sont conservées.  
Type : entier  
Obligatoire : non

 ** CACertificateIdentifier **   
Spécifie l'identifiant du certificat de l'autorité de certification (CA) pour l'instance de base de données.  
Type : chaîne  
Obligatoire : non

 ** DBInstanceClass **   
 Contient le nouveau `DBInstanceClass` pour l'instance qui sera appliquée ou qui est en cours d'application.   
Type : chaîne  
Obligatoire : non

 ** DBInstanceIdentifier **   
 Contient le nouveau `DBInstanceIdentifier` pour l'instance qui sera appliquée ou qui est en cours d'application.   
Type : chaîne  
Obligatoire : non

 ** DBSubnetGroupName **   
Le nouveau groupe de sous-réseaux pour l'instance.   
Type : chaîne  
Obligatoire : non

 ** EngineVersion **   
Indique la version du moteur de base de données.  
Type : chaîne  
Obligatoire : non

 ** Iops **   
Spécifie la nouvelle valeur d'IOPS provisionnées pour l'instance qui sera appliquée ou qui est actuellement appliquée.  
Type : entier  
Obligatoire : non

 ** LicenseModel **   
Le modèle de licence de l'instance.  
Valeurs valides: `license-included`, `bring-your-own-license`, `general-public-license`   
Type : chaîne  
Obligatoire : non

 ** MasterUserPassword **   
Contient la modification en attente ou en cours des informations d'identification principales pour l'instance.  
Type : chaîne  
Obligatoire : non

 ** MultiAZ **   
Indique que l'instance mono-AZ doit passer à un déploiement multi-AZ.  
Type : booléen  
Obligatoire : non

 ** PendingCloudwatchLogsExports **   
Liste des types de journaux dont la configuration est toujours en attente. Ces types de journaux sont en cours d'activation ou de désactivation.  
Type : objet [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md)  
Obligatoire : non

 ** Port **   
Spécifie le port en attente pour l'instance.  
Type : entier  
Obligatoire : non

 ** StorageType **   
Spécifie le type de stockage à associer à l'instance.  
Type : chaîne  
Obligatoire : non

## consultez aussi
<a name="API_PendingModifiedValues_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/PendingModifiedValues) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/PendingModifiedValues) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/PendingModifiedValues) 

# ResourcePendingMaintenanceActions
<a name="API_ResourcePendingMaintenanceActions"></a>

Représente la sortie de[ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md). 

## Table des matières
<a name="API_ResourcePendingMaintenanceActions_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** PendingMaintenanceActionDetails.PendingMaintenanceAction.N **   
Liste qui fournit des détails sur les actions de maintenance en attente pour la ressource.  
Type : tableau d’objets [PendingMaintenanceAction](API_PendingMaintenanceAction.md)  
Obligatoire : non

 ** ResourceIdentifier **   
Le nom de ressource Amazon (ARN) de la ressource pour laquelle des actions de maintenance sont en attente.  
Type : chaîne  
Obligatoire : non

## consultez aussi
<a name="API_ResourcePendingMaintenanceActions_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ResourcePendingMaintenanceActions) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ResourcePendingMaintenanceActions) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ResourcePendingMaintenanceActions) 

# ServerlessV2FeaturesSupport
<a name="API_ServerlessV2FeaturesSupport"></a>

Spécifie toutes les propriétés ou limites Amazon DocumentDB Serverless qui diffèrent selon les versions du moteur Amazon DocumentDB. Vous pouvez tester les valeurs de cet attribut lorsque vous décidez quelle version d'Amazon DocumentDB utiliser dans un cluster nouveau ou mis à niveau. Vous pouvez également récupérer la version d'un cluster existant et vérifier si cette version prend en charge certaines fonctionnalités d'Amazon DocumentDB Serverless avant de tenter de les utiliser.

## Table des matières
<a name="API_ServerlessV2FeaturesSupport_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** MaxCapacity **   
Le nombre maximum d'unités de capacité Amazon DocumentDB (DCUs) pour une instance dans un cluster Amazon DocumentDB Serverless. Vous pouvez spécifier les valeurs DCU par incréments d'un demi-pas, par exemple 32, 32,5, 33, etc.  
Type : double  
Obligatoire : non

 ** MinCapacity **   
Le nombre minimum d'unités de capacité Amazon DocumentDB (DCUs) pour une instance dans un cluster Amazon DocumentDB Serverless. Vous pouvez spécifier les valeurs DCU par incréments d'un demi-pas, par exemple 8, 8,5, 9, etc.  
Type : double  
Obligatoire : non

## consultez aussi
<a name="API_ServerlessV2FeaturesSupport_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2FeaturesSupport) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2FeaturesSupport) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2FeaturesSupport) 

# ServerlessV2ScalingConfiguration
<a name="API_ServerlessV2ScalingConfiguration"></a>

Définit la configuration de dimensionnement d'un cluster Amazon DocumentDB Serverless.

## Table des matières
<a name="API_ServerlessV2ScalingConfiguration_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** MaxCapacity **   
Le nombre maximum d'unités de capacité Amazon DocumentDB (DCUs) pour une instance dans un cluster Amazon DocumentDB Serverless. Vous pouvez spécifier les valeurs DCU par incréments d'un demi-pas, par exemple 32, 32,5, 33, etc.  
Type : double  
Obligatoire : non

 ** MinCapacity **   
Le nombre minimum d'unités de capacité Amazon DocumentDB (DCUs) pour une instance dans un cluster Amazon DocumentDB Serverless. Vous pouvez spécifier les valeurs DCU par incréments d'un demi-pas, par exemple 8, 8,5, 9, etc.  
Type : double  
Obligatoire : non

## consultez aussi
<a name="API_ServerlessV2ScalingConfiguration_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfiguration) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfiguration) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2ScalingConfiguration) 

# ServerlessV2ScalingConfigurationInfo
<a name="API_ServerlessV2ScalingConfigurationInfo"></a>

Récupère la configuration de dimensionnement pour un cluster Amazon DocumentDB Serverless.

## Table des matières
<a name="API_ServerlessV2ScalingConfigurationInfo_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** MaxCapacity **   
Le nombre maximum d'unités de capacité Amazon DocumentDB (DCUs) pour une instance dans un cluster Amazon DocumentDB Serverless. Vous pouvez spécifier les valeurs DCU par incréments d'un demi-pas, par exemple 32, 32,5, 33, etc.   
Type : double  
Obligatoire : non

 ** MinCapacity **   
Le nombre minimum d'unités de capacité Amazon DocumentDB (DCUs) pour une instance dans un cluster Amazon DocumentDB Serverless. Vous pouvez spécifier les valeurs DCU par incréments d'un demi-pas, par exemple 8, 8,5, 9, etc.  
Type : double  
Obligatoire : non

## consultez aussi
<a name="API_ServerlessV2ScalingConfigurationInfo_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ServerlessV2ScalingConfigurationInfo) 

# Subnet
<a name="API_Subnet"></a>

 Informations détaillées sur un sous-réseau. 

## Table des matières
<a name="API_Subnet_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** SubnetAvailabilityZone **   
Spécifie la zone de disponibilité pour le sous-réseau.  
Type : objet [AvailabilityZone](API_AvailabilityZone.md)  
Obligatoire : non

 ** SubnetIdentifier **   
Spécifie l'identifiant du sous-réseau.  
Type : chaîne  
Obligatoire : non

 ** SubnetStatus **   
Spécifie le statut du sous-réseau.  
Type : chaîne  
Obligatoire : non

## consultez aussi
<a name="API_Subnet_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Subnet) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Subnet) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Subnet) 

# Tag
<a name="API_Tag"></a>

Métadonnées attribuées à une ressource Amazon DocumentDB composée d'une paire clé-valeur.

## Table des matières
<a name="API_Tag_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** Key **   
Le nom obligatoire de la balise. La valeur de la chaîne peut comporter de 1 à 128 caractères Unicode et ne peut pas être préfixée par « `aws:` » ou « `rds:` ». La chaîne ne peut contenir que l'ensemble des lettres Unicode, des chiffres, des espaces blancs, « \$1 », « » . ','/',' = ',' \$1 ',' - '(expression régulière Java : « ^ ([\$1 \$1 p \$1L\$1 \$1 \$1 p \$1Z\$1 \$1 \$1 p \$1N\$1 \$1. : /=\$1 \$1 \$1 -] \$1) \$1 »).  
Type : chaîne  
Obligatoire : non

 ** Value **   
La valeur facultative de la balise. La valeur de la chaîne peut comporter de 1 à 256 caractères Unicode et ne peut pas être préfixée par « `aws:` » ou « `rds:` ». La chaîne ne peut contenir que l'ensemble des lettres Unicode, des chiffres, des espaces blancs, « \$1 », « » . ','/',' = ',' \$1 ',' - '(expression régulière Java : « ^ ([\$1 \$1 p \$1L\$1 \$1 \$1 p \$1Z\$1 \$1 \$1 p \$1N\$1 \$1. : /=\$1 \$1 \$1 -] \$1) \$1 »).  
Type : chaîne  
Obligatoire : non

## consultez aussi
<a name="API_Tag_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/Tag) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/Tag) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/Tag) 

# UpgradeTarget
<a name="API_UpgradeTarget"></a>

Version du moteur de base de données vers laquelle une instance peut être mise à niveau.

## Table des matières
<a name="API_UpgradeTarget_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** AutoUpgrade **   
Une valeur qui indique si la version cible est appliquée à toutes les instances de base de données source `AutoMinorVersionUpgrade` définies sur`true`.  
Type : booléen  
Obligatoire : non

 ** Description **   
Version du moteur de base de données vers laquelle une instance peut être mise à niveau.  
Type : chaîne  
Obligatoire : non

 ** Engine **   
Nom du moteur de base de données cible mis à niveau.  
Type : chaîne  
Obligatoire : non

 ** EngineVersion **   
Numéro de version du moteur de base de données cible mis à niveau.  
Type : chaîne  
Obligatoire : non

 ** IsMajorVersionUpgrade **   
Valeur qui indique si un moteur de base de données est mis à niveau vers une version majeure.  
Type : booléen  
Obligatoire : non

## consultez aussi
<a name="API_UpgradeTarget_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/UpgradeTarget) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/UpgradeTarget) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/UpgradeTarget) 

# VpcSecurityGroupMembership
<a name="API_VpcSecurityGroupMembership"></a>

Utilisé comme élément de réponse pour les requêtes concernant l'appartenance à un groupe de sécurité du cloud privé virtuel (VPC).

## Table des matières
<a name="API_VpcSecurityGroupMembership_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** Status **   
Statut du groupe de sécurité VPC.  
Type : chaîne  
Obligatoire : non

 ** VpcSecurityGroupId **   
Nom du groupe de sécurité VPC.  
Type : chaîne  
Obligatoire : non

## consultez aussi
<a name="API_VpcSecurityGroupMembership_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/VpcSecurityGroupMembership) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/VpcSecurityGroupMembership) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/VpcSecurityGroupMembership) 

# Clusters Amazon DocumentDB Elastic
<a name="API_Types_Amazon_DocumentDB_Elastic_Clusters"></a>

Les types de données suivants sont pris en charge par Amazon DocumentDB Elastic Clusters :
+  [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
<a name="API_elastic_Cluster"></a>

Renvoie des informations sur un cluster élastique spécifique.

## Table des matières
<a name="API_elastic_Cluster_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** adminUserName **   <a name="documentdb-Type-elastic_Cluster-adminUserName"></a>
Nom de l'administrateur du cluster Elastic.  
Type : String  
Obligatoire : oui

 ** authType **   <a name="documentdb-Type-elastic_Cluster-authType"></a>
Type d'authentification pour le cluster élastique.  
Type : String  
Valeurs valides : `PLAIN_TEXT | SECRET_ARN`   
Obligatoire : oui

 ** clusterArn **   <a name="documentdb-Type-elastic_Cluster-clusterArn"></a>
L'identifiant ARN du cluster élastique.  
Type : String  
Obligatoire : oui

 ** clusterEndpoint **   <a name="documentdb-Type-elastic_Cluster-clusterEndpoint"></a>
URL utilisée pour se connecter au cluster élastique.  
Type : String  
Obligatoire : oui

 ** clusterName **   <a name="documentdb-Type-elastic_Cluster-clusterName"></a>
Nom du cluster élastique.  
Type : String  
Obligatoire : oui

 ** createTime **   <a name="documentdb-Type-elastic_Cluster-createTime"></a>
Heure à laquelle le cluster élastique a été créé en temps universel coordonné (UTC).  
Type : String  
Obligatoire : oui

 ** kmsKeyId **   <a name="documentdb-Type-elastic_Cluster-kmsKeyId"></a>
Identifiant de clé KMS à utiliser pour chiffrer le cluster élastique.  
Type : String  
Obligatoire : oui

 ** preferredMaintenanceWindow **   <a name="documentdb-Type-elastic_Cluster-preferredMaintenanceWindow"></a>
Intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.  
 *Format* : `ddd:hh24:mi-ddd:hh24:mi`   
Type : String  
Obligatoire : oui

 ** shardCapacity **   <a name="documentdb-Type-elastic_Cluster-shardCapacity"></a>
Le nombre de v CPUs attribué à chaque partition de cluster élastique. Le maximum est de 64. Les valeurs autorisées sont 2, 4, 8, 16, 32, 64.  
Type : entier  
Obligatoire : oui

 ** shardCount **   <a name="documentdb-Type-elastic_Cluster-shardCount"></a>
Le nombre de partitions attribuées au cluster élastique. Le maximum est de 32.  
Type : entier  
Obligatoire : oui

 ** status **   <a name="documentdb-Type-elastic_Cluster-status"></a>
État du cluster élastique.  
Type : String  
Valeurs valides : `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`   
Obligatoire : oui

 ** subnetIds **   <a name="documentdb-Type-elastic_Cluster-subnetIds"></a>
Le EC2 sous-réseau Amazon IDs pour le cluster élastique.  
Type : tableau de chaînes  
Obligatoire : oui

 ** vpcSecurityGroupIds **   <a name="documentdb-Type-elastic_Cluster-vpcSecurityGroupIds"></a>
Liste des groupes de sécurité EC2 VPC associés à ce cluster élastique.  
Type : tableau de chaînes  
Obligatoire : oui

 ** backupRetentionPeriod **   <a name="documentdb-Type-elastic_Cluster-backupRetentionPeriod"></a>
Nombre de jours pendant lesquels les instantanés automatiques sont conservés.  
Type : entier  
Obligatoire : non

 ** preferredBackupWindow **   <a name="documentdb-Type-elastic_Cluster-preferredBackupWindow"></a>
Plage de temps quotidienne pendant laquelle les sauvegardes automatisées sont créées si les sauvegardes automatisées sont activées, comme déterminé par`backupRetentionPeriod`.  
Type : chaîne  
Obligatoire : non

 ** shardInstanceCount **   <a name="documentdb-Type-elastic_Cluster-shardInstanceCount"></a>
Le nombre d'instances de répliques s'appliquant à toutes les partitions du cluster. Une `shardInstanceCount` valeur de 1 signifie qu'il existe une instance d'écriture et que toutes les instances supplémentaires sont des répliques qui peuvent être utilisées pour les lectures et pour améliorer la disponibilité.  
Type : entier  
Obligatoire : non

 ** shards **   <a name="documentdb-Type-elastic_Cluster-shards"></a>
Nombre total de partitions dans le cluster.  
Type : tableau d’objets [Shard](API_elastic_Shard.md)  
Obligatoire : non

## consultez aussi
<a name="API_elastic_Cluster_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Cluster) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Cluster) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Cluster) 

# ClusterInList
<a name="API_elastic_ClusterInList"></a>

Liste des clusters élastiques Amazon DocumentDB.

## Table des matières
<a name="API_elastic_ClusterInList_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** clusterArn **   <a name="documentdb-Type-elastic_ClusterInList-clusterArn"></a>
L'identifiant ARN du cluster élastique.  
Type : String  
Obligatoire : oui

 ** clusterName **   <a name="documentdb-Type-elastic_ClusterInList-clusterName"></a>
Nom de l'agrégat élastique.  
Type : String  
Obligatoire : oui

 ** status **   <a name="documentdb-Type-elastic_ClusterInList-status"></a>
État du cluster élastique.  
Type : String  
Valeurs valides : `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`   
Obligatoire : oui

## consultez aussi
<a name="API_elastic_ClusterInList_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterInList) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterInList) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterInList) 

# ClusterSnapshot
<a name="API_elastic_ClusterSnapshot"></a>

Renvoie des informations sur un instantané de cluster élastique spécifique.

## Table des matières
<a name="API_elastic_ClusterSnapshot_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** adminUserName **   <a name="documentdb-Type-elastic_ClusterSnapshot-adminUserName"></a>
Nom de l'administrateur du cluster Elastic.  
Type : String  
Obligatoire : oui

 ** clusterArn **   <a name="documentdb-Type-elastic_ClusterSnapshot-clusterArn"></a>
L'identifiant ARN du cluster élastique.  
Type : String  
Obligatoire : oui

 ** clusterCreationTime **   <a name="documentdb-Type-elastic_ClusterSnapshot-clusterCreationTime"></a>
Heure à laquelle le cluster élastique a été créé en temps universel coordonné (UTC).  
Type : String  
Obligatoire : oui

 ** kmsKeyId **   <a name="documentdb-Type-elastic_ClusterSnapshot-kmsKeyId"></a>
L'identifiant de clé KMS est l'Amazon Resource Name (ARN) de la clé de chiffrement KMS. Si vous créez un cluster à l'aide du même compte Amazon qui possède cette clé de chiffrement KMS, vous pouvez utiliser l'alias de clé KMS au lieu de l'ARN comme clé de chiffrement KMS. Si aucune clé de chiffrement n'est spécifiée ici, Amazon DocumentDB utilise la clé de chiffrement par défaut créée par KMS pour votre compte. Votre compte possède une clé de chiffrement par défaut différente pour chaque région Amazon.   
Type : String  
Obligatoire : oui

 ** snapshotArn **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotArn"></a>
Identifiant ARN de l'instantané du cluster élastique.  
Type : String  
Obligatoire : oui

 ** snapshotCreationTime **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotCreationTime"></a>
Heure à laquelle l'instantané du cluster élastique a été créé en temps universel coordonné (UTC).  
Type : String  
Obligatoire : oui

 ** snapshotName **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotName"></a>
Nom de l'instantané du cluster élastique.  
Type : String  
Obligatoire : oui

 ** status **   <a name="documentdb-Type-elastic_ClusterSnapshot-status"></a>
État de l'instantané du cluster élastique.  
Type : String  
Valeurs valides : `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`   
Obligatoire : oui

 ** subnetIds **   <a name="documentdb-Type-elastic_ClusterSnapshot-subnetIds"></a>
Le EC2 sous-réseau Amazon IDs pour le cluster élastique.  
Type : tableau de chaînes  
Obligatoire : oui

 ** vpcSecurityGroupIds **   <a name="documentdb-Type-elastic_ClusterSnapshot-vpcSecurityGroupIds"></a>
Liste des groupes de sécurité EC2 VPC à associer au cluster élastique.  
Type : tableau de chaînes  
Obligatoire : oui

 ** snapshotType **   <a name="documentdb-Type-elastic_ClusterSnapshot-snapshotType"></a>
Type de snapshots de cluster à renvoyer. Vous pouvez spécifier l’une des valeurs suivantes :  
+  `automated`- Renvoie tous les instantanés de cluster qu'Amazon DocumentDB a automatiquement créés pour AWS votre compte.
+  `manual`- Renvoie tous les instantanés de cluster que vous avez créés manuellement pour votre AWS compte.
Type : String  
Valeurs valides : `MANUAL | AUTOMATED`   
Obligatoire : non

## consultez aussi
<a name="API_elastic_ClusterSnapshot_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshot) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshot) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterSnapshot) 

# ClusterSnapshotInList
<a name="API_elastic_ClusterSnapshotInList"></a>

Liste des instantanés d'Elastic Cluster.

## Table des matières
<a name="API_elastic_ClusterSnapshotInList_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** clusterArn **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-clusterArn"></a>
L'identifiant ARN du cluster élastique.  
Type : String  
Obligatoire : oui

 ** snapshotArn **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-snapshotArn"></a>
Identifiant ARN de l'instantané du cluster élastique.  
Type : String  
Obligatoire : oui

 ** snapshotCreationTime **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-snapshotCreationTime"></a>
Heure à laquelle l'instantané du cluster élastique a été créé en temps universel coordonné (UTC).  
Type : String  
Obligatoire : oui

 ** snapshotName **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-snapshotName"></a>
Nom de l'instantané du cluster élastique.  
Type : String  
Obligatoire : oui

 ** status **   <a name="documentdb-Type-elastic_ClusterSnapshotInList-status"></a>
État de l'instantané du cluster élastique.  
Type : String  
Valeurs valides : `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`   
Obligatoire : oui

## consultez aussi
<a name="API_elastic_ClusterSnapshotInList_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ClusterSnapshotInList) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ClusterSnapshotInList) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ClusterSnapshotInList) 

# PendingMaintenanceActionDetails
<a name="API_elastic_PendingMaintenanceActionDetails"></a>

Récupère les détails des actions de maintenance en attente.

## Table des matières
<a name="API_elastic_PendingMaintenanceActionDetails_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** action **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-action"></a>
Affiche l'action spécifique d'une action de maintenance en attente.  
Type : String  
Obligatoire : oui

 ** autoAppliedAfterDate **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-autoAppliedAfterDate"></a>
Affiche la date de la fenêtre de maintenance au cours de laquelle l'action est appliquée. L'action de maintenance est appliquée à la ressource lors de sa première fenêtre de maintenance après cette date. Si cette date est spécifiée, toutes les `NEXT_MAINTENANCE` `optInType` demandes sont ignorées.  
Type : chaîne  
Obligatoire : non

 ** currentApplyDate **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-currentApplyDate"></a>
Affiche la date effective à laquelle l'action de maintenance en attente est appliquée à la ressource.  
Type : chaîne  
Obligatoire : non

 ** description **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-description"></a>
Affiche une description fournissant plus de détails sur l'action de maintenance.  
Type : chaîne  
Obligatoire : non

 ** forcedApplyDate **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-forcedApplyDate"></a>
Affiche la date à laquelle l'action de maintenance est automatiquement appliquée. L'action de maintenance est appliquée à la ressource à cette date indépendamment de la fenêtre de maintenance de la ressource. Si cette date est spécifiée, toutes les `IMMEDIATE` `optInType` demandes sont ignorées.  
Type : chaîne  
Obligatoire : non

 ** optInStatus **   <a name="documentdb-Type-elastic_PendingMaintenanceActionDetails-optInStatus"></a>
Affiche le type de `optInType` demande reçue pour la ressource.  
Type : chaîne  
Obligatoire : non

## consultez aussi
<a name="API_elastic_PendingMaintenanceActionDetails_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/PendingMaintenanceActionDetails) 

# ResourcePendingMaintenanceAction
<a name="API_elastic_ResourcePendingMaintenanceAction"></a>

Fournit des informations sur une action de maintenance en attente pour une ressource.

## Table des matières
<a name="API_elastic_ResourcePendingMaintenanceAction_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** pendingMaintenanceActionDetails **   <a name="documentdb-Type-elastic_ResourcePendingMaintenanceAction-pendingMaintenanceActionDetails"></a>
Fournit des informations sur une action de maintenance en attente pour une ressource.  
Type : tableau d’objets [PendingMaintenanceActionDetails](API_elastic_PendingMaintenanceActionDetails.md)  
Obligatoire : non

 ** resourceArn **   <a name="documentdb-Type-elastic_ResourcePendingMaintenanceAction-resourceArn"></a>
Nom de ressource Amazon DocumentDB (ARN) Amazon DocumentDB de la ressource à laquelle s'applique l'action de maintenance en attente.  
Type : chaîne  
Obligatoire : non

## consultez aussi
<a name="API_elastic_ResourcePendingMaintenanceAction_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ResourcePendingMaintenanceAction) 

# Shard
<a name="API_elastic_Shard"></a>

Le nom du shard.

## Table des matières
<a name="API_elastic_Shard_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** createTime **   <a name="documentdb-Type-elastic_Shard-createTime"></a>
Heure à laquelle la partition a été créée en temps universel coordonné (UTC).  
Type : String  
Obligatoire : oui

 ** shardId **   <a name="documentdb-Type-elastic_Shard-shardId"></a>
L'ID du shard.  
Type : String  
Obligatoire : oui

 ** status **   <a name="documentdb-Type-elastic_Shard-status"></a>
État actuel de la partition.  
Type : String  
Valeurs valides : `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`   
Obligatoire : oui

## consultez aussi
<a name="API_elastic_Shard_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/Shard) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/Shard) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/Shard) 

# ValidationExceptionField
<a name="API_elastic_ValidationExceptionField"></a>

Champ spécifique dans lequel une exception de validation donnée s'est produite.

## Table des matières
<a name="API_elastic_ValidationExceptionField_Contents"></a>

**Note**  
Dans la liste suivante, les paramètres requis sont décrits en premier.

 ** message **   <a name="documentdb-Type-elastic_ValidationExceptionField-message"></a>
Message d'erreur décrivant l'exception de validation dans ce champ.  
Type : String  
Obligatoire : oui

 ** name **   <a name="documentdb-Type-elastic_ValidationExceptionField-name"></a>
Nom du champ dans lequel l'exception de validation s'est produite.  
Type : String  
Obligatoire : oui

## consultez aussi
<a name="API_elastic_ValidationExceptionField_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ValidationExceptionField) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ValidationExceptionField) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ValidationExceptionField)