software.amazon.awssdk.services.snowball.model

Class CreateClusterRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.snowball.model.SnowballRequest

software.amazon.awssdk.services.snowball.model.CreateClusterRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateClusterRequest
extends SnowballRequest
implements ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateClusterRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	addressId() The ID for the address that you want the cluster shipped to.
static CreateClusterRequest.Builder	builder()
String	description() An optional description of this specific cluster, for example Environmental Data Cluster-01.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	forwardingAddressId() The forwarding address ID for a cluster.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
JobType	jobType() The type of job for this cluster.
String	jobTypeAsString() The type of job for this cluster.
String	kmsKeyARN() The KmsKeyARN value that you want to associate with this cluster.
Notification	notification() The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
JobResource	resources() The resources associated with the cluster job.
String	roleARN() The RoleARN that you want to associate with this cluster.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateClusterRequest.Builder>	serializableBuilderClass()
ShippingOption	shippingOption() The shipping speed for each node in this cluster.
String	shippingOptionAsString() The shipping speed for each node in this cluster.
SnowballType	snowballType() The type of AWS Snow Family device to use for this cluster.
String	snowballTypeAsString() The type of AWS Snow Family device to use for this cluster.
TaxDocuments	taxDocuments() The tax documents required in your AWS Region.
CreateClusterRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

jobType

public final JobType jobType()

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

If the service returns an enum value that is not available in the current SDK version, jobType will return JobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobTypeAsString().

Returns:

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

See Also:

JobType

jobTypeAsString

public final String jobTypeAsString()

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

If the service returns an enum value that is not available in the current SDK version, jobType will return JobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobTypeAsString().

Returns:

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

See Also:

JobType

resources

public final JobResource resources()

The resources associated with the cluster job. These resources include Amazon S3 buckets and optional AWS Lambda functions written in the Python language.

Returns:

The resources associated with the cluster job. These resources include Amazon S3 buckets and optional AWS Lambda functions written in the Python language.

description

public final String description()

An optional description of this specific cluster, for example Environmental Data Cluster-01.

Returns:

An optional description of this specific cluster, for example Environmental Data Cluster-01.

addressId

public final String addressId()

The ID for the address that you want the cluster shipped to.

Returns:

The ID for the address that you want the cluster shipped to.

kmsKeyARN

public final String kmsKeyARN()

The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS).

Returns:

The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS).

roleARN

public final String roleARN()

The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM).

Returns:

The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM).

snowballType

public final SnowballType snowballType()

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

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

If the service returns an enum value that is not available in the current SDK version, snowballType will return SnowballType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snowballTypeAsString().

Returns:

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

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

See Also:

SnowballType

snowballTypeAsString

public final String snowballTypeAsString()

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

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

If the service returns an enum value that is not available in the current SDK version, snowballType will return SnowballType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from snowballTypeAsString().

Returns:

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

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

See Also:

SnowballType

shippingOption

public final ShippingOption shippingOption()

The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge 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, Snow 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 device are delivered in one to seven days.

• In the United States of America (US), you have access to one-day shipping and two-day shipping.

• 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 device are delivered in one to seven days.

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

If the service returns an enum value that is not available in the current SDK version, shippingOption will return ShippingOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shippingOptionAsString().

Returns:

The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge 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, Snow 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 device are delivered in one to seven days.

• In the United States of America (US), you have access to one-day shipping and two-day shipping.

• 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 device are delivered in one to seven days.

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

See Also:

ShippingOption

shippingOptionAsString

public final String shippingOptionAsString()

The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge 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, Snow 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 device are delivered in one to seven days.

• In the United States of America (US), you have access to one-day shipping and two-day shipping.

• 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 device are delivered in one to seven days.

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

If the service returns an enum value that is not available in the current SDK version, shippingOption will return ShippingOption.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shippingOptionAsString().

Returns:

The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge 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, Snow 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 device are delivered in one to seven days.

• In the United States of America (US), you have access to one-day shipping and two-day shipping.

• 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 device are delivered in one to seven days.

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

See Also:

ShippingOption

notification

public final Notification notification()

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

Returns:

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

forwardingAddressId

public final String forwardingAddressId()

The forwarding address ID for a cluster. This field is not supported in most regions.

Returns:

The forwarding address ID for a cluster. This field is not supported in most regions.

taxDocuments

public final TaxDocuments taxDocuments()

The tax documents required in your AWS Region.

Returns:

The tax documents required in your AWS Region.

toBuilder

public CreateClusterRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>

Specified by:

toBuilder in class SnowballRequest

builder

public static CreateClusterRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateClusterRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo