class Aws::Snowball::Types::CreateClusterRequest
@note When making an API call, you may pass CreateClusterRequest
data as a hash: { job_type: "IMPORT", # required, accepts IMPORT, EXPORT, LOCAL_USE resources: { # required s3_resources: [ { bucket_arn: "ResourceARN", key_range: { begin_marker: "String", end_marker: "String", }, target_on_device_services: [ { service_name: "NFS_ON_DEVICE_SERVICE", # accepts NFS_ON_DEVICE_SERVICE, S3_ON_DEVICE_SERVICE transfer_option: "IMPORT", # accepts IMPORT, EXPORT, LOCAL_USE }, ], }, ], lambda_resources: [ { lambda_arn: "ResourceARN", event_triggers: [ { event_resource_arn: "ResourceARN", }, ], }, ], ec2_ami_resources: [ { ami_id: "AmiId", # required snowball_ami_id: "String", }, ], }, on_device_service_configuration: { nfs_on_device_service: { storage_limit: 1, storage_unit: "TB", # accepts TB }, }, description: "String", address_id: "AddressId", # required kms_key_arn: "KmsKeyARN", role_arn: "RoleARN", # required snowball_type: "STANDARD", # required, accepts STANDARD, EDGE, EDGE_C, EDGE_CG, EDGE_S, SNC1_HDD, SNC1_SSD shipping_option: "SECOND_DAY", # required, accepts SECOND_DAY, NEXT_DAY, EXPRESS, STANDARD notification: { sns_topic_arn: "SnsTopicARN", job_states_to_notify: ["New"], # accepts New, PreparingAppliance, PreparingShipment, InTransitToCustomer, WithCustomer, InTransitToAWS, WithAWSSortingFacility, WithAWS, InProgress, Complete, Cancelled, Listing, Pending notify_all: false, }, forwarding_address_id: "AddressId", tax_documents: { ind: { gstin: "GSTIN", }, }, remote_management: "INSTALLED_ONLY", # accepts INSTALLED_ONLY, INSTALLED_AUTOSTART }
@!attribute [rw] job_type
The type of job for this cluster. Currently, the only job type supported for clusters is `LOCAL_USE`. For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the *Snowcone User Guide* or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the *Snowcone User Guide*. @return [String]
@!attribute [rw] resources
The resources associated with the cluster job. These resources include Amazon S3 buckets and optional AWS Lambda functions written in the Python language. @return [Types::JobResource]
@!attribute [rw] on_device_service_configuration
Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System). @return [Types::OnDeviceServiceConfiguration]
@!attribute [rw] description
An optional description of this specific cluster, for example `Environmental Data Cluster-01`. @return [String]
@!attribute [rw] address_id
The ID for the address that you want the cluster shipped to. @return [String]
@!attribute [rw] kms_key_arn
The `KmsKeyARN` value that you want to associate with this cluster. `KmsKeyARN` values are created by using the [CreateKey][1] API action in AWS Key Management Service (AWS KMS). [1]: https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html @return [String]
@!attribute [rw] role_arn
The `RoleARN` that you want to associate with this cluster. `RoleArn` values are created by using the [CreateRole][1] API action in AWS Identity and Access Management (IAM). [1]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html @return [String]
@!attribute [rw] snowball_type
The type of AWS Snow Family device to use for this cluster. <note markdown="1"> For cluster jobs, AWS Snow Family currently supports only the `EDGE` device type. </note> For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the *Snowcone User Guide* or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the *Snowcone User Guide*. @return [String]
@!attribute [rw] shipping_option
The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows: * In Australia, you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. * In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way. * In India, Snow devices are delivered in one to seven days. * In the United States of America (US), you have access to one-day shipping and two-day shipping. ^ * In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day. * In the European Union (EU), you have access to express shipping. Typically, Snow devices shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way. * In India, Snow devices are delivered in one to seven days. * In the US, you have access to one-day shipping and two-day shipping. @return [String]
@!attribute [rw] notification
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster. @return [Types::Notification]
@!attribute [rw] forwarding_address_id
The forwarding address ID for a cluster. This field is not supported in most regions. @return [String]
@!attribute [rw] tax_documents
The tax documents required in your AWS Region. @return [Types::TaxDocuments]
@!attribute [rw] remote_management
Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to `INSTALLED_AUTOSTART`, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CreateClusterRequest AWS API Documentation
Constants
- SENSITIVE