CreateCluster

Erstellt einen neuen elastischen Amazon DocumentDB-Cluster und gibt dessen Clusterstruktur zurück.

Anforderungssyntax

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" ]
}

URI-Anfrageparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

adminUserName

Der Name des Administrators für elastische Amazon DocumentDB-Cluster.

Einschränkungen:

• Muss zwischen 1 und 63 Buchstaben oder Zahlen enthalten.

• Das erste Zeichen muss ein Buchstabe sein.

• Dies darf kein reserviertes Wort sein.

Typ: Zeichenfolge

Erforderlich: Ja

adminUserPassword

Das Passwort für den Administrator für elastische Amazon DocumentDB-Cluster. Das Passwort kann alle druckbaren ASCII-Zeichen enthalten.

Einschränkungen:

• Muss zwischen 8 und 100 Zeichen enthalten.

• Darf keinen Schrägstrich (/), doppelten Anführungszeichen (") oder das At-Symbol (@) enthalten.

Typ: Zeichenfolge

Erforderlich: Ja

authType

Der Authentifizierungstyp, der verwendet wird, um zu bestimmen, wo das Passwort abgerufen werden soll, das für den Zugriff auf den elastischen Cluster verwendet wird. Gültige Typen sind PLAIN_TEXT oder SECRET_ARN.

Typ: Zeichenfolge

Zulässige Werte: PLAIN_TEXT | SECRET_ARN

Erforderlich: Ja

clusterName

Der Name des neuen elastischen Clusters. Dieser Parameter wird als Zeichenfolge in Kleinbuchstaben gespeichert.

Einschränkungen:

• Muss zwischen 1 und 63 Buchstaben, Ziffern oder Bindestriche enthalten.

• Das erste Zeichen muss ein Buchstabe sein.

• Darf nicht mit einem Bindestrich enden oder zwei aufeinanderfolgende Bindestriche enthalten.

Beispiel: my-cluster

Typ: Zeichenfolge

Erforderlich: Ja

shardCapacity

Die Anzahl der vCPUs, die jedem elastischen Cluster-Shard zugewiesen sind. Das Maximum ist 64. Zulässige Werte sind 2, 4, 8, 16, 32, 64.

Typ: Ganzzahl

Erforderlich: Ja

shardCount

Die Anzahl der dem elastischen Cluster zugewiesenen Shards. Das Maximum ist 32.

Typ: Ganzzahl

Erforderlich: Ja

backupRetentionPeriod

Die Anzahl der Tage, für die automatische Snapshots aufbewahrt werden.

Typ: Ganzzahl

Erforderlich: Nein

clientToken

Das Client-Token für den elastischen Cluster.

Typ: Zeichenfolge

Erforderlich: Nein

kmsKeyId

Die KMS-Schlüsselkennung, die zum Verschlüsseln des neuen elastischen Clusters verwendet werden soll.

Die Kennung für den KMS-Schlüssel ist der Amazon-Ressourcenname (ARN) für den KMS-Verschlüsselungsschlüssel. Wenn Sie einen Cluster mit demselben Amazon-Konto erstellen, das diesen KMS-Verschlüsselungsschlüssel besitzt, können Sie den KMS-Schlüsselalias anstelle des ARN als KMS-Verschlüsselungsschlüssel verwenden.

Wenn kein Verschlüsselungsschlüssel angegeben ist, verwendet Amazon DocumentDB den Standardverschlüsselungsschlüssel, den KMS für Ihr Konto erstellt. Ihr Konto verfügt für jede Amazon-Region über einen anderen Standardverschlüsselungsschlüssel.

Typ: Zeichenfolge

Erforderlich: Nein

preferredBackupWindow

Der tägliche Zeitraum, in dem automatisierte Backups erstellt werden, wenn automatisierte Backups aktiviert sind, wie durch die festgelegtbackupRetentionPeriod.

Typ: Zeichenfolge

Erforderlich: Nein

preferredMaintenanceWindow

Der wöchentliche Zeitraum, in dem Systemwartungen durchgeführt werden können, in UTC (Universal Coordinated Time).

Format: ddd:hh24:mi-ddd:hh24:mi

Standard: ein 30-minütiges Fenster, das zufällig aus einem 8-Stunden-Zeitblock für jede ausgewählt wird AWS-Regionund an einem zufälligen Wochentag stattfindet.

Gültige Tage: Mo, Di, Mi, Do, Fr, Sa, So

Einschränkungen: mindestens 30-Minuten-Zeitfenster.

Typ: Zeichenfolge

Erforderlich: Nein

shardInstanceCount

Die Anzahl der Replikat-Instances, die für alle Shards im elastischen Cluster gelten. Ein shardInstanceCount Wert von 1 bedeutet, dass es eine Writer-Instance gibt und alle zusätzlichen Instances Replikate sind, die für Lesevorgänge und zur Verbesserung der Verfügbarkeit verwendet werden können.

Typ: Ganzzahl

Erforderlich: Nein

subnetIds

Die Amazon EC2-Subnetz-IDs für den neuen elastischen Cluster.

Typ: Zeichenfolgen-Array

Erforderlich: Nein

tags

Die Tags, die dem neuen elastischen Cluster zugewiesen werden sollen.

Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge

Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.

Schlüssel-Muster: ^(?!aws:)[a-zA-Z+-=._:/]+$

Einschränkungen der Wertlänge: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.

Erforderlich: Nein

vpcSecurityGroupIds

Eine Liste der EC2-VPC-Sicherheitsgruppen, die dem neuen elastischen Cluster zugeordnet werden sollen.

Typ: Zeichenfolgen-Array

Erforderlich: Nein

Antwortsyntax

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" ]
   }
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

cluster

Der neue Elastic Cluster, der erstellt wurde.

Typ: Cluster Objekt

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

AccessDeniedException

Eine Ausnahme, die auftritt, wenn nicht genügend Berechtigungen zum Ausführen einer Aktion vorhanden sind.

HTTP Status Code: 403

ConflictException

Es ist ein Zugriffskonflikt aufgetreten.

HTTP-Statuscode: 409

InternalServerException

Es ist ein interner Serverfehler aufgetreten.

HTTP Status Code: 500

ServiceQuotaExceededException

Das Servicekontingent für die Aktion wurde überschritten.

HTTP-Statuscode: 402

ThrottlingException

ThrottlingException wird ausgelöst, wenn die Anforderung aufgrund der Anforderungsdrosselung abgelehnt wurde.

HTTP-Statuscode: 429

ValidationException

Eine Struktur, die eine Validierungsausnahme definiert.

HTTP Status Code: 400

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie unter:

• AWS -Befehlszeilenschnittstelle

• AWS SDK für .NET

• AWS SDK für C++

• AWS SDK für Go

• AWS SDK für Java V2

• AWS SDK für JavaScript V3

• AWS SDK für PHP V3

• AWS SDK für Python

• AWS SDK für Ruby V3