AWS SDK for C++  1.8.51
AWS SDK for C++
Public Member Functions | List of all members
Aws::EBS::Model::StartSnapshotRequest Class Reference

#include <StartSnapshotRequest.h>

+ Inheritance diagram for Aws::EBS::Model::StartSnapshotRequest:

Public Member Functions

 StartSnapshotRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
long long GetVolumeSize () const
 
bool VolumeSizeHasBeenSet () const
 
void SetVolumeSize (long long value)
 
StartSnapshotRequestWithVolumeSize (long long value)
 
const Aws::StringGetParentSnapshotId () const
 
bool ParentSnapshotIdHasBeenSet () const
 
void SetParentSnapshotId (const Aws::String &value)
 
void SetParentSnapshotId (Aws::String &&value)
 
void SetParentSnapshotId (const char *value)
 
StartSnapshotRequestWithParentSnapshotId (const Aws::String &value)
 
StartSnapshotRequestWithParentSnapshotId (Aws::String &&value)
 
StartSnapshotRequestWithParentSnapshotId (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)
 
StartSnapshotRequestWithTags (const Aws::Vector< Tag > &value)
 
StartSnapshotRequestWithTags (Aws::Vector< Tag > &&value)
 
StartSnapshotRequestAddTags (const Tag &value)
 
StartSnapshotRequestAddTags (Tag &&value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
StartSnapshotRequestWithDescription (const Aws::String &value)
 
StartSnapshotRequestWithDescription (Aws::String &&value)
 
StartSnapshotRequestWithDescription (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)
 
StartSnapshotRequestWithClientToken (const Aws::String &value)
 
StartSnapshotRequestWithClientToken (Aws::String &&value)
 
StartSnapshotRequestWithClientToken (const char *value)
 
bool GetEncrypted () const
 
bool EncryptedHasBeenSet () const
 
void SetEncrypted (bool value)
 
StartSnapshotRequestWithEncrypted (bool value)
 
const Aws::StringGetKmsKeyArn () const
 
bool KmsKeyArnHasBeenSet () const
 
void SetKmsKeyArn (const Aws::String &value)
 
void SetKmsKeyArn (Aws::String &&value)
 
void SetKmsKeyArn (const char *value)
 
StartSnapshotRequestWithKmsKeyArn (const Aws::String &value)
 
StartSnapshotRequestWithKmsKeyArn (Aws::String &&value)
 
StartSnapshotRequestWithKmsKeyArn (const char *value)
 
int GetTimeout () const
 
bool TimeoutHasBeenSet () const
 
void SetTimeout (int value)
 
StartSnapshotRequestWithTimeout (int value)
 
- Public Member Functions inherited from Aws::EBS::EBSRequest
virtual ~EBSRequest ()
 
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::EBS::EBSRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file StartSnapshotRequest.h.

Constructor & Destructor Documentation

◆ StartSnapshotRequest()

Aws::EBS::Model::StartSnapshotRequest::StartSnapshotRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

StartSnapshotRequest& Aws::EBS::Model::StartSnapshotRequest::AddTags ( const Tag value)
inline

The tags to apply to the snapshot.

Definition at line 177 of file StartSnapshotRequest.h.

◆ AddTags() [2/2]

StartSnapshotRequest& Aws::EBS::Model::StartSnapshotRequest::AddTags ( Tag &&  value)
inline

The tags to apply to the snapshot.

Definition at line 182 of file StartSnapshotRequest.h.

◆ ClientTokenHasBeenSet()

bool Aws::EBS::Model::StartSnapshotRequest::ClientTokenHasBeenSet ( ) const
inline

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

If you do not specify a client token, one is automatically generated by the AWS SDK.

For more information, see Idempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.

Definition at line 252 of file StartSnapshotRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::EBS::Model::StartSnapshotRequest::DescriptionHasBeenSet ( ) const
inline

A description for the snapshot.

Definition at line 193 of file StartSnapshotRequest.h.

◆ EncryptedHasBeenSet()

bool Aws::EBS::Model::StartSnapshotRequest::EncryptedHasBeenSet ( ) const
inline

Indicates whether to encrypt the snapshot. To create an encrypted snapshot, specify true. To create an unencrypted snapshot, omit this parameter.

If you specify a value for ParentSnapshotId, omit this parameter.

If you specify true, the snapshot is encrypted using the CMK specified using the KmsKeyArn parameter. If no value is specified for KmsKeyArn, the default CMK for your account is used. If no default CMK has been specified for your account, the AWS managed CMK is used. To set a default CMK for your account, use ModifyEbsDefaultKmsKeyId.

If your account is enabled for encryption by default, you cannot set this parameter to false. In this case, you can omit this parameter.

For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.

Definition at line 373 of file StartSnapshotRequest.h.

◆ GetClientToken()

const Aws::String& Aws::EBS::Model::StartSnapshotRequest::GetClientToken ( ) const
inline

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

If you do not specify a client token, one is automatically generated by the AWS SDK.

For more information, see Idempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.

Definition at line 238 of file StartSnapshotRequest.h.

◆ GetDescription()

const Aws::String& Aws::EBS::Model::StartSnapshotRequest::GetDescription ( ) const
inline

A description for the snapshot.

Definition at line 188 of file StartSnapshotRequest.h.

◆ GetEncrypted()

bool Aws::EBS::Model::StartSnapshotRequest::GetEncrypted ( ) const
inline

Indicates whether to encrypt the snapshot. To create an encrypted snapshot, specify true. To create an unencrypted snapshot, omit this parameter.

If you specify a value for ParentSnapshotId, omit this parameter.

If you specify true, the snapshot is encrypted using the CMK specified using the KmsKeyArn parameter. If no value is specified for KmsKeyArn, the default CMK for your account is used. If no default CMK has been specified for your account, the AWS managed CMK is used. To set a default CMK for your account, use ModifyEbsDefaultKmsKeyId.

If your account is enabled for encryption by default, you cannot set this parameter to false. In this case, you can omit this parameter.

For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.

Definition at line 355 of file StartSnapshotRequest.h.

◆ GetKmsKeyArn()

const Aws::String& Aws::EBS::Model::StartSnapshotRequest::GetKmsKeyArn ( ) const
inline

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to be used to encrypt the snapshot. If you do not specify a CMK, the default AWS managed CMK is used.

If you specify a ParentSnapshotId, omit this parameter; the snapshot will be encrypted using the same CMK that was used to encrypt the parent snapshot.

If Encrypted is set to true, you must specify a CMK ARN.

Definition at line 420 of file StartSnapshotRequest.h.

◆ GetParentSnapshotId()

const Aws::String& Aws::EBS::Model::StartSnapshotRequest::GetParentSnapshotId ( ) const
inline

The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.

If your account is enabled for encryption by default, you cannot use an unencrypted snapshot as a parent snapshot. You must first create an encrypted copy of the parent snapshot using CopySnapshot.

Definition at line 71 of file StartSnapshotRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::EBS::Model::StartSnapshotRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file StartSnapshotRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::EBS::Model::StartSnapshotRequest::GetTags ( ) const
inline

The tags to apply to the snapshot.

Definition at line 147 of file StartSnapshotRequest.h.

◆ GetTimeout()

int Aws::EBS::Model::StartSnapshotRequest::GetTimeout ( ) const
inline

The amount of time (in minutes) after which the snapshot is automatically cancelled if:

  • No blocks are written to the snapshot.

  • The snapshot is not completed after writing the last block of data.

If no value is specified, the timeout defaults to 60 minutes.

Definition at line 500 of file StartSnapshotRequest.h.

◆ GetVolumeSize()

long long Aws::EBS::Model::StartSnapshotRequest::GetVolumeSize ( ) const
inline

The size of the volume, in GiB. The maximum size is 16384 GiB (16 TiB).

Definition at line 42 of file StartSnapshotRequest.h.

◆ KmsKeyArnHasBeenSet()

bool Aws::EBS::Model::StartSnapshotRequest::KmsKeyArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to be used to encrypt the snapshot. If you do not specify a CMK, the default AWS managed CMK is used.

If you specify a ParentSnapshotId, omit this parameter; the snapshot will be encrypted using the same CMK that was used to encrypt the parent snapshot.

If Encrypted is set to true, you must specify a CMK ARN.

Definition at line 430 of file StartSnapshotRequest.h.

◆ ParentSnapshotIdHasBeenSet()

bool Aws::EBS::Model::StartSnapshotRequest::ParentSnapshotIdHasBeenSet ( ) const
inline

The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.

If your account is enabled for encryption by default, you cannot use an unencrypted snapshot as a parent snapshot. You must first create an encrypted copy of the parent snapshot using CopySnapshot.

Definition at line 81 of file StartSnapshotRequest.h.

◆ SerializePayload()

Aws::String Aws::EBS::Model::StartSnapshotRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientToken() [1/3]

void Aws::EBS::Model::StartSnapshotRequest::SetClientToken ( const Aws::String value)
inline

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

If you do not specify a client token, one is automatically generated by the AWS SDK.

For more information, see Idempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.

Definition at line 266 of file StartSnapshotRequest.h.

◆ SetClientToken() [2/3]

void Aws::EBS::Model::StartSnapshotRequest::SetClientToken ( Aws::String &&  value)
inline

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

If you do not specify a client token, one is automatically generated by the AWS SDK.

For more information, see Idempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.

Definition at line 280 of file StartSnapshotRequest.h.

◆ SetClientToken() [3/3]

void Aws::EBS::Model::StartSnapshotRequest::SetClientToken ( const char *  value)
inline

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

If you do not specify a client token, one is automatically generated by the AWS SDK.

For more information, see Idempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.

Definition at line 294 of file StartSnapshotRequest.h.

◆ SetDescription() [1/3]

void Aws::EBS::Model::StartSnapshotRequest::SetDescription ( const Aws::String value)
inline

A description for the snapshot.

Definition at line 198 of file StartSnapshotRequest.h.

◆ SetDescription() [2/3]

void Aws::EBS::Model::StartSnapshotRequest::SetDescription ( Aws::String &&  value)
inline

A description for the snapshot.

Definition at line 203 of file StartSnapshotRequest.h.

◆ SetDescription() [3/3]

void Aws::EBS::Model::StartSnapshotRequest::SetDescription ( const char *  value)
inline

A description for the snapshot.

Definition at line 208 of file StartSnapshotRequest.h.

◆ SetEncrypted()

void Aws::EBS::Model::StartSnapshotRequest::SetEncrypted ( bool  value)
inline

Indicates whether to encrypt the snapshot. To create an encrypted snapshot, specify true. To create an unencrypted snapshot, omit this parameter.

If you specify a value for ParentSnapshotId, omit this parameter.

If you specify true, the snapshot is encrypted using the CMK specified using the KmsKeyArn parameter. If no value is specified for KmsKeyArn, the default CMK for your account is used. If no default CMK has been specified for your account, the AWS managed CMK is used. To set a default CMK for your account, use ModifyEbsDefaultKmsKeyId.

If your account is enabled for encryption by default, you cannot set this parameter to false. In this case, you can omit this parameter.

For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.

Definition at line 391 of file StartSnapshotRequest.h.

◆ SetKmsKeyArn() [1/3]

void Aws::EBS::Model::StartSnapshotRequest::SetKmsKeyArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to be used to encrypt the snapshot. If you do not specify a CMK, the default AWS managed CMK is used.

If you specify a ParentSnapshotId, omit this parameter; the snapshot will be encrypted using the same CMK that was used to encrypt the parent snapshot.

If Encrypted is set to true, you must specify a CMK ARN.

Definition at line 440 of file StartSnapshotRequest.h.

◆ SetKmsKeyArn() [2/3]

void Aws::EBS::Model::StartSnapshotRequest::SetKmsKeyArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to be used to encrypt the snapshot. If you do not specify a CMK, the default AWS managed CMK is used.

If you specify a ParentSnapshotId, omit this parameter; the snapshot will be encrypted using the same CMK that was used to encrypt the parent snapshot.

If Encrypted is set to true, you must specify a CMK ARN.

Definition at line 450 of file StartSnapshotRequest.h.

◆ SetKmsKeyArn() [3/3]

void Aws::EBS::Model::StartSnapshotRequest::SetKmsKeyArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to be used to encrypt the snapshot. If you do not specify a CMK, the default AWS managed CMK is used.

If you specify a ParentSnapshotId, omit this parameter; the snapshot will be encrypted using the same CMK that was used to encrypt the parent snapshot.

If Encrypted is set to true, you must specify a CMK ARN.

Definition at line 460 of file StartSnapshotRequest.h.

◆ SetParentSnapshotId() [1/3]

void Aws::EBS::Model::StartSnapshotRequest::SetParentSnapshotId ( const Aws::String value)
inline

The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.

If your account is enabled for encryption by default, you cannot use an unencrypted snapshot as a parent snapshot. You must first create an encrypted copy of the parent snapshot using CopySnapshot.

Definition at line 91 of file StartSnapshotRequest.h.

◆ SetParentSnapshotId() [2/3]

void Aws::EBS::Model::StartSnapshotRequest::SetParentSnapshotId ( Aws::String &&  value)
inline

The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.

If your account is enabled for encryption by default, you cannot use an unencrypted snapshot as a parent snapshot. You must first create an encrypted copy of the parent snapshot using CopySnapshot.

Definition at line 101 of file StartSnapshotRequest.h.

◆ SetParentSnapshotId() [3/3]

void Aws::EBS::Model::StartSnapshotRequest::SetParentSnapshotId ( const char *  value)
inline

The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.

If your account is enabled for encryption by default, you cannot use an unencrypted snapshot as a parent snapshot. You must first create an encrypted copy of the parent snapshot using CopySnapshot.

Definition at line 111 of file StartSnapshotRequest.h.

◆ SetTags() [1/2]

void Aws::EBS::Model::StartSnapshotRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

The tags to apply to the snapshot.

Definition at line 157 of file StartSnapshotRequest.h.

◆ SetTags() [2/2]

void Aws::EBS::Model::StartSnapshotRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

The tags to apply to the snapshot.

Definition at line 162 of file StartSnapshotRequest.h.

◆ SetTimeout()

void Aws::EBS::Model::StartSnapshotRequest::SetTimeout ( int  value)
inline

The amount of time (in minutes) after which the snapshot is automatically cancelled if:

  • No blocks are written to the snapshot.

  • The snapshot is not completed after writing the last block of data.

If no value is specified, the timeout defaults to 60 minutes.

Definition at line 518 of file StartSnapshotRequest.h.

◆ SetVolumeSize()

void Aws::EBS::Model::StartSnapshotRequest::SetVolumeSize ( long long  value)
inline

The size of the volume, in GiB. The maximum size is 16384 GiB (16 TiB).

Definition at line 54 of file StartSnapshotRequest.h.

◆ TagsHasBeenSet()

bool Aws::EBS::Model::StartSnapshotRequest::TagsHasBeenSet ( ) const
inline

The tags to apply to the snapshot.

Definition at line 152 of file StartSnapshotRequest.h.

◆ TimeoutHasBeenSet()

bool Aws::EBS::Model::StartSnapshotRequest::TimeoutHasBeenSet ( ) const
inline

The amount of time (in minutes) after which the snapshot is automatically cancelled if:

  • No blocks are written to the snapshot.

  • The snapshot is not completed after writing the last block of data.

If no value is specified, the timeout defaults to 60 minutes.

Definition at line 509 of file StartSnapshotRequest.h.

◆ VolumeSizeHasBeenSet()

bool Aws::EBS::Model::StartSnapshotRequest::VolumeSizeHasBeenSet ( ) const
inline

The size of the volume, in GiB. The maximum size is 16384 GiB (16 TiB).

Definition at line 48 of file StartSnapshotRequest.h.

◆ WithClientToken() [1/3]

StartSnapshotRequest& Aws::EBS::Model::StartSnapshotRequest::WithClientToken ( const Aws::String value)
inline

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

If you do not specify a client token, one is automatically generated by the AWS SDK.

For more information, see Idempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.

Definition at line 308 of file StartSnapshotRequest.h.

◆ WithClientToken() [2/3]

StartSnapshotRequest& Aws::EBS::Model::StartSnapshotRequest::WithClientToken ( Aws::String &&  value)
inline

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

If you do not specify a client token, one is automatically generated by the AWS SDK.

For more information, see Idempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.

Definition at line 322 of file StartSnapshotRequest.h.

◆ WithClientToken() [3/3]

StartSnapshotRequest& Aws::EBS::Model::StartSnapshotRequest::WithClientToken ( const char *  value)
inline

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

If you do not specify a client token, one is automatically generated by the AWS SDK.

For more information, see Idempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.

Definition at line 336 of file StartSnapshotRequest.h.

◆ WithDescription() [1/3]

StartSnapshotRequest& Aws::EBS::Model::StartSnapshotRequest::WithDescription ( const Aws::String value)
inline

A description for the snapshot.

Definition at line 213 of file StartSnapshotRequest.h.

◆ WithDescription() [2/3]

StartSnapshotRequest& Aws::EBS::Model::StartSnapshotRequest::WithDescription ( Aws::String &&  value)
inline

A description for the snapshot.

Definition at line 218 of file StartSnapshotRequest.h.

◆ WithDescription() [3/3]

StartSnapshotRequest& Aws::EBS::Model::StartSnapshotRequest::WithDescription ( const char *  value)
inline

A description for the snapshot.

Definition at line 223 of file StartSnapshotRequest.h.

◆ WithEncrypted()

StartSnapshotRequest& Aws::EBS::Model::StartSnapshotRequest::WithEncrypted ( bool  value)
inline

Indicates whether to encrypt the snapshot. To create an encrypted snapshot, specify true. To create an unencrypted snapshot, omit this parameter.

If you specify a value for ParentSnapshotId, omit this parameter.

If you specify true, the snapshot is encrypted using the CMK specified using the KmsKeyArn parameter. If no value is specified for KmsKeyArn, the default CMK for your account is used. If no default CMK has been specified for your account, the AWS managed CMK is used. To set a default CMK for your account, use ModifyEbsDefaultKmsKeyId.

If your account is enabled for encryption by default, you cannot set this parameter to false. In this case, you can omit this parameter.

For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.

Definition at line 409 of file StartSnapshotRequest.h.

◆ WithKmsKeyArn() [1/3]

StartSnapshotRequest& Aws::EBS::Model::StartSnapshotRequest::WithKmsKeyArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to be used to encrypt the snapshot. If you do not specify a CMK, the default AWS managed CMK is used.

If you specify a ParentSnapshotId, omit this parameter; the snapshot will be encrypted using the same CMK that was used to encrypt the parent snapshot.

If Encrypted is set to true, you must specify a CMK ARN.

Definition at line 470 of file StartSnapshotRequest.h.

◆ WithKmsKeyArn() [2/3]

StartSnapshotRequest& Aws::EBS::Model::StartSnapshotRequest::WithKmsKeyArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to be used to encrypt the snapshot. If you do not specify a CMK, the default AWS managed CMK is used.

If you specify a ParentSnapshotId, omit this parameter; the snapshot will be encrypted using the same CMK that was used to encrypt the parent snapshot.

If Encrypted is set to true, you must specify a CMK ARN.

Definition at line 480 of file StartSnapshotRequest.h.

◆ WithKmsKeyArn() [3/3]

StartSnapshotRequest& Aws::EBS::Model::StartSnapshotRequest::WithKmsKeyArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to be used to encrypt the snapshot. If you do not specify a CMK, the default AWS managed CMK is used.

If you specify a ParentSnapshotId, omit this parameter; the snapshot will be encrypted using the same CMK that was used to encrypt the parent snapshot.

If Encrypted is set to true, you must specify a CMK ARN.

Definition at line 490 of file StartSnapshotRequest.h.

◆ WithParentSnapshotId() [1/3]

StartSnapshotRequest& Aws::EBS::Model::StartSnapshotRequest::WithParentSnapshotId ( const Aws::String value)
inline

The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.

If your account is enabled for encryption by default, you cannot use an unencrypted snapshot as a parent snapshot. You must first create an encrypted copy of the parent snapshot using CopySnapshot.

Definition at line 121 of file StartSnapshotRequest.h.

◆ WithParentSnapshotId() [2/3]

StartSnapshotRequest& Aws::EBS::Model::StartSnapshotRequest::WithParentSnapshotId ( Aws::String &&  value)
inline

The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.

If your account is enabled for encryption by default, you cannot use an unencrypted snapshot as a parent snapshot. You must first create an encrypted copy of the parent snapshot using CopySnapshot.

Definition at line 131 of file StartSnapshotRequest.h.

◆ WithParentSnapshotId() [3/3]

StartSnapshotRequest& Aws::EBS::Model::StartSnapshotRequest::WithParentSnapshotId ( const char *  value)
inline

The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.

If your account is enabled for encryption by default, you cannot use an unencrypted snapshot as a parent snapshot. You must first create an encrypted copy of the parent snapshot using CopySnapshot.

Definition at line 141 of file StartSnapshotRequest.h.

◆ WithTags() [1/2]

StartSnapshotRequest& Aws::EBS::Model::StartSnapshotRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

The tags to apply to the snapshot.

Definition at line 167 of file StartSnapshotRequest.h.

◆ WithTags() [2/2]

StartSnapshotRequest& Aws::EBS::Model::StartSnapshotRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

The tags to apply to the snapshot.

Definition at line 172 of file StartSnapshotRequest.h.

◆ WithTimeout()

StartSnapshotRequest& Aws::EBS::Model::StartSnapshotRequest::WithTimeout ( int  value)
inline

The amount of time (in minutes) after which the snapshot is automatically cancelled if:

  • No blocks are written to the snapshot.

  • The snapshot is not completed after writing the last block of data.

If no value is specified, the timeout defaults to 60 minutes.

Definition at line 527 of file StartSnapshotRequest.h.

◆ WithVolumeSize()

StartSnapshotRequest& Aws::EBS::Model::StartSnapshotRequest::WithVolumeSize ( long long  value)
inline

The size of the volume, in GiB. The maximum size is 16384 GiB (16 TiB).

Definition at line 60 of file StartSnapshotRequest.h.


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