Struct aws_sdk_snowball::model::ClusterMetadata

#[non_exhaustive]
pub struct ClusterMetadata {

    pub cluster_id: Option<String>,
    pub description: Option<String>,
    pub kms_key_arn: Option<String>,
    pub role_arn: Option<String>,
    pub cluster_state: Option<ClusterState>,
    pub job_type: Option<JobType>,
    pub snowball_type: Option<SnowballType>,
    pub creation_date: Option<Instant>,
    pub resources: Option<JobResource>,
    pub address_id: Option<String>,
    pub shipping_option: Option<ShippingOption>,
    pub notification: Option<Notification>,
    pub forwarding_address_id: Option<String>,
    pub tax_documents: Option<TaxDocuments>,
    pub on_device_service_configuration: Option<OnDeviceServiceConfiguration>,
}

Contains metadata about a specific cluster.

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.

cluster_id: Option<String>

The automatically generated ID for a cluster.

description: Option<String>

The optional description of the cluster.

kms_key_arn: Option<String>

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

role_arn: Option<String>

The role ARN associated with this cluster. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

cluster_state: Option<ClusterState>

The current status of the cluster.

job_type: Option<JobType>

The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.

snowball_type: Option<SnowballType>

The type of AWS Snow device to use for this cluster.

For cluster jobs, AWS Snow Family currently supports only the EDGE device type.

creation_date: Option<Instant>

The creation date for this cluster.

resources: Option<JobResource>

The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

address_id: Option<String>

The automatically generated ID for a specific address.

shipping_option: Option<ShippingOption>

The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each 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, 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 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.

tax_documents: Option<TaxDocuments>

The tax documents required in your AWS Region.

on_device_service_configuration: Option<OnDeviceServiceConfiguration>

Represents metadata and configuration settings for services on an AWS Snow Family device.

Implementations

impl ClusterMetadata

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

The automatically generated ID for a cluster.

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

The optional description of the cluster.

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

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

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

The role ARN associated with this cluster. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

pub fn cluster_state(&self) -> Option<&ClusterState>

The current status of the cluster.

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.

pub fn snowball_type(&self) -> Option<&SnowballType>

The type of AWS Snow device to use for this cluster.

For cluster jobs, AWS Snow Family currently supports only the EDGE device type.

pub fn creation_date(&self) -> Option<&Instant>

The creation date for this cluster.

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

The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

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

The automatically generated ID for a specific address.

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

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

The tax documents required in your AWS Region.

pub fn on_device_service_configuration(
    &self
) -> Option<&OnDeviceServiceConfiguration>

Represents metadata and configuration settings for services on an AWS Snow Family device.

impl ClusterMetadata

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ClusterMetadata

Trait Implementations

impl Clone for ClusterMetadata

fn clone(&self) -> ClusterMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClusterMetadata

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

Formats the value using the given formatter.

impl PartialEq<ClusterMetadata> for ClusterMetadata

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

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

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

This method tests for !=.

impl StructuralPartialEq for ClusterMetadata