Class CreateClusterRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateClusterRequest.Builder,
CreateClusterRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The ID for the address that you want the cluster shipped to.static CreateClusterRequest.Builder
builder()
final String
An optional description of this specific cluster, for exampleEnvironmental Data Cluster-01
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Boolean
Force to create cluster when user attempts to overprovision or underprovision a cluster.final String
The forwarding address ID for a cluster.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LongTermPricingIds property.final Integer
If provided, each job will be automatically created and associated with the new cluster.final JobType
jobType()
The type of job for this cluster.final String
The type of job for this cluster.final String
TheKmsKeyARN
value that you want to associate with this cluster.Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.final Notification
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into.final RemoteManagement
Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network.final String
Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network.final JobResource
The resources associated with the cluster job.final String
roleARN()
TheRoleARN
that you want to associate with this cluster.static Class
<? extends CreateClusterRequest.Builder> final ShippingOption
The shipping speed for each node in this cluster.final String
The shipping speed for each node in this cluster.final SnowballCapacity
If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job.final String
If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job.final SnowballType
The type of Snow Family devices to use for this cluster.final String
The type of Snow Family devices to use for this cluster.final TaxDocuments
The tax documents required in your Amazon Web Services Region.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
jobType
The type of job for this cluster. Currently, the only job type supported for clusters is
LOCAL_USE
.For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
If the service returns an enum value that is not available in the current SDK version,
jobType
will returnJobType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobTypeAsString()
.- Returns:
- The type of job for this cluster. Currently, the only job type supported for clusters is
LOCAL_USE
.For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
- See Also:
-
jobTypeAsString
The type of job for this cluster. Currently, the only job type supported for clusters is
LOCAL_USE
.For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
If the service returns an enum value that is not available in the current SDK version,
jobType
will returnJobType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobTypeAsString()
.- Returns:
- The type of job for this cluster. Currently, the only job type supported for clusters is
LOCAL_USE
.For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
- See Also:
-
resources
The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.
- Returns:
- The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.
-
onDeviceServiceConfiguration
Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).
- Returns:
- Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. Amazon Web Services Snow Family device clusters support Amazon S3 and NFS (Network File System).
-
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
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
The
KmsKeyARN
value that you want to associate with this cluster.KmsKeyARN
values are created by using the CreateKey API action in Key Management Service (KMS).- Returns:
- The
KmsKeyARN
value that you want to associate with this cluster.KmsKeyARN
values are created by using the CreateKey API action in Key Management Service (KMS).
-
roleARN
The
RoleARN
that you want to associate with this cluster.RoleArn
values are created by using the CreateRole API action in 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 Identity and Access Management (IAM).
-
snowballType
The type of Snow Family devices to use for this cluster.
For cluster jobs, Amazon Web Services Snow Family currently supports only the
EDGE
device type.For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
If the service returns an enum value that is not available in the current SDK version,
snowballType
will returnSnowballType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsnowballTypeAsString()
.- Returns:
- The type of Snow Family devices to use for this cluster.
For cluster jobs, Amazon Web Services Snow Family currently supports only the
EDGE
device type.For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
- See Also:
-
snowballTypeAsString
The type of Snow Family devices to use for this cluster.
For cluster jobs, Amazon Web Services Snow Family currently supports only the
EDGE
device type.For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
If the service returns an enum value that is not available in the current SDK version,
snowballType
will returnSnowballType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsnowballTypeAsString()
.- Returns:
- The type of Snow Family devices to use for this cluster.
For cluster jobs, Amazon Web Services Snow Family currently supports only the
EDGE
device type.For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
- See Also:
-
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 devices 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 devices 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 returnShippingOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromshippingOptionAsString()
.- 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 devices 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 devices are delivered in one to seven days.
-
In the US, you have access to one-day shipping and two-day shipping.
-
- See Also:
-
-
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 devices 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 devices 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 returnShippingOption.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromshippingOptionAsString()
.- 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 devices 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 devices are delivered in one to seven days.
-
In the US, you have access to one-day shipping and two-day shipping.
-
- See Also:
-
-
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
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
The tax documents required in your Amazon Web Services Region.
- Returns:
- The tax documents required in your Amazon Web Services Region.
-
remoteManagement
Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to
INSTALLED_AUTOSTART
, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.If the service returns an enum value that is not available in the current SDK version,
remoteManagement
will returnRemoteManagement.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromremoteManagementAsString()
.- Returns:
- Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your
internal network. When set to
INSTALLED_AUTOSTART
, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device. - See Also:
-
remoteManagementAsString
Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set to
INSTALLED_AUTOSTART
, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device.If the service returns an enum value that is not available in the current SDK version,
remoteManagement
will returnRemoteManagement.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromremoteManagementAsString()
.- Returns:
- Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your
internal network. When set to
INSTALLED_AUTOSTART
, remote management will automatically be available when the device arrives at your location. Otherwise, you need to use the Snowball Client to manage the device. - See Also:
-
initialClusterSize
If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.
- Returns:
- If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.
-
forceCreateJobs
Force to create cluster when user attempts to overprovision or underprovision a cluster. A cluster is overprovisioned or underprovisioned if the initial size of the cluster is more (overprovisioned) or less (underprovisioned) than what needed to meet capacity requirement specified with
OnDeviceServiceConfiguration
.- Returns:
- Force to create cluster when user attempts to overprovision or underprovision a cluster. A cluster is
overprovisioned or underprovisioned if the initial size of the cluster is more (overprovisioned) or less
(underprovisioned) than what needed to meet capacity requirement specified with
OnDeviceServiceConfiguration
.
-
hasLongTermPricingIds
public final boolean hasLongTermPricingIds()For responses, this returns true if the service returned a value for the LongTermPricingIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
longTermPricingIds
Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasLongTermPricingIds()
method.- Returns:
- Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.
-
snowballCapacityPreference
If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.
For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
If the service returns an enum value that is not available in the current SDK version,
snowballCapacityPreference
will returnSnowballCapacity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsnowballCapacityPreferenceAsString()
.- Returns:
- If your job is being created in one of the US regions, you have the option of specifying what size Snow
device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.
For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
- See Also:
-
snowballCapacityPreferenceAsString
If your job is being created in one of the US regions, you have the option of specifying what size Snow device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.
For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
If the service returns an enum value that is not available in the current SDK version,
snowballCapacityPreference
will returnSnowballCapacity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsnowballCapacityPreferenceAsString()
.- Returns:
- If your job is being created in one of the US regions, you have the option of specifying what size Snow
device you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.
For more information, see "https://docs.aws.amazon.com/snowball/latest/snowcone-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide or "https://docs.aws.amazon.com/snowball/latest/developer-guide/snow-device-types.html" (Snow Family Devices and Capacity) in the Snowcone User Guide.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateClusterRequest.Builder,
CreateClusterRequest> - Specified by:
toBuilder
in classSnowballRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-