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.
# Référence d'API de gestion des clusters, des instances et des ressources Amazon DocumentDB
Cette section décrit les opérations de gestion des clusters, des instances et des ressources pour Amazon DocumentDB (avec compatibilité MongoDB) accessibles via HTTP, le AWS Command Line Interface (AWS CLI) ou le SDK. AWS Vous pouvez les utiliser APIs pour créer, supprimer et modifier des clusters et des instances.
**Important**
Ils APIs sont utilisés uniquement pour gérer les clusters, les instances et les ressources associées. Pour plus d'informations sur la connexion à un cluster Amazon DocumentDB en cours d'exécution, consultez. [Guide de démarrage](get-started-guide.md)
**Topics**
+ [Actions](API_Operations.md)
+ [Types de données](API_Types.md)
+ [Erreurs courantes](CommonErrors.md)
+ [Paramètres communs](CommonParameters.md)
# Actions
Les actions suivantes sont prises en charge par Amazon DocumentDB (with MongoDB compatibility) :
+ [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md)
+ [AddTagsToResource](API_AddTagsToResource.md)
+ [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md)
+ [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md)
+ [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md)
+ [CreateDBCluster](API_CreateDBCluster.md)
+ [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md)
+ [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md)
+ [CreateDBInstance](API_CreateDBInstance.md)
+ [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md)
+ [CreateEventSubscription](API_CreateEventSubscription.md)
+ [CreateGlobalCluster](API_CreateGlobalCluster.md)
+ [DeleteDBCluster](API_DeleteDBCluster.md)
+ [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md)
+ [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md)
+ [DeleteDBInstance](API_DeleteDBInstance.md)
+ [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md)
+ [DeleteEventSubscription](API_DeleteEventSubscription.md)
+ [DeleteGlobalCluster](API_DeleteGlobalCluster.md)
+ [DescribeCertificates](API_DescribeCertificates.md)
+ [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md)
+ [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md)
+ [DescribeDBClusters](API_DescribeDBClusters.md)
+ [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md)
+ [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md)
+ [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md)
+ [DescribeDBInstances](API_DescribeDBInstances.md)
+ [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md)
+ [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md)
+ [DescribeEventCategories](API_DescribeEventCategories.md)
+ [DescribeEvents](API_DescribeEvents.md)
+ [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md)
+ [DescribeGlobalClusters](API_DescribeGlobalClusters.md)
+ [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md)
+ [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md)
+ [FailoverDBCluster](API_FailoverDBCluster.md)
+ [FailoverGlobalCluster](API_FailoverGlobalCluster.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [ModifyDBCluster](API_ModifyDBCluster.md)
+ [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md)
+ [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md)
+ [ModifyDBInstance](API_ModifyDBInstance.md)
+ [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md)
+ [ModifyEventSubscription](API_ModifyEventSubscription.md)
+ [ModifyGlobalCluster](API_ModifyGlobalCluster.md)
+ [RebootDBInstance](API_RebootDBInstance.md)
+ [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md)
+ [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md)
+ [RemoveTagsFromResource](API_RemoveTagsFromResource.md)
+ [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md)
+ [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md)
+ [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md)
+ [StartDBCluster](API_StartDBCluster.md)
+ [StopDBCluster](API_StopDBCluster.md)
+ [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md)
Les actions suivantes sont prises en charge par Amazon DocumentDB Elastic Clusters :
+ [ApplyPendingMaintenanceAction](API_elastic_ApplyPendingMaintenanceAction.md)
+ [CopyClusterSnapshot](API_elastic_CopyClusterSnapshot.md)
+ [CreateCluster](API_elastic_CreateCluster.md)
+ [CreateClusterSnapshot](API_elastic_CreateClusterSnapshot.md)
+ [DeleteCluster](API_elastic_DeleteCluster.md)
+ [DeleteClusterSnapshot](API_elastic_DeleteClusterSnapshot.md)
+ [GetCluster](API_elastic_GetCluster.md)
+ [GetClusterSnapshot](API_elastic_GetClusterSnapshot.md)
+ [GetPendingMaintenanceAction](API_elastic_GetPendingMaintenanceAction.md)
+ [ListClusters](API_elastic_ListClusters.md)
+ [ListClusterSnapshots](API_elastic_ListClusterSnapshots.md)
+ [ListPendingMaintenanceActions](API_elastic_ListPendingMaintenanceActions.md)
+ [ListTagsForResource](API_elastic_ListTagsForResource.md)
+ [RestoreClusterFromSnapshot](API_elastic_RestoreClusterFromSnapshot.md)
+ [StartCluster](API_elastic_StartCluster.md)
+ [StopCluster](API_elastic_StopCluster.md)
+ [TagResource](API_elastic_TagResource.md)
+ [UntagResource](API_elastic_UntagResource.md)
+ [UpdateCluster](API_elastic_UpdateCluster.md)
# Amazon DocumentDB (with MongoDB compatibility)
Les actions suivantes sont prises en charge par Amazon DocumentDB (with MongoDB compatibility) :
+ [AddSourceIdentifierToSubscription](API_AddSourceIdentifierToSubscription.md)
+ [AddTagsToResource](API_AddTagsToResource.md)
+ [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md)
+ [CopyDBClusterParameterGroup](API_CopyDBClusterParameterGroup.md)
+ [CopyDBClusterSnapshot](API_CopyDBClusterSnapshot.md)
+ [CreateDBCluster](API_CreateDBCluster.md)
+ [CreateDBClusterParameterGroup](API_CreateDBClusterParameterGroup.md)
+ [CreateDBClusterSnapshot](API_CreateDBClusterSnapshot.md)
+ [CreateDBInstance](API_CreateDBInstance.md)
+ [CreateDBSubnetGroup](API_CreateDBSubnetGroup.md)
+ [CreateEventSubscription](API_CreateEventSubscription.md)
+ [CreateGlobalCluster](API_CreateGlobalCluster.md)
+ [DeleteDBCluster](API_DeleteDBCluster.md)
+ [DeleteDBClusterParameterGroup](API_DeleteDBClusterParameterGroup.md)
+ [DeleteDBClusterSnapshot](API_DeleteDBClusterSnapshot.md)
+ [DeleteDBInstance](API_DeleteDBInstance.md)
+ [DeleteDBSubnetGroup](API_DeleteDBSubnetGroup.md)
+ [DeleteEventSubscription](API_DeleteEventSubscription.md)
+ [DeleteGlobalCluster](API_DeleteGlobalCluster.md)
+ [DescribeCertificates](API_DescribeCertificates.md)
+ [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md)
+ [DescribeDBClusterParameters](API_DescribeDBClusterParameters.md)
+ [DescribeDBClusters](API_DescribeDBClusters.md)
+ [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md)
+ [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md)
+ [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md)
+ [DescribeDBInstances](API_DescribeDBInstances.md)
+ [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md)
+ [DescribeEngineDefaultClusterParameters](API_DescribeEngineDefaultClusterParameters.md)
+ [DescribeEventCategories](API_DescribeEventCategories.md)
+ [DescribeEvents](API_DescribeEvents.md)
+ [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md)
+ [DescribeGlobalClusters](API_DescribeGlobalClusters.md)
+ [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md)
+ [DescribePendingMaintenanceActions](API_DescribePendingMaintenanceActions.md)
+ [FailoverDBCluster](API_FailoverDBCluster.md)
+ [FailoverGlobalCluster](API_FailoverGlobalCluster.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [ModifyDBCluster](API_ModifyDBCluster.md)
+ [ModifyDBClusterParameterGroup](API_ModifyDBClusterParameterGroup.md)
+ [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md)
+ [ModifyDBInstance](API_ModifyDBInstance.md)
+ [ModifyDBSubnetGroup](API_ModifyDBSubnetGroup.md)
+ [ModifyEventSubscription](API_ModifyEventSubscription.md)
+ [ModifyGlobalCluster](API_ModifyGlobalCluster.md)
+ [RebootDBInstance](API_RebootDBInstance.md)
+ [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md)
+ [RemoveSourceIdentifierFromSubscription](API_RemoveSourceIdentifierFromSubscription.md)
+ [RemoveTagsFromResource](API_RemoveTagsFromResource.md)
+ [ResetDBClusterParameterGroup](API_ResetDBClusterParameterGroup.md)
+ [RestoreDBClusterFromSnapshot](API_RestoreDBClusterFromSnapshot.md)
+ [RestoreDBClusterToPointInTime](API_RestoreDBClusterToPointInTime.md)
+ [StartDBCluster](API_StartDBCluster.md)
+ [StopDBCluster](API_StopDBCluster.md)
+ [SwitchoverGlobalCluster](API_SwitchoverGlobalCluster.md)
# AddSourceIdentifierToSubscription
Ajoute un identifiant source à un abonnement à la notification d'événements existant.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** SourceIdentifier **
Identifiant de la source d'événement à ajouter :
+ Si le type de source est une instance, un `DBInstanceIdentifier` doit être fourni.
+ Si le type de source est un groupe de sécurité, un `DBSecurityGroupName` doit être fourni.
+ Si le type de source est un groupe de paramètres, un `DBParameterGroupName` doit être fourni.
+ Si le type de source est un instantané, un `DBSnapshotIdentifier` doit être fourni.
Type : Chaîne
Obligatoire : oui
** SubscriptionName **
Nom de l'abonnement aux notifications d'événements Amazon DocumentDB auquel vous souhaitez ajouter un identifiant de source.
Type : Chaîne
Obligatoire : oui
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** EventSubscription **
Informations détaillées sur un événement auquel vous vous êtes inscrit.
Type : objet [EventSubscription](API_EventSubscription.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** SourceNotFound **
La source demandée est introuvable.
Code d’état HTTP :404
** SubscriptionNotFound **
Le nom de l'abonnement n'existe pas.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/AddSourceIdentifierToSubscription)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/AddSourceIdentifierToSubscription)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AddSourceIdentifierToSubscription)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/AddSourceIdentifierToSubscription)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AddSourceIdentifierToSubscription)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/AddSourceIdentifierToSubscription)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/AddSourceIdentifierToSubscription)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/AddSourceIdentifierToSubscription)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/AddSourceIdentifierToSubscription)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AddSourceIdentifierToSubscription)
# AddTagsToResource
Ajoute des balises de métadonnées à une ressource Amazon DocumentDB. Vous pouvez utiliser ces balises avec les rapports de répartition des coûts pour suivre les coûts associés aux ressources Amazon DocumentDB ou dans une `Condition` déclaration d'une politique Gestion des identités et des accès AWS (IAM) pour Amazon DocumentDB.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** ResourceName **
La ressource Amazon DocumentDB à laquelle les balises sont ajoutées. Cette valeur est un nom de ressource Amazon.
Type : Chaîne
Obligatoire : oui
**Étiquettes.Tag.N**
Les balises à attribuer à la ressource Amazon DocumentDB.
Type : tableau d’objets [Tag](API_Tag.md)
Obligatoire : oui
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`ne fait pas référence à un cluster existant.
Code d’état HTTP :404
** DBInstanceNotFound **
`DBInstanceIdentifier`ne fait pas référence à une instance existante.
Code d’état HTTP :404
** DBSnapshotNotFound **
`DBSnapshotIdentifier`ne fait pas référence à un instantané existant.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/AddTagsToResource)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/AddTagsToResource)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/AddTagsToResource)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/AddTagsToResource)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/AddTagsToResource)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/AddTagsToResource)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/AddTagsToResource)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/AddTagsToResource)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/AddTagsToResource)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/AddTagsToResource)
# ApplyPendingMaintenanceAction
Applique une action de maintenance en attente à une ressource (par exemple, à une instance Amazon DocumentDB).
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** ApplyAction **
Action de maintenance en attente à appliquer à cette ressource.
Valeurs valides : `system-update`, `db-upgrade`
Type : Chaîne
Obligatoire : oui
** OptInType **
Valeur qui spécifie le type de demande d'opt-in ou qui annule une demande d'opt-in. Un type demande de confirmation de l'acceptation de type `immediate` ne peut pas être annulée.
Valeurs valides :
+ `immediate` - Appliquer immédiatement l'action de maintenance.
+ `next-maintenance` - Appliquer l'action de maintenance pendant le créneau de maintenance suivant pour la ressource.
+ `undo-opt-in` - Annuler toute demande de confirmation de l'acceptation `next-maintenance` existante.
Type : Chaîne
Obligatoire : oui
** ResourceIdentifier **
ARN (Amazon Resource Name) de la ressource à laquelle s'applique l'action de maintenance en attente.
Type : Chaîne
Obligatoire : oui
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** ResourcePendingMaintenanceActions **
Représente la sortie de[ApplyPendingMaintenanceAction](#API_ApplyPendingMaintenanceAction).
Type : objet [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** InvalidDBClusterStateFault **
Le cluster n'est pas dans un état valide.
Code d’état HTTP : 400
** InvalidDBInstanceState **
L'instance spécifiée n'est pas dans l'état *disponible*.
Code d’état HTTP : 400
** ResourceNotFoundFault **
L'ID de ressource spécifiée est introuvable.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ApplyPendingMaintenanceAction)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ApplyPendingMaintenanceAction)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ApplyPendingMaintenanceAction)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ApplyPendingMaintenanceAction)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ApplyPendingMaintenanceAction)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ApplyPendingMaintenanceAction)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ApplyPendingMaintenanceAction)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ApplyPendingMaintenanceAction)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ApplyPendingMaintenanceAction)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ApplyPendingMaintenanceAction)
# CopyDBClusterParameterGroup
Copie le groupe de paramètres de cluster spécifié.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** SourceDBClusterParameterGroupIdentifier **
Identifiant ou Amazon Resource Name (ARN) du groupe de paramètres du cluster source.
Contraintes:
+ Vous devez spécifier un groupe de paramètres de cluster valide.
+ Si le groupe de paramètres du cluster source est Région AWS identique à celui de la copie, spécifiez un identifiant de groupe de paramètres valide, par exemple`my-db-cluster-param-group`, ou un ARN valide.
+ Si le groupe de paramètres source est différent de Région AWS celui de la copie, spécifiez un ARN de groupe de paramètres de cluster valide ; par exemple,`arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group`.
Type : Chaîne
Obligatoire : oui
** TargetDBClusterParameterGroupDescription **
Description du groupe de paramètres de cluster copié.
Type : Chaîne
Obligatoire : oui
** TargetDBClusterParameterGroupIdentifier **
Identifiant du groupe de paramètres de cluster copié.
Contraintes:
+ Ne peut pas être null ou vide.
+ Doit contenir entre 1 et 255 lettres, chiffres ou traits d'union.
+ Le premier caractère doit être une lettre.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
Exemple : `my-cluster-param-group1`
Type : Chaîne
Obligatoire : oui
**Étiquettes.Tag.N**
Les balises qui doivent être attribuées au groupe de paramètres.
Type : tableau d’objets [Tag](API_Tag.md)
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBClusterParameterGroup **
Informations détaillées sur un groupe de paramètres de cluster.
Type : objet [DBClusterParameterGroup](API_DBClusterParameterGroup.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBParameterGroupAlreadyExists **
Un groupe de paramètres portant le même nom existe déjà.
Code d’état HTTP : 400
** DBParameterGroupNotFound **
`DBParameterGroupName`ne fait pas référence à un groupe de paramètres existant.
Code d’état HTTP :404
** DBParameterGroupQuotaExceeded **
Cette demande vous obligerait à dépasser le nombre autorisé de groupes de paramètres.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CopyDBClusterParameterGroup)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CopyDBClusterParameterGroup)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CopyDBClusterParameterGroup)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CopyDBClusterParameterGroup)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CopyDBClusterParameterGroup)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CopyDBClusterParameterGroup)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CopyDBClusterParameterGroup)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CopyDBClusterParameterGroup)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CopyDBClusterParameterGroup)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CopyDBClusterParameterGroup)
# CopyDBClusterSnapshot
Copie un instantané d'un cluster.
Pour copier un instantané de cluster à partir d'un instantané de cluster manuel partagé, `SourceDBClusterSnapshotIdentifier` il doit s'agir du nom de ressource Amazon (ARN) de l'instantané de cluster partagé. Vous ne pouvez copier qu’un instantané de cluster de bases de données partagé, chiffré ou non, dans la même Région AWS.
Pour annuler l'opération de copie une fois qu'elle est en cours, supprimez le cliché du cluster cible identifié `TargetDBClusterSnapshotIdentifier` alors que cet instantané de cluster est en état de *copie*.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** SourceDBClusterSnapshotIdentifier **
L'identifiant de l'instantané du cluster à copier. Ce paramètre n'est pas sensible à la casse.
Contraintes:
+ Vous devez spécifier un instantané de cluster valide dans l'état *disponible*.
+ Si le cliché du cluster source est Région AWS identique à la copie, spécifiez un identifiant de capture d'écran valide.
+ Si le snapshot du cluster source se trouve dans un autre compte Région AWS ou appartient à un autre AWS compte, spécifiez l'ARN du snapshot.
Exemple : `my-cluster-snapshot1`
Type : Chaîne
Obligatoire : oui
** TargetDBClusterSnapshotIdentifier **
L'identifiant du nouvel instantané du cluster à créer à partir de l'instantané du cluster source. Ce paramètre n'est pas sensible à la casse.
Contraintes:
+ Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union.
+ Le premier caractère doit être une lettre.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
Exemple : `my-cluster-snapshot2`
Type : Chaîne
Obligatoire : oui
** CopyTags **
Définissez sur `true` pour copier toutes les balises de l'instantané du cluster source vers le cliché du cluster cible, et sinon`false`. La valeur par défaut est `false`.
Type : booléen
Obligatoire : non
** KmsKeyId **
ID de AWS KMS clé pour un instantané de cluster chiffré. 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.
Si vous copiez un instantané de cluster chiffré depuis votre Compte AWS, vous pouvez spécifier une valeur `KmsKeyId` pour chiffrer la copie avec une nouvelle clé de AWS KMS chiffrement. Si vous ne spécifiez aucune valeur pour`KmsKeyId`, la copie du cliché de cluster est chiffrée avec la même AWS KMS clé que l'instantané de cluster source.
Si vous copiez un instantané de cluster chiffré partagé depuis un autre Compte AWS, vous devez spécifier une valeur pour`KmsKeyId`.
Pour copier un instantané de cluster chiffré vers un autre Région AWS, définissez `KmsKeyId` l'ID de AWS KMS clé que vous souhaitez utiliser pour chiffrer la copie de l'instantané de cluster dans la région de destination. AWS KMS les clés de chiffrement sont spécifiques à l' Région AWS endroit dans lequel elles ont été créées, et vous ne pouvez pas utiliser les clés de chiffrement les unes Région AWS des autres Région AWS.
Si vous copiez un instantané de cluster non chiffré et que vous spécifiez une valeur pour le `KmsKeyId` paramètre, une erreur est renvoyée.
Type : chaîne
Obligatoire : non
** PreSignedUrl **
L'URL qui contient une demande signée Signature Version 4 pour l'action d'`CopyDBClusterSnapshot`API dans Région AWS laquelle figure l'instantané du cluster source à copier. Vous devez utiliser le `PreSignedUrl` paramètre lorsque vous copiez un instantané de cluster à partir d'un autre Région AWS.
Si vous utilisez un outil AWS SDK ou le AWS CLI, vous pouvez le spécifier `SourceRegion` (ou `--source-region` pour le AWS CLI) au lieu de le spécifier `PreSignedUrl` manuellement. La spécification `SourceRegion` génère automatiquement une URL pré-signée qui est une demande valide pour l'opération pouvant être exécutée dans la source. Région AWS
L'URL présignée doit être une demande valide pour l'action d'`CopyDBClusterSnapshot`API qui peut être exécutée dans la source Région AWS contenant l'instantané du cluster à copier. La demande d'URL pré-signée doit contenir les valeurs de paramètres suivantes :
+ `SourceRegion`- L'ID de la région qui contient le cliché à copier.
+ `SourceDBClusterSnapshotIdentifier`- L'identifiant de l'instantané du cluster chiffré à copier. Cet identifiant doit être au format Amazon Resource Name (ARN) pour la Région AWS source. Par exemple, si vous copiez un instantané de cluster chiffré à partir de l' Région AWS us-east-1, cela ressemble à ce qui `SourceDBClusterSnapshotIdentifier` suit : `arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot`
+ `TargetDBClusterSnapshotIdentifier`- L'identifiant du nouvel instantané du cluster à créer. Ce paramètre n'est pas sensible à la casse.
Type : chaîne
Obligatoire : non
**Étiquettes.Tag.N**
Les balises à attribuer à l'instantané du cluster.
Type : tableau d’objets [Tag](API_Tag.md)
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBClusterSnapshot **
Informations détaillées sur un instantané de cluster.
Type : objet [DBClusterSnapshot](API_DBClusterSnapshot.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterSnapshotAlreadyExistsFault **
Vous disposez déjà d'un instantané du cluster avec l'identifiant indiqué.
Code d’état HTTP : 400
** DBClusterSnapshotNotFoundFault **
`DBClusterSnapshotIdentifier`ne fait pas référence à un instantané de cluster existant.
Code d’état HTTP :404
** InvalidDBClusterSnapshotStateFault **
La valeur fournie n'est pas un état de capture d'écran de cluster valide.
Code d’état HTTP : 400
** InvalidDBClusterStateFault **
Le cluster n'est pas dans un état valide.
Code d’état HTTP : 400
** KMSKeyNotAccessibleFault **
Une erreur s'est produite lors de l'accès à une AWS KMS clé.
Code d’état HTTP : 400
** SnapshotQuotaExceeded **
La demande vous obligerait à dépasser le nombre autorisé de clichés.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CopyDBClusterSnapshot)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CopyDBClusterSnapshot)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CopyDBClusterSnapshot)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CopyDBClusterSnapshot)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CopyDBClusterSnapshot)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CopyDBClusterSnapshot)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CopyDBClusterSnapshot)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CopyDBClusterSnapshot)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CopyDBClusterSnapshot)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CopyDBClusterSnapshot)
# CreateDBCluster
Crée un nouveau cluster Amazon DocumentDB.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterIdentifier **
L'identifiant du cluster. Ce paramètre est stocké sous la forme d'une chaîne en lettres minuscules.
Contraintes:
+ Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union.
+ Le premier caractère doit être une lettre.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
Exemple : `my-cluster`
Type : Chaîne
Obligatoire : oui
** Engine **
Nom du moteur de base de données à utiliser pour ce cluster.
Valeurs valides : `docdb`
Type : Chaîne
Obligatoire : oui
**AvailabilityZones. AvailabilityZone**N.
Liste des zones de disponibilité Amazon EC2 dans lesquelles les instances du cluster peuvent être créées.
Type : tableau de chaînes
Obligatoire : non
** BackupRetentionPeriod **
Nombre de jours de conservation des sauvegardes automatiques. Vous devez spécifier une valeur minimale de 1.
Par défaut : 1
Contraintes:
+ Doit être une valeur comprise entre 1 et 35.
Type : Integer
Obligatoire : non
** DBClusterParameterGroupName **
Nom du groupe de paramètres de cluster à associer à ce cluster.
Type : chaîne
Obligatoire : non
** DBSubnetGroupName **
Groupe de sous-réseaux à associer à ce cluster.
Contraintes : doit correspondre au nom d'un `DBSubnetGroup` existant. Impossible de conserver le nom par défaut.
Exemple : `mySubnetgroup`
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
**EnableCloudwatchLogsExports.membre.n**
Liste des types de journaux qui doivent être activés pour être exportés vers Amazon CloudWatch Logs. Vous pouvez activer les journaux d'audit ou les journaux de profileur. Pour plus d'informations, consultez [Audit des événements Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html) et [profilage des opérations Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html).
Type : tableau de chaînes
Obligatoire : non
** EngineVersion **
Numéro de version du moteur de base de données à utiliser. La version `--engine-version` utilise par défaut la dernière version majeure du moteur. Pour les charges de travail de production, nous vous recommandons de déclarer explicitement ce paramètre avec la version majeur du moteur prévue.
Type : chaîne
Obligatoire : non
** GlobalClusterIdentifier **
Identifiant de cluster du nouveau cluster global.
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
** KmsKeyId **
Identifiant de AWS KMS clé pour un cluster chiffré.
L'identifiant de AWS KMS clé est le Amazon Resource Name (ARN) de la clé de AWS KMS chiffrement. Si vous créez un cluster à l'aide du même cluster Compte AWS qui possède la clé de AWS KMS chiffrement utilisée pour chiffrer le nouveau cluster, vous pouvez utiliser l'alias de AWS KMS clé au lieu de l'ARN pour la clé de AWS KMS chiffrement.
Si aucune clé de chiffrement n'est spécifiée dans `KmsKeyId` :
+ Si le paramètre `StorageEncrypted` est `true`, Amazon DocumentDB utilise votre clé de chiffrement par défaut.
AWS KMS crée la clé de chiffrement par défaut pour votre Compte AWS. Vous disposez Compte AWS d'une clé de chiffrement par défaut différente pour chacune d'entre elles Régions AWS.
Type : chaîne
Obligatoire : non
** ManageMasterUserPassword **
Spécifie s'il faut gérer le mot de passe de l'utilisateur principal avec Amazon Web Services Secrets Manager.
Contrainte : vous ne pouvez pas gérer le mot de passe de l'utilisateur principal avec Amazon Web Services Secrets Manager s'il `MasterUserPassword` est spécifié.
Type : booléen
Obligatoire : non
** MasterUsername **
Nom de l'utilisateur principal du cluster.
Contraintes:
+ Doit comporter entre 1 et 63 lettres ou chiffres.
+ Le premier caractère doit être une lettre.
+ Ne doit pas être un mot réservé pour le moteur de base de données choisi.
Type : chaîne
Obligatoire : non
** MasterUserPassword **
Mot de passe de l'utilisateur principal de la base de données. Ce mot de passe peut contenir tout caractère ASCII imprimable à l'exception de la barre oblique (/), des guillemets doubles (") ou du symbole arobase (@).
Contraintes : doit comporter entre 8 et 100 caractères.
Type : chaîne
Obligatoire : non
** MasterUserSecretKmsKeyId **
L'identifiant de clé KMS d'Amazon Web Services permettant de chiffrer un secret généré et géré automatiquement dans Amazon Web Services Secrets Manager. Ce paramètre n'est valide que si le mot de passe de l'utilisateur principal est géré par Amazon DocumentDB dans Amazon Web Services Secrets Manager pour le cluster de base de données.
L'identifiant de clé KMS d'Amazon Web Services est l'ARN de la clé, l'identifiant de clé, l'alias ARN ou le nom d'alias de la clé KMS. Pour utiliser une clé KMS dans un autre compte Amazon Web Services, spécifiez l'ARN de la clé ou l'alias ARN.
Si vous ne le spécifiez pas`MasterUserSecretKmsKeyId`, la clé `aws/secretsmanager` KMS est utilisée pour chiffrer le secret. Si le secret se trouve dans un autre compte Amazon Web Services, vous ne pouvez pas utiliser la clé `aws/secretsmanager` KMS pour le chiffrer et vous devez utiliser une clé KMS gérée par le client.
Il existe une clé KMS par défaut pour votre compte Amazon Web Services. Votre compte Amazon Web Services possède une clé KMS par défaut différente pour chaque région Amazon Web Services.
Type : chaîne
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
** Port **
Numéro de port sur lequel les instances du cluster acceptent les connexions.
Type : Integer
Obligatoire : non
** PreferredBackupWindow **
Plage de temps quotidienne au cours de laquelle les sauvegardes automatiques sont créées si cette fonctionnalité est activée via le paramètre `BackupRetentionPeriod`.
La valeur par défaut est une fenêtre de 30 minutes sélectionnée au hasard dans un intervalle de 8 heures pour chacune d'entre elles. Région AWS
Contraintes:
+ Doit être au format `hh24:mi-hh24:mi`.
+ Doit être exprimée en heure UTC (Universal Coordinated Time).
+ Ne doit pas être en conflit avec la fenêtre de maintenance préférée.
+ Doit être de 30 minutes minimum.
Type : chaîne
Obligatoire : non
** PreferredMaintenanceWindow **
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`
La valeur par défaut est une fenêtre de 30 minutes sélectionnée au hasard dans un intervalle de 8 heures pour chacune d'elles Région AWS, survenant un jour aléatoire de la semaine.
Jours valides : Mon, Tue, Wed, Thu, Fri, Sat, Sun
Contraintes : fenêtre minimale de 30 minutes.
Type : chaîne
Obligatoire : non
** PreSignedUrl **
Cette option n'est pas prise en charge actuellement.
Type : chaîne
Obligatoire : non
** ServerlessV2ScalingConfiguration **
Contient la configuration de dimensionnement d'un cluster Amazon DocumentDB Serverless.
Type : objet [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)
Obligatoire : non
** StorageEncrypted **
Indique si le cluster est chiffré.
Type : booléen
Obligatoire : non
** StorageType **
Type de stockage à associer au cluster de base de données.
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 `
Lorsque vous créez un cluster Amazon DocumentDB avec le type de stockage défini sur`iopt1`, le type de stockage est renvoyé dans la réponse. Le type de stockage n'est pas renvoyé lorsque vous le définissez sur`standard`.
Type : chaîne
Obligatoire : non
**Étiquettes.Tag.N**
Balises à attribuer au cluster.
Type : tableau d’objets [Tag](API_Tag.md)
Obligatoire : non
**VpcSecurityGroupIds. VpcSecurityGroupId**N.
Liste des groupes de sécurité VPC EC2 à associer à ce cluster.
Type : tableau de chaînes
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBCluster **
Informations détaillées sur un cluster.
Type : objet [DBCluster](API_DBCluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterAlreadyExistsFault **
Vous avez déjà un cluster avec l'identifiant indiqué.
Code d’état HTTP : 400
** DBClusterNotFoundFault **
`DBClusterIdentifier`ne fait pas référence à un cluster existant.
Code d’état HTTP :404
** DBClusterParameterGroupNotFound **
`DBClusterParameterGroupName`ne fait pas référence à un groupe de paramètres de cluster existant.
Code d’état HTTP :404
** DBClusterQuotaExceededFault **
Le cluster ne peut pas être créé car vous avez atteint le quota maximum autorisé de clusters.
Code d’état HTTP : 403
** DBInstanceNotFound **
`DBInstanceIdentifier`ne fait pas référence à une instance existante.
Code d’état HTTP :404
** DBSubnetGroupDoesNotCoverEnoughAZs **
Les sous-réseaux du groupe de sous-réseaux doivent couvrir au moins deux zones de disponibilité, sauf s'il n'existe qu'une seule zone de disponibilité.
Code d’état HTTP : 400
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName`ne fait pas référence à un groupe de sous-réseaux existant.
Code d’état HTTP :404
** GlobalClusterNotFoundFault **
`GlobalClusterIdentifier`Cela ne fait pas référence à un cluster mondial existant.
Code d’état HTTP :404
** InsufficientStorageClusterCapacity **
L'espace de stockage disponible est insuffisant pour l'action en cours. Vous pouvez peut-être résoudre cette erreur en mettant à jour votre groupe de sous-réseaux afin qu'il utilise différentes zones de disponibilité disposant d'un espace de stockage plus important.
Code d’état HTTP : 400
** InvalidDBClusterStateFault **
Le cluster n'est pas dans un état valide.
Code d’état HTTP : 400
** InvalidDBInstanceState **
L'instance spécifiée n'est pas dans l'état *disponible*.
Code d’état HTTP : 400
** InvalidDBSubnetGroupStateFault **
Le groupe de sous-réseaux ne peut pas être supprimé car il est en cours d'utilisation.
Code d’état HTTP : 400
** InvalidGlobalClusterStateFault **
L'opération demandée ne peut pas être effectuée tant que le cluster est dans cet état.
Code d’état HTTP : 400
** InvalidSubnet **
Le sous-réseau demandé n'est pas valide ou plusieurs sous-réseaux ont été demandés mais ils ne se trouvent pas tous dans un cloud privé virtuel (VPC) commun.
Code d’état HTTP : 400
** InvalidVPCNetworkStateFault **
Le groupe de sous-réseaux ne couvre pas toutes les zones de disponibilité après sa création en raison des modifications apportées.
Code d’état HTTP : 400
** KMSKeyNotAccessibleFault **
Une erreur s'est produite lors de l'accès à une AWS KMS clé.
Code d’état HTTP : 400
** NetworkTypeNotSupported **
Le type de réseau n'est pris en charge ni par `DBSubnetGroup` ni par la version du moteur de base de données.
Code d’état HTTP : 400
** StorageQuotaExceeded **
La demande vous obligerait à dépasser la quantité de stockage autorisée disponible sur toutes les instances.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBCluster)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBCluster)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBCluster)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBCluster)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBCluster)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBCluster)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBCluster)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBCluster)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBCluster)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBCluster)
# CreateDBClusterParameterGroup
Crée un nouveau groupe de paramètres de cluster.
Les paramètres d'un groupe de paramètres de cluster s'appliquent à toutes les instances d'un cluster.
Un groupe de paramètres de cluster est initialement créé avec les paramètres par défaut pour le moteur de base de données utilisé par les instances du cluster. Dans Amazon DocumentDB, vous ne pouvez pas modifier directement le groupe de paramètres du `default.docdb3.6` cluster. Si votre cluster Amazon DocumentDB utilise le groupe de paramètres de cluster par défaut et que vous souhaitez y modifier une valeur, vous devez d'abord [créer un nouveau groupe de paramètres](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-create.html) ou [copier un groupe de paramètres existant](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-copy.html), le modifier, puis appliquer le groupe de paramètres modifié à votre cluster. Pour que le nouveau groupe de paramètres de cluster et les paramètres associés prennent effet, vous devez ensuite redémarrer les instances du cluster sans basculement. Pour plus d'informations, consultez [Modifier les groupes de paramètres du cluster Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-modify.html).
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterParameterGroupName **
Nom du groupe de paramètres de cluster.
Contraintes:
+ Ne doit pas correspondre au nom d'un élément `DBClusterParameterGroup` existant.
Cette valeur est stockée sous la forme d’une chaîne en minuscules.
Type : Chaîne
Obligatoire : oui
** DBParameterGroupFamily **
Nom de la famille du groupe de paramètres de cluster.
Type : Chaîne
Obligatoire : oui
** Description **
Description du groupe de paramètres de cluster.
Type : Chaîne
Obligatoire : oui
**Étiquettes.Tag.N**
Balises à attribuer au groupe de paramètres de cluster.
Type : tableau d’objets [Tag](API_Tag.md)
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBClusterParameterGroup **
Informations détaillées sur un groupe de paramètres de cluster.
Type : objet [DBClusterParameterGroup](API_DBClusterParameterGroup.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBParameterGroupAlreadyExists **
Un groupe de paramètres portant le même nom existe déjà.
Code d’état HTTP : 400
** DBParameterGroupQuotaExceeded **
Cette demande vous obligerait à dépasser le nombre autorisé de groupes de paramètres.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBClusterParameterGroup)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBClusterParameterGroup)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBClusterParameterGroup)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBClusterParameterGroup)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBClusterParameterGroup)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBClusterParameterGroup)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBClusterParameterGroup)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBClusterParameterGroup)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBClusterParameterGroup)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBClusterParameterGroup)
# CreateDBClusterSnapshot
Crée un instantané d'un cluster.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterIdentifier **
Identifiant du cluster pour lequel créer un instantané. Ce paramètre n'est pas sensible à la casse.
Contraintes:
+ Doit correspondre à l'identifiant d'un `DBCluster` existant.
Exemple : `my-cluster`
Type : Chaîne
Obligatoire : oui
** DBClusterSnapshotIdentifier **
Identifiant du snapshot du cluster. Ce paramètre est stocké sous la forme d'une chaîne en lettres minuscules.
Contraintes:
+ Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union.
+ Le premier caractère doit être une lettre.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
Exemple : `my-cluster-snapshot1`
Type : Chaîne
Obligatoire : oui
**Étiquettes.Tag.N**
Les balises à attribuer à l'instantané du cluster.
Type : tableau d’objets [Tag](API_Tag.md)
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBClusterSnapshot **
Informations détaillées sur un instantané de cluster.
Type : objet [DBClusterSnapshot](API_DBClusterSnapshot.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`ne fait pas référence à un cluster existant.
Code d’état HTTP :404
** DBClusterSnapshotAlreadyExistsFault **
Vous disposez déjà d'un instantané du cluster avec l'identifiant indiqué.
Code d’état HTTP : 400
** InvalidDBClusterSnapshotStateFault **
La valeur fournie n'est pas un état de capture d'écran de cluster valide.
Code d’état HTTP : 400
** InvalidDBClusterStateFault **
Le cluster n'est pas dans un état valide.
Code d’état HTTP : 400
** SnapshotQuotaExceeded **
La demande vous obligerait à dépasser le nombre autorisé de clichés.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBClusterSnapshot)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBClusterSnapshot)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBClusterSnapshot)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBClusterSnapshot)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBClusterSnapshot)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBClusterSnapshot)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBClusterSnapshot)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBClusterSnapshot)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBClusterSnapshot)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBClusterSnapshot)
# CreateDBInstance
Crée une nouvelle instance.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterIdentifier **
Identifiant du cluster auquel l'instance appartiendra.
Type : Chaîne
Obligatoire : oui
** DBInstanceClass **
Capacité de calcul et de mémoire de l'instance ; par exemple, `db.r5.large`.
Type : Chaîne
Obligatoire : oui
** DBInstanceIdentifier **
Identifiant de l’instance. Ce paramètre est stocké sous la forme d'une chaîne en lettres minuscules.
Contraintes:
+ Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union.
+ Le premier caractère doit être une lettre.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
Exemple : `mydbinstance`
Type : Chaîne
Obligatoire : oui
** Engine **
Nom du moteur de base de données à utiliser pour cette instance.
Valeur valide : `docdb`
Type : Chaîne
Obligatoire : oui
** AutoMinorVersionUpgrade **
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.
Valeur par défaut : `false`
Type : booléen
Obligatoire : non
** AvailabilityZone **
Zone de disponibilité Amazon EC2 dans laquelle l'instance est créée.
Par défaut : une zone de disponibilité choisie au hasard par le système dans le terminal. Région AWS
Exemple : `us-east-1d`
Type : chaîne
Obligatoire : non
** CACertificateIdentifier **
L'identifiant de certificat CA à utiliser pour le 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.*
Type : chaîne
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
** EnablePerformanceInsights **
Une valeur qui indique s'il convient d'activer Performance Insights pour l'instance de base de données. Pour plus d'informations, voir [Utilisation d'Amazon Performance Insights](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html).
Type : booléen
Obligatoire : non
** PerformanceInsightsKMSKeyId **
Identifiant AWS KMS clé pour le chiffrement des données Performance Insights.
L'identifiant de AWS KMS clé est l'ARN de la clé, l'ID de clé, l'alias ARN ou le nom d'alias de la clé KMS.
Si vous ne spécifiez aucune valeur pour PerformanceInsights KMSKey Id, Amazon DocumentDB utilise votre clé KMS par défaut. Il existe une clé KMS par défaut pour votre compte Amazon Web Services. Votre compte Amazon Web Services possède une clé KMS par défaut différente pour chaque région Amazon Web Services.
Type : chaîne
Obligatoire : non
** PreferredMaintenanceWindow **
Intervalle de temps hebdomadaire, au format UTC (temps universel), pendant lequel a lieu la maintenance du système.
Format : `ddd:hh24:mi-ddd:hh24:mi`
La valeur par défaut est une fenêtre de 30 minutes sélectionnée au hasard dans un intervalle de 8 heures pour chacune d'elles Région AWS, survenant un jour aléatoire de la semaine.
Jours valides : Mon, Tue, Wed, Thu, Fri, Sat, Sun
Contraintes : fenêtre minimale de 30 minutes.
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.
Valeur par défaut : 1
Valeurs valides : 0 à 15
Type : Integer
Obligatoire : non
**Étiquettes.Tag.N**
Balises à attribuer à l'instance. Vous pouvez attribuer jusqu'à 10 balises à une instance.
Type : tableau d’objets [Tag](API_Tag.md)
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBInstance **
Informations détaillées sur une instance.
Type : objet [DBInstance](API_DBInstance.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** AuthorizationNotFound **
L'adresse IP CIDR ou le groupe de sécurité Amazon EC2 spécifié n'est pas autorisé pour le groupe de sécurité spécifié.
Amazon DocumentDB peut également ne pas être autorisé à effectuer les actions nécessaires en votre nom à l'aide d'IAM.
Code d’état HTTP :404
** DBClusterNotFoundFault **
`DBClusterIdentifier`ne fait pas référence à un cluster existant.
Code d’état HTTP :404
** DBInstanceAlreadyExists **
Vous avez déjà une instance avec l'identifiant indiqué.
Code d’état HTTP : 400
** DBParameterGroupNotFound **
`DBParameterGroupName`ne fait pas référence à un groupe de paramètres existant.
Code d’état HTTP :404
** DBSecurityGroupNotFound **
`DBSecurityGroupName`ne fait pas référence à un groupe de sécurité existant.
Code d’état HTTP :404
** DBSubnetGroupDoesNotCoverEnoughAZs **
Les sous-réseaux du groupe de sous-réseaux doivent couvrir au moins deux zones de disponibilité, sauf s'il n'existe qu'une seule zone de disponibilité.
Code d’état HTTP : 400
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName`ne fait pas référence à un groupe de sous-réseaux existant.
Code d’état HTTP :404
** InstanceQuotaExceeded **
La demande vous obligerait à dépasser le nombre d'instances autorisé.
Code d’état HTTP : 400
** InsufficientDBInstanceCapacity **
La classe d'instance spécifiée n'est pas disponible dans la zone de disponibilité spécifiée.
Code d’état HTTP : 400
** InvalidDBClusterStateFault **
Le cluster n'est pas dans un état valide.
Code d’état HTTP : 400
** InvalidSubnet **
Le sous-réseau demandé n'est pas valide ou plusieurs sous-réseaux ont été demandés mais ils ne se trouvent pas tous dans un cloud privé virtuel (VPC) commun.
Code d’état HTTP : 400
** InvalidVPCNetworkStateFault **
Le groupe de sous-réseaux ne couvre pas toutes les zones de disponibilité après sa création en raison des modifications apportées.
Code d’état HTTP : 400
** KMSKeyNotAccessibleFault **
Une erreur s'est produite lors de l'accès à une AWS KMS clé.
Code d’état HTTP : 400
** StorageQuotaExceeded **
La demande vous obligerait à dépasser la quantité de stockage autorisée disponible sur toutes les instances.
Code d’état HTTP : 400
** StorageTypeNotSupported **
Le stockage du paramètre spécifié ne `StorageType` peut pas être associé à l'instance de base de données.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBInstance)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBInstance)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBInstance)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBInstance)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBInstance)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBInstance)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBInstance)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBInstance)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBInstance)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBInstance)
# CreateDBSubnetGroup
Crée un nouveau groupe de sous-réseaux. Les groupes de sous-réseaux doivent contenir au moins un sous-réseau dans au moins deux zones de disponibilité du. Région AWS
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBSubnetGroupDescription **
Description du groupe de sous-réseaux.
Type : Chaîne
Obligatoire : oui
** DBSubnetGroupName **
Nom du groupe de sous-réseaux. Cette valeur est stockée sous la forme d’une chaîne en minuscules.
Contraintes : doit comporter au maximum 255 lettres, chiffres, points, traits de soulignement, espaces ou tirets. Impossible de conserver le nom par défaut.
Exemple : `mySubnetgroup`
Type : Chaîne
Obligatoire : oui
**SubnetIds. SubnetIdentifier**N.
Le sous-réseau Amazon EC2 IDs pour le groupe de sous-réseaux.
Type : tableau de chaînes
Obligatoire : oui
**Étiquettes.Tag.N**
Balises à attribuer au groupe de sous-réseaux.
Type : tableau d’objets [Tag](API_Tag.md)
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBSubnetGroup **
Informations détaillées sur un groupe de sous-réseaux.
Type : objet [DBSubnetGroup](API_DBSubnetGroup.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBSubnetGroupAlreadyExists **
`DBSubnetGroupName`est déjà utilisé par un groupe de sous-réseaux existant.
Code d’état HTTP : 400
** DBSubnetGroupDoesNotCoverEnoughAZs **
Les sous-réseaux du groupe de sous-réseaux doivent couvrir au moins deux zones de disponibilité, sauf s'il n'existe qu'une seule zone de disponibilité.
Code d’état HTTP : 400
** DBSubnetGroupQuotaExceeded **
La demande vous obligerait à dépasser le nombre autorisé de groupes de sous-réseaux.
Code d’état HTTP : 400
** DBSubnetQuotaExceededFault **
La demande vous obligerait à dépasser le nombre autorisé de sous-réseaux dans un groupe de sous-réseaux.
Code d’état HTTP : 400
** InvalidSubnet **
Le sous-réseau demandé n'est pas valide ou plusieurs sous-réseaux ont été demandés mais ils ne se trouvent pas tous dans un cloud privé virtuel (VPC) commun.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateDBSubnetGroup)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateDBSubnetGroup)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateDBSubnetGroup)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateDBSubnetGroup)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateDBSubnetGroup)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateDBSubnetGroup)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateDBSubnetGroup)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateDBSubnetGroup)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateDBSubnetGroup)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateDBSubnetGroup)
# CreateEventSubscription
Crée un abonnement aux notifications d'événements Amazon DocumentDB. Cette action nécessite un nom de ressource Amazon (ARN) de rubrique créé à l'aide de la console Amazon DocumentDB, de la console Amazon SNS ou de l'API Amazon SNS. Pour obtenir un ARN avec Amazon SNS, vous devez créer une rubrique dans Amazon SNS et vous y abonner. L'ARN est affiché dans la console Amazon SNS.
Vous pouvez spécifier le type de source (`SourceType`) dont vous souhaitez être informé. Vous pouvez également fournir une liste des sources Amazon DocumentDB (`SourceIds`) qui déclenchent les événements, ainsi qu'une liste de catégories d'événements (`EventCategories`) pour les événements dont vous souhaitez être informé. Par exemple, vous pouvez spécifier`SourceType = db-instance`, `SourceIds = mydbinstance1, mydbinstance2` et`EventCategories = Availability, Backup`.
Si vous spécifiez à la fois le `SourceType` et `SourceIds` (tel que `SourceType = db-instance` et`SourceIdentifier = myDBInstance1`), vous êtes informé de tous les `db-instance` événements relatifs à la source spécifiée. Si vous spécifiez a `SourceType` mais pas a`SourceIdentifier`, vous êtes informé des événements associés à ce type de source pour toutes vos sources Amazon DocumentDB. Si vous ne spécifiez `SourceType` ni le`SourceIdentifier`, vous êtes informé des événements générés par toutes les sources Amazon DocumentDB appartenant à votre compte client.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** SnsTopicArn **
Amazon Resource Name (ARN) de la rubrique SNS créé pour la notification d'événements. Amazon SNS crée l'ARN lorsque vous créez une rubrique et que vous vous y abonnez.
Type : Chaîne
Obligatoire : oui
** SubscriptionName **
Nom de l'abonnement.
Contraintes : Le nom doit comporter moins de 255 caractères.
Type : Chaîne
Obligatoire : oui
** Enabled **
Valeur booléenne ; définie sur `true` pour activer l'abonnement, définie pour `false` créer l'abonnement mais pas pour l'activer.
Type : booléen
Obligatoire : non
**EventCategories. EventCategory**N.
Liste des catégories d'événements `SourceType` auxquels vous souhaitez vous abonner.
Type : tableau de chaînes
Obligatoire : non
**SourceIds. SourceId**N.
Liste des identifiants des sources d'événements pour lesquels des événements sont renvoyés. Si la valeur n'est pas spécifiée, toutes les sources sont incluses dans la réponse. Un identifiant doit commencer par une lettre et contenir uniquement des lettres ASCII, des chiffres et des tirets. Il ne doit pas se terminer par un tiret ou contenir deux tirets consécutifs.
Contraintes:
+ S'`SourceIds`ils sont fournis, ils `SourceType` doivent également être fournis.
+ Si le type de source est une instance, un `DBInstanceIdentifier` doit être fourni.
+ Si le type de source est un groupe de sécurité, un `DBSecurityGroupName` doit être fourni.
+ Si le type de source est un groupe de paramètres, un `DBParameterGroupName` doit être fourni.
+ Si le type de source est un instantané, un `DBSnapshotIdentifier` doit être fourni.
Type : tableau de chaînes
Obligatoire : non
** SourceType **
Type de source qui génère les événements. Par exemple, si vous souhaitez être informé des événements générés par une instance, vous devez définir ce paramètre sur`db-instance`. Si cette valeur n'est pas spécifiée, tous les événements sont renvoyés.
Valeurs valides: `db-instance`, `db-cluster`, `db-parameter-group`, `db-security-group`, `db-cluster-snapshot`
Type : chaîne
Obligatoire : non
**Étiquettes.Tag.N**
Les tags à attribuer à l'abonnement à l'événement.
Type : tableau d’objets [Tag](API_Tag.md)
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** EventSubscription **
Informations détaillées sur un événement auquel vous vous êtes inscrit.
Type : objet [EventSubscription](API_EventSubscription.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** EventSubscriptionQuotaExceeded **
Vous avez atteint le nombre maximum d'abonnements aux événements.
Code d’état HTTP : 400
** SNSInvalidTopic **
Amazon SNS a répondu qu'il y avait un problème avec le sujet spécifié.
Code d’état HTTP : 400
** SNSNoAuthorization **
Vous n'êtes pas autorisé à publier sur la rubrique SNS Amazon Resource Name (ARN).
Code d’état HTTP : 400
** SNSTopicArnNotFound **
La rubrique SNS Amazon Resource Name (ARN) n'existe pas.
Code d’état HTTP :404
** SourceNotFound **
La source demandée n'a pas pu être trouvée.
Code d’état HTTP :404
** SubscriptionAlreadyExist **
Le nom d'abonnement fourni existe déjà.
Code d’état HTTP : 400
** SubscriptionCategoryNotFound **
La catégorie fournie n'existe pas.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateEventSubscription)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateEventSubscription)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateEventSubscription)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateEventSubscription)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateEventSubscription)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateEventSubscription)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateEventSubscription)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateEventSubscription)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateEventSubscription)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateEventSubscription)
# CreateGlobalCluster
Crée un cluster global Amazon DocumentDB qui peut s'étendre sur plusieurs. Régions AWS Le cluster global contient un cluster principal doté d'une capacité de lecture-écriture et jusqu'à 10 clusters secondaires en lecture seule. Les clusters mondiaux utilisent une réplication rapide basée sur le stockage entre les régions avec des latences inférieures à une seconde, en utilisant une infrastructure dédiée sans impact sur les performances de votre charge de travail.
Vous pouvez créer un cluster global initialement vide, puis y ajouter un cluster principal et un cluster secondaire. Vous pouvez également spécifier un cluster existant lors de l'opération de création, et ce cluster devient le principal du cluster global.
**Note**
Cette action s'applique uniquement aux clusters Amazon DocumentDB.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** GlobalClusterIdentifier **
Identifiant de cluster du nouveau cluster global.
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 : oui
** DatabaseName **
Nom de votre base de données comprenant au maximum 64 caractères alphanumériques. Si vous ne fournissez pas de nom, Amazon DocumentDB ne créera pas de base de données dans le cluster global que vous créez.
Type : chaîne
Obligatoire : non
** DeletionProtection **
Le paramètre de protection contre la suppression pour le nouveau cluster global. Le cluster global ne peut pas être supprimé lorsque la protection contre la suppression est activée.
Type : booléen
Obligatoire : non
** Engine **
Nom du moteur de base de données à utiliser pour ce cluster.
Type : chaîne
Obligatoire : non
** EngineVersion **
Version du moteur du cluster global.
Type : chaîne
Obligatoire : non
** SourceDBClusterIdentifier **
Le nom de ressource Amazon (ARN) à utiliser comme cluster principal du cluster mondial. Ce paramètre est facultatif.
Type : chaîne
Obligatoire : non
** StorageEncrypted **
Le paramètre de chiffrement du stockage pour le nouveau cluster global.
Type : booléen
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** GlobalCluster **
Type de données représentant un cluster global Amazon DocumentDB.
Type : objet [GlobalCluster](API_GlobalCluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`ne fait pas référence à un cluster existant.
Code d’état HTTP :404
** GlobalClusterAlreadyExistsFault **
`GlobalClusterIdentifier` existe déjà. Choisissez un nouvel identifiant de cluster global (nom unique) pour créer un nouveau cluster global.
Code d’état HTTP : 400
** GlobalClusterQuotaExceededFault **
Le nombre de clusters globaux pour ce compte est déjà au maximum autorisé.
Code d’état HTTP : 400
** InvalidDBClusterStateFault **
Le cluster n'est pas dans un état valide.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/CreateGlobalCluster)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/CreateGlobalCluster)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/CreateGlobalCluster)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/CreateGlobalCluster)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/CreateGlobalCluster)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/CreateGlobalCluster)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/CreateGlobalCluster)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/CreateGlobalCluster)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/CreateGlobalCluster)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/CreateGlobalCluster)
# DeleteDBCluster
Supprime un cluster précédemment provisionné. Lorsque vous supprimez un cluster, toutes les sauvegardes automatiques de ce cluster sont supprimées et ne peuvent pas être restaurées. Les instantanés manuels du cluster de base de données du cluster spécifié ne sont pas supprimés.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterIdentifier **
Identifiant du cluster à supprimer. Ce paramètre n'est pas sensible à la casse.
Contraintes:
+ Doit correspondre à un existant`DBClusterIdentifier`.
Type : Chaîne
Obligatoire : oui
** FinalDBSnapshotIdentifier **
L'identifiant de capture d'écran de cluster du nouveau cliché de cluster créé lorsque `SkipFinalSnapshot` ce paramètre est défini sur`false`.
Le fait de spécifier ce paramètre et de le `SkipFinalShapshot` définir également sur `true` entraîne une erreur.
Contraintes:
+ Il doit comporter de 1 à 255 lettres, chiffres ou traits d'union.
+ Le premier caractère doit être une lettre.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
Type : chaîne
Obligatoire : non
** SkipFinalSnapshot **
Détermine si un instantané final du cluster est créé avant la suppression du cluster. Si cette `true` option est spécifiée, aucun instantané de cluster n'est créé. Si cela `false` est spécifié, un instantané de cluster est créé avant que le cluster de base de données ne soit supprimé.
Dans `SkipFinalSnapshot` l'`false`affirmative, vous devez spécifier un `FinalDBSnapshotIdentifier` paramètre.
Valeur par défaut : `false`
Type : booléen
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBCluster **
Informations détaillées sur un cluster.
Type : objet [DBCluster](API_DBCluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`ne fait pas référence à un cluster existant.
Code d’état HTTP :404
** DBClusterSnapshotAlreadyExistsFault **
Vous avez déjà un instantané du cluster avec l'identifiant indiqué.
Code d’état HTTP : 400
** InvalidDBClusterSnapshotStateFault **
La valeur fournie n'est pas un état de capture d'écran de cluster valide.
Code d’état HTTP : 400
** InvalidDBClusterStateFault **
Le cluster n'est pas dans un état valide.
Code d’état HTTP : 400
** SnapshotQuotaExceeded **
La demande vous obligerait à dépasser le nombre autorisé de clichés.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBCluster)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBCluster)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBCluster)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBCluster)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBCluster)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBCluster)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBCluster)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBCluster)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBCluster)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBCluster)
# DeleteDBClusterParameterGroup
Supprime un groupe de paramètres de cluster spécifié. Le groupe de paramètres de cluster à supprimer ne peut être associé à aucun cluster.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterParameterGroupName **
Nom du groupe de paramètres de cluster.
Contraintes:
+ Doit être le nom d'un groupe de paramètres de cluster existant.
+ Vous ne pouvez pas supprimer un groupe de paramètres de cluster par défaut.
+ Ne peut être associé à aucun cluster.
Type : Chaîne
Obligatoire : oui
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBParameterGroupNotFound **
`DBParameterGroupName`ne fait pas référence à un groupe de paramètres existant.
Code d’état HTTP :404
** InvalidDBParameterGroupState **
Le groupe de paramètres est en cours d'utilisation ou son état n'est pas valide. Si vous essayez de supprimer le groupe de paramètres, vous ne pouvez pas le supprimer lorsque le groupe de paramètres est dans cet état.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBClusterParameterGroup)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBClusterParameterGroup)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBClusterParameterGroup)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBClusterParameterGroup)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBClusterParameterGroup)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBClusterParameterGroup)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBClusterParameterGroup)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBClusterParameterGroup)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBClusterParameterGroup)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBClusterParameterGroup)
# DeleteDBClusterSnapshot
Supprime un instantané de cluster. Si l'instantané est en cours de copie, l'opération est arrêtée.
**Note**
L'instantané du cluster doit être dans l'`available`état pour être supprimé.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterSnapshotIdentifier **
Identifiant du snapshot du cluster à supprimer.
Contraintes : Doit être le nom d'un instantané de cluster existant dans l'`available`état.
Type : Chaîne
Obligatoire : oui
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBClusterSnapshot **
Informations détaillées sur un instantané de cluster.
Type : objet [DBClusterSnapshot](API_DBClusterSnapshot.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterSnapshotNotFoundFault **
`DBClusterSnapshotIdentifier`ne fait pas référence à un instantané de cluster existant.
Code d’état HTTP :404
** InvalidDBClusterSnapshotStateFault **
La valeur fournie n'est pas un état de capture d'écran de cluster valide.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBClusterSnapshot)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBClusterSnapshot)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBClusterSnapshot)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBClusterSnapshot)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBClusterSnapshot)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBClusterSnapshot)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBClusterSnapshot)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBClusterSnapshot)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBClusterSnapshot)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBClusterSnapshot)
# DeleteDBInstance
Supprime une instance précédemment provisionnée.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBInstanceIdentifier **
L'identifiant de l'instance à supprimer. Ce paramètre n'est pas sensible à la casse.
Contraintes:
+ Doit correspondre au nom d'une instance existante.
Type : Chaîne
Obligatoire : oui
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBInstance **
Informations détaillées sur une instance.
Type : objet [DBInstance](API_DBInstance.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBInstanceNotFound **
`DBInstanceIdentifier`ne fait pas référence à une instance existante.
Code d’état HTTP :404
** DBSnapshotAlreadyExists **
`DBSnapshotIdentifier`est déjà utilisé par un instantané existant.
Code d’état HTTP : 400
** InvalidDBClusterStateFault **
Le cluster n'est pas dans un état valide.
Code d’état HTTP : 400
** InvalidDBInstanceState **
L'instance spécifiée n'est pas dans l'état *disponible*.
Code d’état HTTP : 400
** SnapshotQuotaExceeded **
La demande vous obligerait à dépasser le nombre autorisé de clichés.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBInstance)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBInstance)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBInstance)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBInstance)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBInstance)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBInstance)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBInstance)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBInstance)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBInstance)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBInstance)
# DeleteDBSubnetGroup
Supprime un groupe de sous-réseaux.
**Note**
Le groupe de sous-réseaux de base de données spécifié ne doit pas être associé à des instances de base de données.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBSubnetGroupName **
Nom du groupe de sous-réseaux de base de données à supprimer.
Vous ne pouvez pas supprimer le groupe de sous-réseaux par défaut.
Contraintes:
Doit correspondre au nom d'un `DBSubnetGroup` existant. Impossible de conserver le nom par défaut.
Exemple : `mySubnetgroup`
Type : Chaîne
Obligatoire : oui
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName`ne fait pas référence à un groupe de sous-réseaux existant.
Code d’état HTTP :404
** InvalidDBSubnetGroupStateFault **
Le groupe de sous-réseaux ne peut pas être supprimé car il est en cours d'utilisation.
Code d’état HTTP : 400
** InvalidDBSubnetStateFault **
Le sous-réseau n'est pas dans l'état *disponible*.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteDBSubnetGroup)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteDBSubnetGroup)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteDBSubnetGroup)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteDBSubnetGroup)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteDBSubnetGroup)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteDBSubnetGroup)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteDBSubnetGroup)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteDBSubnetGroup)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteDBSubnetGroup)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteDBSubnetGroup)
# DeleteEventSubscription
Supprime un abonnement aux notifications d'événements Amazon DocumentDB.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** SubscriptionName **
Nom de l'abonnement aux notifications d'événements Amazon DocumentDB que vous souhaitez supprimer.
Type : Chaîne
Obligatoire : oui
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** EventSubscription **
Informations détaillées sur un événement auquel vous vous êtes inscrit.
Type : objet [EventSubscription](API_EventSubscription.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** InvalidEventSubscriptionState **
Quelqu'un d'autre est peut-être en train de modifier un abonnement. Patientez quelques secondes, puis réessayez.
Code d’état HTTP : 400
** SubscriptionNotFound **
Le nom de l'abonnement n'existe pas.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteEventSubscription)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteEventSubscription)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteEventSubscription)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteEventSubscription)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteEventSubscription)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteEventSubscription)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteEventSubscription)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteEventSubscription)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteEventSubscription)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteEventSubscription)
# DeleteGlobalCluster
Supprime un cluster global. Les clusters principal et secondaire doivent déjà être détachés ou supprimés avant de tenter de supprimer un cluster global.
**Note**
Cette action s'applique uniquement aux clusters Amazon DocumentDB.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** GlobalClusterIdentifier **
Identifiant du cluster global en cours de suppression.
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 : oui
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** GlobalCluster **
Type de données représentant un cluster global Amazon DocumentDB.
Type : objet [GlobalCluster](API_GlobalCluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** GlobalClusterNotFoundFault **
`GlobalClusterIdentifier`Cela ne fait pas référence à un cluster mondial existant.
Code d’état HTTP :404
** InvalidGlobalClusterStateFault **
L'opération demandée ne peut pas être effectuée tant que le cluster est dans cet état.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DeleteGlobalCluster)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DeleteGlobalCluster)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DeleteGlobalCluster)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DeleteGlobalCluster)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DeleteGlobalCluster)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DeleteGlobalCluster)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DeleteGlobalCluster)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DeleteGlobalCluster)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DeleteGlobalCluster)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DeleteGlobalCluster)
# DescribeCertificates
Renvoie une liste des certificats d'autorité de certification (CA) fournis par Amazon DocumentDB à cet effet. Compte AWS
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** CertificateIdentifier **
L'identifiant de certificat fourni par l'utilisateur. Si ce paramètre est spécifié, seules les informations relatives au certificat spécifié sont renvoyées. Si ce paramètre est omis, une liste de `MaxRecords` certificats maximum est renvoyée. Ce paramètre n'est pas sensible à la casse.
Constaintes
+ Doit correspondre à un existant`CertificateIdentifier`.
Type : chaîne
Obligatoire : non
**Filtres.Filter.N**
Ce paramètre n'est actuellement pas pris en charge.
Type : tableau d’objets [Filter](API_Filter.md)
Obligatoire : non
** Marker **
Jeton de pagination facultatif fourni par une demande `DescribeCertificates` 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
** MaxRecords **
Nombre maximal d'enregistrements à inclure dans la réponse. Si le nombre d'enregistrements existants est supérieur à la valeur `MaxRecords` spécifiée, un jeton de pagination appelé marqueur est inclus dans la réponse pour permettre la récupération des résultats restants.
Par défaut : 100
Contraintes:
+ Minimum : 20
+ Maximum : 100
Type : Integer
Obligatoire : non
## Éléments de réponse
Les éléments suivants sont renvoyés par le service.
**Certificats.Certificat.N**
Une liste de certificats pour cela Compte AWS.
Type : tableau d’objets [Certificate](API_Certificate.md)
** Marker **
Un jeton de pagination facultatif fourni si le nombre d'enregistrements récupérés est supérieur à`MaxRecords`. Si ce paramètre est spécifié, le marqueur indique l'enregistrement suivant de la liste. Inclure la valeur de `Marker` dans le prochain appel aux `DescribeCertificates` résultats dans la page de certificats suivante.
Type : Chaîne
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** CertificateNotFound **
`CertificateIdentifier`ne fait pas référence à un certificat existant.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeCertificates)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeCertificates)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeCertificates)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeCertificates)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeCertificates)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeCertificates)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeCertificates)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeCertificates)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeCertificates)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeCertificates)
# DescribeDBClusterParameterGroups
Renvoie une liste des descriptions de `DBClusterParameterGroup`. Si un `DBClusterParameterGroupName` paramètre est spécifié, la liste contient uniquement la description du groupe de paramètres de cluster spécifié.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterParameterGroupName **
Nom d'un groupe de paramètres de cluster spécifique pour lequel les détails doivent être renvoyés.
Contraintes:
+ S'il est fourni, il doit correspondre au nom d'un existant`DBClusterParameterGroup`.
Type : chaîne
Obligatoire : non
**Filtres.Filter.N**
Ce paramètre n'est actuellement pas pris en charge.
Type : tableau d’objets [Filter](API_Filter.md)
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
** MaxRecords **
Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` valeur spécifiée, un jeton de pagination (marqueur) est inclus dans la réponse afin que les résultats restants puissent être récupérés.
Par défaut : 100
Contraintes : Minimum 20, maximum 100.
Type : Integer
Obligatoire : non
## Éléments de réponse
Les éléments suivants sont renvoyés par le service.
**DBClusterParameterGroups. DBClusterParameterGroup**N.
Liste des groupes de paramètres du cluster.
Type : tableau d’objets [DBClusterParameterGroup](API_DBClusterParameterGroup.md)
** 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
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBParameterGroupNotFound **
`DBParameterGroupName`ne fait pas référence à un groupe de paramètres existant.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterParameterGroups)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterParameterGroups)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterParameterGroups)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterParameterGroups)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterParameterGroups)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterParameterGroups)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterParameterGroups)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterParameterGroups)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterParameterGroups)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterParameterGroups)
# DescribeDBClusterParameters
Renvoie la liste détaillée des paramètres d'un groupe de paramètres de cluster particulier.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterParameterGroupName **
Nom d'un groupe de paramètres de cluster spécifique pour lequel les détails des paramètres doivent être renvoyés.
Contraintes:
+ S'il est fourni, il doit correspondre au nom d'un existant`DBClusterParameterGroup`.
Type : Chaîne
Obligatoire : oui
**Filtres.Filter.N**
Ce paramètre n'est actuellement pas pris en charge.
Type : tableau d’objets [Filter](API_Filter.md)
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
** MaxRecords **
Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` valeur spécifiée, un jeton de pagination (marqueur) est inclus dans la réponse afin que les résultats restants puissent être récupérés.
Par défaut : 100
Contraintes : Minimum 20, maximum 100.
Type : Integer
Obligatoire : non
** Source **
Valeur indiquée pour renvoyer uniquement les paramètres d'une source spécifique. Les sources du paramètre peuvent être `engine`, `service` ou `customer`.
Type : chaîne
Obligatoire : non
## Éléments de réponse
Les éléments suivants sont renvoyés par le service.
** 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
**Paramètres.Paramètre.N**
Fournit la liste des paramètres du groupe de paramètres de cluster.
Type : tableau d’objets [Parameter](API_Parameter.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBParameterGroupNotFound **
`DBParameterGroupName`ne fait pas référence à un groupe de paramètres existant.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterParameters)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterParameters)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterParameters)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterParameters)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterParameters)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterParameters)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterParameters)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterParameters)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterParameters)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterParameters)
# DescribeDBClusters
Renvoie des informations sur les clusters Amazon DocumentDB provisionnés. Cette opération d'API prend en charge la pagination. Pour certaines fonctionnalités de gestion telles que la gestion du cycle de vie des clusters et des instances, Amazon DocumentDB utilise une technologie opérationnelle partagée avec Amazon RDS et Amazon Neptune. Utilisez le paramètre `filterName=engine,Values=docdb` filter pour renvoyer uniquement les clusters Amazon DocumentDB.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterIdentifier **
L'identifiant de cluster fourni par l'utilisateur. Si ce paramètre est spécifié, les informations provenant uniquement du cluster spécifique sont renvoyées. Ce paramètre n'est pas sensible à la casse.
Contraintes:
+ S'il est fourni, il doit correspondre à un existant`DBClusterIdentifier`.
Type : chaîne
Obligatoire : non
**Filtres.Filter.N**
Filtre qui spécifie un ou plusieurs clusters à décrire.
Filtres pris en charge :
+ `db-cluster-id`- Accepte les identifiants de cluster et les noms de ressources Amazon du cluster (ARNs). La liste des résultats inclut uniquement des informations sur les clusters identifiés par ceux-ci ARNs.
Type : tableau d’objets [Filter](API_Filter.md)
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
** MaxRecords **
Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` valeur spécifiée, un jeton de pagination (marqueur) est inclus dans la réponse afin que les résultats restants puissent être récupérés.
Par défaut : 100
Contraintes : Minimum 20, maximum 100.
Type : Integer
Obligatoire : non
## Éléments de réponse
Les éléments suivants sont renvoyés par le service.
**DBClusters. DBCluster**N.
Une liste de clusters.
Type : tableau d’objets [DBCluster](API_DBCluster.md)
** 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
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`ne fait pas référence à un cluster existant.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusters)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusters)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusters)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusters)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusters)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusters)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusters)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusters)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusters)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusters)
# DescribeDBClusterSnapshotAttributes
Renvoie une liste des noms et des valeurs des attributs d'un instantané de cluster de cluster pour un instantané de cluster de base de données manuel.
Lorsque vous partagez des instantanés avec d'autres Comptes AWS personnes, `DescribeDBClusterSnapshotAttributes` renvoie l'`restore`attribut et une liste IDs de ceux Comptes AWS qui sont autorisés à copier ou à restaurer le cliché manuel du cluster. S'il `all` est inclus dans la liste des valeurs de l'`restore`attribut, l'instantané manuel du cluster est public et peut être copié ou restauré par tous Comptes AWS.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterSnapshotIdentifier **
Identifiant du cliché du cluster dont les attributs doivent être décrits.
Type : Chaîne
Obligatoire : oui
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBClusterSnapshotAttributesResult **
Informations détaillées sur les attributs associés à un instantané de cluster.
Type : objet [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterSnapshotNotFoundFault **
`DBClusterSnapshotIdentifier`ne fait pas référence à un instantané de cluster existant.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes)
# DescribeDBClusterSnapshots
Renvoie des informations sur les instantanés du cluster. Cette opération d'API prend en charge la pagination.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterIdentifier **
ID du cluster pour lequel récupérer la liste des instantanés du cluster. Ce paramètre ne peut pas être utilisé avec le `DBClusterSnapshotIdentifier` paramètre. Ce paramètre n'est pas sensible à la casse.
Contraintes:
+ S'il est fourni, il doit correspondre à l'identifiant d'un existant`DBCluster`.
Type : chaîne
Obligatoire : non
** DBClusterSnapshotIdentifier **
Identifiant de capture d'écran spécifique du cluster à décrire. Ce paramètre ne peut pas être utilisé avec le `DBClusterIdentifier` paramètre. Cette valeur est stockée sous la forme d’une chaîne en minuscules.
Contraintes:
+ S'il est fourni, il doit correspondre à l'identifiant d'un existant`DBClusterSnapshot`.
+ Si cet identifiant est destinée à un instantané automatisé, le paramètre `SnapshotType` doit également être spécifié.
Type : chaîne
Obligatoire : non
**Filtres.Filter.N**
Ce paramètre n'est actuellement pas pris en charge.
Type : tableau d’objets [Filter](API_Filter.md)
Obligatoire : non
** IncludePublic **
Définissez sur `true` pour inclure les instantanés de cluster manuels qui sont publics et peuvent être copiés ou restaurés par n'importe qui Compte AWS, ou autrement`false`. La valeur par défaut est `false`.
Type : booléen
Obligatoire : non
** IncludeShared **
Définissez sur `true` pour inclure les instantanés de cluster manuels partagés provenant d'autres Comptes AWS entités autorisées à copier ou à restaurer, etc. Compte AWS `false` La valeur par défaut est `false`.
Type : booléen
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
** MaxRecords **
Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` valeur spécifiée, un jeton de pagination (marqueur) est inclus dans la réponse afin que les résultats restants puissent être récupérés.
Par défaut : 100
Contraintes : Minimum 20, maximum 100.
Type : Integer
Obligatoire : non
** SnapshotType **
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 vous. Compte AWS
+ `manual`- Renvoie tous les instantanés de cluster que vous avez créés manuellement pour votre Compte AWS.
+ `shared`- Renvoie tous les instantanés de cluster manuels qui ont été partagés avec votre Compte AWS.
+ `public`- Renvoie tous les instantanés du cluster marqués comme publics.
Si vous ne spécifiez aucune `SnapshotType` valeur, les instantanés de cluster automatisés et manuels sont renvoyés. Vous pouvez inclure des instantanés de cluster partagés avec ces résultats en définissant le `IncludeShared` paramètre sur. `true` Vous pouvez inclure des instantanés de clusters publics avec ces résultats en définissant le `IncludePublic` paramètre sur. `true`
Les paramètres `IncludeShared` et `IncludePublic` ne s'appliquent pas pour les valeurs `SnapshotType` de `manual` ou `automated`. Le paramètre `IncludePublic` ne s'applique pas lorsque `SnapshotType` est défini sur `shared`. Le paramètre `IncludeShared` ne s'applique pas lorsque `SnapshotType` est défini sur `public`.
Type : chaîne
Obligatoire : non
## Éléments de réponse
Les éléments suivants sont renvoyés par le service.
**DBClusterInstantanés. DBClusterSnapshot.N**
Fournit une liste des instantanés du cluster.
Type : tableau d’objets [DBClusterSnapshot](API_DBClusterSnapshot.md)
** 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
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterSnapshotNotFoundFault **
`DBClusterSnapshotIdentifier`ne fait pas référence à un instantané de cluster existant.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBClusterSnapshots)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBClusterSnapshots)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBClusterSnapshots)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBClusterSnapshots)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBClusterSnapshots)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBClusterSnapshots)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBClusterSnapshots)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBClusterSnapshots)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBClusterSnapshots)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBClusterSnapshots)
# DescribeDBEngineVersions
Renvoie la liste des moteurs disponibles.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBParameterGroupFamily **
Nom d'une famille de groupes de paramètres spécifique pour laquelle les informations doivent être renvoyées.
Contraintes:
+ S'il est fourni, il doit correspondre à un existant`DBParameterGroupFamily`.
Type : chaîne
Obligatoire : non
** DefaultOnly **
Indique que seule la version par défaut du moteur spécifié ou de l'association moteur et version majeure est renvoyée.
Type : booléen
Obligatoire : non
** Engine **
Moteur de base de données à renvoyer.
Type : chaîne
Obligatoire : non
** EngineVersion **
Version du moteur de base de données à renvoyer.
Exemple : `3.6.0`
Type : chaîne
Obligatoire : non
**Filtres.Filter.N**
Ce paramètre n'est actuellement pas pris en charge.
Type : tableau d’objets [Filter](API_Filter.md)
Obligatoire : non
** ListSupportedCharacterSets **
Si ce paramètre est spécifié et que le moteur demandé prend en charge le paramètre `CharacterSetName` pour `CreateDBInstance`, la réponse inclut une liste des jeux de caractères pris en charge pour chaque version de moteur.
Type : booléen
Obligatoire : non
** ListSupportedTimezones **
Si ce paramètre est spécifié et que le moteur demandé prend en charge le paramètre `TimeZone` pour `CreateDBInstance`, la réponse inclut une liste des fuseaux horaires pris en charge pour chaque version de moteur.
Type : booléen
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
** MaxRecords **
Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` valeur spécifiée, un jeton de pagination (marqueur) est inclus dans la réponse afin que les résultats restants puissent être récupérés.
Par défaut : 100
Contraintes : Minimum 20, maximum 100.
Type : Integer
Obligatoire : non
## Éléments de réponse
Les éléments suivants sont renvoyés par le service.
**DBEngineDes versions. DBEngineVersion.N**
Informations détaillées sur une ou plusieurs versions du moteur.
Type : tableau d’objets [DBEngineVersion](API_DBEngineVersion.md)
** 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
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBEngineVersions)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBEngineVersions)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBEngineVersions)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBEngineVersions)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBEngineVersions)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBEngineVersions)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBEngineVersions)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBEngineVersions)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBEngineVersions)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBEngineVersions)
# DescribeDBInstances
Renvoie des informations sur les instances Amazon DocumentDB provisionnées. Cette API prend en charge la pagination.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBInstanceIdentifier **
L'identifiant d'instance fourni par l'utilisateur. Si ce paramètre est spécifié, les informations provenant uniquement de l'instance spécifique sont renvoyées. Ce paramètre n'est pas sensible à la casse.
Contraintes:
+ S'il est fourni, il doit correspondre à l'identifiant d'un existant`DBInstance`.
Type : chaîne
Obligatoire : non
**Filtres.Filter.N**
Filtre qui spécifie une ou plusieurs instances à décrire.
Filtres pris en charge :
+ `db-cluster-id`- Accepte les identifiants de cluster et les noms de ressources Amazon du cluster (ARNs). La liste des résultats inclut uniquement les informations relatives aux instances associées aux clusters identifiés par celles-ci ARNs.
+ `db-instance-id`- Accepte les identifiants d'instance et les instances ARNs. La liste des résultats inclut uniquement les informations relatives aux instances identifiées par ces derniers ARNs.
Type : tableau d’objets [Filter](API_Filter.md)
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
** MaxRecords **
Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` valeur spécifiée, un jeton de pagination (marqueur) est inclus dans la réponse afin que les résultats restants puissent être récupérés.
Par défaut : 100
Contraintes : Minimum 20, maximum 100.
Type : Integer
Obligatoire : non
## Éléments de réponse
Les éléments suivants sont renvoyés par le service.
**DBInstances. DBInstance**N.
Informations détaillées sur une ou plusieurs instances.
Type : tableau d’objets [DBInstance](API_DBInstance.md)
** 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
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBInstanceNotFound **
`DBInstanceIdentifier`ne fait pas référence à une instance existante.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBInstances)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBInstances)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBInstances)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBInstances)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBInstances)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBInstances)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBInstances)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBInstances)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBInstances)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBInstances)
# DescribeDBSubnetGroups
Renvoie une liste des descriptions de `DBSubnetGroup`. Si a `DBSubnetGroupName` est spécifié, la liste contiendra uniquement les descriptions du spécifié`DBSubnetGroup`.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBSubnetGroupName **
Nom du groupe de sous-réseaux pour lequel les informations doivent être renvoyées.
Type : chaîne
Obligatoire : non
**Filtres.Filter.N**
Ce paramètre n'est actuellement pas pris en charge.
Type : tableau d’objets [Filter](API_Filter.md)
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
** MaxRecords **
Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` valeur spécifiée, un jeton de pagination (marqueur) est inclus dans la réponse afin que les résultats restants puissent être récupérés.
Par défaut : 100
Contraintes : Minimum 20, maximum 100.
Type : Integer
Obligatoire : non
## Éléments de réponse
Les éléments suivants sont renvoyés par le service.
**DBSubnetGroupes. DBSubnetGroupe.N**
Informations détaillées sur un ou plusieurs groupes de sous-réseaux.
Type : tableau d’objets [DBSubnetGroup](API_DBSubnetGroup.md)
** 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
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName`ne fait pas référence à un groupe de sous-réseaux existant.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeDBSubnetGroups)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeDBSubnetGroups)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeDBSubnetGroups)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeDBSubnetGroups)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeDBSubnetGroups)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeDBSubnetGroups)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeDBSubnetGroups)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeDBSubnetGroups)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeDBSubnetGroups)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeDBSubnetGroups)
# DescribeEngineDefaultClusterParameters
Renvoie les informations sur les paramètres de moteur et de système par défaut du moteur de base de données du cluster.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** 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 : oui
**Filtres.Filter.N**
Ce paramètre n'est actuellement pas pris en charge.
Type : tableau d’objets [Filter](API_Filter.md)
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
** MaxRecords **
Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` valeur spécifiée, un jeton de pagination (marqueur) est inclus dans la réponse afin que les résultats restants puissent être récupérés.
Par défaut : 100
Contraintes : Minimum 20, maximum 100.
Type : Integer
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** EngineDefaults **
Contient le résultat d'une invocation réussie de l'`DescribeEngineDefaultClusterParameters`opération.
Type : objet [EngineDefaults](API_EngineDefaults.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEngineDefaultClusterParameters)
# DescribeEventCategories
Affiche une liste des catégories de tous les types de sources de l'événement ou, si la valeur est spécifiée, d'un type de source donné.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
**Filtres.Filter.N**
Ce paramètre n'est actuellement pas pris en charge.
Type : tableau d’objets [Filter](API_Filter.md)
Obligatoire : non
** SourceType **
Type de source qui génère les événements.
Valeurs valides : `db-instance`, `db-parameter-group`, `db-security-group`
Type : chaîne
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
**EventCategoriesMapList. EventCategoriesMap**N.
Liste des cartes des catégories d'événements.
Type : tableau d’objets [EventCategoriesMap](API_EventCategoriesMap.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEventCategories)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEventCategories)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEventCategories)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEventCategories)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEventCategories)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEventCategories)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEventCategories)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEventCategories)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEventCategories)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEventCategories)
# DescribeEvents
Renvoie les événements relatifs aux instances, aux groupes de sécurité, aux instantanés et aux groupes de paramètres de base de données des 14 derniers jours. Vous pouvez obtenir des événements spécifiques à une instance de base de données, à un groupe de sécurité, à un instantané ou à un groupe de paramètres en fournissant le nom en tant que paramètre. Par défaut, les événements de l'heure passée sont renvoyés.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** Duration **
Nombre de minutes pour lesquelles récupérer les événements.
Par défaut : 60
Type : Integer
Obligatoire : non
** EndTime **
Fin de l'intervalle de temps pour lequel récupérer les événements au format ISO 8601.
Exemple : 2009-07-08T18:00Z
Type : Timestamp
Obligatoire : non
**EventCategories. EventCategory**N.
Liste des catégories d'événements qui déclenchent des notifications pour un abonnement aux notifications d'événements.
Type : tableau de chaînes
Obligatoire : non
**Filtres.Filter.N**
Ce paramètre n'est actuellement pas pris en charge.
Type : tableau d’objets [Filter](API_Filter.md)
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
** MaxRecords **
Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` valeur spécifiée, un jeton de pagination (marqueur) est inclus dans la réponse afin que les résultats restants puissent être récupérés.
Par défaut : 100
Contraintes : Minimum 20, maximum 100.
Type : Integer
Obligatoire : non
** SourceIdentifier **
Identifiant de la source de l'événement pour laquelle les événements sont renvoyés. Si la valeur n'est pas spécifiée, toutes les sources sont incluses dans la réponse.
Contraintes:
+ S'il `SourceIdentifier` est fourni, `SourceType` il doit également être fourni.
+ Si le type de source est`DBInstance`, un `DBInstanceIdentifier` doit être fourni.
+ Si le type de source est`DBSecurityGroup`, un `DBSecurityGroupName` doit être fourni.
+ Si le type de source est`DBParameterGroup`, un `DBParameterGroupName` doit être fourni.
+ Si le type de source est`DBSnapshot`, un `DBSnapshotIdentifier` doit être fourni.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
Type : chaîne
Obligatoire : non
** SourceType **
Source de l'événement pour laquelle récupérer les événements. Si aucune valeur n'est spécifiée, tous les événements sont renvoyés.
Type : Chaîne
Valeurs valides : `db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot`
Obligatoire : non
** StartTime **
Début de l'intervalle de temps pour lequel récupérer les événements au format ISO 8601.
Exemple : 2009-07-08T18:00Z
Type : Timestamp
Obligatoire : non
## Éléments de réponse
Les éléments suivants sont renvoyés par le service.
**Événements.Événement.N**
Informations détaillées sur un ou plusieurs événements.
Type : tableau d’objets [Event](API_Event.md)
** 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
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEvents)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEvents)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEvents)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEvents)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEvents)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEvents)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEvents)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEvents)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEvents)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEvents)
# DescribeEventSubscriptions
Répertorie toutes les descriptions d'abonnements d'un compte client. La description d'un abonnement inclut `SubscriptionName``SNSTopicARN`,`CustomerID`, `SourceType``SourceID`,`CreationTime`, et`Status`.
Si vous spécifiez un`SubscriptionName`, répertorie la description de cet abonnement.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
**Filtres.Filter.N**
Ce paramètre n'est actuellement pas pris en charge.
Type : tableau d’objets [Filter](API_Filter.md)
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
** MaxRecords **
Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` valeur spécifiée, un jeton de pagination (marqueur) est inclus dans la réponse afin que les résultats restants puissent être récupérés.
Par défaut : 100
Contraintes : Minimum 20, maximum 100.
Type : Integer
Obligatoire : non
** SubscriptionName **
Nom de l'abonnement aux notifications d'événements Amazon DocumentDB que vous souhaitez décrire.
Type : chaîne
Obligatoire : non
## Éléments de réponse
Les éléments suivants sont renvoyés par le service.
**EventSubscriptionsList. EventSubscription**N.
Liste des abonnements aux événements.
Type : tableau d’objets [EventSubscription](API_EventSubscription.md)
** 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
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** SubscriptionNotFound **
Le nom de l'abonnement n'existe pas.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeEventSubscriptions)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeEventSubscriptions)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeEventSubscriptions)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeEventSubscriptions)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeEventSubscriptions)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeEventSubscriptions)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeEventSubscriptions)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeEventSubscriptions)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeEventSubscriptions)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeEventSubscriptions)
# DescribeGlobalClusters
Renvoie des informations sur les clusters globaux Amazon DocumentDB. Cette API prend en charge la pagination.
**Note**
Cette action s'applique uniquement aux clusters Amazon DocumentDB.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
**Filtres.Filter.N**
Filtre qui spécifie un ou plusieurs clusters de bases de données globaux à décrire.
Filtres pris en charge : `db-cluster-id` accepte les identifiants de cluster et les noms de ressources Amazon de clusters (ARNs). La liste des résultats inclura uniquement des informations sur les clusters identifiés par ceux-ci ARNs.
Type : tableau d’objets [Filter](API_Filter.md)
Obligatoire : non
** GlobalClusterIdentifier **
L'identifiant de cluster fourni par l'utilisateur. Si ce paramètre est spécifié, les informations provenant uniquement du cluster spécifique sont renvoyées. Ce paramètre n'est pas sensible à la casse.
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
** Marker **
Jeton de pagination facultatif fourni par une demande `DescribeGlobalClusters` 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
** MaxRecords **
Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` valeur spécifiée, un jeton de pagination appelé marqueur est inclus dans la réponse afin que vous puissiez récupérer les résultats restants.
Type : Integer
Obligatoire : non
## Éléments de réponse
Les éléments suivants sont renvoyés par le service.
**GlobalClusters. GlobalClusterMember**N.
Type : tableau d’objets [GlobalCluster](API_GlobalCluster.md)
** Marker **
Type : Chaîne
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** GlobalClusterNotFoundFault **
`GlobalClusterIdentifier`Cela ne fait pas référence à un cluster mondial existant.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeGlobalClusters)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeGlobalClusters)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeGlobalClusters)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeGlobalClusters)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeGlobalClusters)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeGlobalClusters)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeGlobalClusters)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeGlobalClusters)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeGlobalClusters)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeGlobalClusters)
# DescribeOrderableDBInstanceOptions
Renvoie une liste d'options d'instance pouvant être commandées pour le moteur spécifié.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** Engine **
Nom du moteur pour lequel les options d'instance doivent être récupérées.
Type : Chaîne
Obligatoire : oui
** DBInstanceClass **
La valeur du filtre de classe d'instance. Spécifiez ce paramètre pour afficher uniquement les offres disponibles correspondant à la classe d'instance spécifiée.
Type : chaîne
Obligatoire : non
** EngineVersion **
Valeur de filtre de la version de moteur. Spécifiez ce paramètre pour afficher uniquement les offres disponibles correspondant à la version du moteur spécifiée.
Type : chaîne
Obligatoire : non
**Filtres.Filter.N**
Ce paramètre n'est actuellement pas pris en charge.
Type : tableau d’objets [Filter](API_Filter.md)
Obligatoire : non
** LicenseModel **
Valeur de filtre du modèle de licence. Spécifiez ce paramètre pour afficher uniquement les offres disponibles correspondant au modèle de licence spécifié.
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
** MaxRecords **
Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` valeur spécifiée, un jeton de pagination (marqueur) est inclus dans la réponse afin que les résultats restants puissent être récupérés.
Par défaut : 100
Contraintes : Minimum 20, maximum 100.
Type : Integer
Obligatoire : non
** Vpc **
La valeur du filtre de cloud privé virtuel (VPC). Spécifiez ce paramètre pour afficher uniquement les offres VPC ou non VPC disponibles.
Type : booléen
Obligatoire : non
## Éléments de réponse
Les éléments suivants sont renvoyés par le service.
** 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
**Options DBInstance commandes.Option commandable.N DBInstance**
Les options disponibles pour une instance commandable particulière.
Type : tableau d’objets [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribeOrderableDBInstanceOptions)
# DescribePendingMaintenanceActions
Renvoie une liste de ressources (par exemple, des instances) pour lesquelles au moins une action de maintenance est en attente.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
**Filtres.Filter.N**
Filtre qui spécifie une ou plusieurs ressources pour lesquelles renvoyer des actions de maintenance en attente.
Filtres pris en charge :
+ `db-cluster-id`- Accepte les identifiants de cluster et les noms de ressources Amazon du cluster (ARNs). La liste des résultats inclut uniquement les actions de maintenance en attente pour les clusters identifiés par ceux-ci ARNs.
+ `db-instance-id`- Accepte les identifiants d'instance et les instances ARNs. La liste des résultats inclut uniquement les actions de maintenance en attente pour les instances de base de données identifiées par celles-ci ARNs.
Type : tableau d’objets [Filter](API_Filter.md)
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
** MaxRecords **
Nombre maximal d'enregistrements à inclure dans la réponse. S'il existe plus d'enregistrements que la `MaxRecords` valeur spécifiée, un jeton de pagination (marqueur) est inclus dans la réponse afin que les résultats restants puissent être récupérés.
Par défaut : 100
Contraintes : Minimum 20, maximum 100.
Type : Integer
Obligatoire : non
** ResourceIdentifier **
ARN d'une ressource pour laquelle renvoyer des actions de maintenance en attente.
Type : chaîne
Obligatoire : non
## Éléments de réponse
Les éléments suivants sont renvoyés par le service.
** 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
**PendingMaintenanceActions. ResourcePendingMaintenanceActions**N.
Les actions de maintenance à appliquer.
Type : tableau d’objets [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** ResourceNotFoundFault **
L'ID de ressource spécifiée est introuvable.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/DescribePendingMaintenanceActions)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/DescribePendingMaintenanceActions)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DescribePendingMaintenanceActions)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/DescribePendingMaintenanceActions)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DescribePendingMaintenanceActions)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/DescribePendingMaintenanceActions)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/DescribePendingMaintenanceActions)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/DescribePendingMaintenanceActions)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/DescribePendingMaintenanceActions)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DescribePendingMaintenanceActions)
# FailoverDBCluster
Force le basculement d'un cluster.
En cas de basculement d'un cluster, l'une des répliques Amazon DocumentDB (instances en lecture seule) du cluster devient l'instance principale (le rédacteur du cluster).
En cas de défaillance de l'instance principale, Amazon DocumentDB bascule automatiquement vers une réplique Amazon DocumentDB, le cas échéant. Vous pouvez forcer un basculement lorsque vous souhaitez simuler un échec d'une instance principale à des fins de test.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterIdentifier **
Identifiant de cluster pour lequel forcer un basculement. Ce paramètre n'est pas sensible à la casse.
Contraintes:
+ Doit correspondre à l'identifiant d'un `DBCluster` existant.
Type : chaîne
Obligatoire : non
** TargetDBInstanceIdentifier **
Nom de l'instance à promouvoir en instance principale.
Vous devez spécifier l'identifiant d'instance pour une réplique Amazon DocumentDB dans le cluster. Par exemple, `mydbcluster-replica1`.
Type : chaîne
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBCluster **
Informations détaillées sur un cluster.
Type : objet [DBCluster](API_DBCluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`ne fait pas référence à un cluster existant.
Code d’état HTTP :404
** InvalidDBClusterStateFault **
Le cluster n'est pas dans un état valide.
Code d’état HTTP : 400
** InvalidDBInstanceState **
L'instance spécifiée n'est pas dans l'état *disponible*.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/FailoverDBCluster)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverDBCluster)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverDBCluster)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverDBCluster)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverDBCluster)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverDBCluster)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverDBCluster)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverDBCluster)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverDBCluster)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverDBCluster)
# FailoverGlobalCluster
Fait du cluster de base de données secondaire spécifié le cluster de base de données principal du cluster global en cas de basculement d'un cluster global.
Utilisez cette opération pour répondre à un événement imprévu, tel qu'une catastrophe régionale dans la région principale. Un échec peut entraîner la perte de données de transaction d'écriture qui n'ont pas été répliquées sur le secondaire choisi avant que le basculement ne se produise. Cependant, le processus de restauration qui fait d'une instance de base de données du cluster de base de données secondaire choisi l'instance de base de données principale du rédacteur garantit que les données sont dans un état de cohérence transactionnelle.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** GlobalClusterIdentifier **
Identifiant du cluster global Amazon DocumentDB pour appliquer cette opération. L'identifiant est la clé unique attribuée par l'utilisateur lors de la création du cluster. En d'autres termes, il s'agit du nom du cluster mondial.
Contraintes:
+ Doit correspondre à l'identifiant d'un cluster global existant.
+ Longueur minimale de 1. Longueur maximale de 255 caractères.
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`
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 : oui
** TargetDbClusterIdentifier **
Identifiant du cluster Amazon DocumentDB secondaire que vous souhaitez promouvoir au rang de cluster principal pour le cluster global. Utilisez l'Amazon Resource Name (ARN) comme identifiant afin qu'Amazon DocumentDB puisse localiser le cluster dans sa AWS région.
Contraintes:
+ Doit correspondre à l'identifiant d'un cluster secondaire existant.
+ Longueur minimale de 1. Longueur maximale de 255 caractères.
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`
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 : oui
** AllowDataLoss **
Spécifie s'il faut autoriser la perte de données pour cette opération de cluster globale. Autoriser la perte de données déclenche une opération de basculement globale.
Si vous ne le spécifiez pas`AllowDataLoss`, le fonctionnement du cluster global est par défaut un basculement.
Contraintes:
+ Ne peut pas être spécifié en même temps que le `Switchover` paramètre.
Type : booléen
Obligatoire : non
** Switchover **
Spécifie s'il convient de basculer entre ce cluster de bases de données global.
Contraintes:
+ Ne peut pas être spécifié en même temps que le `AllowDataLoss` paramètre.
Type : booléen
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** GlobalCluster **
Type de données représentant un cluster global Amazon DocumentDB.
Type : objet [GlobalCluster](API_GlobalCluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`ne fait pas référence à un cluster existant.
Code d’état HTTP :404
** GlobalClusterNotFoundFault **
`GlobalClusterIdentifier`Cela ne fait pas référence à un cluster mondial existant.
Code d’état HTTP :404
** InvalidDBClusterStateFault **
Le cluster n'est pas dans un état valide.
Code d’état HTTP : 400
** InvalidGlobalClusterStateFault **
L'opération demandée ne peut pas être effectuée tant que le cluster est dans cet état.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/FailoverGlobalCluster)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/FailoverGlobalCluster)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/FailoverGlobalCluster)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/FailoverGlobalCluster)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/FailoverGlobalCluster)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/FailoverGlobalCluster)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/FailoverGlobalCluster)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/FailoverGlobalCluster)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/FailoverGlobalCluster)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/FailoverGlobalCluster)
# ListTagsForResource
Répertorie toutes les balises d'une ressource Amazon DocumentDB.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** ResourceName **
La ressource Amazon DocumentDB avec les balises à répertorier. Cette valeur est un Amazon Resource Name (ARN).
Type : Chaîne
Obligatoire : oui
**Filtres.Filter.N**
Ce paramètre n'est actuellement pas pris en charge.
Type : tableau d’objets [Filter](API_Filter.md)
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
**TagList.Tag N**
Liste d'un ou de plusieurs tags.
Type : tableau d’objets [Tag](API_Tag.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`ne fait pas référence à un cluster existant.
Code d’état HTTP :404
** DBInstanceNotFound **
`DBInstanceIdentifier`ne fait pas référence à une instance existante.
Code d’état HTTP :404
** DBSnapshotNotFound **
`DBSnapshotIdentifier`ne fait pas référence à un instantané existant.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ListTagsForResource)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ListTagsForResource)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ListTagsForResource)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ListTagsForResource)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ListTagsForResource)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ListTagsForResource)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ListTagsForResource)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ListTagsForResource)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ListTagsForResource)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ListTagsForResource)
# ModifyDBCluster
Modifie un paramètre pour un cluster Amazon DocumentDB. Vous pouvez modifier un ou plusieurs paramètres de configuration de base de données en spécifiant ces paramètres et les nouvelles valeurs dans la demande.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterIdentifier **
Identifiant du cluster en cours de modification. Ce paramètre n'est pas sensible à la casse.
Contraintes:
+ Doit correspondre à l'identifiant d'un `DBCluster` existant.
Type : Chaîne
Obligatoire : oui
** AllowMajorVersionUpgrade **
Une valeur qui indique que les mises à niveau de version majeures sont autorisées.
Contraintes:
+ Vous devez autoriser les mises à niveau des versions majeures lorsque vous spécifiez une valeur pour le `EngineVersion` paramètre qui est une version majeure différente de la version actuelle du cluster.
+ Certains paramètres étant spécifiques à la version, leur modification nécessite l'exécution d'un nouvel appel d'`ModifyDBCluster`API une fois le MVU en place terminé.
L'exécution d'un MVU a un impact direct sur les paramètres suivants :
+ `MasterUserPassword`
+ `NewDBClusterIdentifier`
+ `VpcSecurityGroupIds`
+ `Port`
Type : booléen
Obligatoire : non
** ApplyImmediately **
Valeur qui indique si les modifications apportées à cette demande et aux modifications en attente sont appliquées de manière asynchrone dès que possible, quel que soit le `PreferredMaintenanceWindow` paramètre du cluster. Si ce paramètre est défini sur`false`, les modifications apportées au cluster sont appliquées lors de la fenêtre de maintenance suivante.
Le `ApplyImmediately` paramètre affecte uniquement les `MasterUserPassword` valeurs `NewDBClusterIdentifier` et. Si vous définissez la valeur de ce paramètre sur`false`, les modifications apportées aux `MasterUserPassword` valeurs `NewDBClusterIdentifier` et sont appliquées lors de la fenêtre de maintenance suivante. Toutes les autres modifications sont appliquées immédiatement, quelle que soit la valeur du paramètre `ApplyImmediately`.
Valeur par défaut : `false`
Type : booléen
Obligatoire : non
** BackupRetentionPeriod **
Nombre de jours de conservation des sauvegardes automatiques. Vous devez spécifier une valeur minimale de 1.
Par défaut : 1
Contraintes:
+ Doit être une valeur comprise entre 1 et 35.
Type : Integer
Obligatoire : non
** CloudwatchLogsExportConfiguration **
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.
Type : objet [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md)
Obligatoire : non
** DBClusterParameterGroupName **
Le nom du groupe de paramètres de cluster à utiliser pour le cluster.
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
** EngineVersion **
Numéro de version du moteur de base de données vers lequel vous souhaitez effectuer la mise à niveau. La modification de ce paramètre entraîne une interruption. La modification sera appliquée pendant la fenêtre de maintenance suivante, sauf si `ApplyImmediately` est activé.
Pour répertorier toutes les versions de moteur disponibles pour Amazon DocumentDB, utilisez la commande suivante :
`aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"`
Type : chaîne
Obligatoire : non
** ManageMasterUserPassword **
Spécifie s'il faut gérer le mot de passe de l'utilisateur principal avec Amazon Web Services Secrets Manager. Si le cluster ne gère pas le mot de passe de l'utilisateur principal avec Amazon Web Services Secrets Manager, vous pouvez activer cette gestion. Dans ce cas, vous ne pouvez pas le spécifier`MasterUserPassword`. Si le cluster gère déjà le mot de passe de l'utilisateur principal avec Amazon Web Services Secrets Manager et que vous spécifiez que le mot de passe de l'utilisateur principal n'est pas géré avec Amazon Web Services Secrets Manager, vous devez le spécifier`MasterUserPassword`. Dans ce cas, Amazon DocumentDB supprime le secret et utilise le nouveau mot de passe de l'utilisateur principal spécifié par. `MasterUserPassword`
Type : booléen
Obligatoire : non
** MasterUserPassword **
Mot de passe de l'utilisateur principal de la base de données. Ce mot de passe peut contenir tout caractère ASCII imprimable à l'exception de la barre oblique (/), des guillemets doubles (") ou du symbole arobase (@).
Contraintes : doit comporter entre 8 et 100 caractères.
Type : chaîne
Obligatoire : non
** MasterUserSecretKmsKeyId **
L'identifiant de clé KMS d'Amazon Web Services permettant de chiffrer un secret généré et géré automatiquement dans Amazon Web Services Secrets Manager.
Ce paramètre n'est valide que si les deux conditions suivantes sont remplies :
+ Le cluster ne gère pas le mot de passe de l'utilisateur principal dans Amazon Web Services Secrets Manager. Si le cluster gère déjà le mot de passe de l'utilisateur principal dans Amazon Web Services Secrets Manager, vous ne pouvez pas modifier la clé KMS utilisée pour chiffrer le secret.
+ Vous êtes en train `ManageMasterUserPassword` d'activer la gestion du mot de passe de l'utilisateur principal dans Amazon Web Services Secrets Manager. Si vous l'activez `ManageMasterUserPassword` et que vous ne le spécifiez pas`MasterUserSecretKmsKeyId`, la clé `aws/secretsmanager` KMS est utilisée pour chiffrer le secret. Si le secret se trouve dans un autre compte Amazon Web Services, vous ne pouvez pas utiliser la clé `aws/secretsmanager` KMS pour le chiffrer et vous devez utiliser une clé KMS gérée par le client.
L'identifiant de clé KMS d'Amazon Web Services est l'ARN de la clé, l'identifiant de clé, l'alias ARN ou le nom d'alias de la clé KMS. Pour utiliser une clé KMS dans un autre compte Amazon Web Services, spécifiez l'ARN de la clé ou l'alias ARN.
Il existe une clé KMS par défaut pour votre compte Amazon Web Services. Votre compte Amazon Web Services possède une clé KMS par défaut différente pour chaque région Amazon Web Services.
Type : chaîne
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
** NewDBClusterIdentifier **
Le nouvel identificateur de cluster pour le cluster lors du changement de nom d'un cluster. Cette valeur est stockée sous la forme d’une chaîne en minuscules.
Contraintes:
+ Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union.
+ Le premier caractère doit être une lettre.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
Exemple : `my-cluster2`
Type : chaîne
Obligatoire : non
** Port **
Numéro de port au niveau duquel le cluster accepte des connexions.
Contraintes : il doit s'agir d'une valeur comprise entre `1150` et`65535`.
Par défaut : le même port que le cluster d'origine.
Type : Integer
Obligatoire : non
** PreferredBackupWindow **
Plage de temps quotidienne au cours de laquelle les sauvegardes automatiques sont créées si cette fonctionnalité est activée via le paramètre `BackupRetentionPeriod`.
La valeur par défaut est une fenêtre de 30 minutes sélectionnée au hasard dans un intervalle de 8 heures pour chacune d'entre elles. Région AWS
Contraintes:
+ Doit être au format `hh24:mi-hh24:mi`.
+ Doit être exprimée en heure UTC (Universal Coordinated Time).
+ Ne doit pas être en conflit avec la fenêtre de maintenance préférée.
+ Doit être de 30 minutes minimum.
Type : chaîne
Obligatoire : non
** PreferredMaintenanceWindow **
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`
La valeur par défaut est une fenêtre de 30 minutes sélectionnée au hasard dans un intervalle de 8 heures pour chacune d'entre elles Région AWS, survenant un jour aléatoire de la semaine.
Jours valides : Mon, Tue, Wed, Thu, Fri, Sat, Sun
Contraintes : fenêtre minimale de 30 minutes.
Type : chaîne
Obligatoire : non
** RotateMasterUserPassword **
Spécifie s'il faut remplacer le secret géré par Amazon Web Services Secrets Manager par le mot de passe de l'utilisateur principal.
Ce paramètre n'est valide que si le mot de passe de l'utilisateur principal est géré par Amazon DocumentDB dans Amazon Web Services Secrets Manager pour le cluster. La valeur secrète contient le mot de passe mis à jour.
Contrainte : vous devez appliquer la modification immédiatement lors de la rotation du mot de passe de l'utilisateur principal.
Type : booléen
Obligatoire : non
** ServerlessV2ScalingConfiguration **
Contient la configuration de dimensionnement d'un cluster Amazon DocumentDB Serverless.
Type : objet [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)
Obligatoire : non
** StorageType **
Type de stockage à associer au cluster de base de données.
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
**VpcSecurityGroupIds. VpcSecurityGroupId**N.
Liste des groupes de sécurité du cloud privé virtuel (VPC) auxquels le cluster appartiendra.
Type : tableau de chaînes
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBCluster **
Informations détaillées sur un cluster.
Type : objet [DBCluster](API_DBCluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterAlreadyExistsFault **
Vous avez déjà un cluster avec l'identifiant indiqué.
Code d’état HTTP : 400
** DBClusterNotFoundFault **
`DBClusterIdentifier`ne fait pas référence à un cluster existant.
Code d’état HTTP :404
** DBClusterParameterGroupNotFound **
`DBClusterParameterGroupName`ne fait pas référence à un groupe de paramètres de cluster existant.
Code d’état HTTP :404
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName`ne fait pas référence à un groupe de sous-réseaux existant.
Code d’état HTTP :404
** InvalidDBClusterStateFault **
Le cluster n'est pas dans un état valide.
Code d’état HTTP : 400
** InvalidDBInstanceState **
L'instance spécifiée n'est pas dans l'état *disponible*.
Code d’état HTTP : 400
** InvalidDBSecurityGroupState **
L'état du groupe de sécurité n'autorise pas la suppression.
Code d’état HTTP : 400
** InvalidDBSubnetGroupStateFault **
Le groupe de sous-réseaux ne peut pas être supprimé car il est en cours d'utilisation.
Code d’état HTTP : 400
** InvalidSubnet **
Le sous-réseau demandé n'est pas valide ou plusieurs sous-réseaux ont été demandés mais ils ne se trouvent pas tous dans un cloud privé virtuel (VPC) commun.
Code d’état HTTP : 400
** InvalidVPCNetworkStateFault **
Le groupe de sous-réseaux ne couvre pas toutes les zones de disponibilité après sa création en raison des modifications apportées.
Code d’état HTTP : 400
** NetworkTypeNotSupported **
Le type de réseau n'est pris en charge ni par `DBSubnetGroup` ni par la version du moteur de base de données.
Code d’état HTTP : 400
** StorageQuotaExceeded **
La demande vous obligerait à dépasser la quantité de stockage autorisée disponible sur toutes les instances.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBCluster)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBCluster)
# ModifyDBClusterParameterGroup
Modifie les paramètres d'un groupe de paramètres de cluster. Pour modifier plusieurs paramètres, soumettez une liste des éléments suivants : `ParameterName`, `ParameterValue` et `ApplyMethod`. 20 paramètres maximum peuvent être modifiés dans une même demande.
**Note**
Les modifications apportées aux paramètres dynamiques sont appliquées immédiatement. Les modifications apportées aux paramètres statiques nécessitent un redémarrage ou une fenêtre de maintenance avant que la modification ne soit prise en compte.
**Important**
Après avoir créé un groupe de paramètres de cluster, vous devez patienter au moins 5 minutes avant de créer votre premier cluster devant utiliser ce groupe de paramètres de cluster comme groupe de paramètres par défaut. Cela permet à Amazon DocumentDB de terminer complètement l'action de création avant que le groupe de paramètres ne soit utilisé par défaut pour un nouveau cluster. Cette étape est particulièrement importante pour les paramètres qui sont essentiels lors de la création de la base de données par défaut d'un cluster, tels que le jeu de caractères de la base de données par défaut définie par le paramètre `character_set_database`.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterParameterGroupName **
Nom du groupe de paramètres de cluster à modifier.
Type : Chaîne
Obligatoire : oui
**Paramètres.Paramètre.N**
Liste des paramètres du groupe de paramètres du cluster à modifier.
Type : tableau d’objets [Parameter](API_Parameter.md)
Obligatoire : oui
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBClusterParameterGroupName **
Nom d'un groupe de paramètres de cluster.
Contraintes:
+ Doit contenir de 1 à 255 lettres ou chiffres.
+ Le premier caractère doit être une lettre.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
Cette valeur est stockée sous la forme d’une chaîne en minuscules.
Type : Chaîne
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBParameterGroupNotFound **
`DBParameterGroupName`ne fait pas référence à un groupe de paramètres existant.
Code d’état HTTP :404
** InvalidDBParameterGroupState **
Le groupe de paramètres est en cours d'utilisation ou son état n'est pas valide. Si vous essayez de supprimer le groupe de paramètres, vous ne pouvez pas le supprimer lorsque le groupe de paramètres est dans cet état.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBClusterParameterGroup)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBClusterParameterGroup)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBClusterParameterGroup)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBClusterParameterGroup)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBClusterParameterGroup)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBClusterParameterGroup)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBClusterParameterGroup)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBClusterParameterGroup)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBClusterParameterGroup)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBClusterParameterGroup)
# ModifyDBClusterSnapshotAttribute
Ajoute un attribut et des valeurs ou supprime un attribut et des valeurs d'un instantané de cluster manuel.
Pour partager un instantané de cluster manuel avec d'autres personnes Comptes AWS`AttributeName`, spécifiez `restore` comme et utilisez le `ValuesToAdd` paramètre pour ajouter une liste IDs des Comptes AWS personnes autorisées à restaurer l'instantané de cluster manuel. Utilisez cette valeur `all` pour rendre public le cliché manuel du cluster, ce qui signifie qu'il peut être copié ou restauré par tous Comptes AWS. N'ajoutez aucune `all` valeur aux instantanés de cluster manuels contenant des informations privées que vous ne souhaitez pas voir accessibles à tous Comptes AWS. Si un instantané de cluster manuel est chiffré, il peut être partagé, mais uniquement en spécifiant une liste de personnes autorisées Compte AWS IDs pour le `ValuesToAdd` paramètre. Dans ce cas, vous ne pouvez pas utiliser `all` comme une valeur pour ce paramètre.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** AttributeName **
Nom de l'attribut de capture d'écran du cluster à modifier.
Pour gérer l'autorisation permettant Comptes AWS à d'autres utilisateurs de copier ou de restaurer un instantané de cluster manuel, définissez cette valeur sur`restore`.
Type : Chaîne
Obligatoire : oui
** DBClusterSnapshotIdentifier **
Identifiant du cliché du cluster dont les attributs doivent être modifiés.
Type : Chaîne
Obligatoire : oui
**ValuesToAdd. AttributeValue**N.
Liste des attributs de capture d'écran du cluster à ajouter à l'attribut spécifié par`AttributeName`.
Pour autoriser d'autres Comptes AWS utilisateurs à copier ou restaurer un instantané de cluster manuel, configurez cette liste pour en inclure un ou plusieurs Compte AWS IDs. Pour que l'instantané manuel du cluster puisse être restauré par n'importe qui Compte AWS, définissez-le sur`all`. N'ajoutez aucune `all` valeur aux instantanés de cluster manuels contenant des informations privées que vous ne souhaitez pas rendre accessibles à tous Comptes AWS.
Type : tableau de chaînes
Obligatoire : non
**ValuesToRemove. AttributeValue**N.
Liste des attributs de capture d'écran du cluster à supprimer de l'attribut spécifié par`AttributeName`.
Pour supprimer l'autorisation permettant Comptes AWS à d'autres utilisateurs de copier ou de restaurer un instantané de cluster manuel, configurez cette liste pour inclure un ou plusieurs Compte AWS identifiants. Pour supprimer l'autorisation permettant Compte AWS à quiconque de copier ou de restaurer l'instantané du cluster, définissez-le sur`all`. Si vous le spécifiez`all`, un Compte AWS utilisateur dont l'ID de compte est explicitement ajouté à l'`restore`attribut peut toujours copier ou restaurer un instantané de cluster manuel.
Type : tableau de chaînes
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBClusterSnapshotAttributesResult **
Informations détaillées sur les attributs associés à un instantané de cluster.
Type : objet [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterSnapshotNotFoundFault **
`DBClusterSnapshotIdentifier`ne fait pas référence à un instantané de cluster existant.
Code d’état HTTP :404
** InvalidDBClusterSnapshotStateFault **
La valeur fournie n'est pas un état de capture d'écran de cluster valide.
Code d’état HTTP : 400
** SharedSnapshotQuotaExceeded **
Vous avez dépassé le nombre maximal de comptes avec lesquels vous pouvez partager un instantané de base de données manuel.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute)
# ModifyDBInstance
Modifie les paramètres d'une instance. Vous pouvez modifier un ou plusieurs paramètres de configuration de base de données en spécifiant ces paramètres et les nouvelles valeurs dans la demande.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBInstanceIdentifier **
Identifiant de l’instance. Cette valeur est stockée sous la forme d’une chaîne en minuscules.
Contraintes:
+ Doit correspondre à l'identifiant d'un `DBInstance` existant.
Type : Chaîne
Obligatoire : oui
** ApplyImmediately **
Spécifie si les modifications de cette demande et les modifications en attente sont appliquées de manière asynchrone dès que possible, quel que soit le `PreferredMaintenanceWindow` paramètre de l'instance.
Si ce paramètre est défini sur`false`, les modifications apportées à l'instance sont appliquées lors de la fenêtre de maintenance suivante. Certaines modifications de paramètres peuvent provoquer une panne et sont appliquées lors du prochain redémarrage.
Valeur par défaut : `false`
Type : booléen
Obligatoire : non
** AutoMinorVersionUpgrade **
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
** CACertificateIdentifier **
Indique le certificat qui doit être associé à l'instance.
Type : chaîne
Obligatoire : non
** CertificateRotationRestart **
Spécifie si l'instance de base de données est redémarrée lorsque vous faites pivoter votre SSL/TLS certificat.
Par défaut, l'instance de base de données est redémarrée lorsque vous faites pivoter votre SSL/TLS certificat. Le certificat n'est pas mis à jour tant que l'instance de base de données n'est pas redémarrée.
Définissez ce paramètre uniquement si vous ne l'utilisez *pas* pour vous connecter SSL/TLS à l'instance de base de données.
*Si vous utilisez SSL/TLS pour vous connecter à l'instance de base de données, 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](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) le guide du développeur Amazon DocumentDB.*
Type : booléen
Obligatoire : non
** CopyTagsToSnapshot **
Une valeur qui indique s'il faut copier toutes les balises de l'instance de base de données vers des 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
** DBInstanceClass **
La nouvelle capacité de calcul et de mémoire de l'instance ; par exemple,`db.r5.large`. Les classes d'instance ne sont pas toutes disponibles Régions AWS.
Si vous modifiez la classe d'instance, une panne se produit lors de la modification. La modification est appliquée pendant la fenêtre de maintenance suivante, sauf si `ApplyImmediately` a été spécifié `true` pour cette demande.
Par défaut : Utilise le paramètre existant.
Type : chaîne
Obligatoire : non
** EnablePerformanceInsights **
Une valeur qui indique s'il convient d'activer Performance Insights pour l'instance de base de données. Pour plus d'informations, voir [Utilisation d'Amazon Performance Insights](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html).
Type : booléen
Obligatoire : non
** NewDBInstanceIdentifier **
Le nouvel identifiant d'instance pour l'instance lorsque vous renommez une instance. Lorsque vous modifiez l'identifiant de l'instance, un redémarrage de l'instance a lieu immédiatement si vous le définissez `Apply Immediately` sur`true`. Cela se produit lors de la fenêtre de maintenance suivante si vous définissez `Apply Immediately` sur`false`. Cette valeur est stockée sous la forme d’une chaîne en minuscules.
Contraintes:
+ Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union.
+ Le premier caractère doit être une lettre.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
Exemple : `mydbinstance`
Type : chaîne
Obligatoire : non
** PerformanceInsightsKMSKeyId **
Identifiant AWS KMS clé pour le chiffrement des données Performance Insights.
L'identifiant de AWS KMS clé est l'ARN de la clé, l'ID de clé, l'alias ARN ou le nom d'alias de la clé KMS.
Si vous ne spécifiez aucune valeur pour PerformanceInsights KMSKey Id, Amazon DocumentDB utilise votre clé KMS par défaut. Il existe une clé KMS par défaut pour votre compte Amazon Web Services. Votre compte Amazon Web Services possède une clé KMS par défaut différente pour chaque région Amazon Web Services.
Type : chaîne
Obligatoire : non
** PreferredMaintenanceWindow **
Intervalle de temps hebdomadaire (au format UTC) pendant lequel se produit la maintenance du système qui peut entraîner une interruption. La modification de ce paramètre n'entraîne pas de panne, sauf dans le cas suivant, et la modification est appliquée de manière asynchrone dès que possible. Si des actions en attente entraînent un redémarrage et que la fenêtre de maintenance est modifiée pour inclure l'heure actuelle, la modification de ce paramètre entraîne le redémarrage de l'instance. Si vous déplacez cette fenêtre vers l'heure actuelle, il doit s'écouler au moins 30 minutes entre l'heure actuelle et la fin de la fenêtre pour garantir que les modifications en attente sont appliquées.
Par défaut : Utilise le paramètre existant.
Format : `ddd:hh24:mi-ddd:hh24:mi`
Jours valides : Mon, Tue, Wed, Thu, Fri, Sat, Sun
Contraintes : Doit durer au moins 30 minutes.
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.
Valeur par défaut : 1
Valeurs valides : 0 à 15
Type : Integer
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBInstance **
Informations détaillées sur une instance.
Type : objet [DBInstance](API_DBInstance.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** AuthorizationNotFound **
L'adresse IP CIDR ou le groupe de sécurité Amazon EC2 spécifié n'est pas autorisé pour le groupe de sécurité spécifié.
Amazon DocumentDB peut également ne pas être autorisé à effectuer les actions nécessaires en votre nom à l'aide d'IAM.
Code d’état HTTP :404
** CertificateNotFound **
`CertificateIdentifier`ne fait pas référence à un certificat existant.
Code d’état HTTP :404
** DBInstanceAlreadyExists **
Vous avez déjà une instance avec l'identifiant indiqué.
Code d’état HTTP : 400
** DBInstanceNotFound **
`DBInstanceIdentifier`ne fait pas référence à une instance existante.
Code d’état HTTP :404
** DBParameterGroupNotFound **
`DBParameterGroupName`ne fait pas référence à un groupe de paramètres existant.
Code d’état HTTP :404
** DBSecurityGroupNotFound **
`DBSecurityGroupName`ne fait pas référence à un groupe de sécurité existant.
Code d’état HTTP :404
** DBUpgradeDependencyFailure **
La mise à niveau a échoué car une ressource dont dépend ne peut pas être modifiée.
Code d’état HTTP : 400
** InsufficientDBInstanceCapacity **
La classe d'instance spécifiée n'est pas disponible dans la zone de disponibilité spécifiée.
Code d’état HTTP : 400
** InvalidDBInstanceState **
L'instance spécifiée n'est pas *disponible*.
Code d’état HTTP : 400
** InvalidDBSecurityGroupState **
L'état du groupe de sécurité n'autorise pas la suppression.
Code d’état HTTP : 400
** InvalidVPCNetworkStateFault **
Le groupe de sous-réseaux ne couvre pas toutes les zones de disponibilité après sa création en raison des modifications apportées.
Code d’état HTTP : 400
** StorageQuotaExceeded **
La demande vous obligerait à dépasser la quantité de stockage autorisée disponible sur toutes les instances.
Code d’état HTTP : 400
** StorageTypeNotSupported **
Le stockage du paramètre spécifié ne `StorageType` peut pas être associé à l'instance de base de données.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBInstance)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBInstance)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBInstance)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBInstance)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBInstance)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBInstance)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBInstance)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBInstance)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBInstance)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBInstance)
# ModifyDBSubnetGroup
Modifie un groupe de sous-réseaux existant. Les groupes de sous-réseaux doivent contenir au moins un sous-réseau dans au moins deux zones de disponibilité du. Région AWS
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBSubnetGroupName **
Nom du groupe de sous-réseaux. Cette valeur est stockée sous la forme d’une chaîne en minuscules. Vous ne pouvez pas modifier le groupe de sous-réseaux par défaut.
Contraintes : doit correspondre au nom d'un `DBSubnetGroup` existant. Impossible de conserver le nom par défaut.
Exemple : `mySubnetgroup`
Type : Chaîne
Obligatoire : oui
**SubnetIds. SubnetIdentifier**N.
Le sous-réseau Amazon EC2 IDs pour le groupe de sous-réseaux.
Type : tableau de chaînes
Obligatoire : oui
** DBSubnetGroupDescription **
Description du groupe de sous-réseaux.
Type : chaîne
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBSubnetGroup **
Informations détaillées sur un groupe de sous-réseaux.
Type : objet [DBSubnetGroup](API_DBSubnetGroup.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBSubnetGroupDoesNotCoverEnoughAZs **
Les sous-réseaux du groupe de sous-réseaux doivent couvrir au moins deux zones de disponibilité, sauf s'il n'existe qu'une seule zone de disponibilité.
Code d’état HTTP : 400
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName`ne fait pas référence à un groupe de sous-réseaux existant.
Code d’état HTTP :404
** DBSubnetQuotaExceededFault **
La demande vous obligerait à dépasser le nombre autorisé de sous-réseaux dans un groupe de sous-réseaux.
Code d’état HTTP : 400
** InvalidSubnet **
Le sous-réseau demandé n'est pas valide ou plusieurs sous-réseaux ont été demandés mais ils ne se trouvent pas tous dans un cloud privé virtuel (VPC) commun.
Code d’état HTTP : 400
** SubnetAlreadyInUse **
Le sous-réseau est déjà utilisé dans la zone de disponibilité.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyDBSubnetGroup)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyDBSubnetGroup)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyDBSubnetGroup)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyDBSubnetGroup)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyDBSubnetGroup)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyDBSubnetGroup)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyDBSubnetGroup)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyDBSubnetGroup)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyDBSubnetGroup)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyDBSubnetGroup)
# ModifyEventSubscription
Modifie un abonnement existant aux notifications d'événements Amazon DocumentDB.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** SubscriptionName **
Nom de l'abonnement aux notifications d'événements Amazon DocumentDB.
Type : Chaîne
Obligatoire : oui
** Enabled **
Valeur booléenne ; définie sur pour `true` activer l'abonnement.
Type : booléen
Obligatoire : non
**EventCategories. EventCategory**N.
Liste des catégories d'événements `SourceType` auxquels vous souhaitez vous abonner.
Type : tableau de chaînes
Obligatoire : non
** SnsTopicArn **
Amazon Resource Name (ARN) de la rubrique SNS créé pour la notification d'événements. L'ARN est créé par Amazon SNS lorsque vous créez une rubrique et vous y abonnez.
Type : chaîne
Obligatoire : non
** SourceType **
Type de source qui génère les événements. Par exemple, si vous souhaitez être informé des événements générés par une instance, définissez ce paramètre sur`db-instance`. Si cette valeur n'est pas spécifiée, tous les événements sont renvoyés.
Valeurs valides : `db-instance`, `db-parameter-group`, `db-security-group`
Type : chaîne
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** EventSubscription **
Informations détaillées sur un événement auquel vous vous êtes inscrit.
Type : objet [EventSubscription](API_EventSubscription.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** EventSubscriptionQuotaExceeded **
Vous avez atteint le nombre maximum d'abonnements aux événements.
Code d’état HTTP : 400
** SNSInvalidTopic **
Amazon SNS a répondu qu'il y avait un problème avec le sujet spécifié.
Code d’état HTTP : 400
** SNSNoAuthorization **
Vous n'êtes pas autorisé à publier sur la rubrique SNS Amazon Resource Name (ARN).
Code d’état HTTP : 400
** SNSTopicArnNotFound **
La rubrique SNS Amazon Resource Name (ARN) n'existe pas.
Code d’état HTTP :404
** SubscriptionCategoryNotFound **
La catégorie fournie n'existe pas.
Code d’état HTTP :404
** SubscriptionNotFound **
Le nom de l'abonnement n'existe pas.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyEventSubscription)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyEventSubscription)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyEventSubscription)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyEventSubscription)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyEventSubscription)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyEventSubscription)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyEventSubscription)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyEventSubscription)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyEventSubscription)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyEventSubscription)
# ModifyGlobalCluster
Modifiez un paramètre pour un cluster global Amazon DocumentDB. Vous pouvez modifier un ou plusieurs paramètres de configuration (par exemple : protection contre la suppression) ou l'identifiant global du cluster en spécifiant ces paramètres et les nouvelles valeurs dans la demande.
**Note**
Cette action s'applique uniquement aux clusters Amazon DocumentDB.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** GlobalClusterIdentifier **
Identifiant du cluster global en cours de modification. Ce paramètre n'est pas sensible à la casse.
Contraintes:
+ Doit correspondre à l'identifiant d'un cluster global existant.
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 : oui
** DeletionProtection **
Indique si la protection contre les suppressions est activée sur le cluster global. Le cluster global ne peut pas être supprimé lorsque la protection contre la suppression est activée.
Type : booléen
Obligatoire : non
** NewGlobalClusterIdentifier **
Le nouvel identifiant d'un cluster global lorsque vous modifiez un cluster global. Cette valeur est stockée sous la forme d’une chaîne en minuscules.
+ Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union
Le premier caractère doit être une lettre
Il ne peut pas se terminer par un trait d'union ou contenir deux traits d'union consécutifs.
Exemple : `my-cluster2`
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
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** GlobalCluster **
Type de données représentant un cluster global Amazon DocumentDB.
Type : objet [GlobalCluster](API_GlobalCluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** GlobalClusterNotFoundFault **
`GlobalClusterIdentifier`Cela ne fait pas référence à un cluster mondial existant.
Code d’état HTTP :404
** InvalidGlobalClusterStateFault **
L'opération demandée ne peut pas être effectuée tant que le cluster est dans cet état.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ModifyGlobalCluster)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ModifyGlobalCluster)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ModifyGlobalCluster)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ModifyGlobalCluster)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ModifyGlobalCluster)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ModifyGlobalCluster)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ModifyGlobalCluster)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ModifyGlobalCluster)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ModifyGlobalCluster)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ModifyGlobalCluster)
# RebootDBInstance
Il se peut que vous deviez redémarrer votre instance, généralement pour des raisons de maintenance. Par exemple, si vous apportez certaines modifications ou si vous modifiez le groupe de paramètres de cluster associé à l'instance, vous devez redémarrer l'instance pour que les modifications prennent effet.
Le redémarrage d'une instance entraîne celui du service du moteur de base de données. *Le redémarrage d'une instance entraîne une interruption momentanée, au cours de laquelle le statut de l'instance est défini sur le redémarrage.*
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBInstanceIdentifier **
Identifiant de l’instance. Ce paramètre est stocké sous la forme d'une chaîne en lettres minuscules.
Contraintes:
+ Doit correspondre à l'identifiant d'un `DBInstance` existant.
Type : Chaîne
Obligatoire : oui
** ForceFailover **
Lorsque `true` le redémarrage est effectué par le biais d'un basculement multi-AZ.
Contrainte : vous ne pouvez pas spécifier `true` si l'instance n'est pas configurée pour le mode multi-AZ.
Type : booléen
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBInstance **
Informations détaillées sur une instance.
Type : objet [DBInstance](API_DBInstance.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBInstanceNotFound **
`DBInstanceIdentifier`ne fait pas référence à une instance existante.
Code d’état HTTP :404
** InvalidDBInstanceState **
L'instance spécifiée n'est pas dans l'état *disponible*.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RebootDBInstance)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RebootDBInstance)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RebootDBInstance)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RebootDBInstance)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RebootDBInstance)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RebootDBInstance)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RebootDBInstance)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RebootDBInstance)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RebootDBInstance)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RebootDBInstance)
# RemoveFromGlobalCluster
Détache un cluster secondaire Amazon DocumentDB d'un cluster global. Le cluster devient un cluster autonome doté d'une fonction de lecture-écriture au lieu d'être en lecture seule et de recevoir des données d'un serveur principal d'une autre région.
**Note**
Cette action s'applique uniquement aux clusters Amazon DocumentDB.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DbClusterIdentifier **
Le nom de ressource Amazon (ARN) identifiant le cluster qui a été détaché du cluster global Amazon DocumentDB.
Type : Chaîne
Obligatoire : oui
** GlobalClusterIdentifier **
Identifiant de cluster à détacher du cluster global Amazon DocumentDB.
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 : oui
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** GlobalCluster **
Type de données représentant un cluster global Amazon DocumentDB.
Type : objet [GlobalCluster](API_GlobalCluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`ne fait pas référence à un cluster existant.
Code d’état HTTP :404
** GlobalClusterNotFoundFault **
`GlobalClusterIdentifier`Cela ne fait pas référence à un cluster mondial existant.
Code d’état HTTP :404
** InvalidGlobalClusterStateFault **
L'opération demandée ne peut pas être effectuée tant que le cluster est dans cet état.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveFromGlobalCluster)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveFromGlobalCluster)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveFromGlobalCluster)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveFromGlobalCluster)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveFromGlobalCluster)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveFromGlobalCluster)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveFromGlobalCluster)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveFromGlobalCluster)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveFromGlobalCluster)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveFromGlobalCluster)
# RemoveSourceIdentifierFromSubscription
Supprime un identifiant de source d'un abonnement existant aux notifications d'événements Amazon DocumentDB.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** SourceIdentifier **
L'identifiant source à supprimer de l'abonnement, tel que l'identifiant d'instance d'une instance ou le nom d'un groupe de sécurité.
Type : Chaîne
Obligatoire : oui
** SubscriptionName **
Nom de l'abonnement aux notifications d'événements Amazon DocumentDB dont vous souhaitez supprimer un identifiant de source.
Type : Chaîne
Obligatoire : oui
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** EventSubscription **
Informations détaillées sur un événement auquel vous vous êtes inscrit.
Type : objet [EventSubscription](API_EventSubscription.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** SourceNotFound **
La source demandée n'a pas pu être trouvée.
Code d’état HTTP :404
** SubscriptionNotFound **
Le nom de l'abonnement n'existe pas.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription)
# RemoveTagsFromResource
Supprime les balises de métadonnées d'une ressource Amazon DocumentDB.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** ResourceName **
La ressource Amazon DocumentDB dont les balises sont supprimées. Cette valeur est un Amazon Resource Name (ARN).
Type : Chaîne
Obligatoire : oui
**TagKeys.membre.n**
Clé de balise (nom) de la balise à supprimer.
Type : tableau de chaînes
Obligatoire : oui
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`ne fait pas référence à un cluster existant.
Code d’état HTTP :404
** DBInstanceNotFound **
`DBInstanceIdentifier`ne fait pas référence à une instance existante.
Code d’état HTTP :404
** DBSnapshotNotFound **
`DBSnapshotIdentifier`ne fait pas référence à un instantané existant.
Code d’état HTTP :404
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RemoveTagsFromResource)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RemoveTagsFromResource)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RemoveTagsFromResource)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RemoveTagsFromResource)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RemoveTagsFromResource)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RemoveTagsFromResource)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RemoveTagsFromResource)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RemoveTagsFromResource)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RemoveTagsFromResource)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RemoveTagsFromResource)
# ResetDBClusterParameterGroup
Modifie les paramètres d'un groupe de paramètres de cluster à la valeur par défaut. Pour réinitialiser des paramètres spécifiques, soumettez une liste des éléments suivants : `ParameterName` et`ApplyMethod`. Pour réinitialiser l'ensemble du groupe de paramètres du cluster, spécifiez les `ResetAllParameters` paramètres `DBClusterParameterGroupName` et.
Lorsque vous réinitialisez l'ensemble du groupe, les paramètres dynamiques sont immédiatement mis à jour et les paramètres statiques sont définis pour `pending-reboot` prendre effet au prochain redémarrage de l'instance de base de données.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterParameterGroupName **
Le nom du groupe de paramètres du cluster à réinitialiser.
Type : Chaîne
Obligatoire : oui
**Paramètres.Paramètre.N**
Liste des noms de paramètres du groupe de paramètres du cluster à rétablir aux valeurs par défaut. Vous ne pouvez pas utiliser ce paramètre si le paramètre `ResetAllParameters` est défini sur `true`.
Type : tableau d’objets [Parameter](API_Parameter.md)
Obligatoire : non
** ResetAllParameters **
Une valeur définie `true` pour rétablir les valeurs par défaut de tous les paramètres du groupe de paramètres du cluster, et dans le `false` cas contraire. Vous ne pouvez pas utiliser ce paramètre si une liste des noms des paramètres spécifiés existe pour le paramètre `Parameters`.
Type : booléen
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBClusterParameterGroupName **
Nom d'un groupe de paramètres de cluster.
Contraintes:
+ Doit contenir de 1 à 255 lettres ou chiffres.
+ Le premier caractère doit être une lettre.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
Cette valeur est stockée sous la forme d’une chaîne en minuscules.
Type : Chaîne
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBParameterGroupNotFound **
`DBParameterGroupName`ne fait pas référence à un groupe de paramètres existant.
Code d’état HTTP :404
** InvalidDBParameterGroupState **
Le groupe de paramètres est en cours d'utilisation ou son état n'est pas valide. Si vous essayez de supprimer le groupe de paramètres, vous ne pouvez pas le supprimer lorsque le groupe de paramètres est dans cet état.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/ResetDBClusterParameterGroup)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/ResetDBClusterParameterGroup)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/ResetDBClusterParameterGroup)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/ResetDBClusterParameterGroup)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/ResetDBClusterParameterGroup)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/ResetDBClusterParameterGroup)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/ResetDBClusterParameterGroup)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/ResetDBClusterParameterGroup)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/ResetDBClusterParameterGroup)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/ResetDBClusterParameterGroup)
# RestoreDBClusterFromSnapshot
Crée un nouveau cluster à partir d'un instantané ou d'un instantané de cluster.
Si un instantané est spécifié, le cluster cible est créé à partir de l'instantané de base de données source avec une configuration et un groupe de sécurité par défaut.
Si un instantané de cluster est spécifié, le cluster cible est créé à partir du point de restauration du cluster source avec la même configuration que le cluster de base de données source d'origine, sauf que le nouveau cluster est créé avec le groupe de sécurité par défaut.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterIdentifier **
Nom du cluster à créer à partir du cliché ou de l'instantané du cluster. Ce paramètre n'est pas sensible à la casse.
Contraintes:
+ Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union.
+ Le premier caractère doit être une lettre.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
Exemple : `my-snapshot-id`
Type : Chaîne
Obligatoire : oui
** Engine **
Le moteur de base de données à utiliser pour le nouveau cluster.
Par défaut : identique à la source.
Contrainte : Doit être compatible avec le moteur de la source.
Type : Chaîne
Obligatoire : oui
** SnapshotIdentifier **
Identifiant de l'instantané ou de l'instantané de cluster à partir duquel effectuer la restauration.
Vous pouvez utiliser le nom ou l'Amazon Resource Name (ARN) pour spécifier un instantané de cluster. Cependant, vous pouvez uniquement utiliser l'ARN pour spécifier un instantané.
Contraintes:
+ Doit correspondre à l'identifiant d'un instantané existant.
Type : Chaîne
Obligatoire : oui
**AvailabilityZones. AvailabilityZone**N.
Fournit la liste des zones de disponibilité Amazon EC2 dans lesquelles les instances du cluster de base de données restauré peuvent être créées.
Type : tableau de chaînes
Obligatoire : non
** DBClusterParameterGroupName **
Nom du groupe de paramètres de cluster DB à associer à ce cluster DB.
*Type* : chaîne. *Nécessaire :* Non
Si cet argument est omis, le groupe de paramètres du cluster de base de données par défaut est utilisé. S'il est fourni, il doit correspondre au nom d'un groupe de paramètres de cluster de base de données par défaut existant. La chaîne doit être composée de 1 à 255 lettres, chiffres ou tirets. Son premier caractère doit être une lettre et il ne peut pas se terminer par un tiret ni contenir deux tirets consécutifs.
Type : chaîne
Obligatoire : non
** DBSubnetGroupName **
Nom du groupe de sous-réseaux à utiliser pour le nouveau cluster.
Contraintes : si indiqué, il doit correspondre au nom d'un existant`DBSubnetGroup`.
Exemple : `mySubnetgroup`
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
**EnableCloudwatchLogsExports.membre.n**
Liste des types de journaux qui doivent être activés pour être exportés vers Amazon CloudWatch Logs.
Type : tableau de chaînes
Obligatoire : non
** EngineVersion **
Version du moteur de base de données à utiliser pour le nouveau cluster.
Type : chaîne
Obligatoire : non
** KmsKeyId **
Identifiant de AWS KMS clé à utiliser lors de la restauration d'un cluster chiffré à partir d'un instantané de base de données ou d'un instantané de cluster.
L'identifiant de AWS KMS clé est le Amazon Resource Name (ARN) de la clé de AWS KMS chiffrement. Si vous restaurez un cluster Compte AWS possédant la clé de AWS KMS chiffrement utilisée pour chiffrer le nouveau cluster, vous pouvez utiliser l'alias de AWS KMS clé au lieu de l'ARN pour la clé de AWS KMS chiffrement.
Si vous ne spécifiez pas de valeur pour le paramètre `KmsKeyId` :
+ Si le cliché ou le cliché de cluster `SnapshotIdentifier` intégré est chiffré, le cluster restauré est chiffré à l'aide de la AWS KMS clé qui a été utilisée pour chiffrer le cliché ou le cliché de cluster.
+ Si le snapshot ou le snapshot du cluster n'`SnapshotIdentifier`est pas chiffré, le cluster de base de données restauré n'est pas chiffré.
Type : chaîne
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
** Port **
Numéro de port sur lequel le nouveau cluster accepte les connexions.
Contraintes : il doit s'agir d'une valeur comprise entre `1150` et`65535`.
Par défaut : le même port que le cluster d'origine.
Type : Integer
Obligatoire : non
** ServerlessV2ScalingConfiguration **
Contient la configuration de dimensionnement d'un cluster Amazon DocumentDB Serverless.
Type : objet [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)
Obligatoire : non
** StorageType **
Type de stockage à associer au cluster de base de données.
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
**Étiquettes.Tag.N**
Les balises à attribuer au cluster restauré.
Type : tableau d’objets [Tag](API_Tag.md)
Obligatoire : non
**VpcSecurityGroupIds. VpcSecurityGroupId**N.
Liste des groupes de sécurité du cloud privé virtuel (VPC) auxquels le nouveau cluster appartiendra.
Type : tableau de chaînes
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBCluster **
Informations détaillées sur un cluster.
Type : objet [DBCluster](API_DBCluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterAlreadyExistsFault **
Vous avez déjà un cluster avec l'identifiant indiqué.
Code d’état HTTP : 400
** DBClusterQuotaExceededFault **
Le cluster ne peut pas être créé car vous avez atteint le quota maximum autorisé de clusters.
Code d’état HTTP : 403
** DBClusterSnapshotNotFoundFault **
`DBClusterSnapshotIdentifier`ne fait pas référence à un instantané de cluster existant.
Code d’état HTTP :404
** DBSnapshotNotFound **
`DBSnapshotIdentifier`ne fait pas référence à un instantané existant.
Code d’état HTTP :404
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName`ne fait pas référence à un groupe de sous-réseaux existant.
Code d’état HTTP :404
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName`ne fait pas référence à un groupe de sous-réseaux existant.
Code d’état HTTP :404
** InsufficientDBClusterCapacityFault **
Le cluster ne dispose pas d'une capacité suffisante pour l'opération en cours.
Code d’état HTTP : 403
** InsufficientStorageClusterCapacity **
L'espace de stockage disponible est insuffisant pour l'action en cours. Vous pouvez peut-être résoudre cette erreur en mettant à jour votre groupe de sous-réseaux afin qu'il utilise différentes zones de disponibilité disposant d'un espace de stockage plus important.
Code d’état HTTP : 400
** InvalidDBClusterSnapshotStateFault **
La valeur fournie n'est pas un état de capture d'écran de cluster valide.
Code d’état HTTP : 400
** InvalidDBSnapshotState **
L'état de l'instantané ne permet pas de le supprimer.
Code d’état HTTP : 400
** InvalidRestoreFault **
Vous ne pouvez pas effectuer de restauration à partir d'une sauvegarde de cloud privé virtuel (VPC) vers une instance de base de données non VPC.
Code d’état HTTP : 400
** InvalidSubnet **
Le sous-réseau demandé n'est pas valide ou plusieurs sous-réseaux ont été demandés mais ils ne se trouvent pas tous dans un cloud privé virtuel (VPC) commun.
Code d’état HTTP : 400
** InvalidVPCNetworkStateFault **
Le groupe de sous-réseaux ne couvre pas toutes les zones de disponibilité après sa création en raison des modifications apportées.
Code d’état HTTP : 400
** KMSKeyNotAccessibleFault **
Une erreur s'est produite lors de l'accès à une AWS KMS clé.
Code d’état HTTP : 400
** NetworkTypeNotSupported **
Le type de réseau n'est pris en charge ni par `DBSubnetGroup` ni par la version du moteur de base de données.
Code d’état HTTP : 400
** StorageQuotaExceeded **
La demande vous obligerait à dépasser la quantité de stockage autorisée disponible sur toutes les instances.
Code d’état HTTP : 400
** StorageQuotaExceeded **
La demande vous obligerait à dépasser la quantité de stockage autorisée disponible sur toutes les instances.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RestoreDBClusterFromSnapshot)
# RestoreDBClusterToPointInTime
Restaure un cluster à un moment arbitraire. Les utilisateurs peuvent restaurer à tout moment avant `LatestRestorableTime` pendant `BackupRetentionPeriod` jours. Le cluster cible est créé à partir du cluster source avec la même configuration que le cluster d'origine, sauf que le nouveau cluster est créé avec le groupe de sécurité par défaut.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterIdentifier **
Il faut créer le nom du nouveau cluster.
Contraintes:
+ Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union.
+ Le premier caractère doit être une lettre.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
Type : Chaîne
Obligatoire : oui
** SourceDBClusterIdentifier **
L'identifiant du cluster source à partir duquel effectuer la restauration.
Contraintes:
+ Doit correspondre à l'identifiant d'un `DBCluster` existant.
Type : Chaîne
Obligatoire : oui
** DBSubnetGroupName **
Le nom du groupe de sous-réseaux à utiliser pour le nouveau cluster.
Contraintes : si indiqué, il doit correspondre au nom d'un existant`DBSubnetGroup`.
Exemple : `mySubnetgroup`
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
**EnableCloudwatchLogsExports.membre.n**
Liste des types de journaux qui doivent être activés pour être exportés vers Amazon CloudWatch Logs.
Type : tableau de chaînes
Obligatoire : non
** KmsKeyId **
Identifiant de AWS KMS clé à utiliser lors de la restauration d'un cluster chiffré à partir d'un cluster chiffré.
L'identifiant de AWS KMS clé est le Amazon Resource Name (ARN) de la clé de AWS KMS chiffrement. Si vous restaurez un cluster Compte AWS possédant la clé de AWS KMS chiffrement utilisée pour chiffrer le nouveau cluster, vous pouvez utiliser l'alias de AWS KMS clé au lieu de l'ARN pour la clé de AWS KMS chiffrement.
Vous pouvez effectuer une restauration sur un nouveau cluster et chiffrer le nouveau cluster avec une AWS KMS clé différente de celle utilisée pour chiffrer le cluster source. AWS KMS Le nouveau cluster de base de données est chiffré avec la AWS KMS clé identifiée par le `KmsKeyId` paramètre.
Si vous ne spécifiez pas de valeur pour le paramètre `KmsKeyId` :
+ Si le cluster est chiffré, le cluster restauré est chiffré à l'aide de la AWS KMS clé utilisée pour chiffrer le cluster source.
+ Si le cluster n'est pas chiffré, le cluster restauré n'est pas chiffré.
S'il s'`DBClusterIdentifier`agit d'un cluster non chiffré, la demande de restauration est rejetée.
Type : chaîne
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
** Port **
Numéro de port sur lequel le nouveau cluster accepte les connexions.
Contraintes : il doit s'agir d'une valeur comprise entre `1150` et`65535`.
Par défaut : port par défaut du moteur.
Type : Integer
Obligatoire : non
** RestoreToTime **
La date et l'heure auxquelles restaurer le cluster.
Valeurs valides : une heure au format UTC (temps universel)
Contraintes:
+ Doit être antérieure à la dernière date de restauration de l'instance.
+ Cela doit être indiqué si le paramètre `UseLatestRestorableTime` n'est pas fourni.
+ Cela ne peut pas être spécifié lorsque le paramètre `UseLatestRestorableTime` est `true`.
+ Cela ne peut pas être spécifié lorsque le paramètre `RestoreType` est `copy-on-write`.
Exemple : `2015-03-07T23:45:00Z`
Type : Timestamp
Obligatoire : non
** RestoreType **
Type de restauration à exécuter. Vous pouvez spécifier l’une des valeurs suivantes :
+ `full-copy` - Le nouveau cluster de base de données est restauré sous la forme d'une copie intégrale du cluster de base de données source.
+ `copy-on-write` - Le nouveau cluster de base de données est restauré sous la forme d'un clone du cluster de base de données source.
Contraintes : vous ne pouvez pas spécifier `copy-on-write` si la version du moteur du cluster de base de données source est antérieure à la version 1.11.
Si vous ne spécifiez pas de valeur pour `RestoreType`, le nouveau cluster de base de données est restauré sous la forme d'une copie intégrale du cluster de base de données source.
Type : chaîne
Obligatoire : non
** ServerlessV2ScalingConfiguration **
Contient la configuration de dimensionnement d'un cluster Amazon DocumentDB Serverless.
Type : objet [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md)
Obligatoire : non
** StorageType **
Type de stockage à associer au cluster de base de données.
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
**Étiquettes.Tag.N**
Les balises à attribuer au cluster restauré.
Type : tableau d’objets [Tag](API_Tag.md)
Obligatoire : non
** UseLatestRestorableTime **
Une valeur définie sur `true` pour restaurer le cluster à la dernière heure de sauvegarde restaurable, et sur `false` dans le cas contraire.
Valeur par défaut : `false`
Contraintes : ne peut pas être spécifiée si le paramètre `RestoreToTime` est fourni.
Type : booléen
Obligatoire : non
**VpcSecurityGroupIds. VpcSecurityGroupId**N.
Liste des groupes de sécurité VPC auxquels appartient le nouveau cluster.
Type : tableau de chaînes
Obligatoire : non
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBCluster **
Informations détaillées sur un cluster.
Type : objet [DBCluster](API_DBCluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterAlreadyExistsFault **
Vous avez déjà un cluster avec l'identifiant indiqué.
Code d’état HTTP : 400
** DBClusterNotFoundFault **
`DBClusterIdentifier`ne fait pas référence à un cluster existant.
Code d’état HTTP :404
** DBClusterQuotaExceededFault **
Le cluster ne peut pas être créé car vous avez atteint le quota maximum autorisé de clusters.
Code d’état HTTP : 403
** DBClusterSnapshotNotFoundFault **
`DBClusterSnapshotIdentifier`ne fait pas référence à un instantané de cluster existant.
Code d’état HTTP :404
** DBSubnetGroupNotFoundFault **
`DBSubnetGroupName`ne fait pas référence à un groupe de sous-réseaux existant.
Code d’état HTTP :404
** InsufficientDBClusterCapacityFault **
Le cluster ne dispose pas d'une capacité suffisante pour l'opération en cours.
Code d’état HTTP : 403
** InsufficientStorageClusterCapacity **
L'espace de stockage disponible est insuffisant pour l'action en cours. Vous pouvez peut-être résoudre cette erreur en mettant à jour votre groupe de sous-réseaux afin qu'il utilise différentes zones de disponibilité disposant d'un espace de stockage plus important.
Code d’état HTTP : 400
** InvalidDBClusterSnapshotStateFault **
La valeur fournie n'est pas un état de capture d'écran de cluster valide.
Code d’état HTTP : 400
** InvalidDBClusterStateFault **
Le cluster n'est pas dans un état valide.
Code d’état HTTP : 400
** InvalidDBSnapshotState **
L'état de l'instantané ne permet pas de le supprimer.
Code d’état HTTP : 400
** InvalidRestoreFault **
Vous ne pouvez pas effectuer de restauration à partir d'une sauvegarde de cloud privé virtuel (VPC) vers une instance de base de données non VPC.
Code d’état HTTP : 400
** InvalidSubnet **
Le sous-réseau demandé n'est pas valide ou plusieurs sous-réseaux ont été demandés mais ils ne se trouvent pas tous dans un cloud privé virtuel (VPC) commun.
Code d’état HTTP : 400
** InvalidVPCNetworkStateFault **
Le groupe de sous-réseaux ne couvre pas toutes les zones de disponibilité après sa création en raison des modifications apportées.
Code d’état HTTP : 400
** KMSKeyNotAccessibleFault **
Une erreur s'est produite lors de l'accès à une AWS KMS clé.
Code d’état HTTP : 400
** NetworkTypeNotSupported **
Le type de réseau n'est pris en charge ni par `DBSubnetGroup` ni par la version du moteur de base de données.
Code d’état HTTP : 400
** StorageQuotaExceeded **
La demande vous obligerait à dépasser la quantité de stockage autorisée disponible sur toutes les instances.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/RestoreDBClusterToPointInTime)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/RestoreDBClusterToPointInTime)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/RestoreDBClusterToPointInTime)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/RestoreDBClusterToPointInTime)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/RestoreDBClusterToPointInTime)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/RestoreDBClusterToPointInTime)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/RestoreDBClusterToPointInTime)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/RestoreDBClusterToPointInTime)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/RestoreDBClusterToPointInTime)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/RestoreDBClusterToPointInTime)
# StartDBCluster
Redémarre le cluster arrêté spécifié par`DBClusterIdentifier`. Pour plus d'informations, consultez [Arrêter et démarrer un cluster Amazon DocumentDB.](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html)
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterIdentifier **
Identifiant du cluster à redémarrer. Exemple : `docdb-2019-05-28-15-24-52`
Type : Chaîne
Obligatoire : oui
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBCluster **
Informations détaillées sur un cluster.
Type : objet [DBCluster](API_DBCluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`ne fait pas référence à un cluster existant.
Code d’état HTTP :404
** InvalidDBClusterStateFault **
Le cluster n'est pas dans un état valide.
Code d’état HTTP : 400
** InvalidDBInstanceState **
L'instance spécifiée n'est pas dans l'état *disponible*.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/StartDBCluster)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/StartDBCluster)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/StartDBCluster)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/StartDBCluster)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/StartDBCluster)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/StartDBCluster)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/StartDBCluster)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/StartDBCluster)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/StartDBCluster)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/StartDBCluster)
# StopDBCluster
Arrête le cluster en cours d'exécution spécifié par`DBClusterIdentifier`. Le cluster doit être dans l'état *disponible*. Pour plus d'informations, consultez [Arrêter et démarrer un cluster Amazon DocumentDB.](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html)
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** DBClusterIdentifier **
Identifiant du cluster à arrêter. Exemple : `docdb-2019-05-28-15-24-52`
Type : Chaîne
Obligatoire : oui
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** DBCluster **
Informations détaillées sur un cluster.
Type : objet [DBCluster](API_DBCluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`ne fait pas référence à un cluster existant.
Code d’état HTTP :404
** InvalidDBClusterStateFault **
Le cluster n'est pas dans un état valide.
Code d’état HTTP : 400
** InvalidDBInstanceState **
L'instance spécifiée n'est pas dans l'état *disponible*.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/StopDBCluster)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/StopDBCluster)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/StopDBCluster)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/StopDBCluster)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/StopDBCluster)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/StopDBCluster)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/StopDBCluster)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/StopDBCluster)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/StopDBCluster)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/StopDBCluster)
# SwitchoverGlobalCluster
Bascule le cluster Amazon DocumentDB secondaire spécifié en nouveau cluster Amazon DocumentDB principal dans le cluster de base de données global.
## Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez [Paramètres courants](CommonParameters.md).
** GlobalClusterIdentifier **
Identifiant du cluster de bases de données global Amazon DocumentDB à basculer. L'identifiant est la clé unique attribuée par l'utilisateur lors de la création du cluster. En d'autres termes, il s'agit du nom du cluster mondial. Ce paramètre ne fait pas la distinction majuscules/minuscules.
Contraintes:
+ Doit correspondre à l'identifiant d'un cluster global existant (base de données globale Amazon DocumentDB).
+ Longueur minimale de 1. Longueur maximale de 255 caractères.
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`
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 : oui
** TargetDbClusterIdentifier **
Identifiant du cluster Amazon DocumentDB secondaire à promouvoir en tant que nouveau cluster principal pour le cluster de bases de données global. Utilisez l'Amazon Resource Name (ARN) comme identifiant afin qu'Amazon DocumentDB puisse localiser le cluster dans sa AWS région.
Contraintes:
+ Doit correspondre à l'identifiant d'un cluster secondaire existant.
+ Longueur minimale de 1. Longueur maximale de 255 caractères.
Modèle : `[A-Za-z][0-9A-Za-z-:._]*`
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 : oui
## Éléments de réponse
L'élément suivant est renvoyé par le service.
** GlobalCluster **
Type de données représentant un cluster global Amazon DocumentDB.
Type : objet [GlobalCluster](API_GlobalCluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** DBClusterNotFoundFault **
`DBClusterIdentifier`ne fait pas référence à un cluster existant.
Code d’état HTTP :404
** GlobalClusterNotFoundFault **
`GlobalClusterIdentifier`Cela ne fait pas référence à un cluster mondial existant.
Code d’état HTTP :404
** InvalidDBClusterStateFault **
Le cluster n'est pas dans un état valide.
Code d’état HTTP : 400
** InvalidGlobalClusterStateFault **
L'opération demandée ne peut pas être effectuée tant que le cluster est dans cet état.
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-2014-10-31/SwitchoverGlobalCluster)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-2014-10-31/SwitchoverGlobalCluster)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/SwitchoverGlobalCluster)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-2014-10-31/SwitchoverGlobalCluster)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/SwitchoverGlobalCluster)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-2014-10-31/SwitchoverGlobalCluster)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-2014-10-31/SwitchoverGlobalCluster)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-2014-10-31/SwitchoverGlobalCluster)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-2014-10-31/SwitchoverGlobalCluster)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/SwitchoverGlobalCluster)
# Clusters Amazon DocumentDB Elastic
Les actions suivantes sont prises en charge par Amazon DocumentDB Elastic Clusters :
+ [ApplyPendingMaintenanceAction](API_elastic_ApplyPendingMaintenanceAction.md)
+ [CopyClusterSnapshot](API_elastic_CopyClusterSnapshot.md)
+ [CreateCluster](API_elastic_CreateCluster.md)
+ [CreateClusterSnapshot](API_elastic_CreateClusterSnapshot.md)
+ [DeleteCluster](API_elastic_DeleteCluster.md)
+ [DeleteClusterSnapshot](API_elastic_DeleteClusterSnapshot.md)
+ [GetCluster](API_elastic_GetCluster.md)
+ [GetClusterSnapshot](API_elastic_GetClusterSnapshot.md)
+ [GetPendingMaintenanceAction](API_elastic_GetPendingMaintenanceAction.md)
+ [ListClusters](API_elastic_ListClusters.md)
+ [ListClusterSnapshots](API_elastic_ListClusterSnapshots.md)
+ [ListPendingMaintenanceActions](API_elastic_ListPendingMaintenanceActions.md)
+ [ListTagsForResource](API_elastic_ListTagsForResource.md)
+ [RestoreClusterFromSnapshot](API_elastic_RestoreClusterFromSnapshot.md)
+ [StartCluster](API_elastic_StartCluster.md)
+ [StopCluster](API_elastic_StopCluster.md)
+ [TagResource](API_elastic_TagResource.md)
+ [UntagResource](API_elastic_UntagResource.md)
+ [UpdateCluster](API_elastic_UpdateCluster.md)
# ApplyPendingMaintenanceAction
Type d'action de maintenance en attente à appliquer à la ressource.
## Syntaxe de la demande
```
POST /pending-action HTTP/1.1
Content-type: application/json
{
"applyAction": "string",
"applyOn": "string",
"optInType": "string",
"resourceArn": "string"
}
```
## Paramètres de demande URI
La demande n’utilise pas de paramètres URI.
## Corps de la demande
Cette demande accepte les données suivantes au format JSON.
** [applyAction](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **
L'action de maintenance en attente à appliquer à la ressource.
Les actions valides sont :
+ `ENGINE_UPDATE `
+ `ENGINE_UPGRADE`
+ `SECURITY_UPDATE`
+ `OS_UPDATE`
+ `MASTER_USER_PASSWORD_UPDATE`
Type : Chaîne
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 256.
Obligatoire : oui
** [optInType](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **
Valeur qui spécifie le type de demande de confirmation de l'acceptation ou annule cette dernière. Un type demande de confirmation de l'acceptation de type `IMMEDIATE` ne peut pas être annulée.
Type : Chaîne
Valeurs valides : `IMMEDIATE | NEXT_MAINTENANCE | APPLY_ON | UNDO_OPT_IN`
Obligatoire : oui
** [resourceArn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **
Nom de ressource Amazon DocumentDB (ARN) Amazon DocumentDB de la ressource à laquelle s'applique l'action de maintenance en attente.
Type : Chaîne
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 256.
Obligatoire : oui
** [applyOn](#API_elastic_ApplyPendingMaintenanceAction_RequestSyntax) **
Une date précise pour appliquer l'action de maintenance en attente. Obligatoire si opt-in-type a pour valeur `APPLY_ON`. Format : `yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm`
Type : Chaîne
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 256.
Obligatoire : non
## Syntaxe de la réponse
```
HTTP/1.1 200
Content-type: application/json
{
"resourcePendingMaintenanceAction": {
"pendingMaintenanceActionDetails": [
{
"action": "string",
"autoAppliedAfterDate": "string",
"currentApplyDate": "string",
"description": "string",
"forcedApplyDate": "string",
"optInStatus": "string"
}
],
"resourceArn": "string"
}
}
```
## Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
** [resourcePendingMaintenanceAction](#API_elastic_ApplyPendingMaintenanceAction_ResponseSyntax) **
Résultat de l'action de maintenance en attente appliquée.
Type : objet [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** AccessDeniedException **
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.
** message **
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403
** ConflictException **
Il y a eu un conflit d'accès.
** resourceId **
L'ID de la ressource où il y a eu un conflit d'accès.
** resourceType **
Type de ressource ayant fait l'objet d'un conflit d'accès.
Code d’état HTTP : 409
** InternalServerException **
Une erreur interne s'est produite au niveau du serveur.
Code d’état HTTP : 500
** ResourceNotFoundException **
La ressource spécifiée n'a pas pu être localisée.
** message **
Un message d'erreur décrivant l'échec.
** resourceId **
L'ID de la ressource introuvable.
** resourceType **
Type de ressource introuvable.
Code d’état HTTP :404
** ThrottlingException **
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.
** retryAfterSeconds **
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429
** ValidationException **
Structure définissant une exception de validation.
** fieldList **
Liste des champs dans lesquels l'exception de validation s'est produite.
** message **
Message d'erreur décrivant l'exception de validation.
** reason **
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ApplyPendingMaintenanceAction)
# CopyClusterSnapshot
Copie un instantané d'un cluster élastique.
## Syntaxe de la demande
```
POST /cluster-snapshot/snapshotArn/copy HTTP/1.1
Content-type: application/json
{
"copyTags": boolean,
"kmsKeyId": "string",
"tags": {
"string" : "string"
},
"targetSnapshotName": "string"
}
```
## Paramètres de demande URI
La demande utilise les paramètres URI suivants.
** [snapshotArn](#API_elastic_CopyClusterSnapshot_RequestSyntax) **
L'identifiant Amazon Resource Name (ARN) de l'instantané du cluster élastique.
Obligatoire : oui
## Corps de la demande
Cette demande accepte les données suivantes au format JSON.
** [targetSnapshotName](#API_elastic_CopyClusterSnapshot_RequestSyntax) **
Identifiant du nouvel instantané de cluster élastique à créer à partir de l'instantané de cluster source. Ce paramètre n'est pas sensible à la casse.
Contraintes:
+ Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union.
+ Le premier caractère doit être une lettre.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
Exemple : `elastic-cluster-snapshot-5`
Type : Chaîne
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.
Obligatoire : oui
** [copyTags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **
Définissez sur `true` pour copier toutes les balises de l'instantané du cluster source vers l'instantané du cluster élastique cible. La valeur par défaut est `false`.
Type : booléen
Obligatoire : non
** [kmsKeyId](#API_elastic_CopyClusterSnapshot_RequestSyntax) **
ID de clé AWS KMS pour un instantané de cluster élastique chiffré. L'ID de clé AWS KMS est le nom de ressource Amazon (ARN), l'identifiant de clé AWS KMS ou l'alias de clé AWS KMS pour la clé de chiffrement AWS KMS.
Si vous copiez un instantané chiffré du cluster Elastic depuis votre AWS compte, vous pouvez spécifier une valeur `KmsKeyId` pour chiffrer la copie avec une nouvelle clé de chiffrement AWS S KMS. Si vous ne spécifiez aucune valeur pour`KmsKeyId`, la copie de l'instantané du cluster élastique est chiffrée avec la même clé `AWS` KMS que l'instantané du cluster élastique source.
Si vous copiez un instantané d'un cluster élastique non chiffré et que vous spécifiez une valeur pour le `KmsKeyId` paramètre, une erreur est renvoyée.
Type : chaîne
Obligatoire : non
** [tags](#API_elastic_CopyClusterSnapshot_RequestSyntax) **
Les balises à attribuer à l'instantané du cluster élastique.
Type : mappage chaîne/chaîne
Contraintes de longueur de clé : longueur minimale de 1. Longueur maximale de 128.
Modèle de clé :`(?!aws:)[a-zA-Z+-=._:/]+`
Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximale de 256.
Obligatoire : non
## Syntaxe de la réponse
```
HTTP/1.1 200
Content-type: application/json
{
"snapshot": {
"adminUserName": "string",
"clusterArn": "string",
"clusterCreationTime": "string",
"kmsKeyId": "string",
"snapshotArn": "string",
"snapshotCreationTime": "string",
"snapshotName": "string",
"snapshotType": "string",
"status": "string",
"subnetIds": [ "string" ],
"vpcSecurityGroupIds": [ "string" ]
}
}
```
## Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
** [snapshot](#API_elastic_CopyClusterSnapshot_ResponseSyntax) **
Renvoie des informations sur un instantané de cluster élastique spécifique.
Type : objet [ClusterSnapshot](API_elastic_ClusterSnapshot.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** AccessDeniedException **
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.
** message **
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403
** ConflictException **
Il y a eu un conflit d'accès.
** resourceId **
L'ID de la ressource où il y a eu un conflit d'accès.
** resourceType **
Type de ressource ayant fait l'objet d'un conflit d'accès.
Code d’état HTTP : 409
** InternalServerException **
Une erreur interne du serveur s'est produite.
Code d’état HTTP : 500
** ResourceNotFoundException **
La ressource spécifiée n'a pas pu être localisée.
** message **
Un message d'erreur décrivant l'échec.
** resourceId **
ID de la ressource introuvable.
** resourceType **
Type de ressource introuvable.
Code d’état HTTP :404
** ServiceQuotaExceededException **
Le quota de service pour l'action a été dépassé.
Code d'état HTTP : 402
** ThrottlingException **
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.
** retryAfterSeconds **
Le nombre de secondes à attendre avant de recommencer l'opération.
Code d’état HTTP : 429
** ValidationException **
Structure définissant une exception de validation.
** fieldList **
Liste des champs dans lesquels l'exception de validation s'est produite.
** message **
Message d'erreur décrivant l'exception de validation.
** reason **
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CopyClusterSnapshot)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CopyClusterSnapshot)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CopyClusterSnapshot)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CopyClusterSnapshot)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CopyClusterSnapshot)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CopyClusterSnapshot)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CopyClusterSnapshot)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CopyClusterSnapshot)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CopyClusterSnapshot)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CopyClusterSnapshot)
# CreateCluster
Crée un nouveau cluster élastique Amazon DocumentDB et renvoie sa structure de cluster.
## Syntaxe de la demande
```
POST /cluster HTTP/1.1
Content-type: application/json
{
"adminUserName": "string",
"adminUserPassword": "string",
"authType": "string",
"backupRetentionPeriod": number,
"clientToken": "string",
"clusterName": "string",
"kmsKeyId": "string",
"preferredBackupWindow": "string",
"preferredMaintenanceWindow": "string",
"shardCapacity": number,
"shardCount": number,
"shardInstanceCount": number,
"subnetIds": [ "string" ],
"tags": {
"string" : "string"
},
"vpcSecurityGroupIds": [ "string" ]
}
```
## Paramètres de demande URI
La demande n’utilise pas de paramètres URI.
## Corps de la demande
Cette demande accepte les données suivantes au format JSON.
** [adminUserName](#API_elastic_CreateCluster_RequestSyntax) **
Nom de l'administrateur des clusters élastiques Amazon DocumentDB.
*Contraintes* :
+ Doit comporter entre 1 et 63 lettres ou chiffres.
+ Le premier caractère doit être une lettre.
+ Ne peut pas être un mot réservé.
Type : Chaîne
Obligatoire : oui
** [adminUserPassword](#API_elastic_CreateCluster_RequestSyntax) **
Le mot de passe de l'administrateur des clusters élastiques Amazon DocumentDB. Le mot de passe peut contenir n'importe quel caractère ASCII imprimable.
*Contraintes* :
+ Doit contenir de 8 à 100 caractères.
+ Ne peut pas contenir de barre oblique (/), de guillemet double («) ou le symbole « at » (@).
Type : Chaîne
Obligatoire : oui
** [authType](#API_elastic_CreateCluster_RequestSyntax) **
Type d'authentification utilisé pour déterminer où récupérer le mot de passe utilisé pour accéder au cluster élastique. Les types valides sont `PLAIN_TEXT` ou`SECRET_ARN`.
Type : Chaîne
Valeurs valides : `PLAIN_TEXT | SECRET_ARN`
Obligatoire : oui
** [clusterName](#API_elastic_CreateCluster_RequestSyntax) **
Nom du nouveau cluster élastique. Ce paramètre est stocké sous la forme d'une chaîne en lettres minuscules.
*Contraintes* :
+ Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union.
+ Le premier caractère doit être une lettre.
+ Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.
*Exemple* : `my-cluster`
Type : Chaîne
Obligatoire : oui
** [shardCapacity](#API_elastic_CreateCluster_RequestSyntax) **
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 : Integer
Obligatoire : oui
** [shardCount](#API_elastic_CreateCluster_RequestSyntax) **
Le nombre de partitions attribuées au cluster élastique. Le maximum est de 32.
Type : Integer
Obligatoire : oui
** [backupRetentionPeriod](#API_elastic_CreateCluster_RequestSyntax) **
Nombre de jours pendant lesquels les instantanés automatiques sont conservés.
Type : Integer
Obligatoire : non
** [clientToken](#API_elastic_CreateCluster_RequestSyntax) **
Le jeton client pour le cluster élastique.
Type : chaîne
Obligatoire : non
** [kmsKeyId](#API_elastic_CreateCluster_RequestSyntax) **
Identifiant de clé KMS à utiliser pour chiffrer le nouveau cluster élastique.
L'identifiant de clé KMS est l'Amazon Resource Name (ARN) de la clé de chiffrement KMS. Si vous créez un cluster en utilisant le 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, 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 : chaîne
Obligatoire : non
** [preferredBackupWindow](#API_elastic_CreateCluster_RequestSyntax) **
La plage horaire quotidienne pendant laquelle les sauvegardes automatisées sont créées si les sauvegardes automatisées sont activées, comme déterminé par le`backupRetentionPeriod`.
Type : chaîne
Obligatoire : non
** [preferredMaintenanceWindow](#API_elastic_CreateCluster_RequestSyntax) **
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`
*Par défaut* : une fenêtre de 30 minutes sélectionnée au hasard dans un intervalle de 8 heures pour chacune d'elles Région AWS, survenant un jour aléatoire de la semaine.
*Jours valides* : lundi, mardi, mercredi, jeudi, vendredi, samedi, dimanche
*Contraintes* : fenêtre minimale de 30 minutes.
Type : chaîne
Obligatoire : non
** [shardInstanceCount](#API_elastic_CreateCluster_RequestSyntax) **
Le nombre d'instances de répliques s'appliquant à toutes les partitions du cluster élastique. 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 : Integer
Obligatoire : non
** [subnetIds](#API_elastic_CreateCluster_RequestSyntax) **
Le sous-réseau Amazon EC2 IDs pour le nouveau cluster élastique.
Type : tableau de chaînes
Obligatoire : non
** [tags](#API_elastic_CreateCluster_RequestSyntax) **
Les balises à attribuer au nouveau cluster élastique.
Type : mappage chaîne/chaîne
Contraintes de longueur de clé : longueur minimale de 1. Longueur maximale de 128.
Modèle de clé :`(?!aws:)[a-zA-Z+-=._:/]+`
Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximale de 256.
Obligatoire : non
** [vpcSecurityGroupIds](#API_elastic_CreateCluster_RequestSyntax) **
Liste des groupes de sécurité VPC EC2 à associer au nouveau cluster élastique.
Type : tableau de chaînes
Obligatoire : non
## Syntaxe de la réponse
```
HTTP/1.1 200
Content-type: application/json
{
"cluster": {
"adminUserName": "string",
"authType": "string",
"backupRetentionPeriod": number,
"clusterArn": "string",
"clusterEndpoint": "string",
"clusterName": "string",
"createTime": "string",
"kmsKeyId": "string",
"preferredBackupWindow": "string",
"preferredMaintenanceWindow": "string",
"shardCapacity": number,
"shardCount": number,
"shardInstanceCount": number,
"shards": [
{
"createTime": "string",
"shardId": "string",
"status": "string"
}
],
"status": "string",
"subnetIds": [ "string" ],
"vpcSecurityGroupIds": [ "string" ]
}
}
```
## Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
** [cluster](#API_elastic_CreateCluster_ResponseSyntax) **
Le nouveau cluster élastique qui a été créé.
Type : objet [Cluster](API_elastic_Cluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** AccessDeniedException **
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.
** message **
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403
** ConflictException **
Il y a eu un conflit d'accès.
** resourceId **
L'ID de la ressource où il y a eu un conflit d'accès.
** resourceType **
Type de ressource ayant fait l'objet d'un conflit d'accès.
Code d’état HTTP : 409
** InternalServerException **
Une erreur interne du serveur s'est produite.
Code d’état HTTP : 500
** ServiceQuotaExceededException **
Le quota de service pour l'action a été dépassé.
Code d'état HTTP : 402
** ThrottlingException **
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.
** retryAfterSeconds **
Le nombre de secondes à attendre avant de recommencer l'opération.
Code d’état HTTP : 429
** ValidationException **
Structure définissant une exception de validation.
** fieldList **
Liste des champs dans lesquels l'exception de validation s'est produite.
** message **
Message d'erreur décrivant l'exception de validation.
** reason **
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateCluster)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateCluster)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateCluster)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateCluster)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateCluster)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateCluster)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateCluster)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateCluster)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateCluster)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateCluster)
# CreateClusterSnapshot
Crée un instantané d'un cluster élastique.
## Syntaxe de la demande
```
POST /cluster-snapshot HTTP/1.1
Content-type: application/json
{
"clusterArn": "string",
"snapshotName": "string",
"tags": {
"string" : "string"
}
}
```
## Paramètres de demande URI
La demande n’utilise pas de paramètres URI.
## Corps de la demande
Cette demande accepte les données suivantes au format JSON.
** [clusterArn](#API_elastic_CreateClusterSnapshot_RequestSyntax) **
Identifiant ARN du cluster élastique dont vous souhaitez créer un instantané.
Type : Chaîne
Obligatoire : oui
** [snapshotName](#API_elastic_CreateClusterSnapshot_RequestSyntax) **
Nom du nouvel instantané du cluster élastique.
Type : Chaîne
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 63.
Obligatoire : oui
** [tags](#API_elastic_CreateClusterSnapshot_RequestSyntax) **
Les balises à attribuer au nouvel instantané du cluster élastique.
Type : mappage chaîne/chaîne
Contraintes de longueur de clé : longueur minimale de 1. Longueur maximale de 128.
Modèle de clé :`(?!aws:)[a-zA-Z+-=._:/]+`
Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximale de 256.
Obligatoire : non
## Syntaxe de la réponse
```
HTTP/1.1 200
Content-type: application/json
{
"snapshot": {
"adminUserName": "string",
"clusterArn": "string",
"clusterCreationTime": "string",
"kmsKeyId": "string",
"snapshotArn": "string",
"snapshotCreationTime": "string",
"snapshotName": "string",
"snapshotType": "string",
"status": "string",
"subnetIds": [ "string" ],
"vpcSecurityGroupIds": [ "string" ]
}
}
```
## Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
** [snapshot](#API_elastic_CreateClusterSnapshot_ResponseSyntax) **
Renvoie des informations sur le nouvel instantané du cluster élastique.
Type : objet [ClusterSnapshot](API_elastic_ClusterSnapshot.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** AccessDeniedException **
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.
** message **
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403
** ConflictException **
Il y a eu un conflit d'accès.
** resourceId **
L'ID de la ressource où il y a eu un conflit d'accès.
** resourceType **
Type de ressource ayant fait l'objet d'un conflit d'accès.
Code d’état HTTP : 409
** InternalServerException **
Une erreur interne du serveur s'est produite.
Code d’état HTTP : 500
** ResourceNotFoundException **
La ressource spécifiée n'a pas pu être localisée.
** message **
Un message d'erreur décrivant l'échec.
** resourceId **
L'ID de la ressource introuvable.
** resourceType **
Type de ressource introuvable.
Code d’état HTTP :404
** ServiceQuotaExceededException **
Le quota de service pour l'action a été dépassé.
Code d'état HTTP : 402
** ThrottlingException **
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.
** retryAfterSeconds **
Le nombre de secondes à attendre avant de recommencer l'opération.
Code d’état HTTP : 429
** ValidationException **
Structure définissant une exception de validation.
** fieldList **
Liste des champs dans lesquels l'exception de validation s'est produite.
** message **
Message d'erreur décrivant l'exception de validation.
** reason **
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/CreateClusterSnapshot)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/CreateClusterSnapshot)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/CreateClusterSnapshot)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/CreateClusterSnapshot)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/CreateClusterSnapshot)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/CreateClusterSnapshot)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/CreateClusterSnapshot)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/CreateClusterSnapshot)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/CreateClusterSnapshot)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/CreateClusterSnapshot)
# DeleteCluster
Supprimez un cluster élastique.
## Syntaxe de la demande
```
DELETE /cluster/clusterArn HTTP/1.1
```
## Paramètres de demande URI
La demande utilise les paramètres URI suivants.
** [clusterArn](#API_elastic_DeleteCluster_RequestSyntax) **
Identifiant ARN du cluster élastique à supprimer.
Obligatoire : oui
## Corps de la demande
La demande n’a pas de corps de requête.
## Syntaxe de la réponse
```
HTTP/1.1 200
Content-type: application/json
{
"cluster": {
"adminUserName": "string",
"authType": "string",
"backupRetentionPeriod": number,
"clusterArn": "string",
"clusterEndpoint": "string",
"clusterName": "string",
"createTime": "string",
"kmsKeyId": "string",
"preferredBackupWindow": "string",
"preferredMaintenanceWindow": "string",
"shardCapacity": number,
"shardCount": number,
"shardInstanceCount": number,
"shards": [
{
"createTime": "string",
"shardId": "string",
"status": "string"
}
],
"status": "string",
"subnetIds": [ "string" ],
"vpcSecurityGroupIds": [ "string" ]
}
}
```
## Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
** [cluster](#API_elastic_DeleteCluster_ResponseSyntax) **
Renvoie des informations sur le cluster élastique récemment supprimé.
Type : objet [Cluster](API_elastic_Cluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** AccessDeniedException **
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.
** message **
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403
** ConflictException **
Il y a eu un conflit d'accès.
** resourceId **
L'ID de la ressource où il y a eu un conflit d'accès.
** resourceType **
Type de ressource ayant fait l'objet d'un conflit d'accès.
Code d’état HTTP : 409
** InternalServerException **
Une erreur interne du serveur s'est produite.
Code d’état HTTP : 500
** ResourceNotFoundException **
La ressource spécifiée n'a pas pu être localisée.
** message **
Un message d'erreur décrivant l'échec.
** resourceId **
L'ID de la ressource introuvable.
** resourceType **
Type de ressource introuvable.
Code d’état HTTP :404
** ThrottlingException **
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.
** retryAfterSeconds **
Le nombre de secondes à attendre avant de recommencer l'opération.
Code d’état HTTP : 429
** ValidationException **
Structure définissant une exception de validation.
** fieldList **
Liste des champs dans lesquels l'exception de validation s'est produite.
** message **
Message d'erreur décrivant l'exception de validation.
** reason **
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteCluster)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteCluster)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteCluster)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteCluster)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteCluster)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteCluster)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteCluster)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteCluster)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteCluster)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteCluster)
# DeleteClusterSnapshot
Supprimez un instantané d'Elastic Cluster.
## Syntaxe de la demande
```
DELETE /cluster-snapshot/snapshotArn HTTP/1.1
```
## Paramètres de demande URI
La demande utilise les paramètres URI suivants.
** [snapshotArn](#API_elastic_DeleteClusterSnapshot_RequestSyntax) **
Identifiant ARN de l'instantané du cluster élastique à supprimer.
Obligatoire : oui
## Corps de la demande
La demande n’a pas de corps de requête.
## Syntaxe de la réponse
```
HTTP/1.1 200
Content-type: application/json
{
"snapshot": {
"adminUserName": "string",
"clusterArn": "string",
"clusterCreationTime": "string",
"kmsKeyId": "string",
"snapshotArn": "string",
"snapshotCreationTime": "string",
"snapshotName": "string",
"snapshotType": "string",
"status": "string",
"subnetIds": [ "string" ],
"vpcSecurityGroupIds": [ "string" ]
}
}
```
## Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
** [snapshot](#API_elastic_DeleteClusterSnapshot_ResponseSyntax) **
Renvoie des informations sur le cliché du cluster élastique récemment supprimé.
Type : objet [ClusterSnapshot](API_elastic_ClusterSnapshot.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** AccessDeniedException **
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.
** message **
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403
** ConflictException **
Il y a eu un conflit d'accès.
** resourceId **
L'ID de la ressource où il y a eu un conflit d'accès.
** resourceType **
Type de ressource ayant fait l'objet d'un conflit d'accès.
Code d’état HTTP : 409
** InternalServerException **
Une erreur interne s'est produite au niveau du serveur.
Code d’état HTTP : 500
** ResourceNotFoundException **
La ressource spécifiée n'a pas pu être localisée.
** message **
Un message d'erreur décrivant l'échec.
** resourceId **
L'ID de la ressource introuvable.
** resourceType **
Type de ressource introuvable.
Code d’état HTTP :404
** ThrottlingException **
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.
** retryAfterSeconds **
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429
** ValidationException **
Structure définissant une exception de validation.
** fieldList **
Liste des champs dans lesquels l'exception de validation s'est produite.
** message **
Message d'erreur décrivant l'exception de validation.
** reason **
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/DeleteClusterSnapshot)
# GetCluster
Renvoie des informations sur un cluster élastique spécifique.
## Syntaxe de la demande
```
GET /cluster/clusterArn HTTP/1.1
```
## Paramètres de demande URI
La demande utilise les paramètres URI suivants.
** [clusterArn](#API_elastic_GetCluster_RequestSyntax) **
L'identifiant ARN du cluster élastique.
Obligatoire : oui
## Corps de la demande
La demande n’a pas de corps de requête.
## Syntaxe de la réponse
```
HTTP/1.1 200
Content-type: application/json
{
"cluster": {
"adminUserName": "string",
"authType": "string",
"backupRetentionPeriod": number,
"clusterArn": "string",
"clusterEndpoint": "string",
"clusterName": "string",
"createTime": "string",
"kmsKeyId": "string",
"preferredBackupWindow": "string",
"preferredMaintenanceWindow": "string",
"shardCapacity": number,
"shardCount": number,
"shardInstanceCount": number,
"shards": [
{
"createTime": "string",
"shardId": "string",
"status": "string"
}
],
"status": "string",
"subnetIds": [ "string" ],
"vpcSecurityGroupIds": [ "string" ]
}
}
```
## Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
** [cluster](#API_elastic_GetCluster_ResponseSyntax) **
Renvoie des informations sur un cluster élastique spécifique.
Type : objet [Cluster](API_elastic_Cluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** AccessDeniedException **
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.
** message **
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403
** InternalServerException **
Une erreur interne du serveur s'est produite.
Code d’état HTTP : 500
** ResourceNotFoundException **
La ressource spécifiée n'a pas pu être localisée.
** message **
Un message d'erreur décrivant l'échec.
** resourceId **
L'ID de la ressource introuvable.
** resourceType **
Type de ressource introuvable.
Code d’état HTTP :404
** ThrottlingException **
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.
** retryAfterSeconds **
Le nombre de secondes à attendre avant de recommencer l'opération.
Code d’état HTTP : 429
** ValidationException **
Structure définissant une exception de validation.
** fieldList **
Liste des champs dans lesquels l'exception de validation s'est produite.
** message **
Message d'erreur décrivant l'exception de validation.
** reason **
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetCluster)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetCluster)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetCluster)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetCluster)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetCluster)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetCluster)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetCluster)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetCluster)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetCluster)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetCluster)
# GetClusterSnapshot
Renvoie des informations sur un instantané de cluster élastique spécifique
## Syntaxe de la demande
```
GET /cluster-snapshot/snapshotArn HTTP/1.1
```
## Paramètres de demande URI
La demande utilise les paramètres URI suivants.
** [snapshotArn](#API_elastic_GetClusterSnapshot_RequestSyntax) **
Identifiant ARN de l'instantané du cluster élastique.
Obligatoire : oui
## Corps de la demande
La demande n’a pas de corps de requête.
## Syntaxe de la réponse
```
HTTP/1.1 200
Content-type: application/json
{
"snapshot": {
"adminUserName": "string",
"clusterArn": "string",
"clusterCreationTime": "string",
"kmsKeyId": "string",
"snapshotArn": "string",
"snapshotCreationTime": "string",
"snapshotName": "string",
"snapshotType": "string",
"status": "string",
"subnetIds": [ "string" ],
"vpcSecurityGroupIds": [ "string" ]
}
}
```
## Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
** [snapshot](#API_elastic_GetClusterSnapshot_ResponseSyntax) **
Renvoie des informations sur un instantané de cluster élastique spécifique.
Type : objet [ClusterSnapshot](API_elastic_ClusterSnapshot.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** AccessDeniedException **
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.
** message **
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403
** InternalServerException **
Une erreur interne s'est produite au niveau du serveur.
Code d’état HTTP : 500
** ResourceNotFoundException **
La ressource spécifiée n'a pas pu être localisée.
** message **
Un message d'erreur décrivant l'échec.
** resourceId **
L'ID de la ressource qui n'a pas pu être localisée.
** resourceType **
Type de ressource introuvable.
Code d’état HTTP :404
** ThrottlingException **
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.
** retryAfterSeconds **
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429
** ValidationException **
Structure définissant une exception de validation.
** fieldList **
Liste des champs dans lesquels l'exception de validation s'est produite.
** message **
Message d'erreur décrivant l'exception de validation.
** reason **
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetClusterSnapshot)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetClusterSnapshot)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetClusterSnapshot)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetClusterSnapshot)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetClusterSnapshot)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetClusterSnapshot)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetClusterSnapshot)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetClusterSnapshot)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetClusterSnapshot)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetClusterSnapshot)
# GetPendingMaintenanceAction
Récupère toutes les actions de maintenance en attente.
## Syntaxe de la demande
```
GET /pending-action/resourceArn HTTP/1.1
```
## Paramètres de demande URI
La demande utilise les paramètres URI suivants.
** [resourceArn](#API_elastic_GetPendingMaintenanceAction_RequestSyntax) **
Récupère les actions de maintenance en attente pour un Amazon Resource Name (ARN) spécifique.
Contraintes de longueur : longueur minimale de 1 caractère. Longueur maximale de 256.
Obligatoire : oui
## Corps de la demande
La demande n’a pas de corps de requête.
## Syntaxe de la réponse
```
HTTP/1.1 200
Content-type: application/json
{
"resourcePendingMaintenanceAction": {
"pendingMaintenanceActionDetails": [
{
"action": "string",
"autoAppliedAfterDate": "string",
"currentApplyDate": "string",
"description": "string",
"forcedApplyDate": "string",
"optInStatus": "string"
}
],
"resourceArn": "string"
}
}
```
## Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
** [resourcePendingMaintenanceAction](#API_elastic_GetPendingMaintenanceAction_ResponseSyntax) **
Fournit des informations sur une action de maintenance en attente pour une ressource.
Type : objet [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** AccessDeniedException **
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.
** message **
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403
** ConflictException **
Il y a eu un conflit d'accès.
** resourceId **
L'ID de la ressource où il y a eu un conflit d'accès.
** resourceType **
Type de ressource ayant fait l'objet d'un conflit d'accès.
Code d’état HTTP : 409
** InternalServerException **
Une erreur interne du serveur s'est produite.
Code d’état HTTP : 500
** ResourceNotFoundException **
La ressource spécifiée n'a pas pu être localisée.
** message **
Un message d'erreur décrivant l'échec.
** resourceId **
L'ID de la ressource introuvable.
** resourceType **
Type de ressource introuvable.
Code d’état HTTP :404
** ThrottlingException **
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.
** retryAfterSeconds **
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429
** ValidationException **
Structure définissant une exception de validation.
** fieldList **
Liste des champs dans lesquels l'exception de validation s'est produite.
** message **
Message d'erreur décrivant l'exception de validation.
** reason **
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/GetPendingMaintenanceAction)
# ListClusters
Renvoie des informations sur les clusters élastiques Amazon DocumentDB provisionnés.
## Syntaxe de la demande
```
GET /clusters?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```
## Paramètres de demande URI
La demande utilise les paramètres URI suivants.
** [maxResults](#API_elastic_ListClusters_RequestSyntax) **
Le nombre maximal de résultats de capture instantanée du cluster élastique à recevoir dans la réponse.
Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.
** [nextToken](#API_elastic_ListClusters_RequestSyntax) **
Un jeton de pagination fourni par une demande précédente. Si ce paramètre est spécifié, la réponse inclut uniquement les enregistrements situés au-delà de ce jeton, jusqu'à la valeur spécifiée par`max-results`.
S'il n'y a plus de données dans la réponse, elles ne `nextToken` seront pas renvoyées.
## Corps de la requête
La demande n’a pas de corps de requête.
## Syntaxe de la réponse
```
HTTP/1.1 200
Content-type: application/json
{
"clusters": [
{
"clusterArn": "string",
"clusterName": "string",
"status": "string"
}
],
"nextToken": "string"
}
```
## Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
** [clusters](#API_elastic_ListClusters_ResponseSyntax) **
Liste des clusters élastiques Amazon DocumentDB.
Type : tableau d’objets [ClusterInList](API_elastic_ClusterInList.md)
** [nextToken](#API_elastic_ListClusters_ResponseSyntax) **
Un jeton de pagination fourni par une demande précédente. Si ce paramètre est spécifié, la réponse inclut uniquement les enregistrements situés au-delà de ce jeton, jusqu'à la valeur spécifiée par`max-results`.
S'il n'y a plus de données dans la réponse, elles ne `nextToken` seront pas renvoyées.
Type : Chaîne
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** AccessDeniedException **
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.
** message **
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403
** InternalServerException **
Une erreur interne s'est produite au niveau du serveur.
Code d’état HTTP : 500
** ThrottlingException **
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.
** retryAfterSeconds **
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429
** ValidationException **
Structure définissant une exception de validation.
** fieldList **
Liste des champs dans lesquels l'exception de validation s'est produite.
** message **
Message d'erreur décrivant l'exception de validation.
** reason **
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusters)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusters)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusters)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusters)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusters)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusters)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusters)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusters)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusters)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusters)
# ListClusterSnapshots
Renvoie des informations sur les instantanés d'un cluster élastique spécifié.
## Syntaxe de la demande
```
GET /cluster-snapshots?clusterArn=clusterArn&maxResults=maxResults&nextToken=nextToken&snapshotType=snapshotType HTTP/1.1
```
## Paramètres de demande URI
La demande utilise les paramètres URI suivants.
** [clusterArn](#API_elastic_ListClusterSnapshots_RequestSyntax) **
L'identifiant ARN du cluster élastique.
** [maxResults](#API_elastic_ListClusterSnapshots_RequestSyntax) **
Le nombre maximal de résultats de capture instantanée du cluster élastique à recevoir dans la réponse.
Plage valide : valeur minimale de 20. Valeur maximale fixée à 100.
** [nextToken](#API_elastic_ListClusterSnapshots_RequestSyntax) **
Un jeton de pagination fourni par une demande précédente. Si ce paramètre est spécifié, la réponse inclut uniquement les enregistrements situés au-delà de ce jeton, jusqu'à la valeur spécifiée par`max-results`.
S'il n'y a plus de données dans la réponse, elles ne `nextToken` seront pas renvoyées.
** [snapshotType](#API_elastic_ListClusterSnapshots_RequestSyntax) **
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.
## Corps de la requête
La demande n’a pas de corps de requête.
## Syntaxe de la réponse
```
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"snapshots": [
{
"clusterArn": "string",
"snapshotArn": "string",
"snapshotCreationTime": "string",
"snapshotName": "string",
"status": "string"
}
]
}
```
## Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
** [nextToken](#API_elastic_ListClusterSnapshots_ResponseSyntax) **
Un jeton de pagination fourni par une demande précédente. Si ce paramètre est spécifié, la réponse inclut uniquement les enregistrements situés au-delà de ce jeton, jusqu'à la valeur spécifiée par`max-results`.
S'il n'y a plus de données dans la réponse, elles ne `nextToken` seront pas renvoyées.
Type : Chaîne
** [snapshots](#API_elastic_ListClusterSnapshots_ResponseSyntax) **
Liste des instantanés pour un cluster élastique spécifié.
Type : tableau d’objets [ClusterSnapshotInList](API_elastic_ClusterSnapshotInList.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** AccessDeniedException **
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.
** message **
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403
** InternalServerException **
Une erreur interne s'est produite au niveau du serveur.
Code d’état HTTP : 500
** ThrottlingException **
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.
** retryAfterSeconds **
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429
** ValidationException **
Structure définissant une exception de validation.
** fieldList **
Liste des champs dans lesquels l'exception de validation s'est produite.
** message **
Message d'erreur décrivant l'exception de validation.
** reason **
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListClusterSnapshots)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListClusterSnapshots)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListClusterSnapshots)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListClusterSnapshots)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListClusterSnapshots)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListClusterSnapshots)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListClusterSnapshots)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListClusterSnapshots)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListClusterSnapshots)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListClusterSnapshots)
# ListPendingMaintenanceActions
Récupère la liste de toutes les actions de maintenance en attente.
## Syntaxe de la demande
```
GET /pending-actions?maxResults=maxResults&nextToken=nextToken HTTP/1.1
```
## Paramètres de demande URI
La demande utilise les paramètres URI suivants.
** [maxResults](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **
Le nombre maximum de résultats à inclure dans la réponse. S'il existe plus d'enregistrements que la `maxResults` valeur spécifiée, un jeton de pagination (marqueur) est inclus dans la réponse afin que les résultats restants puissent être récupérés.
Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.
** [nextToken](#API_elastic_ListPendingMaintenanceActions_RequestSyntax) **
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 `maxResults`.
## Corps de la requête
La demande n’a pas de corps de requête.
## Syntaxe de la réponse
```
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"resourcePendingMaintenanceActions": [
{
"pendingMaintenanceActionDetails": [
{
"action": "string",
"autoAppliedAfterDate": "string",
"currentApplyDate": "string",
"description": "string",
"forcedApplyDate": "string",
"optInStatus": "string"
}
],
"resourceArn": "string"
}
]
}
```
## Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
** [resourcePendingMaintenanceActions](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **
Fournit des informations sur une action de maintenance en attente pour une ressource.
Type : tableau d’objets [ResourcePendingMaintenanceAction](API_elastic_ResourcePendingMaintenanceAction.md)
** [nextToken](#API_elastic_ListPendingMaintenanceActions_ResponseSyntax) **
Jeton de pagination facultatif fourni par une demande précédente. Si ce paramètre est affiché, les réponses incluront uniquement les enregistrements situés au-delà du marqueur, jusqu'à la valeur spécifiée par`maxResults`.
Type : Chaîne
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** AccessDeniedException **
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.
** message **
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403
** InternalServerException **
Une erreur interne s'est produite au niveau du serveur.
Code d’état HTTP : 500
** ThrottlingException **
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.
** retryAfterSeconds **
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429
** ValidationException **
Structure définissant une exception de validation.
** fieldList **
Liste des champs dans lesquels l'exception de validation s'est produite.
** message **
Message d'erreur décrivant l'exception de validation.
** reason **
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListPendingMaintenanceActions)
# ListTagsForResource
Répertorie toutes les balises d'une ressource de cluster élastique
## Syntaxe de la demande
```
GET /tags/resourceArn HTTP/1.1
```
## Paramètres de demande URI
La demande utilise les paramètres URI suivants.
** [resourceArn](#API_elastic_ListTagsForResource_RequestSyntax) **
Identifiant ARN de la ressource Elastic Cluster.
Contraintes de longueur : longueur minimale de 1 caractère. Longueur maximale de 1011.
Obligatoire : oui
## Corps de la demande
La demande n’a pas de corps de requête.
## Syntaxe de la réponse
```
HTTP/1.1 200
Content-type: application/json
{
"tags": {
"string" : "string"
}
}
```
## Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
** [tags](#API_elastic_ListTagsForResource_ResponseSyntax) **
La liste des balises pour la ressource de cluster élastique spécifiée.
Type : mappage chaîne/chaîne
Contraintes de longueur de clé : longueur minimale de 1. Longueur maximale de 128.
Modèle de clé :`(?!aws:)[a-zA-Z+-=._:/]+`
Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximale de 256.
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** InternalServerException **
Une erreur interne du serveur s'est produite.
Code d’état HTTP : 500
** ResourceNotFoundException **
La ressource spécifiée n'a pas pu être localisée.
** message **
Un message d'erreur décrivant l'échec.
** resourceId **
L'ID de la ressource introuvable.
** resourceType **
Type de ressource introuvable.
Code d’état HTTP :404
** ThrottlingException **
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.
** retryAfterSeconds **
Le nombre de secondes à attendre avant de recommencer l'opération.
Code d’état HTTP : 429
** ValidationException **
Structure définissant une exception de validation.
** fieldList **
Liste des champs dans lesquels l'exception de validation s'est produite.
** message **
Message d'erreur décrivant l'exception de validation.
** reason **
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/ListTagsForResource)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/ListTagsForResource)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/ListTagsForResource)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/ListTagsForResource)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/ListTagsForResource)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/ListTagsForResource)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/ListTagsForResource)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/ListTagsForResource)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/ListTagsForResource)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/ListTagsForResource)
# RestoreClusterFromSnapshot
Restaure un cluster élastique à partir d'un instantané.
## Syntaxe de la demande
```
POST /cluster-snapshot/snapshotArn/restore HTTP/1.1
Content-type: application/json
{
"clusterName": "string",
"kmsKeyId": "string",
"shardCapacity": number,
"shardInstanceCount": number,
"subnetIds": [ "string" ],
"tags": {
"string" : "string"
},
"vpcSecurityGroupIds": [ "string" ]
}
```
## Paramètres de demande URI
La demande utilise les paramètres URI suivants.
** [snapshotArn](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **
Identifiant ARN de l'instantané du cluster élastique.
Obligatoire : oui
## Corps de la demande
Cette demande accepte les données suivantes au format JSON.
** [clusterName](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **
Nom du cluster élastique.
Type : Chaîne
Obligatoire : oui
** [kmsKeyId](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **
Identifiant de clé KMS à utiliser pour chiffrer le nouveau cluster de clusters élastiques Amazon DocumentDB.
L'identifiant de clé KMS est l'Amazon Resource Name (ARN) de la clé de chiffrement KMS. Si vous créez un cluster en utilisant le 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 : chaîne
Obligatoire : non
** [shardCapacity](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **
Capacité de chaque partition du nouveau cluster élastique restauré.
Type : Integer
Obligatoire : non
** [shardInstanceCount](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **
Le nombre d'instances de répliques s'appliquant à toutes les partitions du cluster élastique. 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 : Integer
Obligatoire : non
** [subnetIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **
Le sous-réseau Amazon EC2 IDs pour le cluster élastique.
Type : tableau de chaînes
Obligatoire : non
** [tags](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **
Une liste des noms de balises à attribuer au cluster élastique restauré, sous la forme d'un tableau de paires clé-valeur dans lequel la clé est le nom de balise et la valeur est la valeur clé.
Type : mappage chaîne/chaîne
Contraintes de longueur de clé : longueur minimale de 1. Longueur maximale de 128.
Modèle de clé :`(?!aws:)[a-zA-Z+-=._:/]+`
Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximale de 256.
Obligatoire : non
** [vpcSecurityGroupIds](#API_elastic_RestoreClusterFromSnapshot_RequestSyntax) **
Liste des groupes de sécurité VPC EC2 à associer au cluster élastique.
Type : tableau de chaînes
Obligatoire : non
## Syntaxe de la réponse
```
HTTP/1.1 200
Content-type: application/json
{
"cluster": {
"adminUserName": "string",
"authType": "string",
"backupRetentionPeriod": number,
"clusterArn": "string",
"clusterEndpoint": "string",
"clusterName": "string",
"createTime": "string",
"kmsKeyId": "string",
"preferredBackupWindow": "string",
"preferredMaintenanceWindow": "string",
"shardCapacity": number,
"shardCount": number,
"shardInstanceCount": number,
"shards": [
{
"createTime": "string",
"shardId": "string",
"status": "string"
}
],
"status": "string",
"subnetIds": [ "string" ],
"vpcSecurityGroupIds": [ "string" ]
}
}
```
## Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
** [cluster](#API_elastic_RestoreClusterFromSnapshot_ResponseSyntax) **
Renvoie des informations sur le cluster élastique restauré.
Type : objet [Cluster](API_elastic_Cluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** AccessDeniedException **
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.
** message **
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403
** ConflictException **
Il y a eu un conflit d'accès.
** resourceId **
L'ID de la ressource où il y a eu un conflit d'accès.
** resourceType **
Type de ressource ayant fait l'objet d'un conflit d'accès.
Code d’état HTTP : 409
** InternalServerException **
Une erreur interne du serveur s'est produite.
Code d’état HTTP : 500
** ResourceNotFoundException **
La ressource spécifiée n'a pas pu être localisée.
** message **
Un message d'erreur décrivant l'échec.
** resourceId **
L'ID de la ressource introuvable.
** resourceType **
Type de ressource introuvable.
Code d’état HTTP :404
** ServiceQuotaExceededException **
Le quota de service pour l'action a été dépassé.
Code d'état HTTP : 402
** ThrottlingException **
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.
** retryAfterSeconds **
Le nombre de secondes à attendre avant de recommencer l'opération.
Code d’état HTTP : 429
** ValidationException **
Structure définissant une exception de validation.
** fieldList **
Liste des champs dans lesquels l'exception de validation s'est produite.
** message **
Message d'erreur décrivant l'exception de validation.
** reason **
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot)
# StartCluster
Redémarre le cluster élastique arrêté spécifié par`clusterARN`.
## Syntaxe de la demande
```
POST /cluster/clusterArn/start HTTP/1.1
```
## Paramètres de demande URI
La demande utilise les paramètres URI suivants.
** [clusterArn](#API_elastic_StartCluster_RequestSyntax) **
L'identifiant ARN du cluster élastique.
Obligatoire : oui
## Corps de la demande
La demande n’a pas de corps de requête.
## Syntaxe de la réponse
```
HTTP/1.1 200
Content-type: application/json
{
"cluster": {
"adminUserName": "string",
"authType": "string",
"backupRetentionPeriod": number,
"clusterArn": "string",
"clusterEndpoint": "string",
"clusterName": "string",
"createTime": "string",
"kmsKeyId": "string",
"preferredBackupWindow": "string",
"preferredMaintenanceWindow": "string",
"shardCapacity": number,
"shardCount": number,
"shardInstanceCount": number,
"shards": [
{
"createTime": "string",
"shardId": "string",
"status": "string"
}
],
"status": "string",
"subnetIds": [ "string" ],
"vpcSecurityGroupIds": [ "string" ]
}
}
```
## Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
** [cluster](#API_elastic_StartCluster_ResponseSyntax) **
Renvoie des informations sur un cluster élastique spécifique.
Type : objet [Cluster](API_elastic_Cluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** AccessDeniedException **
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.
** message **
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403
** InternalServerException **
Une erreur interne s'est produite au niveau du serveur.
Code d’état HTTP : 500
** ResourceNotFoundException **
La ressource spécifiée n'a pas pu être localisée.
** message **
Un message d'erreur décrivant l'échec.
** resourceId **
L'ID de la ressource introuvable.
** resourceType **
Type de ressource introuvable.
Code d’état HTTP :404
** ThrottlingException **
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.
** retryAfterSeconds **
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429
** ValidationException **
Structure définissant une exception de validation.
** fieldList **
Liste des champs dans lesquels l'exception de validation s'est produite.
** message **
Message d'erreur décrivant l'exception de validation.
** reason **
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StartCluster)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StartCluster)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StartCluster)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StartCluster)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StartCluster)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StartCluster)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StartCluster)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StartCluster)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StartCluster)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StartCluster)
# StopCluster
Arrête le cluster élastique en cours d'exécution spécifié par`clusterArn`. Le cluster élastique doit être dans l'état *disponible*.
## Syntaxe de la demande
```
POST /cluster/clusterArn/stop HTTP/1.1
```
## Paramètres de demande URI
La demande utilise les paramètres URI suivants.
** [clusterArn](#API_elastic_StopCluster_RequestSyntax) **
L'identifiant ARN du cluster élastique.
Obligatoire : oui
## Corps de la demande
La demande n’a pas de corps de requête.
## Syntaxe de la réponse
```
HTTP/1.1 200
Content-type: application/json
{
"cluster": {
"adminUserName": "string",
"authType": "string",
"backupRetentionPeriod": number,
"clusterArn": "string",
"clusterEndpoint": "string",
"clusterName": "string",
"createTime": "string",
"kmsKeyId": "string",
"preferredBackupWindow": "string",
"preferredMaintenanceWindow": "string",
"shardCapacity": number,
"shardCount": number,
"shardInstanceCount": number,
"shards": [
{
"createTime": "string",
"shardId": "string",
"status": "string"
}
],
"status": "string",
"subnetIds": [ "string" ],
"vpcSecurityGroupIds": [ "string" ]
}
}
```
## Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
** [cluster](#API_elastic_StopCluster_ResponseSyntax) **
Renvoie des informations sur un cluster élastique spécifique.
Type : objet [Cluster](API_elastic_Cluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** AccessDeniedException **
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.
** message **
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403
** InternalServerException **
Une erreur interne s'est produite au niveau du serveur.
Code d’état HTTP : 500
** ResourceNotFoundException **
La ressource spécifiée n'a pas pu être localisée.
** message **
Un message d'erreur décrivant l'échec.
** resourceId **
L'ID de la ressource qui n'a pas pu être localisée.
** resourceType **
Type de ressource introuvable.
Code d’état HTTP :404
** ThrottlingException **
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.
** retryAfterSeconds **
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429
** ValidationException **
Structure définissant une exception de validation.
** fieldList **
Liste des champs dans lesquels l'exception de validation s'est produite.
** message **
Message d'erreur décrivant l'exception de validation.
** reason **
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/StopCluster)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/StopCluster)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/StopCluster)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/StopCluster)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/StopCluster)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/StopCluster)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/StopCluster)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/StopCluster)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/StopCluster)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/StopCluster)
# TagResource
Ajoute des balises de métadonnées à une ressource de cluster élastique
## Syntaxe de la demande
```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json
{
"tags": {
"string" : "string"
}
}
```
## Paramètres de demande URI
La demande utilise les paramètres URI suivants.
** [resourceArn](#API_elastic_TagResource_RequestSyntax) **
Identifiant ARN de la ressource Elastic Cluster.
Contraintes de longueur : longueur minimale de 1 caractère. Longueur maximale de 1011.
Obligatoire : oui
## Corps de la demande
Cette demande accepte les données suivantes au format JSON.
** [tags](#API_elastic_TagResource_RequestSyntax) **
Les balises attribuées à la ressource Elastic Cluster.
Type : mappage chaîne/chaîne
Contraintes de longueur de clé : longueur minimale de 1. Longueur maximale de 128.
Modèle de clé :`(?!aws:)[a-zA-Z+-=._:/]+`
Contraintes de longueur de valeur : longueur minimale de 0. Longueur maximale de 256.
Obligatoire : oui
## Syntaxe de la réponse
```
HTTP/1.1 200
```
## Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** InternalServerException **
Une erreur interne s'est produite au niveau du serveur.
Code d’état HTTP : 500
** ResourceNotFoundException **
La ressource spécifiée n'a pas pu être localisée.
** message **
Un message d'erreur décrivant l'échec.
** resourceId **
L'ID de la ressource introuvable.
** resourceType **
Type de ressource introuvable.
Code d’état HTTP :404
** ThrottlingException **
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.
** retryAfterSeconds **
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429
** ValidationException **
Structure définissant une exception de validation.
** fieldList **
Liste des champs dans lesquels l'exception de validation s'est produite.
** message **
Message d'erreur décrivant l'exception de validation.
** reason **
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/TagResource)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/TagResource)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/TagResource)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/TagResource)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/TagResource)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/TagResource)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/TagResource)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/TagResource)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/TagResource)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/TagResource)
# UntagResource
Supprime les balises de métadonnées d'une ressource de cluster élastique
## Syntaxe de la demande
```
DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1
```
## Paramètres de demande URI
La demande utilise les paramètres URI suivants.
** [resourceArn](#API_elastic_UntagResource_RequestSyntax) **
Identifiant ARN de la ressource Elastic Cluster.
Contraintes de longueur : longueur minimale de 1 caractère. Longueur maximale de 1011.
Obligatoire : oui
** [tagKeys](#API_elastic_UntagResource_RequestSyntax) **
Les clés de balise à supprimer de la ressource Elastic Cluster.
Membres du tableau : nombre minimum de 0 élément. Nombre maximal de 50 éléments.
Contraintes de longueur : longueur minimale de 1 caractère. Longueur maximale de 128.
Modèle : `(?!aws:)[a-zA-Z+-=._:/]+`
Obligatoire : oui
## Corps de la demande
La demande n’a pas de corps de requête.
## Syntaxe de la réponse
```
HTTP/1.1 200
```
## Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** InternalServerException **
Une erreur interne du serveur s'est produite.
Code d’état HTTP : 500
** ResourceNotFoundException **
La ressource spécifiée n'a pas pu être localisée.
** message **
Un message d'erreur décrivant l'échec.
** resourceId **
L'ID de la ressource introuvable.
** resourceType **
Type de ressource introuvable.
Code d’état HTTP :404
** ThrottlingException **
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.
** retryAfterSeconds **
Le nombre de secondes à attendre avant de recommencer l'opération.
Code d’état HTTP : 429
** ValidationException **
Structure définissant une exception de validation.
** fieldList **
Liste des champs dans lesquels l'exception de validation s'est produite.
** message **
Message d'erreur décrivant l'exception de validation.
** reason **
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UntagResource)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UntagResource)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UntagResource)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UntagResource)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UntagResource)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UntagResource)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UntagResource)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UntagResource)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UntagResource)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UntagResource)
# UpdateCluster
Modifie un cluster élastique. Cela inclut la mise à jour du nom d'utilisateur/mot de passe administrateur, la mise à niveau de la version de l'API et la configuration d'une fenêtre de sauvegarde et d'une fenêtre de maintenance
## Syntaxe de la demande
```
PUT /cluster/clusterArn HTTP/1.1
Content-type: application/json
{
"adminUserPassword": "string",
"authType": "string",
"backupRetentionPeriod": number,
"clientToken": "string",
"preferredBackupWindow": "string",
"preferredMaintenanceWindow": "string",
"shardCapacity": number,
"shardCount": number,
"shardInstanceCount": number,
"subnetIds": [ "string" ],
"vpcSecurityGroupIds": [ "string" ]
}
```
## Paramètres de demande URI
La demande utilise les paramètres URI suivants.
** [clusterArn](#API_elastic_UpdateCluster_RequestSyntax) **
L'identifiant ARN du cluster élastique.
Obligatoire : oui
## Corps de la demande
Cette demande accepte les données suivantes au format JSON.
** [adminUserPassword](#API_elastic_UpdateCluster_RequestSyntax) **
Le mot de passe associé à l'administrateur du cluster Elastic. Ce mot de passe peut contenir tout caractère ASCII imprimable à l'exception de la barre oblique (/), des guillemets doubles (") ou du symbole arobase (@).
*Contraintes* : Doit contenir de 8 à 100 caractères.
Type : chaîne
Obligatoire : non
** [authType](#API_elastic_UpdateCluster_RequestSyntax) **
Type d'authentification utilisé pour déterminer où récupérer le mot de passe utilisé pour accéder au cluster élastique. Les types valides sont `PLAIN_TEXT` ou`SECRET_ARN`.
Type : Chaîne
Valeurs valides : `PLAIN_TEXT | SECRET_ARN`
Obligatoire : non
** [backupRetentionPeriod](#API_elastic_UpdateCluster_RequestSyntax) **
Nombre de jours pendant lesquels les instantanés automatiques sont conservés.
Type : Integer
Obligatoire : non
** [clientToken](#API_elastic_UpdateCluster_RequestSyntax) **
Le jeton client pour le cluster élastique.
Type : chaîne
Obligatoire : non
** [preferredBackupWindow](#API_elastic_UpdateCluster_RequestSyntax) **
La plage horaire quotidienne pendant laquelle les sauvegardes automatisées sont créées si les sauvegardes automatisées sont activées, comme déterminé par le`backupRetentionPeriod`.
Type : chaîne
Obligatoire : non
** [preferredMaintenanceWindow](#API_elastic_UpdateCluster_RequestSyntax) **
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`
*Par défaut* : une fenêtre de 30 minutes sélectionnée au hasard dans un intervalle de 8 heures pour chacune d'elles Région AWS, survenant un jour aléatoire de la semaine.
*Jours valides* : lundi, mardi, mercredi, jeudi, vendredi, samedi, dimanche
*Contraintes* : fenêtre minimale de 30 minutes.
Type : chaîne
Obligatoire : non
** [shardCapacity](#API_elastic_UpdateCluster_RequestSyntax) **
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 : Integer
Obligatoire : non
** [shardCount](#API_elastic_UpdateCluster_RequestSyntax) **
Le nombre de partitions attribuées au cluster élastique. Le maximum est de 32.
Type : Integer
Obligatoire : non
** [shardInstanceCount](#API_elastic_UpdateCluster_RequestSyntax) **
Le nombre d'instances de répliques s'appliquant à toutes les partitions du cluster élastique. 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 : Integer
Obligatoire : non
** [subnetIds](#API_elastic_UpdateCluster_RequestSyntax) **
Le sous-réseau Amazon EC2 IDs pour le cluster élastique.
Type : tableau de chaînes
Obligatoire : non
** [vpcSecurityGroupIds](#API_elastic_UpdateCluster_RequestSyntax) **
Liste des groupes de sécurité VPC EC2 à associer au cluster élastique.
Type : tableau de chaînes
Obligatoire : non
## Syntaxe de la réponse
```
HTTP/1.1 200
Content-type: application/json
{
"cluster": {
"adminUserName": "string",
"authType": "string",
"backupRetentionPeriod": number,
"clusterArn": "string",
"clusterEndpoint": "string",
"clusterName": "string",
"createTime": "string",
"kmsKeyId": "string",
"preferredBackupWindow": "string",
"preferredMaintenanceWindow": "string",
"shardCapacity": number,
"shardCount": number,
"shardInstanceCount": number,
"shards": [
{
"createTime": "string",
"shardId": "string",
"status": "string"
}
],
"status": "string",
"subnetIds": [ "string" ],
"vpcSecurityGroupIds": [ "string" ]
}
}
```
## Eléments de réponse
Si l’action aboutit, le service renvoie une réponse HTTP 200.
Les données suivantes sont renvoyées au format JSON par le service.
** [cluster](#API_elastic_UpdateCluster_ResponseSyntax) **
Renvoie des informations sur le cluster élastique mis à jour.
Type : objet [Cluster](API_elastic_Cluster.md)
## Erreurs
Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Erreurs courantes](CommonErrors.md).
** AccessDeniedException **
Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.
** message **
Un message d'erreur expliquant pourquoi l'accès a été refusé.
Code d’état HTTP : 403
** ConflictException **
Il y a eu un conflit d'accès.
** resourceId **
L'ID de la ressource où il y a eu un conflit d'accès.
** resourceType **
Type de ressource ayant fait l'objet d'un conflit d'accès.
Code d’état HTTP : 409
** InternalServerException **
Une erreur interne du serveur s'est produite.
Code d’état HTTP : 500
** ResourceNotFoundException **
La ressource spécifiée n'a pas pu être localisée.
** message **
Un message d'erreur décrivant l'échec.
** resourceId **
L'ID de la ressource introuvable.
** resourceType **
Type de ressource introuvable.
Code d’état HTTP :404
** ThrottlingException **
ThrottlingException sera lancé lorsque la demande a été refusée en raison de la limitation des demandes.
** retryAfterSeconds **
Le nombre de secondes à attendre avant de réessayer l'opération.
Code d’état HTTP : 429
** ValidationException **
Structure définissant une exception de validation.
** fieldList **
Liste des champs dans lesquels l'exception de validation s'est produite.
** message **
Message d'erreur décrivant l'exception de validation.
** reason **
La raison pour laquelle l'exception de validation s'est produite (l'une des raisons suivantes : `unknownOperation` `cannotParse``fieldValidationFailed`,, ou`other`).
Code d’état HTTP : 400
## Voir aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/docdb-elastic-2022-11-28/UpdateCluster)
+ [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/docdb-elastic-2022-11-28/UpdateCluster)
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-elastic-2022-11-28/UpdateCluster)
+ [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/docdb-elastic-2022-11-28/UpdateCluster)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-elastic-2022-11-28/UpdateCluster)
+ [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/docdb-elastic-2022-11-28/UpdateCluster)
+ [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/docdb-elastic-2022-11-28/UpdateCluster)
+ [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/docdb-elastic-2022-11-28/UpdateCluster)
+ [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/docdb-elastic-2022-11-28/UpdateCluster)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-elastic-2022-11-28/UpdateCluster)
# Types de données
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)
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
Informations sur une zone de disponibilité.
## Table des matières
**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
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
Un certificat d'autorité de certification (CA) pour un Compte AWS.
## Table des matières
**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
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
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
**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
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
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
**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
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
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
**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
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
Informations détaillées sur un cluster.
## Table des matières
**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
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
Contient des informations sur une instance faisant partie d'un cluster.
## Table des matières
**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
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
Informations détaillées sur un groupe de paramètres de cluster.
## Table des matières
**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
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
Décrit un rôle Gestion des identités et des accès AWS (IAM) associé à un cluster.
## Table des matières
**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
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
Informations détaillées sur un instantané de cluster.
## Table des matières
**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
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
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
**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
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
Informations détaillées sur les attributs associés à un instantané de cluster.
## Table des matières
**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
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
Informations détaillées sur une version du moteur.
## Table des matières
**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
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
Informations détaillées sur une instance.
## Table des matières
**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
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
Fournit une liste d'informations d'état pour une instance.
## Table des matières
**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
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
Informations détaillées sur un groupe de sous-réseaux.
## Table des matières
**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
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
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
**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
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
Contient le résultat d'une invocation réussie de l'`DescribeEngineDefaultClusterParameters`opération.
## Table des matières
**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
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
Informations détaillées sur un événement.
## Table des matières
**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
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
Type de source d'événement, accompagné d'un ou de plusieurs noms de catégories d'événements.
## Table des matières
**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
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
Informations détaillées sur un événement auquel vous vous êtes inscrit.
## Table des matières
**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
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
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
**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
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
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
**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
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
Type de données représentant un cluster global Amazon DocumentDB.
## Table des matières
**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
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
Structure de données contenant des informations sur les clusters principaux et secondaires associés à un cluster global Amazon DocumentDB.
## Table des matières
**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
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
Les options disponibles pour une instance.
## Table des matières
**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
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
Informations détaillées sur un paramètre individuel.
## Table des matières
**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
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
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
**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
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
Fournit des informations sur une action de maintenance en attente pour une ressource.
## Table des matières
**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
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
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
**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
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
Représente la sortie de[ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md).
## Table des matières
**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
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
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
**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
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
Définit la configuration de dimensionnement d'un cluster Amazon DocumentDB Serverless.
## Table des matières
**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
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
Récupère la configuration de dimensionnement pour un cluster Amazon DocumentDB Serverless.
## Table des matières
**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
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
Informations détaillées sur un sous-réseau.
## Table des matières
**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
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
Métadonnées attribuées à une ressource Amazon DocumentDB composée d'une paire clé-valeur.
## Table des matières
**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
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
Version du moteur de base de données vers laquelle une instance peut être mise à niveau.
## Table des matières
**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
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
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
**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
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
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
Renvoie des informations sur un cluster élastique spécifique.
## Table des matières
**Note**
Dans la liste suivante, les paramètres requis sont décrits en premier.
** adminUserName **
Nom de l'administrateur du cluster Elastic.
Type : String
Obligatoire : oui
** authType **
Type d'authentification pour le cluster élastique.
Type : String
Valeurs valides : `PLAIN_TEXT | SECRET_ARN`
Obligatoire : oui
** clusterArn **
L'identifiant ARN du cluster élastique.
Type : String
Obligatoire : oui
** clusterEndpoint **
URL utilisée pour se connecter au cluster élastique.
Type : String
Obligatoire : oui
** clusterName **
Nom du cluster élastique.
Type : String
Obligatoire : oui
** createTime **
Heure à laquelle le cluster élastique a été créé en temps universel coordonné (UTC).
Type : String
Obligatoire : oui
** kmsKeyId **
Identifiant de clé KMS à utiliser pour chiffrer le cluster élastique.
Type : String
Obligatoire : oui
** preferredMaintenanceWindow **
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 **
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 **
Le nombre de partitions attribuées au cluster élastique. Le maximum est de 32.
Type : entier
Obligatoire : oui
** status **
É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 **
Le EC2 sous-réseau Amazon IDs pour le cluster élastique.
Type : tableau de chaînes
Obligatoire : oui
** vpcSecurityGroupIds **
Liste des groupes de sécurité EC2 VPC associés à ce cluster élastique.
Type : tableau de chaînes
Obligatoire : oui
** backupRetentionPeriod **
Nombre de jours pendant lesquels les instantanés automatiques sont conservés.
Type : entier
Obligatoire : non
** preferredBackupWindow **
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 **
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 **
Nombre total de partitions dans le cluster.
Type : tableau d’objets [Shard](API_elastic_Shard.md)
Obligatoire : non
## consultez aussi
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
Liste des clusters élastiques Amazon DocumentDB.
## Table des matières
**Note**
Dans la liste suivante, les paramètres requis sont décrits en premier.
** clusterArn **
L'identifiant ARN du cluster élastique.
Type : String
Obligatoire : oui
** clusterName **
Nom de l'agrégat élastique.
Type : String
Obligatoire : oui
** status **
É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
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
Renvoie des informations sur un instantané de cluster élastique spécifique.
## Table des matières
**Note**
Dans la liste suivante, les paramètres requis sont décrits en premier.
** adminUserName **
Nom de l'administrateur du cluster Elastic.
Type : String
Obligatoire : oui
** clusterArn **
L'identifiant ARN du cluster élastique.
Type : String
Obligatoire : oui
** clusterCreationTime **
Heure à laquelle le cluster élastique a été créé en temps universel coordonné (UTC).
Type : String
Obligatoire : oui
** kmsKeyId **
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 **
Identifiant ARN de l'instantané du cluster élastique.
Type : String
Obligatoire : oui
** snapshotCreationTime **
Heure à laquelle l'instantané du cluster élastique a été créé en temps universel coordonné (UTC).
Type : String
Obligatoire : oui
** snapshotName **
Nom de l'instantané du cluster élastique.
Type : String
Obligatoire : oui
** status **
É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 **
Le EC2 sous-réseau Amazon IDs pour le cluster élastique.
Type : tableau de chaînes
Obligatoire : oui
** vpcSecurityGroupIds **
Liste des groupes de sécurité EC2 VPC à associer au cluster élastique.
Type : tableau de chaînes
Obligatoire : oui
** snapshotType **
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
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
Liste des instantanés d'Elastic Cluster.
## Table des matières
**Note**
Dans la liste suivante, les paramètres requis sont décrits en premier.
** clusterArn **
L'identifiant ARN du cluster élastique.
Type : String
Obligatoire : oui
** snapshotArn **
Identifiant ARN de l'instantané du cluster élastique.
Type : String
Obligatoire : oui
** snapshotCreationTime **
Heure à laquelle l'instantané du cluster élastique a été créé en temps universel coordonné (UTC).
Type : String
Obligatoire : oui
** snapshotName **
Nom de l'instantané du cluster élastique.
Type : String
Obligatoire : oui
** status **
É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
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
Récupère les détails des actions de maintenance en attente.
## Table des matières
**Note**
Dans la liste suivante, les paramètres requis sont décrits en premier.
** action **
Affiche l'action spécifique d'une action de maintenance en attente.
Type : String
Obligatoire : oui
** autoAppliedAfterDate **
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 **
Affiche la date effective à laquelle l'action de maintenance en attente est appliquée à la ressource.
Type : chaîne
Obligatoire : non
** description **
Affiche une description fournissant plus de détails sur l'action de maintenance.
Type : chaîne
Obligatoire : non
** forcedApplyDate **
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 **
Affiche le type de `optInType` demande reçue pour la ressource.
Type : chaîne
Obligatoire : non
## consultez aussi
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
Fournit des informations sur une action de maintenance en attente pour une ressource.
## Table des matières
**Note**
Dans la liste suivante, les paramètres requis sont décrits en premier.
** pendingMaintenanceActionDetails **
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 **
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
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
Le nom du shard.
## Table des matières
**Note**
Dans la liste suivante, les paramètres requis sont décrits en premier.
** createTime **
Heure à laquelle la partition a été créée en temps universel coordonné (UTC).
Type : String
Obligatoire : oui
** shardId **
L'ID du shard.
Type : String
Obligatoire : oui
** status **
É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
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
Champ spécifique dans lequel une exception de validation donnée s'est produite.
## Table des matières
**Note**
Dans la liste suivante, les paramètres requis sont décrits en premier.
** message **
Message d'erreur décrivant l'exception de validation dans ce champ.
Type : String
Obligatoire : oui
** name **
Nom du champ dans lequel l'exception de validation s'est produite.
Type : String
Obligatoire : oui
## consultez aussi
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)
# Erreurs courantes
Cette section répertorie les erreurs communes aux actions d'API de tous les AWS services. Pour les erreurs spécifiques à une action d’API pour ce service, consultez la rubrique pour cette action d’API.
**AccessDeniedException**
Vous ne disposez pas d’un accès suffisant pour effectuer cette action.
Code d’état HTTP : 400
**IncompleteSignature**
La signature de la demande n'est pas conforme aux AWS normes.
Code d’état HTTP : 400
**InternalFailure**
Le traitement de la demande a échoué en raison d'une erreur, d'une exception ou d'un échec inconnu.
Code d’état HTTP : 500
**InvalidAction**
L'action ou l'opération demandée n'est pas valide. Vérifiez que l’action est entrée correctement.
Code d’état HTTP : 400
**InvalidClientTokenId**
Le certificat X.509 ou AWS l'ID de clé d'accès fourni n'existe pas dans nos archives.
Code d’état HTTP : 403
**NotAuthorized**
Vous ne disposez pas de l’autorisation nécessaire pour effectuer cette action.
Code d’état HTTP : 400
**OptInRequired**
L'ID de clé d' AWS accès nécessite un abonnement au service.
Code d’état HTTP : 403
**RequestExpired**
La demande est parvenue au service plus de 15 minutes après l'horodatage sur la demande ou plus de 15 minutes après la date d'expiration de la demande (par exemple pour les demandes pré-signées URLs), ou le horodatage sur la demande est daté dans plus de 15 minutes dans le futur.
Code d’état HTTP : 400
**ServiceUnavailable**
La requête a échoué en raison d’une défaillance temporaire du serveur.
HTTP Status Code: 503
**ThrottlingException**
La demande a été refusée suite à une limitation des demandes.
Code d’état HTTP : 400
**ValidationError**
L'entrée ne satisfait pas les contraintes spécifiées par un AWS service.
Code d’état HTTP : 400
# Paramètres communs
La liste suivante contient les paramètres que toutes les actions utilisent pour signer les demandes Signature Version 4 à l'aide d'une chaîne de requête. Tous les paramètres spécifiques d'une action particulière sont énumérées dans le sujet consacré à cette action. Pour plus d'informations sur la version 4 de Signature, consultez [la section Signing AWS API](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) du *guide de l'utilisateur IAM*.
**Action**
Action à effectuer.
Type : chaîne
Obligatoire : oui
**Version**
Version de l'API pour laquelle la demande est écrite, exprimée dans le format YYYY-MM-DD.
Type : chaîne
Obligatoire : oui
**X-Amz-Algorithm**
Algorithme de hachage que vous avez utilisé pour créer la signature de la demande.
Condition : spécifiez ce paramètre lorsque vous incluez des informations d'authentification dans une chaîne de requête plutôt que dans l'en-tête d'autorisation HTTP.
Type : chaîne
Valeurs valides : `AWS4-HMAC-SHA256`
Obligatoire : Conditionnelle
**X-Amz-Credential**
Valeur de la portée des informations d'identification, qui est une chaîne incluant votre clé d'accès, la date, la région cible, le service demandé et une chaîne de terminaison (« aws4\$1request »). Spécifiez la valeur au format suivant : *access\$1key*/*AAAAMMJJ*/*région*/*service*/aws4\$1request.
Pour plus d'informations, consultez la section [Création d'une demande d' AWS API signée](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) dans le *guide de l'utilisateur IAM*.
Condition : spécifiez ce paramètre lorsque vous incluez des informations d'authentification dans une chaîne de requête plutôt que dans l'en-tête d'autorisation HTTP.
Type : chaîne
Obligatoire : Conditionnelle
**X-Amz-Date**
La date utilisée pour créer la signature. Le format doit être au format de base ISO 8601 (AAAAMMJJ'T'HHMMSS'Z'). Par exemple, la date et l'heure suivantes sont une X-Amz-Date valeur valide :`20120325T120000Z`.
Condition : X-Amz-Date est un en-tête facultatif pour toutes les demandes. Il peut être utilisé pour signer les demandes. Si l'en-tête Date est spécifié au format de base ISO 8601, X-Amz-Date il n'est pas obligatoire. Lorsqu'il X-Amz-Date est utilisé, il remplace toujours la valeur de l'en-tête Date. Pour plus d'informations, consultez la section [Éléments d'une signature de demande d' AWS API](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html) dans le *Guide de l'utilisateur IAM*.
Type : chaîne
Obligatoire : Conditionnelle
**X-Amz-Security-Token**
Le jeton de sécurité temporaire obtenu par un appel à AWS Security Token Service (AWS STS). Pour obtenir la liste des services prenant en charge les informations d'identification de sécurité temporaires d' AWS STS, consultez [Services AWS qui fonctionnent avec IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html) dans le *Guide de l'utilisateur IAM*.
Condition : Si vous utilisez des informations d'identification de sécurité temporaires provenant de AWS STS, vous devez inclure le jeton de sécurité.
Type : chaîne
Obligatoire : Conditionnelle
**X-Amz-Signature**
Spécifie la signature codée en hexadécimal qui a été calculée à partir de la chaîne à signer et de la clé de signature dérivée.
Condition : spécifiez ce paramètre lorsque vous incluez des informations d'authentification dans une chaîne de requête plutôt que dans l'en-tête d'autorisation HTTP.
Type : chaîne
Obligatoire : Conditionnelle
**X-Amz-SignedHeaders**
Spécifie tous les en-têtes HTTP qui ont été inclus dans la demande canonique. Pour plus d'informations sur la spécification d'en-têtes signés, consultez la section [Créer une demande d' AWS API signée](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) dans le guide de l'*utilisateur IAM*.
Condition : spécifiez ce paramètre lorsque vous incluez des informations d'authentification dans une chaîne de requête plutôt que dans l'en-tête d'autorisation HTTP.
Type : chaîne
Obligatoire : Conditionnelle