View a markdown version of this page

CreateCluster - Amazon MemoryDB

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. Auf allen Knoten im Cluster wird dieselbe protokollkonforme Engine-Software ausgeführt.

Anforderungssyntax

{ "ACLName": "string", "AutoMinorVersionUpgrade": boolean, "ClusterName": "string", "DataTiering": boolean, "Description": "string", "Engine": "string", "EngineVersion": "string", "IpDiscovery": "string", "KmsKeyId": "string", "MaintenanceWindow": "string", "MultiRegionClusterName": "string", "NetworkType": "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 }

Anforderungsparameter

Informationen zu den Parametern, die alle Aktionen gemeinsam haben, 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 beträgt 1 Zeichen.

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

Erforderlich: Ja

AutoMinorVersionUpgrade

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

Typ: Boolesch

Erforderlich: Nein

ClusterName

Der Name des Clusters. Dieser Wert muss eindeutig sein, da er auch als Cluster-ID dient. Dieser Wert wird als Zeichenfolge in Kleinbuchstaben gespeichert.

Typ: Zeichenfolge

Erforderlich: Ja

DataTiering

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

Typ: Boolesch

Erforderlich: Nein

Description

Eine optionale Beschreibung des Clusters.

Typ: Zeichenfolge

Erforderlich: Nein

Engine

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

Typ: Zeichenfolge

Erforderlich: Nein

EngineVersion

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

Typ: Zeichenfolge

Erforderlich: Nein

IpDiscovery

Der Mechanismus zum Ermitteln von IP-Adressen für das Cluster-Discovery-Protokoll. Gültige Werte sind 'ipv4' oder 'ipv6'. Wenn der Wert auf 'ipv4' gesetzt ist, geben Clustererkennungsfunktionen wie Cluster-Slots, Cluster-Shards und Clusterknoten IPv4-Adressen für Clusterknoten zurück. Wenn die Einstellung auf 'ipv6' gesetzt ist, geben die Cluster-Discovery-Funktionen IPv6-Adressen für Clusterknoten zurück. Der Wert muss mit dem Parameter kompatibel sein. NetworkType Wenn nicht angegeben, ist die Standardeinstellung 'ipv4'.

Typ: Zeichenfolge

Zulässige Werte: ipv4 | ipv6

Erforderlich: Nein

KmsKeyId

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

Typ: Zeichenfolge

Erforderlich: Nein

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

Erforderlich: Nein

MultiRegionClusterName

Der Name des Clusters mit mehreren Regionen, der erstellt werden soll.

Typ: Zeichenfolge

Erforderlich: Nein

NetworkType

Gibt den IP-Adresstyp für den Cluster an. Gültige Werte sind 'ipv4', 'ipv6' oder 'dual_stack'. Wenn der Wert auf 'ipv4' gesetzt ist, kann auf den Cluster nur über IPv4-Adressen zugegriffen werden. Wenn die Einstellung auf 'ipv6' gesetzt ist, kann auf den Cluster nur über IPv6-Adressen zugegriffen werden. Wenn der Wert auf 'dual_stack' gesetzt ist, kann auf den Cluster sowohl über IPv4- als auch über IPv6-Adressen zugegriffen werden. Wenn nicht angegeben, ist die Standardeinstellung 'ipv4'.

Typ: Zeichenfolge

Zulässige Werte: ipv4 | ipv6 | dual_stack

Erforderlich: Nein

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 ist 1. Der Höchstwert ist 5.

Typ: Ganzzahl

Erforderlich: Nein

NumShards

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

Typ: Ganzzahl

Erforderlich: Nein

ParameterGroupName

Der Name der Parametergruppe, die dem Cluster zugeordnet ist.

Typ: Zeichenfolge

Erforderlich: Nein

Port

Die Portnummer, auf der jeder der Knoten Verbindungen akzeptiert.

Typ: Ganzzahl

Erforderlich: Nein

SecurityGroupIds

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

Typ: Zeichenfolgen-Array

Erforderlich: Nein

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 füllen. Der Amazon S3-Objektname im ARN darf keine Kommata enthalten.

Typ: Zeichenfolgen-Array

Erforderlich: Nein

SnapshotName

Der Name eines Snapshots, aus dem Daten im neuen Cluster wiederhergestellt werden sollen. Während der Erstellung des neuen Clusters ändert sich der Snapshot-Status in Wiederherstellen.

Typ: Zeichenfolge

Erforderlich: Nein

SnapshotRetentionLimit

Die Anzahl der Tage, für die MemoryDB automatische Snapshots aufbewahrt, bevor sie gelöscht werden. Wenn Sie beispielsweise den Wert SnapshotRetentionLimit 5 angeben, wird ein Snapshot, der heute aufgenommen wurde, 5 Tage lang aufbewahrt, bevor er gelöscht wird.

Typ: Ganzzahl

Erforderlich: Nein

SnapshotWindow

Der tägliche Zeitraum (in UTC), in dem MemoryDB beginnt, täglich einen Snapshot Ihres Shards zu erstellen.

Beispiel: 05:00-09:00

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

Typ: Zeichenfolge

Erforderlich: Nein

SnsTopicArn

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

Typ: Zeichenfolge

Erforderlich: Nein

SubnetGroupName

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

Typ: Zeichenfolge

Erforderlich: Nein

Tags

Eine Liste von Tags, die dieser Ressource hinzugefügt werden sollen. Tags sind durch Kommas getrennte Schlüssel- und Wertepaare (z. B. key=myKey, value=MY. KeyValue Sie können mehrere Tags wie folgt hinzufügen: key=myKEY, value=My KEY=MY KEY=MY, value=MY. KeyValue SecondKey SecondKeyValue

Typ: Array von Tag-Objekten

Array-Mitglieder: Maximale Anzahl von 200 Elementen.

Erforderlich: Nein

TLSEnabled

Ein Flag zur Aktivierung der Verschlüsselung bei der Übertragung auf dem Cluster.

Typ: Boolesch

Erforderlich: Nein

Antwortsyntax

{ "Cluster": { "ACLName": "string", "ARN": "string", "AutoMinorVersionUpgrade": boolean, "AvailabilityMode": "string", "ClusterEndpoint": { "Address": "string", "Port": number }, "DataTiering": "string", "Description": "string", "Engine": "string", "EnginePatchVersion": "string", "EngineVersion": "string", "IpDiscovery": "string", "KmsKeyId": "string", "MaintenanceWindow": "string", "MultiRegionClusterName": "string", "Name": "string", "NetworkType": "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

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

ACLNotFoundFault

HTTP-Statuscode: 400

ClusterAlreadyExistsFault

HTTP-Statuscode: 400

ClusterQuotaForCustomerExceededFault

HTTP-Statuscode: 400

InsufficientClusterCapacityFault

HTTP-Statuscode: 400

InvalidACLStateFault

HTTP-Statuscode: 400

InvalidCredentialsException

HTTP-Statuscode: 400

InvalidMultiRegionClusterStateFault

Der angeforderte Vorgang kann auf dem Cluster mit mehreren Regionen in seinem aktuellen Zustand nicht ausgeführt werden.

HTTP-Statuscode: 400

InvalidParameterCombinationException

HTTP-Statuscode: 400

InvalidParameterValueException

HTTP-Statuscode: 400

InvalidVPCNetworkStateFault

HTTP-Statuscode: 400

MultiRegionClusterNotFoundFault

Der angegebene Cluster mit mehreren Regionen ist nicht vorhanden.

HTTP-Statuscode: 400

NodeQuotaForClusterExceededFault

HTTP-Statuscode: 400

NodeQuotaForCustomerExceededFault

HTTP-Statuscode: 400

ParameterGroupNotFoundFault

HTTP-Statuscode: 400

ServiceLinkedRoleNotFoundFault

HTTP-Statuscode: 400

ShardsPerClusterQuotaExceededFault

HTTP-Statuscode: 400

SubnetGroupNotFoundFault

HTTP-Statuscode: 400

TagQuotaPerResourceExceeded

HTTP-Statuscode: 400

Weitere Informationen finden Sie unter:

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