CreateCluster - Amazon MemoryDB
AnforderungssyntaxAnfrageparameterAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

CreateCluster

Erstellt einen Cluster. Alle Knoten im Cluster verwenden dieselbe protokollkonforme Engine-Software.

Anforderungssyntax

{
   "ACLName": "string",
   "AutoMinorVersionUpgrade": boolean,
   "ClusterName": "string",
   "DataTiering": boolean,
   "Description": "string",
   "EngineVersion": "string",
   "KmsKeyId": "string",
   "MaintenanceWindow": "string",
   "NodeType": "string",
   "NumReplicasPerShard": number,
   "NumShards": number,
   "ParameterGroupName": "string",
   "Port": number,
   "SecurityGroupIds": [ "string" ],
   "SnapshotArns": [ "string" ],
   "SnapshotName": "string",
   "SnapshotRetentionLimit": number,
   "SnapshotWindow": "string",
   "SnsTopicArn": "string",
   "SubnetGroupName": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "TLSEnabled": boolean
}

Anfrageparameter

Informationen zu den Parametern, die allen Aktionen gemeinsam sind, finden Sie unter Allgemeine Parameter.

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

ACLName

Der Name der Zugriffskontrollliste, die dem Cluster zugeordnet werden soll.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 1.

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

Erforderlich: Ja

AutoMinorVersionUpgrade

Wenn auf „true“ gesetzt, erhält der Cluster nach dem Launch automatisch kleinere Engine-Versions-Upgrades.

Typ: Boolesch

Required: No

ClusterName

Der Name des Clusters Dieser Wert muss eindeutig sein, da er auch als Cluster-ID dient.

Typ: Zeichenfolge

Erforderlich: Ja

DataTiering

Ermöglicht Daten-Tiering. Daten-Tiering wird nur für Cluster mit R6gd-Knotentyp unterstützt. Dieser Parameter muss festgelegt werden, wenn R6gd-Knoten verwendet werden. Weitere Informationen finden Sie unter Daten-Tiering.

Typ: Boolesch

Required: No

Description

Eine optionale Beschreibung des Clusters.

Typ: Zeichenfolge

Required: No

EngineVersion

Die Versionsnummer der Redis-Engine, die für den Cluster verwendet werden soll.

Typ: Zeichenfolge

Required: No

KmsKeyId

Die ID des KMS-Schlüssels, der zum Verschlüsseln des Clusters verwendet wird.

Typ: Zeichenfolge

Required: No

MaintenanceWindow

Dies gibt den wöchentlichen Zeitraum, in dem die Wartung der Cluster ausgeführt wird. Es wird als Bereich im Format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC) angegeben. Das minimale Wartungszeitfenster ist ein Zeitraum von 60 Minuten.

Gültige Werte für ddd sind:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Beispiel: sun:23:00-mon:01:30

Typ: Zeichenfolge

Required: No

NodeType

Die Rechen- und Speicherkapazität der Knoten im Cluster.

Typ: Zeichenfolge

Erforderlich: Ja

NumReplicasPerShard

Die Anzahl der Replikate, die auf jeden Shard angewendet werden sollen. Der Standardwert lautet 1. Das Maximum ist 5.

Typ: Ganzzahl

Required: No

NumShards

Die Anzahl der Shards, die der Cluster enthalten wird. Der Standardwert lautet 1.

Typ: Ganzzahl

Required: No

ParameterGroupName

Der Name der Parametergruppe, die dem Cluster zugeordnet ist.

Typ: Zeichenfolge

Required: No

Port

Die Portnummer, an dem die einzelnen Knoten die Verknüpfungen akzeptieren.

Typ: Ganzzahl

Required: No

SecurityGroupIds

Eine Liste der Sicherheitsgruppennamen, die diesem Cluster zugeordnet werden sollen.

Typ: Zeichenfolge-Array

Required: No

SnapshotArns

Eine Liste von Amazon-Ressourcennamen (ARN), die die in Amazon S3 gespeicherten RDB-Snapshot-Dateien eindeutig identifizieren. Die Snapshot-Dateien werden verwendet, um den neuen Cluster zu befüllen. Der Amazon S3-Objektname im ARN darf keine Kommata enthalten.

Typ: Zeichenfolge-Array

Required: No

SnapshotName

Der Name eines Snapshots aus, der für die Wiederherstellung von Daten im neuen Cluster verwendet wird. Der Snapshot-Status ändert sich in Wiederherstellung, während der neue Cluster erstellt wird.

Typ: Zeichenfolge

Required: No

SnapshotRetentionLimit

Die Anzahl der Tage, für die MemoryDB automatische Snapshots behält, bevor sie gelöscht werden. Wenn Sie zum Beispiel einen Snapshot festlegen SnapshotRetentionLimit , der heute gemacht wurde, dann wird er 5 Tage behalten bevor er gelöscht wird.

Typ: Ganzzahl

Required: No

SnapshotWindow

Der tägliche Zeitbereich (in UTC) innerhalb dessen MemoryDB beginnt, tägliche Snapshots Ihres Shards) zu erstellen.

Beispiel: 05:00-09:00

Wenn Sie diesen Parameter nicht angeben, wählt MemoryDB automatisch einen entsprechenden Zeitraum.

Typ: Zeichenfolge

Required: No

SnsTopicArn

Der Amazon-Ressourcenname (ARN) des Amazon Simple Notification Service (SNS) Themas, an das die Benachrichtigungen gesendet werden.

Typ: Zeichenfolge

Required: No

SubnetGroupName

Der Name der Subnetzgruppe, die für den Cluster verwendet werden soll.

Typ: Zeichenfolge

Required: No

Tags

Eine Liste von Tags, die dieser Ressource hinzugefügt werden sollen. Tags sind kommagetrennte Schlüssel/Werte-Paare (z.B. Key=MyKey, Value=)myKeyValue. Sie können mehrere Tags hinzufügen. Beispiel: Key=MyKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKey Value.

Typ: Array von Tag-Objekten

Array-Mitglieder: Maximale Anzahl von 200 Elementen.

Required: No

TLSEnabled

Ein Flag zum Aktivieren der Verschlüsselung während der Übertragung für den Cluster.

Typ: Boolesch

Required: No

Antwortsyntax

{
   "Cluster": { 
      "ACLName": "string",
      "ARN": "string",
      "AutoMinorVersionUpgrade": boolean,
      "AvailabilityMode": "string",
      "ClusterEndpoint": { 
         "Address": "string",
         "Port": number
      },
      "DataTiering": "string",
      "Description": "string",
      "EnginePatchVersion": "string",
      "EngineVersion": "string",
      "KmsKeyId": "string",
      "MaintenanceWindow": "string",
      "Name": "string",
      "NodeType": "string",
      "NumberOfShards": number,
      "ParameterGroupName": "string",
      "ParameterGroupStatus": "string",
      "PendingUpdates": { 
         "ACLs": { 
            "ACLToApply": "string"
         },
         "Resharding": { 
            "SlotMigration": { 
               "ProgressPercentage": number
            }
         },
         "ServiceUpdates": [ 
            { 
               "ServiceUpdateName": "string",
               "Status": "string"
            }
         ]
      },
      "SecurityGroups": [ 
         { 
            "SecurityGroupId": "string",
            "Status": "string"
         }
      ],
      "Shards": [ 
         { 
            "Name": "string",
            "Nodes": [ 
               { 
                  "AvailabilityZone": "string",
                  "CreateTime": number,
                  "Endpoint": { 
                     "Address": "string",
                     "Port": number
                  },
                  "Name": "string",
                  "Status": "string"
               }
            ],
            "NumberOfNodes": number,
            "Slots": "string",
            "Status": "string"
         }
      ],
      "SnapshotRetentionLimit": number,
      "SnapshotWindow": "string",
      "SnsTopicArn": "string",
      "SnsTopicStatus": "string",
      "Status": "string",
      "SubnetGroupName": "string",
      "TLSEnabled": boolean
   }
}

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 neu erstellte Cluster.

Typ: Cluster Objekt

Fehler

Hinweise zu den Fehlern, die allen Aktionen gemeinsam sind, finden Sie unterHäufige Fehler.

ACLNotFoundFault

HTTP Status Code: 400

ClusterAlreadyExistsFault

HTTP Status Code: 400

ClusterQuotaForCustomerExceededFault

HTTP Status Code: 400

InsufficientClusterCapacityFault

HTTP Status Code: 400

InvalidACLStateFault

HTTP Status Code: 400

InvalidCredentialsException

HTTP Status Code: 400

InvalidParameterCombinationException

HTTP Status Code: 400

InvalidParameterValueException

HTTP Status Code: 400

InvalidVPCNetworkStateFault

HTTP Status Code: 400

NodeQuotaForClusterExceededFault

HTTP Status Code: 400

NodeQuotaForCustomerExceededFault

HTTP Status Code: 400

ParameterGroupNotFoundFault

HTTP Status Code: 400

ServiceLinkedRoleNotFoundFault

HTTP Status Code: 400

ShardsPerClusterQuotaExceededFault

HTTP Status Code: 400

SubnetGroupNotFoundFault

HTTP Status Code: 400

TagQuotaPerResourceExceeded

HTTP Status Code: 400

Weitere Informationen finden Sie unter:

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