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

#include <ActivateGatewayRequest.h>

+ Inheritance diagram for Aws::StorageGateway::Model::ActivateGatewayRequest:

Public Member Functions

 ActivateGatewayRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetActivationKey () const
 
bool ActivationKeyHasBeenSet () const
 
void SetActivationKey (const Aws::String &value)
 
void SetActivationKey (Aws::String &&value)
 
void SetActivationKey (const char *value)
 
ActivateGatewayRequestWithActivationKey (const Aws::String &value)
 
ActivateGatewayRequestWithActivationKey (Aws::String &&value)
 
ActivateGatewayRequestWithActivationKey (const char *value)
 
const Aws::StringGetGatewayName () const
 
bool GatewayNameHasBeenSet () const
 
void SetGatewayName (const Aws::String &value)
 
void SetGatewayName (Aws::String &&value)
 
void SetGatewayName (const char *value)
 
ActivateGatewayRequestWithGatewayName (const Aws::String &value)
 
ActivateGatewayRequestWithGatewayName (Aws::String &&value)
 
ActivateGatewayRequestWithGatewayName (const char *value)
 
const Aws::StringGetGatewayTimezone () const
 
bool GatewayTimezoneHasBeenSet () const
 
void SetGatewayTimezone (const Aws::String &value)
 
void SetGatewayTimezone (Aws::String &&value)
 
void SetGatewayTimezone (const char *value)
 
ActivateGatewayRequestWithGatewayTimezone (const Aws::String &value)
 
ActivateGatewayRequestWithGatewayTimezone (Aws::String &&value)
 
ActivateGatewayRequestWithGatewayTimezone (const char *value)
 
const Aws::StringGetGatewayRegion () const
 
bool GatewayRegionHasBeenSet () const
 
void SetGatewayRegion (const Aws::String &value)
 
void SetGatewayRegion (Aws::String &&value)
 
void SetGatewayRegion (const char *value)
 
ActivateGatewayRequestWithGatewayRegion (const Aws::String &value)
 
ActivateGatewayRequestWithGatewayRegion (Aws::String &&value)
 
ActivateGatewayRequestWithGatewayRegion (const char *value)
 
const Aws::StringGetGatewayType () const
 
bool GatewayTypeHasBeenSet () const
 
void SetGatewayType (const Aws::String &value)
 
void SetGatewayType (Aws::String &&value)
 
void SetGatewayType (const char *value)
 
ActivateGatewayRequestWithGatewayType (const Aws::String &value)
 
ActivateGatewayRequestWithGatewayType (Aws::String &&value)
 
ActivateGatewayRequestWithGatewayType (const char *value)
 
const Aws::StringGetTapeDriveType () const
 
bool TapeDriveTypeHasBeenSet () const
 
void SetTapeDriveType (const Aws::String &value)
 
void SetTapeDriveType (Aws::String &&value)
 
void SetTapeDriveType (const char *value)
 
ActivateGatewayRequestWithTapeDriveType (const Aws::String &value)
 
ActivateGatewayRequestWithTapeDriveType (Aws::String &&value)
 
ActivateGatewayRequestWithTapeDriveType (const char *value)
 
const Aws::StringGetMediumChangerType () const
 
bool MediumChangerTypeHasBeenSet () const
 
void SetMediumChangerType (const Aws::String &value)
 
void SetMediumChangerType (Aws::String &&value)
 
void SetMediumChangerType (const char *value)
 
ActivateGatewayRequestWithMediumChangerType (const Aws::String &value)
 
ActivateGatewayRequestWithMediumChangerType (Aws::String &&value)
 
ActivateGatewayRequestWithMediumChangerType (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
ActivateGatewayRequestWithTags (const Aws::Vector< Tag > &value)
 
ActivateGatewayRequestWithTags (Aws::Vector< Tag > &&value)
 
ActivateGatewayRequestAddTags (const Tag &value)
 
ActivateGatewayRequestAddTags (Tag &&value)
 
- Public Member Functions inherited from Aws::StorageGateway::StorageGatewayRequest
virtual ~StorageGatewayRequest ()
 
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

A JSON object containing one or more of the following fields:

See Also:

AWS API Reference

Definition at line 34 of file ActivateGatewayRequest.h.

Constructor & Destructor Documentation

◆ ActivateGatewayRequest()

Aws::StorageGateway::Model::ActivateGatewayRequest::ActivateGatewayRequest ( )

Member Function Documentation

◆ ActivationKeyHasBeenSet()

bool Aws::StorageGateway::Model::ActivateGatewayRequest::ActivationKeyHasBeenSet ( ) const
inline

Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults – the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

For more information, see Getting activation key in the Storage Gateway User Guide.

Definition at line 74 of file ActivateGatewayRequest.h.

◆ AddTags() [1/2]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::AddTags ( const Tag value)
inline

A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

Definition at line 629 of file ActivateGatewayRequest.h.

◆ AddTags() [2/2]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::AddTags ( Tag &&  value)
inline

A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

Definition at line 639 of file ActivateGatewayRequest.h.

◆ GatewayNameHasBeenSet()

bool Aws::StorageGateway::Model::ActivateGatewayRequest::GatewayNameHasBeenSet ( ) const
inline

The name you configured for your gateway.

Definition at line 163 of file ActivateGatewayRequest.h.

◆ GatewayRegionHasBeenSet()

bool Aws::StorageGateway::Model::ActivateGatewayRequest::GatewayRegionHasBeenSet ( ) const
inline

A value that indicates the Region where you want to store your data. The gateway Region specified must be the same Region as the Region in your Host header in the request. For more information about available Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

Definition at line 295 of file ActivateGatewayRequest.h.

◆ GatewayTimezoneHasBeenSet()

bool Aws::StorageGateway::Model::ActivateGatewayRequest::GatewayTimezoneHasBeenSet ( ) const
inline

A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

Definition at line 212 of file ActivateGatewayRequest.h.

◆ GatewayTypeHasBeenSet()

bool Aws::StorageGateway::Model::ActivateGatewayRequest::GatewayTypeHasBeenSet ( ) const
inline

A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED.

Valid Values: STORED | CACHED | VTL | FILE_S3 | FILE_FSX_SMB|

Definition at line 398 of file ActivateGatewayRequest.h.

◆ GetActivationKey()

const Aws::String& Aws::StorageGateway::Model::ActivateGatewayRequest::GetActivationKey ( ) const
inline

Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults – the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

For more information, see Getting activation key in the Storage Gateway User Guide.

Definition at line 61 of file ActivateGatewayRequest.h.

◆ GetGatewayName()

const Aws::String& Aws::StorageGateway::Model::ActivateGatewayRequest::GetGatewayName ( ) const
inline

The name you configured for your gateway.

Definition at line 158 of file ActivateGatewayRequest.h.

◆ GetGatewayRegion()

const Aws::String& Aws::StorageGateway::Model::ActivateGatewayRequest::GetGatewayRegion ( ) const
inline

A value that indicates the Region where you want to store your data. The gateway Region specified must be the same Region as the Region in your Host header in the request. For more information about available Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

Definition at line 281 of file ActivateGatewayRequest.h.

◆ GetGatewayTimezone()

const Aws::String& Aws::StorageGateway::Model::ActivateGatewayRequest::GetGatewayTimezone ( ) const
inline

A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

Definition at line 203 of file ActivateGatewayRequest.h.

◆ GetGatewayType()

const Aws::String& Aws::StorageGateway::Model::ActivateGatewayRequest::GetGatewayType ( ) const
inline

A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED.

Valid Values: STORED | CACHED | VTL | FILE_S3 | FILE_FSX_SMB|

Definition at line 389 of file ActivateGatewayRequest.h.

◆ GetMediumChangerType()

const Aws::String& Aws::StorageGateway::Model::ActivateGatewayRequest::GetMediumChangerType ( ) const
inline

The value that indicates the type of medium changer to use for tape gateway. This field is optional.

Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402

Definition at line 509 of file ActivateGatewayRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::StorageGateway::Model::ActivateGatewayRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::StorageGateway::Model::ActivateGatewayRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 43 of file ActivateGatewayRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::StorageGateway::Model::ActivateGatewayRequest::GetTags ( ) const
inline

A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

Definition at line 569 of file ActivateGatewayRequest.h.

◆ GetTapeDriveType()

const Aws::String& Aws::StorageGateway::Model::ActivateGatewayRequest::GetTapeDriveType ( ) const
inline

The value that indicates the type of tape drive to use for tape gateway. This field is optional.

Valid Values: IBM-ULT3580-TD5

Definition at line 459 of file ActivateGatewayRequest.h.

◆ MediumChangerTypeHasBeenSet()

bool Aws::StorageGateway::Model::ActivateGatewayRequest::MediumChangerTypeHasBeenSet ( ) const
inline

The value that indicates the type of medium changer to use for tape gateway. This field is optional.

Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402

Definition at line 516 of file ActivateGatewayRequest.h.

◆ SerializePayload()

Aws::String Aws::StorageGateway::Model::ActivateGatewayRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetActivationKey() [1/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetActivationKey ( Aws::String &&  value)
inline

Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults – the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

For more information, see Getting activation key in the Storage Gateway User Guide.

Definition at line 100 of file ActivateGatewayRequest.h.

◆ SetActivationKey() [2/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetActivationKey ( const Aws::String value)
inline

Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults – the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

For more information, see Getting activation key in the Storage Gateway User Guide.

Definition at line 87 of file ActivateGatewayRequest.h.

◆ SetActivationKey() [3/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetActivationKey ( const char *  value)
inline

Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults – the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

For more information, see Getting activation key in the Storage Gateway User Guide.

Definition at line 113 of file ActivateGatewayRequest.h.

◆ SetGatewayName() [1/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetGatewayName ( Aws::String &&  value)
inline

The name you configured for your gateway.

Definition at line 173 of file ActivateGatewayRequest.h.

◆ SetGatewayName() [2/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetGatewayName ( const Aws::String value)
inline

The name you configured for your gateway.

Definition at line 168 of file ActivateGatewayRequest.h.

◆ SetGatewayName() [3/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetGatewayName ( const char *  value)
inline

The name you configured for your gateway.

Definition at line 178 of file ActivateGatewayRequest.h.

◆ SetGatewayRegion() [1/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetGatewayRegion ( Aws::String &&  value)
inline

A value that indicates the Region where you want to store your data. The gateway Region specified must be the same Region as the Region in your Host header in the request. For more information about available Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

Definition at line 323 of file ActivateGatewayRequest.h.

◆ SetGatewayRegion() [2/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetGatewayRegion ( const Aws::String value)
inline

A value that indicates the Region where you want to store your data. The gateway Region specified must be the same Region as the Region in your Host header in the request. For more information about available Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

Definition at line 309 of file ActivateGatewayRequest.h.

◆ SetGatewayRegion() [3/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetGatewayRegion ( const char *  value)
inline

A value that indicates the Region where you want to store your data. The gateway Region specified must be the same Region as the Region in your Host header in the request. For more information about available Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

Definition at line 337 of file ActivateGatewayRequest.h.

◆ SetGatewayTimezone() [1/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetGatewayTimezone ( Aws::String &&  value)
inline

A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

Definition at line 230 of file ActivateGatewayRequest.h.

◆ SetGatewayTimezone() [2/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetGatewayTimezone ( const Aws::String value)
inline

A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

Definition at line 221 of file ActivateGatewayRequest.h.

◆ SetGatewayTimezone() [3/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetGatewayTimezone ( const char *  value)
inline

A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

Definition at line 239 of file ActivateGatewayRequest.h.

◆ SetGatewayType() [1/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetGatewayType ( Aws::String &&  value)
inline

A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED.

Valid Values: STORED | CACHED | VTL | FILE_S3 | FILE_FSX_SMB|

Definition at line 416 of file ActivateGatewayRequest.h.

◆ SetGatewayType() [2/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetGatewayType ( const Aws::String value)
inline

A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED.

Valid Values: STORED | CACHED | VTL | FILE_S3 | FILE_FSX_SMB|

Definition at line 407 of file ActivateGatewayRequest.h.

◆ SetGatewayType() [3/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetGatewayType ( const char *  value)
inline

A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED.

Valid Values: STORED | CACHED | VTL | FILE_S3 | FILE_FSX_SMB|

Definition at line 425 of file ActivateGatewayRequest.h.

◆ SetMediumChangerType() [1/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetMediumChangerType ( Aws::String &&  value)
inline

The value that indicates the type of medium changer to use for tape gateway. This field is optional.

Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402

Definition at line 530 of file ActivateGatewayRequest.h.

◆ SetMediumChangerType() [2/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetMediumChangerType ( const Aws::String value)
inline

The value that indicates the type of medium changer to use for tape gateway. This field is optional.

Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402

Definition at line 523 of file ActivateGatewayRequest.h.

◆ SetMediumChangerType() [3/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetMediumChangerType ( const char *  value)
inline

The value that indicates the type of medium changer to use for tape gateway. This field is optional.

Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402

Definition at line 537 of file ActivateGatewayRequest.h.

◆ SetTags() [1/2]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

Definition at line 599 of file ActivateGatewayRequest.h.

◆ SetTags() [2/2]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

Definition at line 589 of file ActivateGatewayRequest.h.

◆ SetTapeDriveType() [1/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetTapeDriveType ( Aws::String &&  value)
inline

The value that indicates the type of tape drive to use for tape gateway. This field is optional.

Valid Values: IBM-ULT3580-TD5

Definition at line 477 of file ActivateGatewayRequest.h.

◆ SetTapeDriveType() [2/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetTapeDriveType ( const Aws::String value)
inline

The value that indicates the type of tape drive to use for tape gateway. This field is optional.

Valid Values: IBM-ULT3580-TD5

Definition at line 471 of file ActivateGatewayRequest.h.

◆ SetTapeDriveType() [3/3]

void Aws::StorageGateway::Model::ActivateGatewayRequest::SetTapeDriveType ( const char *  value)
inline

The value that indicates the type of tape drive to use for tape gateway. This field is optional.

Valid Values: IBM-ULT3580-TD5

Definition at line 483 of file ActivateGatewayRequest.h.

◆ TagsHasBeenSet()

bool Aws::StorageGateway::Model::ActivateGatewayRequest::TagsHasBeenSet ( ) const
inline

A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

Definition at line 579 of file ActivateGatewayRequest.h.

◆ TapeDriveTypeHasBeenSet()

bool Aws::StorageGateway::Model::ActivateGatewayRequest::TapeDriveTypeHasBeenSet ( ) const
inline

The value that indicates the type of tape drive to use for tape gateway. This field is optional.

Valid Values: IBM-ULT3580-TD5

Definition at line 465 of file ActivateGatewayRequest.h.

◆ WithActivationKey() [1/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithActivationKey ( Aws::String &&  value)
inline

Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults – the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

For more information, see Getting activation key in the Storage Gateway User Guide.

Definition at line 139 of file ActivateGatewayRequest.h.

◆ WithActivationKey() [2/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithActivationKey ( const Aws::String value)
inline

Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults – the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

For more information, see Getting activation key in the Storage Gateway User Guide.

Definition at line 126 of file ActivateGatewayRequest.h.

◆ WithActivationKey() [3/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithActivationKey ( const char *  value)
inline

Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults – the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

For more information, see Getting activation key in the Storage Gateway User Guide.

Definition at line 152 of file ActivateGatewayRequest.h.

◆ WithGatewayName() [1/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithGatewayName ( Aws::String &&  value)
inline

The name you configured for your gateway.

Definition at line 188 of file ActivateGatewayRequest.h.

◆ WithGatewayName() [2/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithGatewayName ( const Aws::String value)
inline

The name you configured for your gateway.

Definition at line 183 of file ActivateGatewayRequest.h.

◆ WithGatewayName() [3/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithGatewayName ( const char *  value)
inline

The name you configured for your gateway.

Definition at line 193 of file ActivateGatewayRequest.h.

◆ WithGatewayRegion() [1/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithGatewayRegion ( Aws::String &&  value)
inline

A value that indicates the Region where you want to store your data. The gateway Region specified must be the same Region as the Region in your Host header in the request. For more information about available Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

Definition at line 365 of file ActivateGatewayRequest.h.

◆ WithGatewayRegion() [2/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithGatewayRegion ( const Aws::String value)
inline

A value that indicates the Region where you want to store your data. The gateway Region specified must be the same Region as the Region in your Host header in the request. For more information about available Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

Definition at line 351 of file ActivateGatewayRequest.h.

◆ WithGatewayRegion() [3/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithGatewayRegion ( const char *  value)
inline

A value that indicates the Region where you want to store your data. The gateway Region specified must be the same Region as the Region in your Host header in the request. For more information about available Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference.

Definition at line 379 of file ActivateGatewayRequest.h.

◆ WithGatewayTimezone() [1/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithGatewayTimezone ( Aws::String &&  value)
inline

A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

Definition at line 257 of file ActivateGatewayRequest.h.

◆ WithGatewayTimezone() [2/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithGatewayTimezone ( const Aws::String value)
inline

A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

Definition at line 248 of file ActivateGatewayRequest.h.

◆ WithGatewayTimezone() [3/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithGatewayTimezone ( const char *  value)
inline

A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

Definition at line 266 of file ActivateGatewayRequest.h.

◆ WithGatewayType() [1/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithGatewayType ( Aws::String &&  value)
inline

A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED.

Valid Values: STORED | CACHED | VTL | FILE_S3 | FILE_FSX_SMB|

Definition at line 443 of file ActivateGatewayRequest.h.

◆ WithGatewayType() [2/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithGatewayType ( const Aws::String value)
inline

A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED.

Valid Values: STORED | CACHED | VTL | FILE_S3 | FILE_FSX_SMB|

Definition at line 434 of file ActivateGatewayRequest.h.

◆ WithGatewayType() [3/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithGatewayType ( const char *  value)
inline

A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED.

Valid Values: STORED | CACHED | VTL | FILE_S3 | FILE_FSX_SMB|

Definition at line 452 of file ActivateGatewayRequest.h.

◆ WithMediumChangerType() [1/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithMediumChangerType ( Aws::String &&  value)
inline

The value that indicates the type of medium changer to use for tape gateway. This field is optional.

Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402

Definition at line 551 of file ActivateGatewayRequest.h.

◆ WithMediumChangerType() [2/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithMediumChangerType ( const Aws::String value)
inline

The value that indicates the type of medium changer to use for tape gateway. This field is optional.

Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402

Definition at line 544 of file ActivateGatewayRequest.h.

◆ WithMediumChangerType() [3/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithMediumChangerType ( const char *  value)
inline

The value that indicates the type of medium changer to use for tape gateway. This field is optional.

Valid Values: STK-L700 | AWS-Gateway-VTL | IBM-03584L32-0402

Definition at line 558 of file ActivateGatewayRequest.h.

◆ WithTags() [1/2]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

Definition at line 619 of file ActivateGatewayRequest.h.

◆ WithTags() [2/2]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / . The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

Definition at line 609 of file ActivateGatewayRequest.h.

◆ WithTapeDriveType() [1/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithTapeDriveType ( Aws::String &&  value)
inline

The value that indicates the type of tape drive to use for tape gateway. This field is optional.

Valid Values: IBM-ULT3580-TD5

Definition at line 495 of file ActivateGatewayRequest.h.

◆ WithTapeDriveType() [2/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithTapeDriveType ( const Aws::String value)
inline

The value that indicates the type of tape drive to use for tape gateway. This field is optional.

Valid Values: IBM-ULT3580-TD5

Definition at line 489 of file ActivateGatewayRequest.h.

◆ WithTapeDriveType() [3/3]

ActivateGatewayRequest& Aws::StorageGateway::Model::ActivateGatewayRequest::WithTapeDriveType ( const char *  value)
inline

The value that indicates the type of tape drive to use for tape gateway. This field is optional.

Valid Values: IBM-ULT3580-TD5

Definition at line 501 of file ActivateGatewayRequest.h.


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