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.
# 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)