@Generated(value="software.amazon.awssdk:codegen") public final class ClusterMetadata extends Object implements StructuredPojo, ToCopyableBuilder<ClusterMetadata.Builder,ClusterMetadata>
Contains metadata about a specific cluster.
Modifier and Type | Class and Description |
---|---|
static interface |
ClusterMetadata.Builder |
Modifier and Type | Method and Description |
---|---|
String |
addressId()
The automatically generated ID for a specific address.
|
static ClusterMetadata.Builder |
builder() |
String |
clusterId()
The automatically generated ID for a cluster.
|
ClusterState |
clusterState()
The current status of the cluster.
|
String |
clusterStateAsString()
The current status of the cluster.
|
Instant |
creationDate()
The creation date for this cluster.
|
String |
description()
The optional description of the cluster.
|
boolean |
equals(Object obj) |
String |
forwardingAddressId()
The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address.
|
<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 Amazon Resource Name (ARN) associated with this cluster. |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
Notification |
notification()
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
|
JobResource |
resources()
The arrays of JobResource objects that can include updated S3Resource objects or
LambdaResource objects.
|
String |
roleARN()
The role ARN associated with this cluster.
|
static Class<? extends ClusterMetadata.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 Snowball appliance to use for this cluster.
|
String |
snowballTypeAsString()
The type of AWS Snowball appliance to use for this cluster.
|
ClusterMetadata.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String clusterId()
The automatically generated ID for a cluster.
public String description()
The optional description of the cluster.
public 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).
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).public 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).
public ClusterState clusterState()
The current status of the cluster.
If the service returns an enum value that is not available in the current SDK version, clusterState
will
return ClusterState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
clusterStateAsString()
.
ClusterState
public String clusterStateAsString()
The current status of the cluster.
If the service returns an enum value that is not available in the current SDK version, clusterState
will
return ClusterState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
clusterStateAsString()
.
ClusterState
public 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()
.
LOCAL_USE
.JobType
public 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()
.
LOCAL_USE
.JobType
public SnowballType snowballType()
The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for
cluster jobs is EDGE
.
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()
.
EDGE
.SnowballType
public String snowballTypeAsString()
The type of AWS Snowball appliance to use for this cluster. Currently, the only supported appliance type for
cluster jobs is EDGE
.
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()
.
EDGE
.SnowballType
public Instant creationDate()
The creation date for this cluster.
public JobResource resources()
The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.
public String addressId()
The automatically generated ID for a specific address.
public 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.
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()
.
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.
ShippingOption
public String shippingOptionAsString()
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.
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()
.
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.
ShippingOption
public Notification notification()
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
public 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.
public ClusterMetadata.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ClusterMetadata.Builder,ClusterMetadata>
public static ClusterMetadata.Builder builder()
public static Class<? extends ClusterMetadata.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.