AWS SDK for C++  1.9.72
AWS SDK for C++
Public Member Functions | List of all members
Aws::Snowball::Model::ClusterMetadata Class Reference

#include <ClusterMetadata.h>

Public Member Functions

 ClusterMetadata ()
 
 ClusterMetadata (Aws::Utils::Json::JsonView jsonValue)
 
ClusterMetadataoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetClusterId () const
 
bool ClusterIdHasBeenSet () const
 
void SetClusterId (const Aws::String &value)
 
void SetClusterId (Aws::String &&value)
 
void SetClusterId (const char *value)
 
ClusterMetadataWithClusterId (const Aws::String &value)
 
ClusterMetadataWithClusterId (Aws::String &&value)
 
ClusterMetadataWithClusterId (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
ClusterMetadataWithDescription (const Aws::String &value)
 
ClusterMetadataWithDescription (Aws::String &&value)
 
ClusterMetadataWithDescription (const char *value)
 
const Aws::StringGetKmsKeyARN () const
 
bool KmsKeyARNHasBeenSet () const
 
void SetKmsKeyARN (const Aws::String &value)
 
void SetKmsKeyARN (Aws::String &&value)
 
void SetKmsKeyARN (const char *value)
 
ClusterMetadataWithKmsKeyARN (const Aws::String &value)
 
ClusterMetadataWithKmsKeyARN (Aws::String &&value)
 
ClusterMetadataWithKmsKeyARN (const char *value)
 
const Aws::StringGetRoleARN () const
 
bool RoleARNHasBeenSet () const
 
void SetRoleARN (const Aws::String &value)
 
void SetRoleARN (Aws::String &&value)
 
void SetRoleARN (const char *value)
 
ClusterMetadataWithRoleARN (const Aws::String &value)
 
ClusterMetadataWithRoleARN (Aws::String &&value)
 
ClusterMetadataWithRoleARN (const char *value)
 
const ClusterStateGetClusterState () const
 
bool ClusterStateHasBeenSet () const
 
void SetClusterState (const ClusterState &value)
 
void SetClusterState (ClusterState &&value)
 
ClusterMetadataWithClusterState (const ClusterState &value)
 
ClusterMetadataWithClusterState (ClusterState &&value)
 
const JobTypeGetJobType () const
 
bool JobTypeHasBeenSet () const
 
void SetJobType (const JobType &value)
 
void SetJobType (JobType &&value)
 
ClusterMetadataWithJobType (const JobType &value)
 
ClusterMetadataWithJobType (JobType &&value)
 
const SnowballTypeGetSnowballType () const
 
bool SnowballTypeHasBeenSet () const
 
void SetSnowballType (const SnowballType &value)
 
void SetSnowballType (SnowballType &&value)
 
ClusterMetadataWithSnowballType (const SnowballType &value)
 
ClusterMetadataWithSnowballType (SnowballType &&value)
 
const Aws::Utils::DateTimeGetCreationDate () const
 
bool CreationDateHasBeenSet () const
 
void SetCreationDate (const Aws::Utils::DateTime &value)
 
void SetCreationDate (Aws::Utils::DateTime &&value)
 
ClusterMetadataWithCreationDate (const Aws::Utils::DateTime &value)
 
ClusterMetadataWithCreationDate (Aws::Utils::DateTime &&value)
 
const JobResourceGetResources () const
 
bool ResourcesHasBeenSet () const
 
void SetResources (const JobResource &value)
 
void SetResources (JobResource &&value)
 
ClusterMetadataWithResources (const JobResource &value)
 
ClusterMetadataWithResources (JobResource &&value)
 
const Aws::StringGetAddressId () const
 
bool AddressIdHasBeenSet () const
 
void SetAddressId (const Aws::String &value)
 
void SetAddressId (Aws::String &&value)
 
void SetAddressId (const char *value)
 
ClusterMetadataWithAddressId (const Aws::String &value)
 
ClusterMetadataWithAddressId (Aws::String &&value)
 
ClusterMetadataWithAddressId (const char *value)
 
const ShippingOptionGetShippingOption () const
 
bool ShippingOptionHasBeenSet () const
 
void SetShippingOption (const ShippingOption &value)
 
void SetShippingOption (ShippingOption &&value)
 
ClusterMetadataWithShippingOption (const ShippingOption &value)
 
ClusterMetadataWithShippingOption (ShippingOption &&value)
 
const NotificationGetNotification () const
 
bool NotificationHasBeenSet () const
 
void SetNotification (const Notification &value)
 
void SetNotification (Notification &&value)
 
ClusterMetadataWithNotification (const Notification &value)
 
ClusterMetadataWithNotification (Notification &&value)
 
const Aws::StringGetForwardingAddressId () const
 
bool ForwardingAddressIdHasBeenSet () const
 
void SetForwardingAddressId (const Aws::String &value)
 
void SetForwardingAddressId (Aws::String &&value)
 
void SetForwardingAddressId (const char *value)
 
ClusterMetadataWithForwardingAddressId (const Aws::String &value)
 
ClusterMetadataWithForwardingAddressId (Aws::String &&value)
 
ClusterMetadataWithForwardingAddressId (const char *value)
 
const TaxDocumentsGetTaxDocuments () const
 
bool TaxDocumentsHasBeenSet () const
 
void SetTaxDocuments (const TaxDocuments &value)
 
void SetTaxDocuments (TaxDocuments &&value)
 
ClusterMetadataWithTaxDocuments (const TaxDocuments &value)
 
ClusterMetadataWithTaxDocuments (TaxDocuments &&value)
 
const OnDeviceServiceConfigurationGetOnDeviceServiceConfiguration () const
 
bool OnDeviceServiceConfigurationHasBeenSet () const
 
void SetOnDeviceServiceConfiguration (const OnDeviceServiceConfiguration &value)
 
void SetOnDeviceServiceConfiguration (OnDeviceServiceConfiguration &&value)
 
ClusterMetadataWithOnDeviceServiceConfiguration (const OnDeviceServiceConfiguration &value)
 
ClusterMetadataWithOnDeviceServiceConfiguration (OnDeviceServiceConfiguration &&value)
 

Detailed Description

Contains metadata about a specific cluster.

See Also:

AWS API Reference

Definition at line 40 of file ClusterMetadata.h.

Constructor & Destructor Documentation

◆ ClusterMetadata() [1/2]

Aws::Snowball::Model::ClusterMetadata::ClusterMetadata ( )

◆ ClusterMetadata() [2/2]

Aws::Snowball::Model::ClusterMetadata::ClusterMetadata ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddressIdHasBeenSet()

bool Aws::Snowball::Model::ClusterMetadata::AddressIdHasBeenSet ( ) const
inline

The automatically generated ID for a specific address.

Definition at line 440 of file ClusterMetadata.h.

◆ ClusterIdHasBeenSet()

bool Aws::Snowball::Model::ClusterMetadata::ClusterIdHasBeenSet ( ) const
inline

The automatically generated ID for a cluster.

Definition at line 57 of file ClusterMetadata.h.

◆ ClusterStateHasBeenSet()

bool Aws::Snowball::Model::ClusterMetadata::ClusterStateHasBeenSet ( ) const
inline

The current status of the cluster.

Definition at line 261 of file ClusterMetadata.h.

◆ CreationDateHasBeenSet()

bool Aws::Snowball::Model::ClusterMetadata::CreationDateHasBeenSet ( ) const
inline

The creation date for this cluster.

Definition at line 372 of file ClusterMetadata.h.

◆ DescriptionHasBeenSet()

bool Aws::Snowball::Model::ClusterMetadata::DescriptionHasBeenSet ( ) const
inline

The optional description of the cluster.

Definition at line 98 of file ClusterMetadata.h.

◆ ForwardingAddressIdHasBeenSet()

bool Aws::Snowball::Model::ClusterMetadata::ForwardingAddressIdHasBeenSet ( ) const
inline

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.

Definition at line 611 of file ClusterMetadata.h.

◆ GetAddressId()

const Aws::String& Aws::Snowball::Model::ClusterMetadata::GetAddressId ( ) const
inline

The automatically generated ID for a specific address.

Definition at line 435 of file ClusterMetadata.h.

◆ GetClusterId()

const Aws::String& Aws::Snowball::Model::ClusterMetadata::GetClusterId ( ) const
inline

The automatically generated ID for a cluster.

Definition at line 52 of file ClusterMetadata.h.

◆ GetClusterState()

const ClusterState& Aws::Snowball::Model::ClusterMetadata::GetClusterState ( ) const
inline

The current status of the cluster.

Definition at line 256 of file ClusterMetadata.h.

◆ GetCreationDate()

const Aws::Utils::DateTime& Aws::Snowball::Model::ClusterMetadata::GetCreationDate ( ) const
inline

The creation date for this cluster.

Definition at line 367 of file ClusterMetadata.h.

◆ GetDescription()

const Aws::String& Aws::Snowball::Model::ClusterMetadata::GetDescription ( ) const
inline

The optional description of the cluster.

Definition at line 93 of file ClusterMetadata.h.

◆ GetForwardingAddressId()

const Aws::String& Aws::Snowball::Model::ClusterMetadata::GetForwardingAddressId ( ) const
inline

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.

Definition at line 605 of file ClusterMetadata.h.

◆ GetJobType()

const JobType& Aws::Snowball::Model::ClusterMetadata::GetJobType ( ) const
inline

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

Definition at line 288 of file ClusterMetadata.h.

◆ GetKmsKeyARN()

const Aws::String& Aws::Snowball::Model::ClusterMetadata::GetKmsKeyARN ( ) const
inline

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

Definition at line 137 of file ClusterMetadata.h.

◆ GetNotification()

const Notification& Aws::Snowball::Model::ClusterMetadata::GetNotification ( ) const
inline

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

Definition at line 568 of file ClusterMetadata.h.

◆ GetOnDeviceServiceConfiguration()

const OnDeviceServiceConfiguration& Aws::Snowball::Model::ClusterMetadata::GetOnDeviceServiceConfiguration ( ) const
inline

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

Definition at line 685 of file ClusterMetadata.h.

◆ GetResources()

const JobResource& Aws::Snowball::Model::ClusterMetadata::GetResources ( ) const
inline

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

Definition at line 399 of file ClusterMetadata.h.

◆ GetRoleARN()

const Aws::String& Aws::Snowball::Model::ClusterMetadata::GetRoleARN ( ) const
inline

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

Definition at line 201 of file ClusterMetadata.h.

◆ GetShippingOption()

const ShippingOption& Aws::Snowball::Model::ClusterMetadata::GetShippingOption ( ) const
inline

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.

Definition at line 486 of file ClusterMetadata.h.

◆ GetSnowballType()

const SnowballType& Aws::Snowball::Model::ClusterMetadata::GetSnowballType ( ) const
inline

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

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

Definition at line 326 of file ClusterMetadata.h.

◆ GetTaxDocuments()

const TaxDocuments& Aws::Snowball::Model::ClusterMetadata::GetTaxDocuments ( ) const
inline

The tax documents required in your AWS Region.

Definition at line 653 of file ClusterMetadata.h.

◆ JobTypeHasBeenSet()

bool Aws::Snowball::Model::ClusterMetadata::JobTypeHasBeenSet ( ) const
inline

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

Definition at line 294 of file ClusterMetadata.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Snowball::Model::ClusterMetadata::Jsonize ( ) const

◆ KmsKeyARNHasBeenSet()

bool Aws::Snowball::Model::ClusterMetadata::KmsKeyARNHasBeenSet ( ) const
inline

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

Definition at line 145 of file ClusterMetadata.h.

◆ NotificationHasBeenSet()

bool Aws::Snowball::Model::ClusterMetadata::NotificationHasBeenSet ( ) const
inline

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

Definition at line 574 of file ClusterMetadata.h.

◆ OnDeviceServiceConfigurationHasBeenSet()

bool Aws::Snowball::Model::ClusterMetadata::OnDeviceServiceConfigurationHasBeenSet ( ) const
inline

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

Definition at line 691 of file ClusterMetadata.h.

◆ operator=()

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ResourcesHasBeenSet()

bool Aws::Snowball::Model::ClusterMetadata::ResourcesHasBeenSet ( ) const
inline

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

Definition at line 405 of file ClusterMetadata.h.

◆ RoleARNHasBeenSet()

bool Aws::Snowball::Model::ClusterMetadata::RoleARNHasBeenSet ( ) const
inline

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

Definition at line 208 of file ClusterMetadata.h.

◆ SetAddressId() [1/3]

void Aws::Snowball::Model::ClusterMetadata::SetAddressId ( Aws::String &&  value)
inline

The automatically generated ID for a specific address.

Definition at line 450 of file ClusterMetadata.h.

◆ SetAddressId() [2/3]

void Aws::Snowball::Model::ClusterMetadata::SetAddressId ( const Aws::String value)
inline

The automatically generated ID for a specific address.

Definition at line 445 of file ClusterMetadata.h.

◆ SetAddressId() [3/3]

void Aws::Snowball::Model::ClusterMetadata::SetAddressId ( const char *  value)
inline

The automatically generated ID for a specific address.

Definition at line 455 of file ClusterMetadata.h.

◆ SetClusterId() [1/3]

void Aws::Snowball::Model::ClusterMetadata::SetClusterId ( Aws::String &&  value)
inline

The automatically generated ID for a cluster.

Definition at line 67 of file ClusterMetadata.h.

◆ SetClusterId() [2/3]

void Aws::Snowball::Model::ClusterMetadata::SetClusterId ( const Aws::String value)
inline

The automatically generated ID for a cluster.

Definition at line 62 of file ClusterMetadata.h.

◆ SetClusterId() [3/3]

void Aws::Snowball::Model::ClusterMetadata::SetClusterId ( const char *  value)
inline

The automatically generated ID for a cluster.

Definition at line 72 of file ClusterMetadata.h.

◆ SetClusterState() [1/2]

void Aws::Snowball::Model::ClusterMetadata::SetClusterState ( ClusterState &&  value)
inline

The current status of the cluster.

Definition at line 271 of file ClusterMetadata.h.

◆ SetClusterState() [2/2]

void Aws::Snowball::Model::ClusterMetadata::SetClusterState ( const ClusterState value)
inline

The current status of the cluster.

Definition at line 266 of file ClusterMetadata.h.

◆ SetCreationDate() [1/2]

void Aws::Snowball::Model::ClusterMetadata::SetCreationDate ( Aws::Utils::DateTime &&  value)
inline

The creation date for this cluster.

Definition at line 382 of file ClusterMetadata.h.

◆ SetCreationDate() [2/2]

void Aws::Snowball::Model::ClusterMetadata::SetCreationDate ( const Aws::Utils::DateTime value)
inline

The creation date for this cluster.

Definition at line 377 of file ClusterMetadata.h.

◆ SetDescription() [1/3]

void Aws::Snowball::Model::ClusterMetadata::SetDescription ( Aws::String &&  value)
inline

The optional description of the cluster.

Definition at line 108 of file ClusterMetadata.h.

◆ SetDescription() [2/3]

void Aws::Snowball::Model::ClusterMetadata::SetDescription ( const Aws::String value)
inline

The optional description of the cluster.

Definition at line 103 of file ClusterMetadata.h.

◆ SetDescription() [3/3]

void Aws::Snowball::Model::ClusterMetadata::SetDescription ( const char *  value)
inline

The optional description of the cluster.

Definition at line 113 of file ClusterMetadata.h.

◆ SetForwardingAddressId() [1/3]

void Aws::Snowball::Model::ClusterMetadata::SetForwardingAddressId ( Aws::String &&  value)
inline

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.

Definition at line 623 of file ClusterMetadata.h.

◆ SetForwardingAddressId() [2/3]

void Aws::Snowball::Model::ClusterMetadata::SetForwardingAddressId ( const Aws::String value)
inline

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.

Definition at line 617 of file ClusterMetadata.h.

◆ SetForwardingAddressId() [3/3]

void Aws::Snowball::Model::ClusterMetadata::SetForwardingAddressId ( const char *  value)
inline

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.

Definition at line 629 of file ClusterMetadata.h.

◆ SetJobType() [1/2]

void Aws::Snowball::Model::ClusterMetadata::SetJobType ( const JobType value)
inline

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

Definition at line 300 of file ClusterMetadata.h.

◆ SetJobType() [2/2]

void Aws::Snowball::Model::ClusterMetadata::SetJobType ( JobType &&  value)
inline

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

Definition at line 306 of file ClusterMetadata.h.

◆ SetKmsKeyARN() [1/3]

void Aws::Snowball::Model::ClusterMetadata::SetKmsKeyARN ( Aws::String &&  value)
inline

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

Definition at line 161 of file ClusterMetadata.h.

◆ SetKmsKeyARN() [2/3]

void Aws::Snowball::Model::ClusterMetadata::SetKmsKeyARN ( const Aws::String value)
inline

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

Definition at line 153 of file ClusterMetadata.h.

◆ SetKmsKeyARN() [3/3]

void Aws::Snowball::Model::ClusterMetadata::SetKmsKeyARN ( const char *  value)
inline

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

Definition at line 169 of file ClusterMetadata.h.

◆ SetNotification() [1/2]

void Aws::Snowball::Model::ClusterMetadata::SetNotification ( const Notification value)
inline

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

Definition at line 580 of file ClusterMetadata.h.

◆ SetNotification() [2/2]

void Aws::Snowball::Model::ClusterMetadata::SetNotification ( Notification &&  value)
inline

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

Definition at line 586 of file ClusterMetadata.h.

◆ SetOnDeviceServiceConfiguration() [1/2]

void Aws::Snowball::Model::ClusterMetadata::SetOnDeviceServiceConfiguration ( const OnDeviceServiceConfiguration value)
inline

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

Definition at line 697 of file ClusterMetadata.h.

◆ SetOnDeviceServiceConfiguration() [2/2]

void Aws::Snowball::Model::ClusterMetadata::SetOnDeviceServiceConfiguration ( OnDeviceServiceConfiguration &&  value)
inline

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

Definition at line 703 of file ClusterMetadata.h.

◆ SetResources() [1/2]

void Aws::Snowball::Model::ClusterMetadata::SetResources ( const JobResource value)
inline

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

Definition at line 411 of file ClusterMetadata.h.

◆ SetResources() [2/2]

void Aws::Snowball::Model::ClusterMetadata::SetResources ( JobResource &&  value)
inline

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

Definition at line 417 of file ClusterMetadata.h.

◆ SetRoleARN() [1/3]

void Aws::Snowball::Model::ClusterMetadata::SetRoleARN ( Aws::String &&  value)
inline

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

Definition at line 222 of file ClusterMetadata.h.

◆ SetRoleARN() [2/3]

void Aws::Snowball::Model::ClusterMetadata::SetRoleARN ( const Aws::String value)
inline

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

Definition at line 215 of file ClusterMetadata.h.

◆ SetRoleARN() [3/3]

void Aws::Snowball::Model::ClusterMetadata::SetRoleARN ( const char *  value)
inline

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

Definition at line 229 of file ClusterMetadata.h.

◆ SetShippingOption() [1/2]

void Aws::Snowball::Model::ClusterMetadata::SetShippingOption ( const ShippingOption value)
inline

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.

Definition at line 516 of file ClusterMetadata.h.

◆ SetShippingOption() [2/2]

void Aws::Snowball::Model::ClusterMetadata::SetShippingOption ( ShippingOption &&  value)
inline

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.

Definition at line 531 of file ClusterMetadata.h.

◆ SetSnowballType() [1/2]

void Aws::Snowball::Model::ClusterMetadata::SetSnowballType ( const SnowballType value)
inline

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

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

Definition at line 340 of file ClusterMetadata.h.

◆ SetSnowballType() [2/2]

void Aws::Snowball::Model::ClusterMetadata::SetSnowballType ( SnowballType &&  value)
inline

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

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

Definition at line 347 of file ClusterMetadata.h.

◆ SetTaxDocuments() [1/2]

void Aws::Snowball::Model::ClusterMetadata::SetTaxDocuments ( const TaxDocuments value)
inline

The tax documents required in your AWS Region.

Definition at line 663 of file ClusterMetadata.h.

◆ SetTaxDocuments() [2/2]

void Aws::Snowball::Model::ClusterMetadata::SetTaxDocuments ( TaxDocuments &&  value)
inline

The tax documents required in your AWS Region.

Definition at line 668 of file ClusterMetadata.h.

◆ ShippingOptionHasBeenSet()

bool Aws::Snowball::Model::ClusterMetadata::ShippingOptionHasBeenSet ( ) const
inline

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.

Definition at line 501 of file ClusterMetadata.h.

◆ SnowballTypeHasBeenSet()

bool Aws::Snowball::Model::ClusterMetadata::SnowballTypeHasBeenSet ( ) const
inline

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

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

Definition at line 333 of file ClusterMetadata.h.

◆ TaxDocumentsHasBeenSet()

bool Aws::Snowball::Model::ClusterMetadata::TaxDocumentsHasBeenSet ( ) const
inline

The tax documents required in your AWS Region.

Definition at line 658 of file ClusterMetadata.h.

◆ WithAddressId() [1/3]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithAddressId ( Aws::String &&  value)
inline

The automatically generated ID for a specific address.

Definition at line 465 of file ClusterMetadata.h.

◆ WithAddressId() [2/3]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithAddressId ( const Aws::String value)
inline

The automatically generated ID for a specific address.

Definition at line 460 of file ClusterMetadata.h.

◆ WithAddressId() [3/3]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithAddressId ( const char *  value)
inline

The automatically generated ID for a specific address.

Definition at line 470 of file ClusterMetadata.h.

◆ WithClusterId() [1/3]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithClusterId ( Aws::String &&  value)
inline

The automatically generated ID for a cluster.

Definition at line 82 of file ClusterMetadata.h.

◆ WithClusterId() [2/3]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithClusterId ( const Aws::String value)
inline

The automatically generated ID for a cluster.

Definition at line 77 of file ClusterMetadata.h.

◆ WithClusterId() [3/3]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithClusterId ( const char *  value)
inline

The automatically generated ID for a cluster.

Definition at line 87 of file ClusterMetadata.h.

◆ WithClusterState() [1/2]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithClusterState ( ClusterState &&  value)
inline

The current status of the cluster.

Definition at line 281 of file ClusterMetadata.h.

◆ WithClusterState() [2/2]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithClusterState ( const ClusterState value)
inline

The current status of the cluster.

Definition at line 276 of file ClusterMetadata.h.

◆ WithCreationDate() [1/2]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithCreationDate ( Aws::Utils::DateTime &&  value)
inline

The creation date for this cluster.

Definition at line 392 of file ClusterMetadata.h.

◆ WithCreationDate() [2/2]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithCreationDate ( const Aws::Utils::DateTime value)
inline

The creation date for this cluster.

Definition at line 387 of file ClusterMetadata.h.

◆ WithDescription() [1/3]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithDescription ( Aws::String &&  value)
inline

The optional description of the cluster.

Definition at line 123 of file ClusterMetadata.h.

◆ WithDescription() [2/3]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithDescription ( const Aws::String value)
inline

The optional description of the cluster.

Definition at line 118 of file ClusterMetadata.h.

◆ WithDescription() [3/3]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithDescription ( const char *  value)
inline

The optional description of the cluster.

Definition at line 128 of file ClusterMetadata.h.

◆ WithForwardingAddressId() [1/3]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithForwardingAddressId ( Aws::String &&  value)
inline

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.

Definition at line 641 of file ClusterMetadata.h.

◆ WithForwardingAddressId() [2/3]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithForwardingAddressId ( const Aws::String value)
inline

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.

Definition at line 635 of file ClusterMetadata.h.

◆ WithForwardingAddressId() [3/3]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithForwardingAddressId ( const char *  value)
inline

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.

Definition at line 647 of file ClusterMetadata.h.

◆ WithJobType() [1/2]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithJobType ( const JobType value)
inline

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

Definition at line 312 of file ClusterMetadata.h.

◆ WithJobType() [2/2]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithJobType ( JobType &&  value)
inline

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

Definition at line 318 of file ClusterMetadata.h.

◆ WithKmsKeyARN() [1/3]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithKmsKeyARN ( Aws::String &&  value)
inline

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

Definition at line 185 of file ClusterMetadata.h.

◆ WithKmsKeyARN() [2/3]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithKmsKeyARN ( const Aws::String value)
inline

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

Definition at line 177 of file ClusterMetadata.h.

◆ WithKmsKeyARN() [3/3]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithKmsKeyARN ( const char *  value)
inline

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

Definition at line 193 of file ClusterMetadata.h.

◆ WithNotification() [1/2]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithNotification ( const Notification value)
inline

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

Definition at line 592 of file ClusterMetadata.h.

◆ WithNotification() [2/2]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithNotification ( Notification &&  value)
inline

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

Definition at line 598 of file ClusterMetadata.h.

◆ WithOnDeviceServiceConfiguration() [1/2]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithOnDeviceServiceConfiguration ( const OnDeviceServiceConfiguration value)
inline

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

Definition at line 709 of file ClusterMetadata.h.

◆ WithOnDeviceServiceConfiguration() [2/2]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithOnDeviceServiceConfiguration ( OnDeviceServiceConfiguration &&  value)
inline

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

Definition at line 715 of file ClusterMetadata.h.

◆ WithResources() [1/2]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithResources ( const JobResource value)
inline

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

Definition at line 423 of file ClusterMetadata.h.

◆ WithResources() [2/2]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithResources ( JobResource &&  value)
inline

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

Definition at line 429 of file ClusterMetadata.h.

◆ WithRoleARN() [1/3]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithRoleARN ( Aws::String &&  value)
inline

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

Definition at line 243 of file ClusterMetadata.h.

◆ WithRoleARN() [2/3]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithRoleARN ( const Aws::String value)
inline

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

Definition at line 236 of file ClusterMetadata.h.

◆ WithRoleARN() [3/3]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithRoleARN ( const char *  value)
inline

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

Definition at line 250 of file ClusterMetadata.h.

◆ WithShippingOption() [1/2]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithShippingOption ( const ShippingOption value)
inline

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.

Definition at line 546 of file ClusterMetadata.h.

◆ WithShippingOption() [2/2]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithShippingOption ( ShippingOption &&  value)
inline

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.

Definition at line 561 of file ClusterMetadata.h.

◆ WithSnowballType() [1/2]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithSnowballType ( const SnowballType value)
inline

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

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

Definition at line 354 of file ClusterMetadata.h.

◆ WithSnowballType() [2/2]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithSnowballType ( SnowballType &&  value)
inline

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

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

Definition at line 361 of file ClusterMetadata.h.

◆ WithTaxDocuments() [1/2]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithTaxDocuments ( const TaxDocuments value)
inline

The tax documents required in your AWS Region.

Definition at line 673 of file ClusterMetadata.h.

◆ WithTaxDocuments() [2/2]

ClusterMetadata& Aws::Snowball::Model::ClusterMetadata::WithTaxDocuments ( TaxDocuments &&  value)
inline

The tax documents required in your AWS Region.

Definition at line 678 of file ClusterMetadata.h.


The documentation for this class was generated from the following file: