View a markdown version of this page

CreateCluster - 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.

CreateCluster

Créez un cluster. Tous les nœuds du cluster exécutent le même logiciel moteur conforme au protocole.

Syntaxe de la requête

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

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

Nom de la liste de contrôle d'accès à associer au cluster.

Type : Chaîne

Contraintes de longueur : longueur minimum de 1.

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

Obligatoire : oui

AutoMinorVersionUpgrade

Lorsque ce paramètre est défini sur true, le cluster reçoit automatiquement des mises à niveau mineures des versions du moteur après le lancement.

Type : booléen

Obligatoire : non

ClusterName

Le nom du cluster. Cette valeur doit être unique car elle sert également d'identifiant de cluster. Cette valeur est stockée sous la forme d’une chaîne en minuscules.

Type : Chaîne

Obligatoire : oui

DataTiering

Active la hiérarchisation des données. La hiérarchisation des données n'est prise en charge que pour les clusters utilisant le type de nœud r6gd. Ce paramètre doit être défini lors de l'utilisation de nœuds r6gd. Pour plus d’informations, consultez la rubrique Hiérarchisation des données.

Type : booléen

Obligatoire : non

Description

Description facultative du cluster.

Type : chaîne

Obligatoire : non

Engine

Nom du moteur à utiliser pour le cluster.

Type : chaîne

Obligatoire : non

EngineVersion

Numéro de version du moteur Redis OSS à utiliser pour le cluster.

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

KmsKeyId

L'ID de la clé KMS utilisée pour chiffrer le cluster.

Type : chaîne

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

MultiRegionClusterName

Nom du cluster multirégional à créer.

Type : chaîne

Obligatoire : non

NetworkType

Spécifie le type d'adresse IP du cluster. Les valeurs valides sont « ipv4 », « ipv6 » ou « dual_stack ». Lorsqu'il est réglé sur « ipv4 », le cluster ne sera accessible que via des adresses IPv4. Lorsqu'il est défini sur « ipv6 », le cluster ne sera accessible que via des adresses IPv6. Lorsqu'il est défini sur « dual_stack », le cluster sera accessible via des adresses IPv4 et IPv6. S'il n'est pas spécifié, la valeur par défaut est « ipv4 ».

Type : Chaîne

Valeurs valides : ipv4 | ipv6 | dual_stack

Obligatoire : non

NodeType

La capacité de calcul et de mémoire des nœuds du cluster.

Type : Chaîne

Obligatoire : oui

NumReplicasPerShard

Le nombre de réplicas à appliquer à chaque partition. La valeur par défaut est 1. Le maximum est de 5.

Type : Integer

Obligatoire : non

NumShards

Le nombre de fragments que le cluster contiendra. La valeur par défaut est 1.

Type : Integer

Obligatoire : non

ParameterGroupName

Nom du groupe de paramètres associé au cluster.

Type : chaîne

Obligatoire : non

Port

Numéro de port sur lequel chacun des nœuds accepte les connexions.

Type : Integer

Obligatoire : non

SecurityGroupIds

Liste de noms de groupe de sécurité à associer à ce cluster.

Type : tableau de chaînes

Obligatoire : non

SnapshotArns

Une liste de noms Amazon Resource Name (ARN) qui identifient de façon unique les fichiers d'instantané RDB stockés dans Amazon S3. Les fichiers de capture d'écran sont utilisés pour remplir le nouveau cluster. Le nom de l'objet Amazon S3 dans l'ARN ne peut pas contenir de virgules.

Type : tableau de chaînes

Obligatoire : non

SnapshotName

Nom d'un instantané à partir duquel restaurer les données dans le nouveau cluster. L'état de l'instantané passe à la restauration lors de la création du nouveau cluster.

Type : chaîne

Obligatoire : non

SnapshotRetentionLimit

Nombre de jours pendant lesquels MemoryDB conserve les instantanés automatiques 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 partition.

Exemple : 05:00-09:00

Si vous ne spécifiez pas ce paramètre, MemoryDB choisit automatiquement une plage de temps appropriée.

Type : chaîne

Obligatoire : non

SnsTopicArn

L'Amazon Resource Name (ARN) de la rubrique Amazon Simple Notification Service (SNS) à laquelle les notifications sont envoyées.

Type : chaîne

Obligatoire : non

SubnetGroupName

Le nom du groupe de sous-réseaux à utiliser pour le cluster.

Type : chaîne

Obligatoire : non

Tags

Liste des balises à ajouter à cette ressource. Les balises sont des paires clé-valeur séparées par des virgules (par exemple Key=MyKey, Value=My). KeyValue Vous pouvez inclure plusieurs balises comme indiqué ci-dessous : key=MyKey, value=My Key=my, KeyValue value=MY. SecondKey SecondKeyValue

Type : tableau d’objets Tag

Membres du tableau : nombre maximum de 200 éléments.

Obligatoire : non

TLSEnabled

Indicateur permettant d'activer le chiffrement en transit sur le cluster.

Type : booléen

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 nouvellement créé.

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

ClusterAlreadyExistsFault

Code d’état HTTP : 400

ClusterQuotaForCustomerExceededFault

Code d’état HTTP : 400

InsufficientClusterCapacityFault

Code d’état HTTP : 400

InvalidACLStateFault

Code d’état HTTP : 400

InvalidCredentialsException

Code d’état HTTP : 400

InvalidMultiRegionClusterStateFault

L'opération demandée ne peut pas être effectuée sur le cluster multirégional dans son état actuel.

Code d’état HTTP : 400

InvalidParameterCombinationException

Code d’état HTTP : 400

InvalidParameterValueException

Code d’état HTTP : 400

InvalidVPCNetworkStateFault

Code d’état HTTP : 400

MultiRegionClusterNotFoundFault

Le cluster multirégional spécifié n'existe pas.

Code d’état HTTP : 400

NodeQuotaForClusterExceededFault

Code d’état HTTP : 400

NodeQuotaForCustomerExceededFault

Code d’état HTTP : 400

ParameterGroupNotFoundFault

Code d’état HTTP : 400

ServiceLinkedRoleNotFoundFault

Code d’état HTTP : 400

ShardsPerClusterQuotaExceededFault

Code d’état HTTP : 400

SubnetGroupNotFoundFault

Code d’état HTTP : 400

TagQuotaPerResourceExceeded

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 :