CreateCluster - Amazon DocumentDB
Syntaxe de la demandeParamètres de demande URICorps de la demandeSyntaxe de la réponseEléments de réponseErreursconsultez aussi

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.

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

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 : String

Obligatoire : oui

adminUserPassword

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 : String

Obligatoire : oui

authType

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 ouSECRET_ARN.

Type : String

Valeurs valides : PLAIN_TEXT | SECRET_ARN

Obligatoire : oui

clusterName

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 trait d'union ni contenir deux traits d'union consécutifs.

Exemple : my-cluster

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

backupRetentionPeriod

Nombre de jours pendant lesquels les instantanés automatiques sont conservés.

Type : entier

Obligatoire : non

clientToken

Le jeton client pour le cluster élastique.

Type : chaîne

Obligatoire : non

kmsKeyId

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

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 lebackupRetentionPeriod.

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

Par défaut : une fenêtre de 30 minutes sélectionnée au hasard dans un intervalle de 8 heures pour chacune 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

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 : entier

Obligatoire : non

subnetIds

Le EC2 sous-réseau Amazon IDs pour le nouveau cluster élastique.

Type : tableau de chaînes

Obligatoire : non

tags

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

Liste des groupes de sécurité EC2 VPC à 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

Le nouveau cluster élastique qui a été créé.

Type : objet Cluster

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

AccessDeniedException

Exception qui se produit lorsque les autorisations ne sont pas suffisantes pour effectuer une action.

Code d’état HTTP : 403

ConflictException

Il y a eu 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.

Code d’état HTTP : 429

ValidationException

Structure définissant une exception de validation.

Code d’état HTTP : 400

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 :