Struct aws_sdk_snowball::operation::create_cluster::builders::CreateClusterFluentBuilder

pub struct CreateClusterFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateCluster.

Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.

Implementations

impl CreateClusterFluentBuilder

pub fn as_input(&self) -> &CreateClusterInputBuilder

Access the CreateCluster as a reference.

pub async fn send( self ) -> Result<CreateClusterOutput, SdkError<CreateClusterError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<CreateClusterOutput, CreateClusterError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn job_type(self, input: JobType) -> Self

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.

pub fn set_job_type(self, input: Option<JobType>) -> Self

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.

pub fn get_job_type(&self) -> &Option<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.

pub fn resources(self, input: JobResource) -> Self

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

pub fn set_resources(self, input: Option<JobResource>) -> Self

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

pub fn get_resources(&self) -> &Option<JobResource>

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

pub fn on_device_service_configuration( self, input: OnDeviceServiceConfiguration ) -> Self

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

pub fn set_on_device_service_configuration( self, input: Option<OnDeviceServiceConfiguration> ) -> Self

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

pub fn get_on_device_service_configuration( &self ) -> &Option<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).

pub fn description(self, input: impl Into<String>) -> Self

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

pub fn set_description(self, input: Option<String>) -> Self

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

pub fn get_description(&self) -> &Option<String>

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

pub fn address_id(self, input: impl Into<String>) -> Self

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

pub fn set_address_id(self, input: Option<String>) -> Self

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

pub fn get_address_id(&self) -> &Option<String>

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

pub fn kms_key_arn(self, input: impl Into<String>) -> Self

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

pub fn set_kms_key_arn(self, input: Option<String>) -> Self

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

pub fn get_kms_key_arn(&self) -> &Option<String>

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

pub fn role_arn(self, input: impl Into<String>) -> Self

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

pub fn set_role_arn(self, input: Option<String>) -> Self

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

pub fn get_role_arn(&self) -> &Option<String>

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

pub fn snowball_type(self, input: SnowballType) -> Self

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.

pub fn set_snowball_type(self, input: Option<SnowballType>) -> Self

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.

pub fn get_snowball_type(&self) -> &Option<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.

pub fn shipping_option(self, input: ShippingOption) -> Self

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.

pub fn set_shipping_option(self, input: Option<ShippingOption>) -> Self

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.

pub fn get_shipping_option(&self) -> &Option<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.

pub fn notification(self, input: Notification) -> Self

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

pub fn set_notification(self, input: Option<Notification>) -> Self

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

pub fn get_notification(&self) -> &Option<Notification>

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

pub fn forwarding_address_id(self, input: impl Into<String>) -> Self

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

pub fn set_forwarding_address_id(self, input: Option<String>) -> Self

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

pub fn get_forwarding_address_id(&self) -> &Option<String>

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

pub fn tax_documents(self, input: TaxDocuments) -> Self

The tax documents required in your Amazon Web Services Region.

pub fn set_tax_documents(self, input: Option<TaxDocuments>) -> Self

The tax documents required in your Amazon Web Services Region.

pub fn get_tax_documents(&self) -> &Option<TaxDocuments>

The tax documents required in your Amazon Web Services Region.

pub fn remote_management(self, input: RemoteManagement) -> Self

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.

pub fn set_remote_management(self, input: Option<RemoteManagement>) -> Self

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.

pub fn get_remote_management(&self) -> &Option<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.

pub fn initial_cluster_size(self, input: i32) -> Self

If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.

pub fn set_initial_cluster_size(self, input: Option<i32>) -> Self

If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.

pub fn get_initial_cluster_size(&self) -> &Option<i32>

If provided, each job will be automatically created and associated with the new cluster. If not provided, will be treated as 0.

pub fn force_create_jobs(self, input: bool) -> Self

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.

pub fn set_force_create_jobs(self, input: Option<bool>) -> Self

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.

pub fn get_force_create_jobs(&self) -> &Option<bool>

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.

pub fn long_term_pricing_ids(self, input: impl Into<String>) -> Self

Appends an item to LongTermPricingIds.

To override the contents of this collection use set_long_term_pricing_ids.

Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.

pub fn set_long_term_pricing_ids(self, input: Option<Vec<String>>) -> Self

Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.

pub fn get_long_term_pricing_ids(&self) -> &Option<Vec<String>>

Lists long-term pricing id that will be used to associate with jobs automatically created for the new cluster.

pub fn snowball_capacity_preference(self, input: SnowballCapacity) -> Self

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.

pub fn set_snowball_capacity_preference( self, input: Option<SnowballCapacity> ) -> Self

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.

pub fn get_snowball_capacity_preference(&self) -> &Option<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. 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.

Trait Implementations

impl Clone for CreateClusterFluentBuilder

fn clone(&self) -> CreateClusterFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateClusterFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.