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

#include <CreateCachediSCSIVolumeRequest.h>

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

Public Member Functions

 CreateCachediSCSIVolumeRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetGatewayARN () const
 
bool GatewayARNHasBeenSet () const
 
void SetGatewayARN (const Aws::String &value)
 
void SetGatewayARN (Aws::String &&value)
 
void SetGatewayARN (const char *value)
 
CreateCachediSCSIVolumeRequestWithGatewayARN (const Aws::String &value)
 
CreateCachediSCSIVolumeRequestWithGatewayARN (Aws::String &&value)
 
CreateCachediSCSIVolumeRequestWithGatewayARN (const char *value)
 
long long GetVolumeSizeInBytes () const
 
bool VolumeSizeInBytesHasBeenSet () const
 
void SetVolumeSizeInBytes (long long value)
 
CreateCachediSCSIVolumeRequestWithVolumeSizeInBytes (long long value)
 
const Aws::StringGetSnapshotId () const
 
bool SnapshotIdHasBeenSet () const
 
void SetSnapshotId (const Aws::String &value)
 
void SetSnapshotId (Aws::String &&value)
 
void SetSnapshotId (const char *value)
 
CreateCachediSCSIVolumeRequestWithSnapshotId (const Aws::String &value)
 
CreateCachediSCSIVolumeRequestWithSnapshotId (Aws::String &&value)
 
CreateCachediSCSIVolumeRequestWithSnapshotId (const char *value)
 
const Aws::StringGetTargetName () const
 
bool TargetNameHasBeenSet () const
 
void SetTargetName (const Aws::String &value)
 
void SetTargetName (Aws::String &&value)
 
void SetTargetName (const char *value)
 
CreateCachediSCSIVolumeRequestWithTargetName (const Aws::String &value)
 
CreateCachediSCSIVolumeRequestWithTargetName (Aws::String &&value)
 
CreateCachediSCSIVolumeRequestWithTargetName (const char *value)
 
const Aws::StringGetSourceVolumeARN () const
 
bool SourceVolumeARNHasBeenSet () const
 
void SetSourceVolumeARN (const Aws::String &value)
 
void SetSourceVolumeARN (Aws::String &&value)
 
void SetSourceVolumeARN (const char *value)
 
CreateCachediSCSIVolumeRequestWithSourceVolumeARN (const Aws::String &value)
 
CreateCachediSCSIVolumeRequestWithSourceVolumeARN (Aws::String &&value)
 
CreateCachediSCSIVolumeRequestWithSourceVolumeARN (const char *value)
 
const Aws::StringGetNetworkInterfaceId () const
 
bool NetworkInterfaceIdHasBeenSet () const
 
void SetNetworkInterfaceId (const Aws::String &value)
 
void SetNetworkInterfaceId (Aws::String &&value)
 
void SetNetworkInterfaceId (const char *value)
 
CreateCachediSCSIVolumeRequestWithNetworkInterfaceId (const Aws::String &value)
 
CreateCachediSCSIVolumeRequestWithNetworkInterfaceId (Aws::String &&value)
 
CreateCachediSCSIVolumeRequestWithNetworkInterfaceId (const char *value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
CreateCachediSCSIVolumeRequestWithClientToken (const Aws::String &value)
 
CreateCachediSCSIVolumeRequestWithClientToken (Aws::String &&value)
 
CreateCachediSCSIVolumeRequestWithClientToken (const char *value)
 
bool GetKMSEncrypted () const
 
bool KMSEncryptedHasBeenSet () const
 
void SetKMSEncrypted (bool value)
 
CreateCachediSCSIVolumeRequestWithKMSEncrypted (bool value)
 
const Aws::StringGetKMSKey () const
 
bool KMSKeyHasBeenSet () const
 
void SetKMSKey (const Aws::String &value)
 
void SetKMSKey (Aws::String &&value)
 
void SetKMSKey (const char *value)
 
CreateCachediSCSIVolumeRequestWithKMSKey (const Aws::String &value)
 
CreateCachediSCSIVolumeRequestWithKMSKey (Aws::String &&value)
 
CreateCachediSCSIVolumeRequestWithKMSKey (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)
 
CreateCachediSCSIVolumeRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateCachediSCSIVolumeRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateCachediSCSIVolumeRequestAddTags (const Tag &value)
 
CreateCachediSCSIVolumeRequestAddTags (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

Definition at line 23 of file CreateCachediSCSIVolumeRequest.h.

Constructor & Destructor Documentation

◆ CreateCachediSCSIVolumeRequest()

Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::CreateCachediSCSIVolumeRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

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

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

Valid characters for key and value are letters, spaces, and numbers that you can represent 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 596 of file CreateCachediSCSIVolumeRequest.h.

◆ AddTags() [2/2]

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

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

Valid characters for key and value are letters, spaces, and numbers that you can represent 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 606 of file CreateCachediSCSIVolumeRequest.h.

◆ ClientTokenHasBeenSet()

bool Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::ClientTokenHasBeenSet ( ) const
inline

A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

Definition at line 395 of file CreateCachediSCSIVolumeRequest.h.

◆ GatewayARNHasBeenSet()

bool Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::GatewayARNHasBeenSet ( ) const
inline

Definition at line 43 of file CreateCachediSCSIVolumeRequest.h.

◆ GetClientToken()

const Aws::String& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::GetClientToken ( ) const
inline

A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

Definition at line 389 of file CreateCachediSCSIVolumeRequest.h.

◆ GetGatewayARN()

const Aws::String& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::GetGatewayARN ( ) const
inline

Definition at line 40 of file CreateCachediSCSIVolumeRequest.h.

◆ GetKMSEncrypted()

bool Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::GetKMSEncrypted ( ) const
inline

Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

Definition at line 439 of file CreateCachediSCSIVolumeRequest.h.

◆ GetKMSKey()

const Aws::String& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::GetKMSKey ( ) const
inline

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

Definition at line 469 of file CreateCachediSCSIVolumeRequest.h.

◆ GetNetworkInterfaceId()

const Aws::String& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::GetNetworkInterfaceId ( ) const
inline

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

Definition at line 326 of file CreateCachediSCSIVolumeRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file CreateCachediSCSIVolumeRequest.h.

◆ GetSnapshotId()

const Aws::String& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::GetSnapshotId ( ) const
inline

The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

Definition at line 93 of file CreateCachediSCSIVolumeRequest.h.

◆ GetSourceVolumeARN()

const Aws::String& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::GetSourceVolumeARN ( ) const
inline

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

Definition at line 261 of file CreateCachediSCSIVolumeRequest.h.

◆ GetTags()

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

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

Valid characters for key and value are letters, spaces, and numbers that you can represent 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 536 of file CreateCachediSCSIVolumeRequest.h.

◆ GetTargetName()

const Aws::String& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::GetTargetName ( ) const
inline

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Definition at line 175 of file CreateCachediSCSIVolumeRequest.h.

◆ GetVolumeSizeInBytes()

long long Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::GetVolumeSizeInBytes ( ) const
inline

The size of the volume in bytes.

Definition at line 67 of file CreateCachediSCSIVolumeRequest.h.

◆ KMSEncryptedHasBeenSet()

bool Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::KMSEncryptedHasBeenSet ( ) const
inline

Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

Definition at line 446 of file CreateCachediSCSIVolumeRequest.h.

◆ KMSKeyHasBeenSet()

bool Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::KMSKeyHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

Definition at line 477 of file CreateCachediSCSIVolumeRequest.h.

◆ NetworkInterfaceIdHasBeenSet()

bool Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::NetworkInterfaceIdHasBeenSet ( ) const
inline

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

Definition at line 334 of file CreateCachediSCSIVolumeRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientToken() [1/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetClientToken ( Aws::String &&  value)
inline

A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

Definition at line 407 of file CreateCachediSCSIVolumeRequest.h.

◆ SetClientToken() [2/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetClientToken ( const Aws::String value)
inline

A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

Definition at line 401 of file CreateCachediSCSIVolumeRequest.h.

◆ SetClientToken() [3/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetClientToken ( const char *  value)
inline

A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

Definition at line 413 of file CreateCachediSCSIVolumeRequest.h.

◆ SetGatewayARN() [1/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetGatewayARN ( Aws::String &&  value)
inline

Definition at line 49 of file CreateCachediSCSIVolumeRequest.h.

◆ SetGatewayARN() [2/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetGatewayARN ( const Aws::String value)
inline

Definition at line 46 of file CreateCachediSCSIVolumeRequest.h.

◆ SetGatewayARN() [3/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetGatewayARN ( const char *  value)
inline

Definition at line 52 of file CreateCachediSCSIVolumeRequest.h.

◆ SetKMSEncrypted()

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetKMSEncrypted ( bool  value)
inline

Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

Definition at line 453 of file CreateCachediSCSIVolumeRequest.h.

◆ SetKMSKey() [1/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetKMSKey ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

Definition at line 493 of file CreateCachediSCSIVolumeRequest.h.

◆ SetKMSKey() [2/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetKMSKey ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

Definition at line 485 of file CreateCachediSCSIVolumeRequest.h.

◆ SetKMSKey() [3/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetKMSKey ( const char *  value)
inline

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

Definition at line 501 of file CreateCachediSCSIVolumeRequest.h.

◆ SetNetworkInterfaceId() [1/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetNetworkInterfaceId ( Aws::String &&  value)
inline

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

Definition at line 350 of file CreateCachediSCSIVolumeRequest.h.

◆ SetNetworkInterfaceId() [2/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetNetworkInterfaceId ( const Aws::String value)
inline

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

Definition at line 342 of file CreateCachediSCSIVolumeRequest.h.

◆ SetNetworkInterfaceId() [3/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetNetworkInterfaceId ( const char *  value)
inline

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

Definition at line 358 of file CreateCachediSCSIVolumeRequest.h.

◆ SetSnapshotId() [1/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetSnapshotId ( Aws::String &&  value)
inline

The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

Definition at line 123 of file CreateCachediSCSIVolumeRequest.h.

◆ SetSnapshotId() [2/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetSnapshotId ( const Aws::String value)
inline

The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

Definition at line 113 of file CreateCachediSCSIVolumeRequest.h.

◆ SetSnapshotId() [3/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetSnapshotId ( const char *  value)
inline

The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

Definition at line 133 of file CreateCachediSCSIVolumeRequest.h.

◆ SetSourceVolumeARN() [1/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetSourceVolumeARN ( Aws::String &&  value)
inline

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

Definition at line 285 of file CreateCachediSCSIVolumeRequest.h.

◆ SetSourceVolumeARN() [2/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetSourceVolumeARN ( const Aws::String value)
inline

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

Definition at line 277 of file CreateCachediSCSIVolumeRequest.h.

◆ SetSourceVolumeARN() [3/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetSourceVolumeARN ( const char *  value)
inline

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

Definition at line 293 of file CreateCachediSCSIVolumeRequest.h.

◆ SetTags() [1/2]

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

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

Valid characters for key and value are letters, spaces, and numbers that you can represent 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 566 of file CreateCachediSCSIVolumeRequest.h.

◆ SetTags() [2/2]

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

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

Valid characters for key and value are letters, spaces, and numbers that you can represent 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 556 of file CreateCachediSCSIVolumeRequest.h.

◆ SetTargetName() [1/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetTargetName ( Aws::String &&  value)
inline

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Definition at line 208 of file CreateCachediSCSIVolumeRequest.h.

◆ SetTargetName() [2/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetTargetName ( const Aws::String value)
inline

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Definition at line 197 of file CreateCachediSCSIVolumeRequest.h.

◆ SetTargetName() [3/3]

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetTargetName ( const char *  value)
inline

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Definition at line 219 of file CreateCachediSCSIVolumeRequest.h.

◆ SetVolumeSizeInBytes()

void Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SetVolumeSizeInBytes ( long long  value)
inline

The size of the volume in bytes.

Definition at line 77 of file CreateCachediSCSIVolumeRequest.h.

◆ SnapshotIdHasBeenSet()

bool Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SnapshotIdHasBeenSet ( ) const
inline

The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

Definition at line 103 of file CreateCachediSCSIVolumeRequest.h.

◆ SourceVolumeARNHasBeenSet()

bool Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::SourceVolumeARNHasBeenSet ( ) const
inline

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

Definition at line 269 of file CreateCachediSCSIVolumeRequest.h.

◆ TagsHasBeenSet()

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

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

Valid characters for key and value are letters, spaces, and numbers that you can represent 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 546 of file CreateCachediSCSIVolumeRequest.h.

◆ TargetNameHasBeenSet()

bool Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::TargetNameHasBeenSet ( ) const
inline

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Definition at line 186 of file CreateCachediSCSIVolumeRequest.h.

◆ VolumeSizeInBytesHasBeenSet()

bool Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::VolumeSizeInBytesHasBeenSet ( ) const
inline

The size of the volume in bytes.

Definition at line 72 of file CreateCachediSCSIVolumeRequest.h.

◆ WithClientToken() [1/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithClientToken ( Aws::String &&  value)
inline

A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

Definition at line 425 of file CreateCachediSCSIVolumeRequest.h.

◆ WithClientToken() [2/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithClientToken ( const Aws::String value)
inline

A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

Definition at line 419 of file CreateCachediSCSIVolumeRequest.h.

◆ WithClientToken() [3/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithClientToken ( const char *  value)
inline

A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

Definition at line 431 of file CreateCachediSCSIVolumeRequest.h.

◆ WithGatewayARN() [1/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithGatewayARN ( Aws::String &&  value)
inline

Definition at line 58 of file CreateCachediSCSIVolumeRequest.h.

◆ WithGatewayARN() [2/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithGatewayARN ( const Aws::String value)
inline

Definition at line 55 of file CreateCachediSCSIVolumeRequest.h.

◆ WithGatewayARN() [3/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithGatewayARN ( const char *  value)
inline

Definition at line 61 of file CreateCachediSCSIVolumeRequest.h.

◆ WithKMSEncrypted()

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithKMSEncrypted ( bool  value)
inline

Set to true to use Amazon S3 server-side encryption with your own KMS key, or false to use a key managed by Amazon S3. Optional.

Valid Values: true | false

Definition at line 460 of file CreateCachediSCSIVolumeRequest.h.

◆ WithKMSKey() [1/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithKMSKey ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

Definition at line 517 of file CreateCachediSCSIVolumeRequest.h.

◆ WithKMSKey() [2/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithKMSKey ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

Definition at line 509 of file CreateCachediSCSIVolumeRequest.h.

◆ WithKMSKey() [3/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithKMSKey ( const char *  value)
inline

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

Definition at line 525 of file CreateCachediSCSIVolumeRequest.h.

◆ WithNetworkInterfaceId() [1/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithNetworkInterfaceId ( Aws::String &&  value)
inline

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

Definition at line 374 of file CreateCachediSCSIVolumeRequest.h.

◆ WithNetworkInterfaceId() [2/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithNetworkInterfaceId ( const Aws::String value)
inline

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

Definition at line 366 of file CreateCachediSCSIVolumeRequest.h.

◆ WithNetworkInterfaceId() [3/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithNetworkInterfaceId ( const char *  value)
inline

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

Valid Values: A valid IP address.

Definition at line 382 of file CreateCachediSCSIVolumeRequest.h.

◆ WithSnapshotId() [1/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithSnapshotId ( Aws::String &&  value)
inline

The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

Definition at line 153 of file CreateCachediSCSIVolumeRequest.h.

◆ WithSnapshotId() [2/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithSnapshotId ( const Aws::String value)
inline

The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

Definition at line 143 of file CreateCachediSCSIVolumeRequest.h.

◆ WithSnapshotId() [3/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithSnapshotId ( const char *  value)
inline

The snapshot ID (e.g. "snap-1122aabb") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot; otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

Definition at line 163 of file CreateCachediSCSIVolumeRequest.h.

◆ WithSourceVolumeARN() [1/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithSourceVolumeARN ( Aws::String &&  value)
inline

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

Definition at line 309 of file CreateCachediSCSIVolumeRequest.h.

◆ WithSourceVolumeARN() [2/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithSourceVolumeARN ( const Aws::String value)
inline

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

Definition at line 301 of file CreateCachediSCSIVolumeRequest.h.

◆ WithSourceVolumeARN() [3/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithSourceVolumeARN ( const char *  value)
inline

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

Definition at line 317 of file CreateCachediSCSIVolumeRequest.h.

◆ WithTags() [1/2]

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

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

Valid characters for key and value are letters, spaces, and numbers that you can represent 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 586 of file CreateCachediSCSIVolumeRequest.h.

◆ WithTags() [2/2]

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

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

Valid characters for key and value are letters, spaces, and numbers that you can represent 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 576 of file CreateCachediSCSIVolumeRequest.h.

◆ WithTargetName() [1/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithTargetName ( Aws::String &&  value)
inline

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Definition at line 241 of file CreateCachediSCSIVolumeRequest.h.

◆ WithTargetName() [2/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithTargetName ( const Aws::String value)
inline

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Definition at line 230 of file CreateCachediSCSIVolumeRequest.h.

◆ WithTargetName() [3/3]

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithTargetName ( const char *  value)
inline

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Definition at line 252 of file CreateCachediSCSIVolumeRequest.h.

◆ WithVolumeSizeInBytes()

CreateCachediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateCachediSCSIVolumeRequest::WithVolumeSizeInBytes ( long long  value)
inline

The size of the volume in bytes.

Definition at line 82 of file CreateCachediSCSIVolumeRequest.h.


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