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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateClusterRequest as input to an Aws::Client method, you can use a vanilla 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",
          },
        ],
      },
    ],
    ec2_ami_resources: [
      {
        ami_id: "AmiId", # required
        snowball_ami_id: "String",
      },
    ],
  },
  description: "String",
  address_id: "AddressId", # required
  kms_key_arn: "KmsKeyARN",
  role_arn: "RoleARN", # required
  snowball_type: "STANDARD", # accepts STANDARD, EDGE, EDGE_C, EDGE_CG, EDGE_S, SNC1_HDD
  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",
    },
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#address_id ⇒ String

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

Returns:

  • (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.

Returns:

  • (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. This field is not supported in most regions.

Returns:

  • (String) —

    The forwarding address ID for a cluster.

#job_type ⇒ String

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

Possible values:

  • IMPORT
  • EXPORT
  • LOCAL_USE

Returns:

  • (String) —

    The type of job for this cluster.

#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 AWS Key Management Service (AWS KMS).

Returns:

  • (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.

Returns:

  • (Types::Notification) —

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

#resources ⇒ Types::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:

#role_arn ⇒ String

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) —

    The RoleARN that you want to associate with this cluster.

#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 device 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 device are delivered in one to seven days.

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

    Possible values:

    • SECOND_DAY
    • NEXT_DAY
    • EXPRESS
    • STANDARD

Returns:

  • (String) —

    The shipping speed for each node in this cluster.

#snowball_type ⇒ String

The type of AWS Snow Family device to use for this cluster.

For cluster jobs, AWS Snow Family currently supports only the EDGE device type.

Possible values:

  • STANDARD
  • EDGE
  • EDGE_C
  • EDGE_CG
  • EDGE_S
  • SNC1_HDD

Returns:

  • (String) —

    The type of AWS Snow Family device to use for this cluster.

#tax_documents ⇒ Types::TaxDocuments

The tax documents required in your AWS Region.

Returns: