View a markdown version of this page

UpdateCluster - Amazon MemoryDB
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerWeitere 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.

UpdateCluster

Ändert die Einstellungen für einen Cluster. Sie können diesen Vorgang verwenden, um eine oder mehrere Cluster-Konfigurationseinstellungen zu ändern, indem Sie die Einstellungen und die neuen Werte angeben.

Anforderungssyntax

{
   "ACLName": "string",
   "ClusterName": "string",
   "Description": "string",
   "Engine": "string",
   "EngineVersion": "string",
   "IpDiscovery": "string",
   "MaintenanceWindow": "string",
   "NodeType": "string",
   "ParameterGroupName": "string",
   "ReplicaConfiguration": { 
      "ReplicaCount": number
   },
   "SecurityGroupIds": [ "string" ],
   "ShardConfiguration": { 
      "ShardCount": number
   },
   "SnapshotRetentionLimit": number,
   "SnapshotWindow": "string",
   "SnsTopicArn": "string",
   "SnsTopicStatus": "string"
}

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

Die Zugriffskontrollliste, die dem Cluster zugeordnet ist.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen.

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

Erforderlich: Nein

ClusterName

Der Name des Clusters, der aktualisiert werden soll.

Typ: Zeichenfolge

Erforderlich: Ja

Description

Die Beschreibung des Clusters, das aktualisiert werden soll.

Typ: Zeichenfolge

Erforderlich: Nein

Engine

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

Typ: Zeichenfolge

Erforderlich: Nein

EngineVersion

Die aktualisierte Version der Engine, die auf den Knoten ausgeführt werden soll. Sie können ein Upgrade auf eine neuere Engine-Version durchführen, ein Downgrade auf eine frühere Engine-Version ist jedoch nicht möglich. Wenn Sie eine frühere Engine-Version verwenden möchten, müssen Sie den vorhandenen Cluster löschen und ihn mit der früheren Engine-Version erneut erstellen.

Typ: Zeichenfolge

Erforderlich: Nein

IpDiscovery

Der Mechanismus zur Erkennung 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

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

NodeType

Ein gültiger Knotentyp, auf den Sie diesen Cluster hoch- oder herunterskalieren möchten.

Typ: Zeichenfolge

Erforderlich: Nein

ParameterGroupName

Der Name der Parametergruppe, die aktualisiert werden soll.

Typ: Zeichenfolge

Erforderlich: Nein

ReplicaConfiguration

Die Anzahl der Replikate, die sich in jedem Shard befinden werden.

Typ: ReplicaConfigurationRequest Objekt

Erforderlich: Nein

SecurityGroupIds

Die zu aktualisierenden SecurityGroupIds .

Typ: Zeichenfolgen-Array

Erforderlich: Nein

ShardConfiguration

Die Anzahl der Shards im Cluster.

Typ: ShardConfigurationRequest Objekt

Erforderlich: Nein

SnapshotRetentionLimit

Die Anzahl der Tage, für die MemoryDB automatische Cluster-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 Clusters zu erstellen.

Typ: Zeichenfolge

Erforderlich: Nein

SnsTopicArn

Der ARN des SNS-Themas, der aktualisiert werden soll.

Typ: Zeichenfolge

Erforderlich: Nein

SnsTopicStatus

Der Status des Amazon SNS-Benachrichtigungsthemas. Benachrichtigungen werden nur gesendet, wenn der Status aktiv ist.

Typ: Zeichenfolge

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 aktualisierte 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

ClusterNotFoundFault

HTTP-Statuscode: 400

ClusterQuotaForCustomerExceededFault

HTTP-Statuscode: 400

InvalidACLStateFault

HTTP-Statuscode: 400

InvalidClusterStateFault

HTTP-Statuscode: 400

InvalidKMSKeyFault

HTTP-Statuscode: 400

InvalidNodeStateFault

HTTP-Statuscode: 400

InvalidParameterCombinationException

HTTP-Statuscode: 400

InvalidParameterValueException

HTTP-Statuscode: 400

InvalidVPCNetworkStateFault

HTTP-Statuscode: 400

NodeQuotaForClusterExceededFault

HTTP-Statuscode: 400

NodeQuotaForCustomerExceededFault

HTTP-Statuscode: 400

NoOperationFault

HTTP-Statuscode: 400

ParameterGroupNotFoundFault

HTTP-Statuscode: 400

ServiceLinkedRoleNotFoundFault

HTTP-Statuscode: 400

ShardsPerClusterQuotaExceededFault

HTTP-Statuscode: 400

Weitere Informationen finden Sie unter:

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