Class: Aws::Snowball::Types::CreateClusterRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Snowball::Types::CreateClusterRequest
- Defined in:
- gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb
Overview
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
},
tgw_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
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#address_id ⇒ String
The ID for the address that you want the cluster shipped to.
-
#description ⇒ String
An optional description of this specific cluster, for example
Environmental Data Cluster-01
. -
#forwarding_address_id ⇒ String
The forwarding address ID for a cluster.
-
#job_type ⇒ String
The type of job for this cluster.
-
#kms_key_arn ⇒ String
The
KmsKeyARN
value that you want to associate with this cluster. -
#notification ⇒ Types::Notification
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
-
#on_device_service_configuration ⇒ Types::OnDeviceServiceConfiguration
Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into.
-
#remote_management ⇒ String
Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network.
-
#resources ⇒ Types::JobResource
The resources associated with the cluster job.
-
#role_arn ⇒ String
The
RoleARN
that you want to associate with this cluster. -
#shipping_option ⇒ String
The shipping speed for each node in this cluster.
-
#snowball_type ⇒ String
The type of Snow Family Devices to use for this cluster.
-
#tax_documents ⇒ Types::TaxDocuments
The tax documents required in your Amazon Web Services Region.
Instance Attribute Details
#address_id ⇒ String
The ID for the address that you want the cluster shipped to.
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 629 class CreateClusterRequest < Struct.new( :job_type, :resources, :on_device_service_configuration, :description, :address_id, :kms_key_arn, :role_arn, :snowball_type, :shipping_option, :notification, :forwarding_address_id, :tax_documents, :remote_management) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
An optional description of this specific cluster, for example
Environmental Data Cluster-01
.
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 629 class CreateClusterRequest < Struct.new( :job_type, :resources, :on_device_service_configuration, :description, :address_id, :kms_key_arn, :role_arn, :snowball_type, :shipping_option, :notification, :forwarding_address_id, :tax_documents, :remote_management) SENSITIVE = [] include Aws::Structure end |
#forwarding_address_id ⇒ String
The forwarding address ID for a cluster. This field is not supported in most regions.
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 629 class CreateClusterRequest < Struct.new( :job_type, :resources, :on_device_service_configuration, :description, :address_id, :kms_key_arn, :role_arn, :snowball_type, :shipping_option, :notification, :forwarding_address_id, :tax_documents, :remote_management) SENSITIVE = [] include Aws::Structure end |
#job_type ⇒ String
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.
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 629 class CreateClusterRequest < Struct.new( :job_type, :resources, :on_device_service_configuration, :description, :address_id, :kms_key_arn, :role_arn, :snowball_type, :shipping_option, :notification, :forwarding_address_id, :tax_documents, :remote_management) SENSITIVE = [] include Aws::Structure end |
#kms_key_arn ⇒ String
The KmsKeyARN
value that you want to associate with this cluster.
KmsKeyARN
values are created by using the CreateKey API
action in Key Management Service (KMS).
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 629 class CreateClusterRequest < Struct.new( :job_type, :resources, :on_device_service_configuration, :description, :address_id, :kms_key_arn, :role_arn, :snowball_type, :shipping_option, :notification, :forwarding_address_id, :tax_documents, :remote_management) SENSITIVE = [] include Aws::Structure end |
#notification ⇒ Types::Notification
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 629 class CreateClusterRequest < Struct.new( :job_type, :resources, :on_device_service_configuration, :description, :address_id, :kms_key_arn, :role_arn, :snowball_type, :shipping_option, :notification, :forwarding_address_id, :tax_documents, :remote_management) SENSITIVE = [] include Aws::Structure end |
#on_device_service_configuration ⇒ Types::OnDeviceServiceConfiguration
Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 629 class CreateClusterRequest < Struct.new( :job_type, :resources, :on_device_service_configuration, :description, :address_id, :kms_key_arn, :role_arn, :snowball_type, :shipping_option, :notification, :forwarding_address_id, :tax_documents, :remote_management) SENSITIVE = [] include Aws::Structure end |
#remote_management ⇒ String
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.
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 629 class CreateClusterRequest < Struct.new( :job_type, :resources, :on_device_service_configuration, :description, :address_id, :kms_key_arn, :role_arn, :snowball_type, :shipping_option, :notification, :forwarding_address_id, :tax_documents, :remote_management) SENSITIVE = [] include Aws::Structure end |
#resources ⇒ Types::JobResource
The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 629 class CreateClusterRequest < Struct.new( :job_type, :resources, :on_device_service_configuration, :description, :address_id, :kms_key_arn, :role_arn, :snowball_type, :shipping_option, :notification, :forwarding_address_id, :tax_documents, :remote_management) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The RoleARN
that you want to associate with this cluster.
RoleArn
values are created by using the CreateRole API action
in Identity and Access Management (IAM).
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 629 class CreateClusterRequest < Struct.new( :job_type, :resources, :on_device_service_configuration, :description, :address_id, :kms_key_arn, :role_arn, :snowball_type, :shipping_option, :notification, :forwarding_address_id, :tax_documents, :remote_management) SENSITIVE = [] include Aws::Structure end |
#shipping_option ⇒ String
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.
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 629 class CreateClusterRequest < Struct.new( :job_type, :resources, :on_device_service_configuration, :description, :address_id, :kms_key_arn, :role_arn, :snowball_type, :shipping_option, :notification, :forwarding_address_id, :tax_documents, :remote_management) SENSITIVE = [] include Aws::Structure end |
#snowball_type ⇒ String
The type of Snow Family Devices to use for this cluster.
EDGE
device type.
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.
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 629 class CreateClusterRequest < Struct.new( :job_type, :resources, :on_device_service_configuration, :description, :address_id, :kms_key_arn, :role_arn, :snowball_type, :shipping_option, :notification, :forwarding_address_id, :tax_documents, :remote_management) SENSITIVE = [] include Aws::Structure end |
#tax_documents ⇒ Types::TaxDocuments
The tax documents required in your Amazon Web Services Region.
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 |
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 629 class CreateClusterRequest < Struct.new( :job_type, :resources, :on_device_service_configuration, :description, :address_id, :kms_key_arn, :role_arn, :snowball_type, :shipping_option, :notification, :forwarding_address_id, :tax_documents, :remote_management) SENSITIVE = [] include Aws::Structure end |