Documentation

Contains metadata about a specific cluster.

See: newClusterMetadata smart constructor.

Create a value of ClusterMetadata with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:jobType:ClusterMetadata', clusterMetadata_jobType - The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.

$sel:kmsKeyARN:ClusterMetadata', clusterMetadata_kmsKeyARN - 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).

$sel:clusterState:ClusterMetadata', clusterMetadata_clusterState - The current status of the cluster.

$sel:notification:ClusterMetadata', clusterMetadata_notification - The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.

$sel:forwardingAddressId:ClusterMetadata', clusterMetadata_forwardingAddressId - 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.

$sel:addressId:ClusterMetadata', clusterMetadata_addressId - The automatically generated ID for a specific address.

$sel:snowballType:ClusterMetadata', clusterMetadata_snowballType - The type of AWS Snow device to use for this cluster.

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

$sel:shippingOption:ClusterMetadata', clusterMetadata_shippingOption - 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.

$sel:resources:ClusterMetadata', clusterMetadata_resources - The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

$sel:onDeviceServiceConfiguration:ClusterMetadata', clusterMetadata_onDeviceServiceConfiguration - Represents metadata and configuration settings for services on an AWS Snow Family device.

$sel:clusterId:ClusterMetadata', clusterMetadata_clusterId - The automatically generated ID for a cluster.

$sel:creationDate:ClusterMetadata', clusterMetadata_creationDate - The creation date for this cluster.

$sel:description:ClusterMetadata', clusterMetadata_description - The optional description of the cluster.

$sel:taxDocuments:ClusterMetadata', clusterMetadata_taxDocuments - The tax documents required in your AWS Region.

$sel:roleARN:ClusterMetadata', clusterMetadata_roleARN - The role ARN associated with this cluster. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

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

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

The current status of the cluster.

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

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.

The automatically generated ID for a specific address.

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

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

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.

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

Represents metadata and configuration settings for services on an AWS Snow Family device.

The automatically generated ID for a cluster.

The creation date for this cluster.

The optional description of the cluster.

The tax documents required in your AWS Region.

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