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

#include <CreateStorediSCSIVolumeRequest.h>

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

Public Member Functions

 CreateStorediSCSIVolumeRequest ()
 
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)
 
CreateStorediSCSIVolumeRequestWithGatewayARN (const Aws::String &value)
 
CreateStorediSCSIVolumeRequestWithGatewayARN (Aws::String &&value)
 
CreateStorediSCSIVolumeRequestWithGatewayARN (const char *value)
 
const Aws::StringGetDiskId () const
 
bool DiskIdHasBeenSet () const
 
void SetDiskId (const Aws::String &value)
 
void SetDiskId (Aws::String &&value)
 
void SetDiskId (const char *value)
 
CreateStorediSCSIVolumeRequestWithDiskId (const Aws::String &value)
 
CreateStorediSCSIVolumeRequestWithDiskId (Aws::String &&value)
 
CreateStorediSCSIVolumeRequestWithDiskId (const char *value)
 
const Aws::StringGetSnapshotId () const
 
bool SnapshotIdHasBeenSet () const
 
void SetSnapshotId (const Aws::String &value)
 
void SetSnapshotId (Aws::String &&value)
 
void SetSnapshotId (const char *value)
 
CreateStorediSCSIVolumeRequestWithSnapshotId (const Aws::String &value)
 
CreateStorediSCSIVolumeRequestWithSnapshotId (Aws::String &&value)
 
CreateStorediSCSIVolumeRequestWithSnapshotId (const char *value)
 
bool GetPreserveExistingData () const
 
bool PreserveExistingDataHasBeenSet () const
 
void SetPreserveExistingData (bool value)
 
CreateStorediSCSIVolumeRequestWithPreserveExistingData (bool value)
 
const Aws::StringGetTargetName () const
 
bool TargetNameHasBeenSet () const
 
void SetTargetName (const Aws::String &value)
 
void SetTargetName (Aws::String &&value)
 
void SetTargetName (const char *value)
 
CreateStorediSCSIVolumeRequestWithTargetName (const Aws::String &value)
 
CreateStorediSCSIVolumeRequestWithTargetName (Aws::String &&value)
 
CreateStorediSCSIVolumeRequestWithTargetName (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)
 
CreateStorediSCSIVolumeRequestWithNetworkInterfaceId (const Aws::String &value)
 
CreateStorediSCSIVolumeRequestWithNetworkInterfaceId (Aws::String &&value)
 
CreateStorediSCSIVolumeRequestWithNetworkInterfaceId (const char *value)
 
bool GetKMSEncrypted () const
 
bool KMSEncryptedHasBeenSet () const
 
void SetKMSEncrypted (bool value)
 
CreateStorediSCSIVolumeRequestWithKMSEncrypted (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)
 
CreateStorediSCSIVolumeRequestWithKMSKey (const Aws::String &value)
 
CreateStorediSCSIVolumeRequestWithKMSKey (Aws::String &&value)
 
CreateStorediSCSIVolumeRequestWithKMSKey (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)
 
CreateStorediSCSIVolumeRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateStorediSCSIVolumeRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateStorediSCSIVolumeRequestAddTags (const Tag &value)
 
CreateStorediSCSIVolumeRequestAddTags (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 32 of file CreateStorediSCSIVolumeRequest.h.

Constructor & Destructor Documentation

◆ CreateStorediSCSIVolumeRequest()

Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::CreateStorediSCSIVolumeRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

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

A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable 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.

Definition at line 557 of file CreateStorediSCSIVolumeRequest.h.

◆ AddTags() [2/2]

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

A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable 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.

Definition at line 566 of file CreateStorediSCSIVolumeRequest.h.

◆ DiskIdHasBeenSet()

bool Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::DiskIdHasBeenSet ( ) const
inline

The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.

Definition at line 87 of file CreateStorediSCSIVolumeRequest.h.

◆ GatewayARNHasBeenSet()

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

Definition at line 52 of file CreateStorediSCSIVolumeRequest.h.

◆ GetDiskId()

const Aws::String& Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::GetDiskId ( ) const
inline

The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.

Definition at line 79 of file CreateStorediSCSIVolumeRequest.h.

◆ GetGatewayARN()

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

Definition at line 49 of file CreateStorediSCSIVolumeRequest.h.

◆ GetKMSEncrypted()

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

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

Valid Values: true | false

Definition at line 407 of file CreateStorediSCSIVolumeRequest.h.

◆ GetKMSKey()

const Aws::String& Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 437 of file CreateStorediSCSIVolumeRequest.h.

◆ GetNetworkInterfaceId()

const Aws::String& Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 343 of file CreateStorediSCSIVolumeRequest.h.

◆ GetPreserveExistingData()

bool Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::GetPreserveExistingData ( ) const
inline

Set to true if you want to preserve the data on the local disk. Otherwise, set to false to create an empty volume.

Valid Values: true | false

Definition at line 224 of file CreateStorediSCSIVolumeRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 41 of file CreateStorediSCSIVolumeRequest.h.

◆ GetSnapshotId()

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

The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored 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 146 of file CreateStorediSCSIVolumeRequest.h.

◆ GetTags()

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

A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable 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.

Definition at line 503 of file CreateStorediSCSIVolumeRequest.h.

◆ GetTargetName()

const Aws::String& Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 257 of file CreateStorediSCSIVolumeRequest.h.

◆ KMSEncryptedHasBeenSet()

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

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

Valid Values: true | false

Definition at line 414 of file CreateStorediSCSIVolumeRequest.h.

◆ KMSKeyHasBeenSet()

bool Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 445 of file CreateStorediSCSIVolumeRequest.h.

◆ NetworkInterfaceIdHasBeenSet()

bool Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 351 of file CreateStorediSCSIVolumeRequest.h.

◆ PreserveExistingDataHasBeenSet()

bool Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::PreserveExistingDataHasBeenSet ( ) const
inline

Set to true if you want to preserve the data on the local disk. Otherwise, set to false to create an empty volume.

Valid Values: true | false

Definition at line 231 of file CreateStorediSCSIVolumeRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDiskId() [1/3]

void Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::SetDiskId ( Aws::String &&  value)
inline

The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.

Definition at line 103 of file CreateStorediSCSIVolumeRequest.h.

◆ SetDiskId() [2/3]

void Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::SetDiskId ( const Aws::String value)
inline

The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.

Definition at line 95 of file CreateStorediSCSIVolumeRequest.h.

◆ SetDiskId() [3/3]

void Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::SetDiskId ( const char *  value)
inline

The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.

Definition at line 111 of file CreateStorediSCSIVolumeRequest.h.

◆ SetGatewayARN() [1/3]

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

Definition at line 58 of file CreateStorediSCSIVolumeRequest.h.

◆ SetGatewayARN() [2/3]

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

Definition at line 55 of file CreateStorediSCSIVolumeRequest.h.

◆ SetGatewayARN() [3/3]

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

Definition at line 61 of file CreateStorediSCSIVolumeRequest.h.

◆ SetKMSEncrypted()

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

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

Valid Values: true | false

Definition at line 421 of file CreateStorediSCSIVolumeRequest.h.

◆ SetKMSKey() [1/3]

void Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 461 of file CreateStorediSCSIVolumeRequest.h.

◆ SetKMSKey() [2/3]

void Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 453 of file CreateStorediSCSIVolumeRequest.h.

◆ SetKMSKey() [3/3]

void Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 469 of file CreateStorediSCSIVolumeRequest.h.

◆ SetNetworkInterfaceId() [1/3]

void Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 367 of file CreateStorediSCSIVolumeRequest.h.

◆ SetNetworkInterfaceId() [2/3]

void Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 359 of file CreateStorediSCSIVolumeRequest.h.

◆ SetNetworkInterfaceId() [3/3]

void Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 375 of file CreateStorediSCSIVolumeRequest.h.

◆ SetPreserveExistingData()

void Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::SetPreserveExistingData ( bool  value)
inline

Set to true if you want to preserve the data on the local disk. Otherwise, set to false to create an empty volume.

Valid Values: true | false

Definition at line 238 of file CreateStorediSCSIVolumeRequest.h.

◆ SetSnapshotId() [1/3]

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

The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored 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 176 of file CreateStorediSCSIVolumeRequest.h.

◆ SetSnapshotId() [2/3]

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

The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored 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 166 of file CreateStorediSCSIVolumeRequest.h.

◆ SetSnapshotId() [3/3]

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

The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored 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 186 of file CreateStorediSCSIVolumeRequest.h.

◆ SetTags() [1/2]

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

A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable 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.

Definition at line 530 of file CreateStorediSCSIVolumeRequest.h.

◆ SetTags() [2/2]

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

A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable 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.

Definition at line 521 of file CreateStorediSCSIVolumeRequest.h.

◆ SetTargetName() [1/3]

void Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 290 of file CreateStorediSCSIVolumeRequest.h.

◆ SetTargetName() [2/3]

void Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 279 of file CreateStorediSCSIVolumeRequest.h.

◆ SetTargetName() [3/3]

void Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 301 of file CreateStorediSCSIVolumeRequest.h.

◆ SnapshotIdHasBeenSet()

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

The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored 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 156 of file CreateStorediSCSIVolumeRequest.h.

◆ TagsHasBeenSet()

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

A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable 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.

Definition at line 512 of file CreateStorediSCSIVolumeRequest.h.

◆ TargetNameHasBeenSet()

bool Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 268 of file CreateStorediSCSIVolumeRequest.h.

◆ WithDiskId() [1/3]

CreateStorediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::WithDiskId ( Aws::String &&  value)
inline

The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.

Definition at line 127 of file CreateStorediSCSIVolumeRequest.h.

◆ WithDiskId() [2/3]

CreateStorediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::WithDiskId ( const Aws::String value)
inline

The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.

Definition at line 119 of file CreateStorediSCSIVolumeRequest.h.

◆ WithDiskId() [3/3]

CreateStorediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::WithDiskId ( const char *  value)
inline

The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.

Definition at line 135 of file CreateStorediSCSIVolumeRequest.h.

◆ WithGatewayARN() [1/3]

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

Definition at line 67 of file CreateStorediSCSIVolumeRequest.h.

◆ WithGatewayARN() [2/3]

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

Definition at line 64 of file CreateStorediSCSIVolumeRequest.h.

◆ WithGatewayARN() [3/3]

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

Definition at line 70 of file CreateStorediSCSIVolumeRequest.h.

◆ WithKMSEncrypted()

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

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

Valid Values: true | false

Definition at line 428 of file CreateStorediSCSIVolumeRequest.h.

◆ WithKMSKey() [1/3]

CreateStorediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 485 of file CreateStorediSCSIVolumeRequest.h.

◆ WithKMSKey() [2/3]

CreateStorediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 477 of file CreateStorediSCSIVolumeRequest.h.

◆ WithKMSKey() [3/3]

CreateStorediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 493 of file CreateStorediSCSIVolumeRequest.h.

◆ WithNetworkInterfaceId() [1/3]

CreateStorediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 391 of file CreateStorediSCSIVolumeRequest.h.

◆ WithNetworkInterfaceId() [2/3]

CreateStorediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 383 of file CreateStorediSCSIVolumeRequest.h.

◆ WithNetworkInterfaceId() [3/3]

CreateStorediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 399 of file CreateStorediSCSIVolumeRequest.h.

◆ WithPreserveExistingData()

CreateStorediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::WithPreserveExistingData ( bool  value)
inline

Set to true if you want to preserve the data on the local disk. Otherwise, set to false to create an empty volume.

Valid Values: true | false

Definition at line 245 of file CreateStorediSCSIVolumeRequest.h.

◆ WithSnapshotId() [1/3]

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

The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored 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 206 of file CreateStorediSCSIVolumeRequest.h.

◆ WithSnapshotId() [2/3]

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

The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored 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 196 of file CreateStorediSCSIVolumeRequest.h.

◆ WithSnapshotId() [3/3]

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

The snapshot ID (e.g., "snap-1122aabb") of the snapshot to restore as the new stored 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 216 of file CreateStorediSCSIVolumeRequest.h.

◆ WithTags() [1/2]

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

A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable 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.

Definition at line 548 of file CreateStorediSCSIVolumeRequest.h.

◆ WithTags() [2/2]

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

A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable 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.

Definition at line 539 of file CreateStorediSCSIVolumeRequest.h.

◆ WithTargetName() [1/3]

CreateStorediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 323 of file CreateStorediSCSIVolumeRequest.h.

◆ WithTargetName() [2/3]

CreateStorediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 312 of file CreateStorediSCSIVolumeRequest.h.

◆ WithTargetName() [3/3]

CreateStorediSCSIVolumeRequest& Aws::StorageGateway::Model::CreateStorediSCSIVolumeRequest::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 334 of file CreateStorediSCSIVolumeRequest.h.


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