AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Overview

Contains metadata about a specific cluster.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#address_idString

The automatically generated ID for a specific address.

Returns:

  • (String)


319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 319

class ClusterMetadata < Struct.new(
  :cluster_id,
  :description,
  :kms_key_arn,
  :role_arn,
  :cluster_state,
  :job_type,
  :snowball_type,
  :creation_date,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id,
  :tax_documents)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_idString

The automatically generated ID for a cluster.

Returns:

  • (String)


319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 319

class ClusterMetadata < Struct.new(
  :cluster_id,
  :description,
  :kms_key_arn,
  :role_arn,
  :cluster_state,
  :job_type,
  :snowball_type,
  :creation_date,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id,
  :tax_documents)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_stateString

The current status of the cluster.

Returns:

  • (String)


319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 319

class ClusterMetadata < Struct.new(
  :cluster_id,
  :description,
  :kms_key_arn,
  :role_arn,
  :cluster_state,
  :job_type,
  :snowball_type,
  :creation_date,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id,
  :tax_documents)
  SENSITIVE = []
  include Aws::Structure
end

#creation_dateTime

The creation date for this cluster.

Returns:

  • (Time)


319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 319

class ClusterMetadata < Struct.new(
  :cluster_id,
  :description,
  :kms_key_arn,
  :role_arn,
  :cluster_state,
  :job_type,
  :snowball_type,
  :creation_date,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id,
  :tax_documents)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The optional description of the cluster.

Returns:

  • (String)


319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 319

class ClusterMetadata < Struct.new(
  :cluster_id,
  :description,
  :kms_key_arn,
  :role_arn,
  :cluster_state,
  :job_type,
  :snowball_type,
  :creation_date,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id,
  :tax_documents)
  SENSITIVE = []
  include Aws::Structure
end

#forwarding_address_idString

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)


319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 319

class ClusterMetadata < Struct.new(
  :cluster_id,
  :description,
  :kms_key_arn,
  :role_arn,
  :cluster_state,
  :job_type,
  :snowball_type,
  :creation_date,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id,
  :tax_documents)
  SENSITIVE = []
  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)


319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 319

class ClusterMetadata < Struct.new(
  :cluster_id,
  :description,
  :kms_key_arn,
  :role_arn,
  :cluster_state,
  :job_type,
  :snowball_type,
  :creation_date,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id,
  :tax_documents)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arnString

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)


319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 319

class ClusterMetadata < Struct.new(
  :cluster_id,
  :description,
  :kms_key_arn,
  :role_arn,
  :cluster_state,
  :job_type,
  :snowball_type,
  :creation_date,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id,
  :tax_documents)
  SENSITIVE = []
  include Aws::Structure
end

#notificationTypes::Notification

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

Returns:



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 319

class ClusterMetadata < Struct.new(
  :cluster_id,
  :description,
  :kms_key_arn,
  :role_arn,
  :cluster_state,
  :job_type,
  :snowball_type,
  :creation_date,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id,
  :tax_documents)
  SENSITIVE = []
  include Aws::Structure
end

#resourcesTypes::JobResource

The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

Returns:



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 319

class ClusterMetadata < Struct.new(
  :cluster_id,
  :description,
  :kms_key_arn,
  :role_arn,
  :cluster_state,
  :job_type,
  :snowball_type,
  :creation_date,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id,
  :tax_documents)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

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)


319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 319

class ClusterMetadata < Struct.new(
  :cluster_id,
  :description,
  :kms_key_arn,
  :role_arn,
  :cluster_state,
  :job_type,
  :snowball_type,
  :creation_date,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id,
  :tax_documents)
  SENSITIVE = []
  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 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.

Returns:

  • (String)


319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 319

class ClusterMetadata < Struct.new(
  :cluster_id,
  :description,
  :kms_key_arn,
  :role_arn,
  :cluster_state,
  :job_type,
  :snowball_type,
  :creation_date,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id,
  :tax_documents)
  SENSITIVE = []
  include Aws::Structure
end

#snowball_typeString

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

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

Returns:

  • (String)


319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 319

class ClusterMetadata < Struct.new(
  :cluster_id,
  :description,
  :kms_key_arn,
  :role_arn,
  :cluster_state,
  :job_type,
  :snowball_type,
  :creation_date,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id,
  :tax_documents)
  SENSITIVE = []
  include Aws::Structure
end

#tax_documentsTypes::TaxDocuments

The tax documents required in your AWS Region.

Returns:



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
# File 'gems/aws-sdk-snowball/lib/aws-sdk-snowball/types.rb', line 319

class ClusterMetadata < Struct.new(
  :cluster_id,
  :description,
  :kms_key_arn,
  :role_arn,
  :cluster_state,
  :job_type,
  :snowball_type,
  :creation_date,
  :resources,
  :address_id,
  :shipping_option,
  :notification,
  :forwarding_address_id,
  :tax_documents)
  SENSITIVE = []
  include Aws::Structure
end