CreateCluster

Crée un cluster vide. Chaque cluster prend en charge cinq nœuds. Vous utilisez l'CreateJobaction séparément pour créer les tâches pour chacun de ces nœuds. Le cluster n'est pas livré tant que ces cinq tâches de nœud n'ont pas été créées.

Syntaxe de la requête

{
   "AddressId": "string",
   "Description": "string",
   "ForwardingAddressId": "string",
   "JobType": "string",
   "KmsKeyARN": "string",
   "Notification": { 
      "JobStatesToNotify": [ "string" ],
      "NotifyAll": boolean,
      "SnsTopicARN": "string"
   },
   "OnDeviceServiceConfiguration": { 
      "EKSOnDeviceService": { 
         "EKSAnywhereVersion": "string",
         "KubernetesVersion": "string"
      },
      "NFSOnDeviceService": { 
         "StorageLimit": number,
         "StorageUnit": "string"
      },
      "TGWOnDeviceService": { 
         "StorageLimit": number,
         "StorageUnit": "string"
      }
   },
   "RemoteManagement": "string",
   "Resources": { 
      "Ec2AmiResources": [ 
         { 
            "AmiId": "string",
            "SnowballAmiId": "string"
         }
      ],
      "LambdaResources": [ 
         { 
            "EventTriggers": [ 
               { 
                  "EventResourceARN": "string"
               }
            ],
            "LambdaArn": "string"
         }
      ],
      "S3Resources": [ 
         { 
            "BucketArn": "string",
            "KeyRange": { 
               "BeginMarker": "string",
               "EndMarker": "string"
            },
            "TargetOnDeviceServices": [ 
               { 
                  "ServiceName": "string",
                  "TransferOption": "string"
               }
            ]
         }
      ]
   },
   "RoleARN": "string",
   "ShippingOption": "string",
   "SnowballType": "string",
   "TaxDocuments": { 
      "IND": { 
         "GSTIN": "string"
      }
   }
}

Paramètres de demande

Pour plus d'informations sur les paramètres communs à toutes les actions, voir Paramètres communs.

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

AddressId

L'ID de l'adresse à laquelle vous souhaitez que le cluster soit expédié.

Type : String

Contraintes de longueur : longueur fixe de 40.

Modèle : ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Obligatoire : oui

Description

Une description facultative de ce cluster spécifique, par exempleEnvironmental Data Cluster-01.

Type : String

Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 1024.

Modèle : .*

Obligatoire : non

ForwardingAddressId

Ce champ n'est pas pris en charge dans votre région.

Type : String

Contraintes de longueur : longueur fixe de 40.

Modèle : ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Obligatoire : non

JobType

Le type de tâche de tâche. Actuellement, le seul type de tâche pris en charge pour les clusters estLOCAL_USE.

Pour plus d'informations sur les types d'appareils de la famille Snow, consultez les sections Appareils et capacités de la famille Snow dans le guide de l'utilisateur Snowcone ou Appareils et capacités de la famille Snow dans le guide de l'utilisateur Snowball Edge.

Type : String

Valeurs valides : IMPORT | EXPORT | LOCAL_USE

Obligatoire : oui

KmsKeyARN

KmsKeyARNLa type de. KmsKeyARNles valeurs sont créées à l'aide de l'action d'CreateKeyAPI dansAWS Key Management Service (AWS KMS).

Type : String

Contraintes de longueur : longueur maximale de 255.

Modèle : arn:aws.*:kms:.*:[0-9]{12}:key/.*

Obligatoire : non

Notification

Fournde notification Amazon Simple Notification Service (Amazon SNS) pour ce cluster.

Type : objet Notification

Obligatoire : non

OnDeviceServiceConfiguration

Spécifie le ou les services de l'appareil Snow Family à partir desquels les données transférées seront exportées ou importées. AWS Les clusters d'appareils de la famille Snow prennent en charge Amazon S3 et NFS (Network File System).

Type : objet OnDeviceServiceConfiguration

Obligatoire : non

RemoteManagement

Vous permet de faire fonctionner et de gérer en toute sécurité les appareils Snow d'un cluster à distance depuis l'extérieur de votre réseau interne. Lorsque ce paramètre est réglé surINSTALLED_AUTOSTART, la gestion à distance sera automatiquement disponible lorsque l'appareil arrivera chez vous. Sinon, vous devez utiliser le client Snowball pour gérer l'appareil.

Type : String

Valeurs valides : INSTALLED_ONLY | INSTALLED_AUTOSTART

Obligatoire : non

Resources

Fournde tâche de. Ces ressources incluent des compartiments Amazon S3 et desAWS Lambda fonctions facultatives écrites en langage Python.

Type : objet JobResource

Obligatoire : oui

RoleARN

LeRoleARN type de cluster. RoleArnles valeurs sont créées à l'aide de l'action d'CreateRoleAPI dansAWS Identity and Access Management (IAM).

Type : String

Contraintes de longueur : longueur maximale de 255.

Modèle : arn:aws.*:iam::[0-9]{12}:role/.*

Obligatoire : oui

ShippingOption

Vitesse d'expédition pour chaque nœud de ce cluster. Cette vitesse ne dicte pas la rapidité avec laquelle vous recevrez chaque appareil Snowball Edge, mais plutôt la rapidité avec laquelle chaque appareil se déplace vers sa destination pendant le transport. Les vitesses d'expédition régionales sont les suivantes :

• En Australie, vous avez accès à la livraison express. En règle générale, les appareils Snow expédiés en express sont livrés en une journée environ.

• Dans l'Union européenne (UE), vous avez accès à la livraison express. En règle générale, les appareils Snow expédiés en express sont livrés en une journée environ. En outre, la plupart des pays de l'UE ont accès à l'expédition standard, ce qui prend généralement moins d'une semaine dans un sens.

• En Inde, les appareils Snow sont livrés en un à sept jours.

• Aux États-Unis d'Amérique (USA), vous avez accès à la livraison en un jour et à la livraison en deux jours.

• En Australie, vous avez accès à la livraison express. En général, les appareils expédiés en express sont livrés en une journée environ.

• Dans l'Union européenne (UE), vous avez accès à la livraison express. En règle générale, les appareils Snow expédiés en express sont livrés en une journée environ. En outre, la plupart des pays de l'UE ont accès à l'expédition standard, ce qui prend généralement moins d'une semaine dans un sens.

• En Inde, les appareils Snow sont livrés en un à sept jours.

• Aux États-Unis, vous avez accès à la livraison en un jour et à la livraison en deux jours.

Type : String

Valeurs valides : SECOND_DAY | NEXT_DAY | EXPRESS | STANDARD

Obligatoire : oui

SnowballType

Type de périphériques Snow Family à utiliser pour ce cluster.

Note

Pour les tâches de cluster,AWS Snow Family ne prend actuellement en charge que le type d'EDGEappareil.

Pour plus d'informations sur les types d'appareils de la famille Snow, consultez les sections Appareils et capacités de la famille Snow dans le guide de l'utilisateur Snowcone ou Appareils et capacités de la famille Snow dans le guide de l'utilisateur Snowball Edge.

Type : String

Valeurs valides : STANDARD | EDGE | EDGE_C | EDGE_CG | EDGE_S | SNC1_HDD | SNC1_SSD | V3_5C

Obligatoire : oui

TaxDocuments

Les documents fiscaux requis dans votreRégion AWS.

Type : objet TaxDocuments

Obligatoire : non

Syntaxe de la réponse

{
   "ClusterId": "string"
}

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.

ClusterId

L'ID généré automatiquement pour un cluster.

Type : String

Contraintes de longueur : longueur fixe de 39.

Modèle : CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Erreurs

Pour plus d'informations sur les erreurs communes à toutes les actions, consultezErreurs courantes.

Ec2RequestFailedException

Votre utilisateur IAM ne dispose pas des autorisations Amazon EC2 nécessaires pour effectuer l'action tentée.

Code d'état HTTP : 400

InvalidInputCombinationException

La création de Job ou de tâche. Une ou plusieurs entrées n'étaient pas valides. Vérifiez que laSnowballType valeur CreateCluster: est compatible avec votre CreateJob:JobType, puis réessayez.

Code d'état HTTP : 400

InvalidResourceException

La ressource spécifiée est introuvable. Vérifiez les informations que vous avez fournies dans votre dernière demande et réessayez.

Code d'état HTTP : 400

KMSRequestFailedException

LaAWS Key Management Service clé fournie ne dispose pas des autorisations nécessaires pour exécuter l'UpdateJobactionCreateJob ou l'action spécifiée.

Code d'état HTTP : 400

Voir aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des kits SDK AWS spécifiques au langage, consultez les ressources suivantes :

• Interface de ligne de commande AWS

• AWS SDK pour .NET

• Kit AWS SDK pour C++

• Kit AWS SDK pour Go

• Kit SDK AWS pour Java V2

• AWSSDK pour JavaScript

• AWS SDK pour PHP V3

• AWS SDK pour Python

• Kit SDK AWS pour Ruby V3