View a markdown version of this page

UpdateCluster - Amazon MemoryDB
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursVoir 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.

UpdateCluster

Modifie les paramètres d'un cluster. Vous pouvez utiliser cette opération pour modifier un ou plusieurs paramètres de configuration du cluster en spécifiant les paramètres et les nouvelles valeurs.

Syntaxe de la requête

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

Paramètres de demande

Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.

Cette demande accepte les données suivantes au format JSON.

ACLName

La liste de contrôle d'accès associée au cluster.

Type : Chaîne

Contraintes de longueur : longueur minimum de 1.

Modèle : [a-zA-Z][a-zA-Z0-9\-]*

Obligatoire : non

ClusterName

Le nom du cluster à mettre à jour.

Type : Chaîne

Obligatoire : oui

Description

Description du cluster à mettre à jour.

Type : chaîne

Obligatoire : non

Engine

Nom du moteur à utiliser pour le cluster.

Type : chaîne

Obligatoire : non

EngineVersion

Version améliorée du moteur à exécuter sur les nœuds. Vous pouvez effectuer une mise à niveau vers une version plus récente du moteur, mais vous ne pouvez pas revenir à une version antérieure du moteur. Si vous souhaitez utiliser une version antérieure du moteur, vous devez supprimer le cluster existant et le créer à nouveau avec la version précédente du moteur.

Type : chaîne

Obligatoire : non

IpDiscovery

Le mécanisme de découverte des adresses IP pour le protocole de découverte de clusters. Les valeurs valides sont « ipv4 » ou « ipv6 ». Lorsqu'elles sont définies sur « ipv4 », les fonctions de découverte de clusters telles que les emplacements de cluster, les fragments de cluster et les nœuds de cluster renvoient des adresses IPv4 pour les nœuds de cluster. Lorsqu'elles sont définies sur « ipv6 », les fonctions de découverte de clusters renvoient des adresses IPv6 pour les nœuds de cluster. La valeur doit être compatible avec le NetworkType paramètre. S'il n'est pas spécifié, la valeur par défaut est « ipv4 ».

Type : Chaîne

Valeurs valides : ipv4 | ipv6

Obligatoire : non

MaintenanceWindow

Indique la plage de temps hebdomadaire au cours de laquelle la maintenance sur le cluster est effectuée. Elle est spécifiée en tant que plage au format jjj:hh24:mi-jjjj:hh24:mi (24 H UTC). La fenêtre de maintenance minimale est une période de 60 minutes.

Les valeurs valides pour ddd sont :

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

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

Type : chaîne

Obligatoire : non

NodeType

Type de nœud valide auquel vous souhaitez augmenter ou diminuer la taille de ce cluster.

Type : chaîne

Obligatoire : non

ParameterGroupName

Nom du groupe de paramètres à mettre à jour.

Type : chaîne

Obligatoire : non

ReplicaConfiguration

Le nombre de répliques qui résideront dans chaque fragment.

Type : objet ReplicaConfigurationRequest

Obligatoire : non

SecurityGroupIds

Le SecurityGroupIds à mettre à jour.

Type : tableau de chaînes

Obligatoire : non

ShardConfiguration

Le nombre de fragments dans le cluster.

Type : objet ShardConfigurationRequest

Obligatoire : non

SnapshotRetentionLimit

Nombre de jours pendant lesquels MemoryDB conserve les instantanés automatiques des clusters avant de les supprimer. Par exemple, si vous définissez la SnapshotRetentionLimit valeur 5, une capture d'écran prise aujourd'hui est conservée pendant 5 jours avant d'être supprimée.

Type : Integer

Obligatoire : non

SnapshotWindow

Plage horaire quotidienne (en UTC) pendant laquelle MemoryDB commence à prendre un instantané quotidien de votre cluster.

Type : chaîne

Obligatoire : non

SnsTopicArn

L'ARN de la rubrique SNS à mettre à jour.

Type : chaîne

Obligatoire : non

SnsTopicStatus

État de la rubrique de notification Amazon SNS. Les notifications ne sont envoyées que si le statut est actif.

Type : chaîne

Obligatoire : non

Syntaxe de la réponse

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

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 cluster mis à jour.

Type : objet Cluster

Erreurs

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

ACLNotFoundFault

Code d’état HTTP : 400

ClusterNotFoundFault

Code d’état HTTP : 400

ClusterQuotaForCustomerExceededFault

Code d’état HTTP : 400

InvalidACLStateFault

Code d’état HTTP : 400

InvalidClusterStateFault

Code d’état HTTP : 400

InvalidKMSKeyFault

Code d’état HTTP : 400

InvalidNodeStateFault

Code d’état HTTP : 400

InvalidParameterCombinationException

Code d’état HTTP : 400

InvalidParameterValueException

Code d’état HTTP : 400

InvalidVPCNetworkStateFault

Code d’état HTTP : 400

NodeQuotaForClusterExceededFault

Code d’état HTTP : 400

NodeQuotaForCustomerExceededFault

Code d’état HTTP : 400

NoOperationFault

Code d’état HTTP : 400

ParameterGroupNotFoundFault

Code d’état HTTP : 400

ServiceLinkedRoleNotFoundFault

Code d’état HTTP : 400

ShardsPerClusterQuotaExceededFault

Code d’état HTTP : 400

Voir aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS kits SDK spécifiques à une langue, consultez les rubriques suivantes :