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

Class: Aws::Snowball::Types::ClusterMetadata

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

Overview

Contains metadata about a specific cluster.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#address_id ⇒ String

The automatically generated ID for a specific address.

Returns:

  • (String) —

    The automatically generated ID for a specific address.

#cluster_id ⇒ String

The automatically generated ID for a cluster.

Returns:

  • (String) —

    The automatically generated ID for a cluster.

#cluster_state ⇒ String

The current status of the cluster.

Possible values:

  • AwaitingQuorum
  • Pending
  • InUse
  • Complete
  • Cancelled

Returns:

  • (String) —

    The current status of the cluster.

#creation_date ⇒ Time

The creation date for this cluster.

Returns:

  • (Time) —

    The creation date for this cluster.

#description ⇒ String

The optional description of the cluster.

Returns:

  • (String) —

    The optional description of the cluster.

#forwarding_address_id ⇒ String

The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

Returns:

  • (String) —

    The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address.

#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 Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in AWS Key Management Service (AWS KMS).

Returns:

  • (String) —

    The KmsKeyARN Amazon Resource Name (ARN) associated 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 arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

Returns:

#role_arn ⇒ String

The role ARN associated with this cluster. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

Returns:

  • (String) —

    The role ARN associated 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 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, 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.

    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 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 device to use for this cluster.

#tax_documents ⇒ Types::TaxDocuments

The tax documents required in your AWS Region.

Returns: