Interface CreateClusterRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateClusterRequest.Builder,
,CreateClusterRequest> SdkBuilder<CreateClusterRequest.Builder,
,CreateClusterRequest> SdkPojo
,SdkRequest.Builder
,SnowballRequest.Builder
- Enclosing class:
CreateClusterRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe ID for the address that you want the cluster shipped to.description
(String description) An optional description of this specific cluster, for exampleEnvironmental Data Cluster-01
.forceCreateJobs
(Boolean forceCreateJobs) Force to create cluster when user attempts to overprovision or underprovision a cluster.forwardingAddressId
(String forwardingAddressId) The forwarding address ID for a cluster.initialClusterSize
(Integer initialClusterSize) If provided, each job will be automatically created and associated with the new cluster.The type of job for this cluster.The type of job for this cluster.TheKmsKeyARN
value that you want to associate with this cluster.longTermPricingIds
(String... longTermPricingIds) Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.longTermPricingIds
(Collection<String> longTermPricingIds) Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.default CreateClusterRequest.Builder
notification
(Consumer<Notification.Builder> notification) The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.notification
(Notification notification) The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.default CreateClusterRequest.Builder
onDeviceServiceConfiguration
(Consumer<OnDeviceServiceConfiguration.Builder> onDeviceServiceConfiguration) Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into.onDeviceServiceConfiguration
(OnDeviceServiceConfiguration onDeviceServiceConfiguration) Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.remoteManagement
(String remoteManagement) Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network.remoteManagement
(RemoteManagement remoteManagement) Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network.default CreateClusterRequest.Builder
resources
(Consumer<JobResource.Builder> resources) The resources associated with the cluster job.resources
(JobResource resources) The resources associated with the cluster job.TheRoleARN
that you want to associate with this cluster.shippingOption
(String shippingOption) The shipping speed for each node in this cluster.shippingOption
(ShippingOption shippingOption) The shipping speed for each node in this cluster.snowballCapacityPreference
(String 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.snowballCapacityPreference
(SnowballCapacity 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.snowballType
(String snowballType) The type of Snow Family devices to use for this cluster.snowballType
(SnowballType snowballType) The type of Snow Family devices to use for this cluster.default CreateClusterRequest.Builder
taxDocuments
(Consumer<TaxDocuments.Builder> taxDocuments) The tax documents required in your Amazon Web Services Region.taxDocuments
(TaxDocuments taxDocuments) The tax documents required in your Amazon Web Services Region.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.snowball.model.SnowballRequest.Builder
build
-
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.
- Parameters:
jobType
- The type of job for this cluster. Currently, the only job type supported for clusters isLOCAL_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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
jobType
- The type of job for this cluster. Currently, the only job type supported for clusters isLOCAL_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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
resources
- The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resources
The resources associated with the cluster job. These resources include Amazon S3 buckets and optional Lambda functions written in the Python language.
This is a convenience method that creates an instance of theJobResource.Builder
avoiding the need to create one manually viaJobResource.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresources(JobResource)
.- Parameters:
resources
- a consumer that will call methods onJobResource.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
onDeviceServiceConfiguration
CreateClusterRequest.Builder onDeviceServiceConfiguration(OnDeviceServiceConfiguration 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).
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
onDeviceServiceConfiguration
default CreateClusterRequest.Builder onDeviceServiceConfiguration(Consumer<OnDeviceServiceConfiguration.Builder> 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).
This is a convenience method that creates an instance of theOnDeviceServiceConfiguration.Builder
avoiding the need to create one manually viaOnDeviceServiceConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toonDeviceServiceConfiguration(OnDeviceServiceConfiguration)
.- Parameters:
onDeviceServiceConfiguration
- a consumer that will call methods onOnDeviceServiceConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
description
An optional description of this specific cluster, for example
Environmental Data Cluster-01
.- Parameters:
description
- An optional description of this specific cluster, for exampleEnvironmental Data Cluster-01
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addressId
The ID for the address that you want the cluster shipped to.
- Parameters:
addressId
- The ID for the address that you want the cluster shipped to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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).- Parameters:
kmsKeyARN
- TheKmsKeyARN
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:
- Returns a reference to this object so that method calls can be chained together.
-
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).- Parameters:
roleARN
- TheRoleARN
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
-
notification
The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.
This is a convenience method that creates an instance of theNotification.Builder
avoiding the need to create one manually viaNotification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonotification(Notification)
.- Parameters:
notification
- a consumer that will call methods onNotification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
forwardingAddressId
The forwarding address ID for a cluster. This field is not supported in most regions.
- Parameters:
forwardingAddressId
- The forwarding address ID for a cluster. This field is not supported in most regions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taxDocuments
The tax documents required in your Amazon Web Services Region.
- Parameters:
taxDocuments
- The tax documents required in your Amazon Web Services Region.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taxDocuments
The tax documents required in your Amazon Web Services Region.
This is a convenience method that creates an instance of theTaxDocuments.Builder
avoiding the need to create one manually viaTaxDocuments.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totaxDocuments(TaxDocuments)
.- Parameters:
taxDocuments
- a consumer that will call methods onTaxDocuments.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
remoteManagement
- Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set toINSTALLED_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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
remoteManagement
- Allows you to securely operate and manage Snow devices in a cluster remotely from outside of your internal network. When set toINSTALLED_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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- 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.
- Parameters:
initialClusterSize
- If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
.- Parameters:
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 withOnDeviceServiceConfiguration
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
longTermPricingIds
Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.
- Parameters:
longTermPricingIds
- Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
longTermPricingIds
Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.
- Parameters:
longTermPricingIds
- Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
snowballCapacityPreference
CreateClusterRequest.Builder snowballCapacityPreference(SnowballCapacity 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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-