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

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

Overview

Contains metadata about a specific cluster.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#address_id ⇒ String

The automatically generated ID for a specific address.

Returns:

  • (String) 


296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-snowball/types.rb', line 296

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,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_id ⇒ String

The automatically generated ID for a cluster.

Returns:

  • (String) 


296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-snowball/types.rb', line 296

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,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_state ⇒ String

The current status of the cluster.

Returns:

  • (String) 


296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-snowball/types.rb', line 296

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,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#creation_date ⇒ Time

The creation date for this cluster.

Returns:

  • (Time) 


296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-snowball/types.rb', line 296

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,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The optional description of the cluster.

Returns:

  • (String) 


296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-snowball/types.rb', line 296

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,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

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


296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-snowball/types.rb', line 296

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,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#job_type ⇒ String

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

Returns:

  • (String) 


296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-snowball/types.rb', line 296

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,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ String

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

[1]: docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html

Returns:

  • (String) 


296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-snowball/types.rb', line 296

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,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#notification ⇒ Types::Notification

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

Returns:



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-snowball/types.rb', line 296

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,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#on_device_service_configuration ⇒ Types::OnDeviceServiceConfiguration

Represents metadata and configuration settings for services on an Amazon Web Services Snow Family device.

Returns:



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-snowball/types.rb', line 296

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,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#resources ⇒ Types::JobResource

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

Returns:



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-snowball/types.rb', line 296

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,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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

[1]: docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html

Returns:

  • (String) 


296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-snowball/types.rb', line 296

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,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String) 


296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-snowball/types.rb', line 296

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,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#snowball_type ⇒ String

The type of Snowcone device to use for this cluster.

<note markdown=“1”> For cluster jobs, Amazon Web Services Snow Family currently supports only the ‘EDGE` device type.

</note>

Returns:

  • (String) 


296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-snowball/types.rb', line 296

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,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#tax_documents ⇒ Types::TaxDocuments

The tax documents required in your Amazon Web Services Region.

Returns:



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-snowball/types.rb', line 296

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,
  :on_device_service_configuration)
  SENSITIVE = []
  include Aws::Structure
end