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

#include <CreateClusterRequest.h>

+ Inheritance diagram for Aws::Snowball::Model::CreateClusterRequest:

Public Member Functions

 CreateClusterRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const JobTypeGetJobType () const
 
bool JobTypeHasBeenSet () const
 
void SetJobType (const JobType &value)
 
void SetJobType (JobType &&value)
 
CreateClusterRequestWithJobType (const JobType &value)
 
CreateClusterRequestWithJobType (JobType &&value)
 
const JobResourceGetResources () const
 
bool ResourcesHasBeenSet () const
 
void SetResources (const JobResource &value)
 
void SetResources (JobResource &&value)
 
CreateClusterRequestWithResources (const JobResource &value)
 
CreateClusterRequestWithResources (JobResource &&value)
 
const OnDeviceServiceConfigurationGetOnDeviceServiceConfiguration () const
 
bool OnDeviceServiceConfigurationHasBeenSet () const
 
void SetOnDeviceServiceConfiguration (const OnDeviceServiceConfiguration &value)
 
void SetOnDeviceServiceConfiguration (OnDeviceServiceConfiguration &&value)
 
CreateClusterRequestWithOnDeviceServiceConfiguration (const OnDeviceServiceConfiguration &value)
 
CreateClusterRequestWithOnDeviceServiceConfiguration (OnDeviceServiceConfiguration &&value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateClusterRequestWithDescription (const Aws::String &value)
 
CreateClusterRequestWithDescription (Aws::String &&value)
 
CreateClusterRequestWithDescription (const char *value)
 
const Aws::StringGetAddressId () const
 
bool AddressIdHasBeenSet () const
 
void SetAddressId (const Aws::String &value)
 
void SetAddressId (Aws::String &&value)
 
void SetAddressId (const char *value)
 
CreateClusterRequestWithAddressId (const Aws::String &value)
 
CreateClusterRequestWithAddressId (Aws::String &&value)
 
CreateClusterRequestWithAddressId (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)
 
CreateClusterRequestWithKmsKeyARN (const Aws::String &value)
 
CreateClusterRequestWithKmsKeyARN (Aws::String &&value)
 
CreateClusterRequestWithKmsKeyARN (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)
 
CreateClusterRequestWithRoleARN (const Aws::String &value)
 
CreateClusterRequestWithRoleARN (Aws::String &&value)
 
CreateClusterRequestWithRoleARN (const char *value)
 
const SnowballTypeGetSnowballType () const
 
bool SnowballTypeHasBeenSet () const
 
void SetSnowballType (const SnowballType &value)
 
void SetSnowballType (SnowballType &&value)
 
CreateClusterRequestWithSnowballType (const SnowballType &value)
 
CreateClusterRequestWithSnowballType (SnowballType &&value)
 
const ShippingOptionGetShippingOption () const
 
bool ShippingOptionHasBeenSet () const
 
void SetShippingOption (const ShippingOption &value)
 
void SetShippingOption (ShippingOption &&value)
 
CreateClusterRequestWithShippingOption (const ShippingOption &value)
 
CreateClusterRequestWithShippingOption (ShippingOption &&value)
 
const NotificationGetNotification () const
 
bool NotificationHasBeenSet () const
 
void SetNotification (const Notification &value)
 
void SetNotification (Notification &&value)
 
CreateClusterRequestWithNotification (const Notification &value)
 
CreateClusterRequestWithNotification (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)
 
CreateClusterRequestWithForwardingAddressId (const Aws::String &value)
 
CreateClusterRequestWithForwardingAddressId (Aws::String &&value)
 
CreateClusterRequestWithForwardingAddressId (const char *value)
 
const TaxDocumentsGetTaxDocuments () const
 
bool TaxDocumentsHasBeenSet () const
 
void SetTaxDocuments (const TaxDocuments &value)
 
void SetTaxDocuments (TaxDocuments &&value)
 
CreateClusterRequestWithTaxDocuments (const TaxDocuments &value)
 
CreateClusterRequestWithTaxDocuments (TaxDocuments &&value)
 
const RemoteManagementGetRemoteManagement () const
 
bool RemoteManagementHasBeenSet () const
 
void SetRemoteManagement (const RemoteManagement &value)
 
void SetRemoteManagement (RemoteManagement &&value)
 
CreateClusterRequestWithRemoteManagement (const RemoteManagement &value)
 
CreateClusterRequestWithRemoteManagement (RemoteManagement &&value)
 
- Public Member Functions inherited from Aws::Snowball::SnowballRequest
virtual ~SnowballRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 29 of file CreateClusterRequest.h.

Constructor & Destructor Documentation

◆ CreateClusterRequest()

Aws::Snowball::Model::CreateClusterRequest::CreateClusterRequest ( )

Member Function Documentation

◆ AddressIdHasBeenSet()

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

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

Definition at line 249 of file CreateClusterRequest.h.

◆ DescriptionHasBeenSet()

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

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

Definition at line 202 of file CreateClusterRequest.h.

◆ ForwardingAddressIdHasBeenSet()

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

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

Definition at line 665 of file CreateClusterRequest.h.

◆ GetAddressId()

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

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

Definition at line 244 of file CreateClusterRequest.h.

◆ GetDescription()

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

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

Definition at line 196 of file CreateClusterRequest.h.

◆ GetForwardingAddressId()

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

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

Definition at line 659 of file CreateClusterRequest.h.

◆ GetJobType()

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

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.

Definition at line 53 of file CreateClusterRequest.h.

◆ GetKmsKeyARN()

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

The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS).

Definition at line 288 of file CreateClusterRequest.h.

◆ GetNotification()

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

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

Definition at line 622 of file CreateClusterRequest.h.

◆ GetOnDeviceServiceConfiguration()

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

Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).

Definition at line 154 of file CreateClusterRequest.h.

◆ GetRemoteManagement()

const RemoteManagement& Aws::Snowball::Model::CreateClusterRequest::GetRemoteManagement ( ) const
inline

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.

Definition at line 742 of file CreateClusterRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Snowball::Model::CreateClusterRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::Snowball::SnowballRequest.

◆ GetResources()

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

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

Definition at line 111 of file CreateClusterRequest.h.

◆ GetRoleARN()

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

The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM).

Definition at line 353 of file CreateClusterRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Snowball::Model::CreateClusterRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file CreateClusterRequest.h.

◆ GetShippingOption()

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

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.

Definition at line 500 of file CreateClusterRequest.h.

◆ GetSnowballType()

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

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

For cluster jobs, AWS 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.

Definition at line 421 of file CreateClusterRequest.h.

◆ GetTaxDocuments()

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

The tax documents required in your AWS Region.

Definition at line 707 of file CreateClusterRequest.h.

◆ JobTypeHasBeenSet()

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

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.

Definition at line 63 of file CreateClusterRequest.h.

◆ KmsKeyARNHasBeenSet()

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

The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS).

Definition at line 296 of file CreateClusterRequest.h.

◆ NotificationHasBeenSet()

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

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

Definition at line 628 of file CreateClusterRequest.h.

◆ OnDeviceServiceConfigurationHasBeenSet()

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

Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).

Definition at line 161 of file CreateClusterRequest.h.

◆ RemoteManagementHasBeenSet()

bool Aws::Snowball::Model::CreateClusterRequest::RemoteManagementHasBeenSet ( ) const
inline

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.

Definition at line 751 of file CreateClusterRequest.h.

◆ ResourcesHasBeenSet()

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

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

Definition at line 118 of file CreateClusterRequest.h.

◆ RoleARNHasBeenSet()

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

The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM).

Definition at line 361 of file CreateClusterRequest.h.

◆ SerializePayload()

Aws::String Aws::Snowball::Model::CreateClusterRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAddressId() [1/3]

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

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

Definition at line 259 of file CreateClusterRequest.h.

◆ SetAddressId() [2/3]

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

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

Definition at line 254 of file CreateClusterRequest.h.

◆ SetAddressId() [3/3]

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

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

Definition at line 264 of file CreateClusterRequest.h.

◆ SetDescription() [1/3]

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

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

Definition at line 214 of file CreateClusterRequest.h.

◆ SetDescription() [2/3]

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

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

Definition at line 208 of file CreateClusterRequest.h.

◆ SetDescription() [3/3]

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

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

Definition at line 220 of file CreateClusterRequest.h.

◆ SetForwardingAddressId() [1/3]

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

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

Definition at line 677 of file CreateClusterRequest.h.

◆ SetForwardingAddressId() [2/3]

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

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

Definition at line 671 of file CreateClusterRequest.h.

◆ SetForwardingAddressId() [3/3]

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

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

Definition at line 683 of file CreateClusterRequest.h.

◆ SetJobType() [1/2]

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

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.

Definition at line 73 of file CreateClusterRequest.h.

◆ SetJobType() [2/2]

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

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.

Definition at line 83 of file CreateClusterRequest.h.

◆ SetKmsKeyARN() [1/3]

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

The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS).

Definition at line 312 of file CreateClusterRequest.h.

◆ SetKmsKeyARN() [2/3]

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

The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS).

Definition at line 304 of file CreateClusterRequest.h.

◆ SetKmsKeyARN() [3/3]

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

The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS).

Definition at line 320 of file CreateClusterRequest.h.

◆ SetNotification() [1/2]

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

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

Definition at line 634 of file CreateClusterRequest.h.

◆ SetNotification() [2/2]

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

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

Definition at line 640 of file CreateClusterRequest.h.

◆ SetOnDeviceServiceConfiguration() [1/2]

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

Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).

Definition at line 168 of file CreateClusterRequest.h.

◆ SetOnDeviceServiceConfiguration() [2/2]

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

Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).

Definition at line 175 of file CreateClusterRequest.h.

◆ SetRemoteManagement() [1/2]

void Aws::Snowball::Model::CreateClusterRequest::SetRemoteManagement ( const RemoteManagement value)
inline

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.

Definition at line 760 of file CreateClusterRequest.h.

◆ SetRemoteManagement() [2/2]

void Aws::Snowball::Model::CreateClusterRequest::SetRemoteManagement ( RemoteManagement &&  value)
inline

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.

Definition at line 769 of file CreateClusterRequest.h.

◆ SetResources() [1/2]

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

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

Definition at line 125 of file CreateClusterRequest.h.

◆ SetResources() [2/2]

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

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

Definition at line 132 of file CreateClusterRequest.h.

◆ SetRoleARN() [1/3]

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

The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM).

Definition at line 377 of file CreateClusterRequest.h.

◆ SetRoleARN() [2/3]

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

The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM).

Definition at line 369 of file CreateClusterRequest.h.

◆ SetRoleARN() [3/3]

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

The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM).

Definition at line 385 of file CreateClusterRequest.h.

◆ SetShippingOption() [1/2]

void Aws::Snowball::Model::CreateClusterRequest::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 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.

Definition at line 546 of file CreateClusterRequest.h.

◆ SetShippingOption() [2/2]

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

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.

Definition at line 569 of file CreateClusterRequest.h.

◆ SetSnowballType() [1/2]

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

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

For cluster jobs, AWS 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.

Definition at line 443 of file CreateClusterRequest.h.

◆ SetSnowballType() [2/2]

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

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

For cluster jobs, AWS 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.

Definition at line 454 of file CreateClusterRequest.h.

◆ SetTaxDocuments() [1/2]

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

The tax documents required in your AWS Region.

Definition at line 717 of file CreateClusterRequest.h.

◆ SetTaxDocuments() [2/2]

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

The tax documents required in your AWS Region.

Definition at line 722 of file CreateClusterRequest.h.

◆ ShippingOptionHasBeenSet()

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

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.

Definition at line 523 of file CreateClusterRequest.h.

◆ SnowballTypeHasBeenSet()

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

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

For cluster jobs, AWS 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.

Definition at line 432 of file CreateClusterRequest.h.

◆ TaxDocumentsHasBeenSet()

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

The tax documents required in your AWS Region.

Definition at line 712 of file CreateClusterRequest.h.

◆ WithAddressId() [1/3]

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

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

Definition at line 274 of file CreateClusterRequest.h.

◆ WithAddressId() [2/3]

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

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

Definition at line 269 of file CreateClusterRequest.h.

◆ WithAddressId() [3/3]

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

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

Definition at line 279 of file CreateClusterRequest.h.

◆ WithDescription() [1/3]

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

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

Definition at line 232 of file CreateClusterRequest.h.

◆ WithDescription() [2/3]

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

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

Definition at line 226 of file CreateClusterRequest.h.

◆ WithDescription() [3/3]

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

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

Definition at line 238 of file CreateClusterRequest.h.

◆ WithForwardingAddressId() [1/3]

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

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

Definition at line 695 of file CreateClusterRequest.h.

◆ WithForwardingAddressId() [2/3]

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

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

Definition at line 689 of file CreateClusterRequest.h.

◆ WithForwardingAddressId() [3/3]

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

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

Definition at line 701 of file CreateClusterRequest.h.

◆ WithJobType() [1/2]

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

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.

Definition at line 93 of file CreateClusterRequest.h.

◆ WithJobType() [2/2]

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

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.

Definition at line 103 of file CreateClusterRequest.h.

◆ WithKmsKeyARN() [1/3]

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

The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS).

Definition at line 336 of file CreateClusterRequest.h.

◆ WithKmsKeyARN() [2/3]

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

The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS).

Definition at line 328 of file CreateClusterRequest.h.

◆ WithKmsKeyARN() [3/3]

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

The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS).

Definition at line 344 of file CreateClusterRequest.h.

◆ WithNotification() [1/2]

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

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

Definition at line 646 of file CreateClusterRequest.h.

◆ WithNotification() [2/2]

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

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

Definition at line 652 of file CreateClusterRequest.h.

◆ WithOnDeviceServiceConfiguration() [1/2]

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

Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).

Definition at line 182 of file CreateClusterRequest.h.

◆ WithOnDeviceServiceConfiguration() [2/2]

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

Specifies the service or services on the Snow Family device that your transferred data will be exported from or imported into. AWS Snow Family supports Amazon S3 and NFS (Network File System).

Definition at line 189 of file CreateClusterRequest.h.

◆ WithRemoteManagement() [1/2]

CreateClusterRequest& Aws::Snowball::Model::CreateClusterRequest::WithRemoteManagement ( const RemoteManagement value)
inline

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.

Definition at line 778 of file CreateClusterRequest.h.

◆ WithRemoteManagement() [2/2]

CreateClusterRequest& Aws::Snowball::Model::CreateClusterRequest::WithRemoteManagement ( RemoteManagement &&  value)
inline

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.

Definition at line 787 of file CreateClusterRequest.h.

◆ WithResources() [1/2]

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

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

Definition at line 139 of file CreateClusterRequest.h.

◆ WithResources() [2/2]

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

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

Definition at line 146 of file CreateClusterRequest.h.

◆ WithRoleARN() [1/3]

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

The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM).

Definition at line 401 of file CreateClusterRequest.h.

◆ WithRoleARN() [2/3]

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

The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM).

Definition at line 393 of file CreateClusterRequest.h.

◆ WithRoleARN() [3/3]

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

The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM).

Definition at line 409 of file CreateClusterRequest.h.

◆ WithShippingOption() [1/2]

CreateClusterRequest& Aws::Snowball::Model::CreateClusterRequest::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 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.

Definition at line 592 of file CreateClusterRequest.h.

◆ WithShippingOption() [2/2]

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

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.

Definition at line 615 of file CreateClusterRequest.h.

◆ WithSnowballType() [1/2]

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

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

For cluster jobs, AWS 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.

Definition at line 465 of file CreateClusterRequest.h.

◆ WithSnowballType() [2/2]

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

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

For cluster jobs, AWS 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.

Definition at line 476 of file CreateClusterRequest.h.

◆ WithTaxDocuments() [1/2]

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

The tax documents required in your AWS Region.

Definition at line 727 of file CreateClusterRequest.h.

◆ WithTaxDocuments() [2/2]

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

The tax documents required in your AWS Region.

Definition at line 732 of file CreateClusterRequest.h.


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