Package software.amazon.awssdk.services.snowball.model

Interface ClusterMetadata.Builder

All Superinterfaces:

CopyableBuilder<ClusterMetadata.Builder,ClusterMetadata>, SdkBuilder<ClusterMetadata.Builder,ClusterMetadata>

Enclosing class:

ClusterMetadata

public static interface ClusterMetadata.Builder
extends CopyableBuilder<ClusterMetadata.Builder,ClusterMetadata>

Method Summary

Modifier and Type	Method	Description
ClusterMetadata.Builder	addressId(String addressId)	The automatically generated ID for a specific address.
ClusterMetadata.Builder	clusterId(String clusterId)	The automatically generated ID for a cluster.
ClusterMetadata.Builder	clusterState(String clusterState)	The current status of the cluster.
ClusterMetadata.Builder	clusterState(ClusterState clusterState)	The current status of the cluster.
ClusterMetadata.Builder	creationDate(Date creationDate)	The creation date for this cluster.
ClusterMetadata.Builder	description(String description)	The optional description of the cluster.
ClusterMetadata.Builder	forwardingAddressId(String forwardingAddressId)	The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address.
ClusterMetadata.Builder	jobType(String jobType)	The type of job for this cluster.
ClusterMetadata.Builder	jobType(JobType jobType)	The type of job for this cluster.
ClusterMetadata.Builder	kmsKeyARN(String kmsKeyARN)	The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster.
ClusterMetadata.Builder	notification(Notification notification)	The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
ClusterMetadata.Builder	resources(JobResource resources)	The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
ClusterMetadata.Builder	roleARN(String roleARN)	The role ARN associated with this cluster.
ClusterMetadata.Builder	shippingOption(String shippingOption)	The shipping speed for each node in this cluster.
ClusterMetadata.Builder	shippingOption(ShippingOption shippingOption)	The shipping speed for each node in this cluster.
ClusterMetadata.Builder	snowballType(String snowballType)	The type of AWS Snowball appliance to use for this cluster.
ClusterMetadata.Builder	snowballType(SnowballType snowballType)	The type of AWS Snowball appliance to use for this cluster.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

clusterId

ClusterMetadata.Builder clusterId(String clusterId)

The automatically generated ID for a cluster.

Parameters:

clusterId - The automatically generated ID for a cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

ClusterMetadata.Builder description(String description)

The optional description of the cluster.

Parameters:

description - The optional description of the cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKeyARN

ClusterMetadata.Builder kmsKeyARN(String 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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

roleARN

ClusterMetadata.Builder roleARN(String roleARN)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

clusterState

ClusterMetadata.Builder clusterState(String clusterState)

The current status of the cluster.

Parameters:

clusterState - The current status of the cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ClusterState

clusterState

ClusterMetadata.Builder clusterState(ClusterState clusterState)

The current status of the cluster.

Parameters:

clusterState - The current status of the cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ClusterState

jobType

ClusterMetadata.Builder jobType(String jobType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobType

jobType

ClusterMetadata.Builder jobType(JobType jobType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobType

snowballType

ClusterMetadata.Builder snowballType(String snowballType)

The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs is EDGE.

Parameters:

snowballType - The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs is EDGE.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SnowballType

snowballType

ClusterMetadata.Builder snowballType(SnowballType snowballType)

The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs is EDGE.

Parameters:

snowballType - The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for cluster jobs is EDGE.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SnowballType

creationDate

ClusterMetadata.Builder creationDate(Date creationDate)

The creation date for this cluster.

Parameters:

creationDate - The creation date for this cluster.

Returns:

Returns a reference to this object so that method calls can be chained together.

resources

ClusterMetadata.Builder resources(JobResource resources)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

addressId

ClusterMetadata.Builder addressId(String addressId)

The automatically generated ID for a specific address.

Parameters:

addressId - The automatically generated ID for a specific address.

Returns:

Returns a reference to this object so that method calls can be chained together.

shippingOption

ClusterMetadata.Builder shippingOption(String shippingOption)

The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows:

• In Australia, you have access to express shipping. Typically, appliances shipped express are delivered in about a day.

• In the European Union (EU), you have access to express shipping. Typically, Snowball Edges 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, Snowball Edges are delivered in one to seven days.

• In the US, you have access to one-day shipping and two-day shipping.

Parameters:

shippingOption - The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows:

• In Australia, you have access to express shipping. Typically, appliances shipped express are delivered in about a day.

• In the European Union (EU), you have access to express shipping. Typically, Snowball Edges 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, Snowball Edges are delivered in one to seven days.

• In the US, you have access to one-day shipping and two-day shipping.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ShippingOption

shippingOption

ClusterMetadata.Builder shippingOption(ShippingOption shippingOption)

The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows:

• In Australia, you have access to express shipping. Typically, appliances shipped express are delivered in about a day.

• In the European Union (EU), you have access to express shipping. Typically, Snowball Edges 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, Snowball Edges are delivered in one to seven days.

• In the US, you have access to one-day shipping and two-day shipping.

Parameters:

shippingOption - The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge appliance, rather it represents how quickly each appliance moves to its destination while in transit. Regional shipping speeds are as follows:

• In Australia, you have access to express shipping. Typically, appliances shipped express are delivered in about a day.

• In the European Union (EU), you have access to express shipping. Typically, Snowball Edges 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, Snowball Edges are delivered in one to seven days.

• In the US, you have access to one-day shipping and two-day shipping.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ShippingOption

notification

ClusterMetadata.Builder notification(Notification notification)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

forwardingAddressId

ClusterMetadata.Builder forwardingAddressId(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.