Class: Aws::Snowball::Types::CreateClusterRequest

Inherits:

Struct

Object
Struct
Aws::Snowball::Types::CreateClusterRequest

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-snowball/types.rb

Overview

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`.
#force_create_jobs ⇒ Boolean

Force to create cluster when user attempts to overprovision or underprovision a cluster.
#forwarding_address_id ⇒ String

The forwarding address ID for a cluster.
#initial_cluster_size ⇒ Integer

If provided, each job will be automatically created and associated with the new 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.
#long_term_pricing_ids ⇒ Array<String>

Lists long-term pricing id that will be used to associate with jobs automatically created for the new 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_capacity_preference ⇒ String

If your job is being created in one of the US regions, you have the option of specifying what size Snow device you’d like for this job.
#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.

Returns:

(String)

# File 'lib/aws-sdk-snowball/types.rb', line 542

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,
  :initial_cluster_size,
  :force_create_jobs,
  :long_term_pricing_ids,
  :snowball_capacity_preference)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

An optional description of this specific cluster, for example ‘Environmental Data Cluster-01`.

Returns:

(String)

# File 'lib/aws-sdk-snowball/types.rb', line 542

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,
  :initial_cluster_size,
  :force_create_jobs,
  :long_term_pricing_ids,
  :snowball_capacity_preference)
  SENSITIVE = []
  include Aws::Structure
end

#force_create_jobs ⇒ `Boolean`

Force to create cluster when user attempts to overprovision or underprovision a cluster. A cluster is overprovisioned or underprovisioned if the initial size of the cluster is more (overprovisioned) or less (underprovisioned) than what needed to meet capacity requirement specified with ‘OnDeviceServiceConfiguration`.

Returns:

(Boolean)

# File 'lib/aws-sdk-snowball/types.rb', line 542

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,
  :initial_cluster_size,
  :force_create_jobs,
  :long_term_pricing_ids,
  :snowball_capacity_preference)
  SENSITIVE = []
  include Aws::Structure
end

#forwarding_address_id ⇒ `String`

The forwarding address ID for a cluster. This field is not supported in most regions.

Returns:

(String)

# File 'lib/aws-sdk-snowball/types.rb', line 542

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,
  :initial_cluster_size,
  :force_create_jobs,
  :long_term_pricing_ids,
  :snowball_capacity_preference)
  SENSITIVE = []
  include Aws::Structure
end

#initial_cluster_size ⇒ `Integer`

If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.

Returns:

(Integer)

# File 'lib/aws-sdk-snowball/types.rb', line 542

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,
  :initial_cluster_size,
  :force_create_jobs,
  :long_term_pricing_ids,
  :snowball_capacity_preference)
  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 “docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the *Snowcone User Guide* or “docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html” (Snow Family Devices and Capacity) in the *Snowcone User Guide*.

Returns:

(String)

# File 'lib/aws-sdk-snowball/types.rb', line 542

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,
  :initial_cluster_size,
  :force_create_jobs,
  :long_term_pricing_ids,
  :snowball_capacity_preference)
  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).

[1]: docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html

Returns:

(String)

# File 'lib/aws-sdk-snowball/types.rb', line 542

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,
  :initial_cluster_size,
  :force_create_jobs,
  :long_term_pricing_ids,
  :snowball_capacity_preference)
  SENSITIVE = []
  include Aws::Structure
end

#long_term_pricing_ids ⇒ `Array<String>`

Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.

Returns:

(Array<String>)

# File 'lib/aws-sdk-snowball/types.rb', line 542

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,
  :initial_cluster_size,
  :force_create_jobs,
  :long_term_pricing_ids,
  :snowball_capacity_preference)
  SENSITIVE = []
  include Aws::Structure
end

#notification ⇒ `Types::Notification`

The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.

Returns:

(Types::Notification)

# File 'lib/aws-sdk-snowball/types.rb', line 542

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,
  :initial_cluster_size,
  :force_create_jobs,
  :long_term_pricing_ids,
  :snowball_capacity_preference)
  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).

Returns:

(Types::OnDeviceServiceConfiguration)

# File 'lib/aws-sdk-snowball/types.rb', line 542

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,
  :initial_cluster_size,
  :force_create_jobs,
  :long_term_pricing_ids,
  :snowball_capacity_preference)
  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.

Returns:

(String)

# File 'lib/aws-sdk-snowball/types.rb', line 542

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,
  :initial_cluster_size,
  :force_create_jobs,
  :long_term_pricing_ids,
  :snowball_capacity_preference)
  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.

Returns:

(Types::JobResource)

# File 'lib/aws-sdk-snowball/types.rb', line 542

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,
  :initial_cluster_size,
  :force_create_jobs,
  :long_term_pricing_ids,
  :snowball_capacity_preference)
  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).

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html

Returns:

(String)

# File 'lib/aws-sdk-snowball/types.rb', line 542

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,
  :initial_cluster_size,
  :force_create_jobs,
  :long_term_pricing_ids,
  :snowball_capacity_preference)
  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.

Returns:

(String)

# File 'lib/aws-sdk-snowball/types.rb', line 542

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,
  :initial_cluster_size,
  :force_create_jobs,
  :long_term_pricing_ids,
  :snowball_capacity_preference)
  SENSITIVE = []
  include Aws::Structure
end

#snowball_capacity_preference ⇒ `String`

If your job is being created in one of the US regions, you have the option of specifying what size Snow device you’d like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

Returns:

(String)

# File 'lib/aws-sdk-snowball/types.rb', line 542

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,
  :initial_cluster_size,
  :force_create_jobs,
  :long_term_pricing_ids,
  :snowball_capacity_preference)
  SENSITIVE = []
  include Aws::Structure
end

#snowball_type ⇒ `String`

The type of Snow Family devices to use for this cluster.

<note markdown=“1”> For cluster jobs, Amazon Web Services Snow Family currently supports only the ‘EDGE` device type.

</note>

Returns:

(String)

# File 'lib/aws-sdk-snowball/types.rb', line 542

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,
  :initial_cluster_size,
  :force_create_jobs,
  :long_term_pricing_ids,
  :snowball_capacity_preference)
  SENSITIVE = []
  include Aws::Structure
end

#tax_documents ⇒ `Types::TaxDocuments`

The tax documents required in your Amazon Web Services Region.

Returns:

(Types::TaxDocuments)

# File 'lib/aws-sdk-snowball/types.rb', line 542

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,
  :initial_cluster_size,
  :force_create_jobs,
  :long_term_pricing_ids,
  :snowball_capacity_preference)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Snowball::Types::CreateClusterRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#address_id ⇒ String

#description ⇒ String

#force_create_jobs ⇒ Boolean

#forwarding_address_id ⇒ String

#initial_cluster_size ⇒ Integer

#job_type ⇒ String

#kms_key_arn ⇒ String

#long_term_pricing_ids ⇒ Array<String>

#notification ⇒ Types::Notification

#on_device_service_configuration ⇒ Types::OnDeviceServiceConfiguration

#remote_management ⇒ String

#resources ⇒ Types::JobResource

#role_arn ⇒ String

#shipping_option ⇒ String

#snowball_capacity_preference ⇒ String

#snowball_type ⇒ String

#tax_documents ⇒ Types::TaxDocuments

#address_id ⇒ `String`

#description ⇒ `String`

#force_create_jobs ⇒ `Boolean`

#forwarding_address_id ⇒ `String`

#initial_cluster_size ⇒ `Integer`

#job_type ⇒ `String`

#kms_key_arn ⇒ `String`

#long_term_pricing_ids ⇒ `Array<String>`

#notification ⇒ `Types::Notification`

#on_device_service_configuration ⇒ `Types::OnDeviceServiceConfiguration`

#remote_management ⇒ `String`

#resources ⇒ `Types::JobResource`

#role_arn ⇒ `String`

#shipping_option ⇒ `String`

#snowball_capacity_preference ⇒ `String`

#snowball_type ⇒ `String`

#tax_documents ⇒ `Types::TaxDocuments`