You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb

Overview

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",
        },
      },
    ],
    lambda_resources: [
      {
        lambda_arn: "ResourceARN",
        event_triggers: [
          {
            event_resource_arn: "ResourceARN",
          },
        ],
      },
    ],
  },
  description: "String",
  address_id: "AddressId", # required
  kms_key_arn: "KmsKeyARN",
  role_arn: "RoleARN", # required
  snowball_type: "STANDARD", # accepts STANDARD, EDGE
  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, WithAWS, InProgress, Complete, Cancelled, Listing, Pending
    notify_all: false,
  },
  forwarding_address_id: "AddressId",
}

Instance Attribute Summary collapse

Instance Attribute Details

#address_idString

The ID for the address that you want the cluster shipped to.>

Returns:

  • (String)


472
473
474
475
476
477
478
479
480
481
482
483
484
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 472

class CreateClusterRequest < Struct.new(
  :job_type,
  :resources,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_type,
  :shipping_option,
  :notification,
  :forwarding_address_id)
  include Aws::Structure
end

#descriptionString

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

Returns:

  • (String)


472
473
474
475
476
477
478
479
480
481
482
483
484
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 472

class CreateClusterRequest < Struct.new(
  :job_type,
  :resources,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_type,
  :shipping_option,
  :notification,
  :forwarding_address_id)
  include Aws::Structure
end

#forwarding_address_idString

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

Returns:

  • (String)


472
473
474
475
476
477
478
479
480
481
482
483
484
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 472

class CreateClusterRequest < Struct.new(
  :job_type,
  :resources,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_type,
  :shipping_option,
  :notification,
  :forwarding_address_id)
  include Aws::Structure
end

#job_typeString

The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.

Returns:

  • (String)


472
473
474
475
476
477
478
479
480
481
482
483
484
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 472

class CreateClusterRequest < Struct.new(
  :job_type,
  :resources,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_type,
  :shipping_option,
  :notification,
  :forwarding_address_id)
  include Aws::Structure
end

#kms_key_arnString

The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS).

Returns:

  • (String)


472
473
474
475
476
477
478
479
480
481
482
483
484
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 472

class CreateClusterRequest < Struct.new(
  :job_type,
  :resources,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_type,
  :shipping_option,
  :notification,
  :forwarding_address_id)
  include Aws::Structure
end

#notificationTypes::Notification

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

Returns:



472
473
474
475
476
477
478
479
480
481
482
483
484
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 472

class CreateClusterRequest < Struct.new(
  :job_type,
  :resources,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_type,
  :shipping_option,
  :notification,
  :forwarding_address_id)
  include Aws::Structure
end

#resourcesTypes::JobResource

The resources associated with the cluster job. These resources include Amazon S3 buckets and optional AWS Lambda functions written in the Python language.

Returns:



472
473
474
475
476
477
478
479
480
481
482
483
484
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 472

class CreateClusterRequest < Struct.new(
  :job_type,
  :resources,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_type,
  :shipping_option,
  :notification,
  :forwarding_address_id)
  include Aws::Structure
end

#role_arnString

The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM).

Returns:

  • (String)


472
473
474
475
476
477
478
479
480
481
482
483
484
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 472

class CreateClusterRequest < Struct.new(
  :job_type,
  :resources,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_type,
  :shipping_option,
  :notification,
  :forwarding_address_id)
  include Aws::Structure
end

#shipping_optionString

The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows:

  • In Australia, you have access to express shipping. Typically, appliances shipped express are delivered in about a day.

  • In the European Union (EU), you have access to express shipping. Typically, Snowball Edges 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, Snowball Edges are delivered in one to seven days.

  • In the US, you have access to one-day shipping and two-day shipping.

Returns:

  • (String)


472
473
474
475
476
477
478
479
480
481
482
483
484
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 472

class CreateClusterRequest < Struct.new(
  :job_type,
  :resources,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_type,
  :shipping_option,
  :notification,
  :forwarding_address_id)
  include Aws::Structure
end

#snowball_typeString

The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs is EDGE.

Returns:

  • (String)


472
473
474
475
476
477
478
479
480
481
482
483
484
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 472

class CreateClusterRequest < Struct.new(
  :job_type,
  :resources,
  :description,
  :address_id,
  :kms_key_arn,
  :role_arn,
  :snowball_type,
  :shipping_option,
  :notification,
  :forwarding_address_id)
  include Aws::Structure
end