class Aws::Snowball::Types::ClusterMetadata

Contains metadata about a specific cluster.

@!attribute [rw] cluster_id

The automatically generated ID for a cluster.
@return [String]

@!attribute [rw] description

The optional description of the cluster.
@return [String]

@!attribute [rw] kms_key_arn

The `KmsKeyARN` Amazon Resource Name (ARN) associated with this
cluster. This ARN was created using the [CreateKey][1] API action in
AWS Key Management Service (AWS KMS).

[1]: https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html
@return [String]

@!attribute [rw] role_arn

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

[1]: https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html
@return [String]

@!attribute [rw] cluster_state

The current status of the cluster.
@return [String]

@!attribute [rw] job_type

The type of job for this cluster. Currently, the only job type
supported for clusters is `LOCAL_USE`.
@return [String]

@!attribute [rw] snowball_type

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

<note markdown="1"> For cluster jobs, AWS Snow Family currently supports only the `EDGE`
device type.

 </note>
@return [String]

@!attribute [rw] creation_date

The creation date for this cluster.
@return [Time]

@!attribute [rw] resources

The arrays of JobResource objects that can include updated
S3Resource objects or LambdaResource objects.
@return [Types::JobResource]

@!attribute [rw] address_id

The automatically generated ID for a specific address.
@return [String]

@!attribute [rw] shipping_option

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.
@return [String]

@!attribute [rw] notification

The Amazon Simple Notification Service (Amazon SNS) notification
settings for this cluster.
@return [Types::Notification]

@!attribute [rw] forwarding_address_id

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.
@return [String]

@!attribute [rw] tax_documents

The tax documents required in your AWS Region.
@return [Types::TaxDocuments]

@!attribute [rw] on_device_service_configuration

Represents metadata and configuration settings for services on an
AWS Snow Family device.
@return [Types::OnDeviceServiceConfiguration]

@see docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/ClusterMetadata AWS API Documentation

Constants

SENSITIVE