Struct aws_sdk_snowball::operation::create_cluster::CreateClusterInput

#[non_exhaustive]
pub struct CreateClusterInput {

    pub job_type: Option<JobType>,
    pub resources: Option<JobResource>,
    pub on_device_service_configuration: Option<OnDeviceServiceConfiguration>,
    pub description: Option<String>,
    pub address_id: Option<String>,
    pub kms_key_arn: Option<String>,
    pub role_arn: Option<String>,
    pub snowball_type: Option<SnowballType>,
    pub shipping_option: Option<ShippingOption>,
    pub notification: Option<Notification>,
    pub forwarding_address_id: Option<String>,
    pub tax_documents: Option<TaxDocuments>,
    pub remote_management: Option<RemoteManagement>,
    pub initial_cluster_size: Option<i32>,
    pub force_create_jobs: Option<bool>,
    pub long_term_pricing_ids: Option<Vec<String>>,
    pub snowball_capacity_preference: Option<SnowballCapacity>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

job_type: 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.

resources: Option<JobResource>

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

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

description: Option<String>

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

address_id: Option<String>

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

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

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

snowball_type: 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.

shipping_option: 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.

notification: Option<Notification>

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

forwarding_address_id: Option<String>

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

tax_documents: Option<TaxDocuments>

The tax documents required in your Amazon Web Services Region.

remote_management: 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.

initial_cluster_size: Option<i32>

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

force_create_jobs: 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.

long_term_pricing_ids: Option<Vec<String>>

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

snowball_capacity_preference: 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.

Implementations

impl CreateClusterInput

pub fn 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) -> 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 ) -> 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) -> Option<&str>

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

pub fn address_id(&self) -> Option<&str>

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

pub fn kms_key_arn(&self) -> Option<&str>

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) -> Option<&str>

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) -> 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) -> 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) -> Option<&Notification>

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

pub fn forwarding_address_id(&self) -> Option<&str>

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

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

The tax documents required in your Amazon Web Services Region.

pub fn 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) -> 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) -> 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) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .long_term_pricing_ids.is_none().

pub fn 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.

impl CreateClusterInput

pub fn builder() -> CreateClusterInputBuilder

Creates a new builder-style object to manufacture CreateClusterInput.

Trait Implementations

impl Clone for CreateClusterInput

fn clone(&self) -> CreateClusterInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateClusterInput

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

Formats the value using the given formatter.

impl PartialEq for CreateClusterInput

fn eq(&self, other: &CreateClusterInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateClusterInput