AWS SDK for C++  1.7.228
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::EC2::Model::CopySnapshotRequest Class Reference

#include <CopySnapshotRequest.h>

+ Inheritance diagram for Aws::EC2::Model::CopySnapshotRequest:

Public Member Functions

 CopySnapshotRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CopySnapshotRequestWithDescription (const Aws::String &value)
 
CopySnapshotRequestWithDescription (Aws::String &&value)
 
CopySnapshotRequestWithDescription (const char *value)
 
const Aws::StringGetDestinationRegion () const
 
bool DestinationRegionHasBeenSet () const
 
void SetDestinationRegion (const Aws::String &value)
 
void SetDestinationRegion (Aws::String &&value)
 
void SetDestinationRegion (const char *value)
 
CopySnapshotRequestWithDestinationRegion (const Aws::String &value)
 
CopySnapshotRequestWithDestinationRegion (Aws::String &&value)
 
CopySnapshotRequestWithDestinationRegion (const char *value)
 
bool GetEncrypted () const
 
bool EncryptedHasBeenSet () const
 
void SetEncrypted (bool value)
 
CopySnapshotRequestWithEncrypted (bool value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
CopySnapshotRequestWithKmsKeyId (const Aws::String &value)
 
CopySnapshotRequestWithKmsKeyId (Aws::String &&value)
 
CopySnapshotRequestWithKmsKeyId (const char *value)
 
const Aws::StringGetPresignedUrl () const
 
bool PresignedUrlHasBeenSet () const
 
void SetPresignedUrl (const Aws::String &value)
 
void SetPresignedUrl (Aws::String &&value)
 
void SetPresignedUrl (const char *value)
 
CopySnapshotRequestWithPresignedUrl (const Aws::String &value)
 
CopySnapshotRequestWithPresignedUrl (Aws::String &&value)
 
CopySnapshotRequestWithPresignedUrl (const char *value)
 
const Aws::StringGetSourceRegion () const
 
bool SourceRegionHasBeenSet () const
 
void SetSourceRegion (const Aws::String &value)
 
void SetSourceRegion (Aws::String &&value)
 
void SetSourceRegion (const char *value)
 
CopySnapshotRequestWithSourceRegion (const Aws::String &value)
 
CopySnapshotRequestWithSourceRegion (Aws::String &&value)
 
CopySnapshotRequestWithSourceRegion (const char *value)
 
const Aws::StringGetSourceSnapshotId () const
 
bool SourceSnapshotIdHasBeenSet () const
 
void SetSourceSnapshotId (const Aws::String &value)
 
void SetSourceSnapshotId (Aws::String &&value)
 
void SetSourceSnapshotId (const char *value)
 
CopySnapshotRequestWithSourceSnapshotId (const Aws::String &value)
 
CopySnapshotRequestWithSourceSnapshotId (Aws::String &&value)
 
CopySnapshotRequestWithSourceSnapshotId (const char *value)
 
const Aws::Vector< TagSpecification > & GetTagSpecifications () const
 
bool TagSpecificationsHasBeenSet () const
 
void SetTagSpecifications (const Aws::Vector< TagSpecification > &value)
 
void SetTagSpecifications (Aws::Vector< TagSpecification > &&value)
 
CopySnapshotRequestWithTagSpecifications (const Aws::Vector< TagSpecification > &value)
 
CopySnapshotRequestWithTagSpecifications (Aws::Vector< TagSpecification > &&value)
 
CopySnapshotRequestAddTagSpecifications (const TagSpecification &value)
 
CopySnapshotRequestAddTagSpecifications (TagSpecification &&value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
CopySnapshotRequestWithDryRun (bool value)
 
- Public Member Functions inherited from Aws::EC2::EC2Request
virtual ~EC2Request ()
 
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
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::EC2::EC2Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Contains the parameters for CopySnapshot.

See Also:

AWS API Reference

Definition at line 36 of file CopySnapshotRequest.h.

Constructor & Destructor Documentation

◆ CopySnapshotRequest()

Aws::EC2::Model::CopySnapshotRequest::CopySnapshotRequest ( )

Member Function Documentation

◆ AddTagSpecifications() [1/2]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::AddTagSpecifications ( const TagSpecification value)
inline

Definition at line 636 of file CopySnapshotRequest.h.

◆ AddTagSpecifications() [2/2]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::AddTagSpecifications ( TagSpecification &&  value)
inline

Definition at line 639 of file CopySnapshotRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::EC2::Model::CopySnapshotRequest::DescriptionHasBeenSet ( ) const
inline

A description for the EBS snapshot.

Definition at line 62 of file CopySnapshotRequest.h.

◆ DestinationRegionHasBeenSet()

bool Aws::EC2::Model::CopySnapshotRequest::DestinationRegionHasBeenSet ( ) const
inline

The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.

The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the AWS CLI, this is specified using the –region parameter or the default Region in your AWS configuration file.

Definition at line 117 of file CopySnapshotRequest.h.

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::CopySnapshotRequest::DryRunHasBeenSet ( ) const
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 656 of file CopySnapshotRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::CopySnapshotRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ EncryptedHasBeenSet()

bool Aws::EC2::Model::CopySnapshotRequest::EncryptedHasBeenSet ( ) const
inline

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Definition at line 212 of file CopySnapshotRequest.h.

◆ GetDescription()

const Aws::String& Aws::EC2::Model::CopySnapshotRequest::GetDescription ( ) const
inline

A description for the EBS snapshot.

Definition at line 57 of file CopySnapshotRequest.h.

◆ GetDestinationRegion()

const Aws::String& Aws::EC2::Model::CopySnapshotRequest::GetDestinationRegion ( ) const
inline

The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.

The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the AWS CLI, this is specified using the –region parameter or the default Region in your AWS configuration file.

Definition at line 105 of file CopySnapshotRequest.h.

◆ GetDryRun()

bool Aws::EC2::Model::CopySnapshotRequest::GetDryRun ( ) const
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 648 of file CopySnapshotRequest.h.

◆ GetEncrypted()

bool Aws::EC2::Model::CopySnapshotRequest::GetEncrypted ( ) const
inline

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Definition at line 201 of file CopySnapshotRequest.h.

◆ GetKmsKeyId()

const Aws::String& Aws::EC2::Model::CopySnapshotRequest::GetKmsKeyId ( ) const
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 252 of file CopySnapshotRequest.h.

◆ GetPresignedUrl()

const Aws::String& Aws::EC2::Model::CopySnapshotRequest::GetPresignedUrl ( ) const
inline

When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query Requests.

The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

Definition at line 392 of file CopySnapshotRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::EC2::Model::CopySnapshotRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 45 of file CopySnapshotRequest.h.

◆ GetSourceRegion()

const Aws::String& Aws::EC2::Model::CopySnapshotRequest::GetSourceRegion ( ) const
inline

The ID of the Region that contains the snapshot to be copied.

Definition at line 538 of file CopySnapshotRequest.h.

◆ GetSourceSnapshotId()

const Aws::String& Aws::EC2::Model::CopySnapshotRequest::GetSourceSnapshotId ( ) const
inline

The ID of the EBS snapshot to copy.

Definition at line 579 of file CopySnapshotRequest.h.

◆ GetTagSpecifications()

const Aws::Vector<TagSpecification>& Aws::EC2::Model::CopySnapshotRequest::GetTagSpecifications ( ) const
inline

Definition at line 618 of file CopySnapshotRequest.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::EC2::Model::CopySnapshotRequest::KmsKeyIdHasBeenSet ( ) const
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 269 of file CopySnapshotRequest.h.

◆ PresignedUrlHasBeenSet()

bool Aws::EC2::Model::CopySnapshotRequest::PresignedUrlHasBeenSet ( ) const
inline

When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query Requests.

The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

Definition at line 412 of file CopySnapshotRequest.h.

◆ SerializePayload()

Aws::String Aws::EC2::Model::CopySnapshotRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDescription() [1/3]

void Aws::EC2::Model::CopySnapshotRequest::SetDescription ( const Aws::String value)
inline

A description for the EBS snapshot.

Definition at line 67 of file CopySnapshotRequest.h.

◆ SetDescription() [2/3]

void Aws::EC2::Model::CopySnapshotRequest::SetDescription ( Aws::String &&  value)
inline

A description for the EBS snapshot.

Definition at line 72 of file CopySnapshotRequest.h.

◆ SetDescription() [3/3]

void Aws::EC2::Model::CopySnapshotRequest::SetDescription ( const char *  value)
inline

A description for the EBS snapshot.

Definition at line 77 of file CopySnapshotRequest.h.

◆ SetDestinationRegion() [1/3]

void Aws::EC2::Model::CopySnapshotRequest::SetDestinationRegion ( const Aws::String value)
inline

The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.

The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the AWS CLI, this is specified using the –region parameter or the default Region in your AWS configuration file.

Definition at line 129 of file CopySnapshotRequest.h.

◆ SetDestinationRegion() [2/3]

void Aws::EC2::Model::CopySnapshotRequest::SetDestinationRegion ( Aws::String &&  value)
inline

The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.

The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the AWS CLI, this is specified using the –region parameter or the default Region in your AWS configuration file.

Definition at line 141 of file CopySnapshotRequest.h.

◆ SetDestinationRegion() [3/3]

void Aws::EC2::Model::CopySnapshotRequest::SetDestinationRegion ( const char *  value)
inline

The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.

The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the AWS CLI, this is specified using the –region parameter or the default Region in your AWS configuration file.

Definition at line 153 of file CopySnapshotRequest.h.

◆ SetDryRun()

void Aws::EC2::Model::CopySnapshotRequest::SetDryRun ( bool  value)
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 664 of file CopySnapshotRequest.h.

◆ SetEncrypted()

void Aws::EC2::Model::CopySnapshotRequest::SetEncrypted ( bool  value)
inline

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Definition at line 223 of file CopySnapshotRequest.h.

◆ SetKmsKeyId() [1/3]

void Aws::EC2::Model::CopySnapshotRequest::SetKmsKeyId ( const Aws::String value)
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 286 of file CopySnapshotRequest.h.

◆ SetKmsKeyId() [2/3]

void Aws::EC2::Model::CopySnapshotRequest::SetKmsKeyId ( Aws::String &&  value)
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 303 of file CopySnapshotRequest.h.

◆ SetKmsKeyId() [3/3]

void Aws::EC2::Model::CopySnapshotRequest::SetKmsKeyId ( const char *  value)
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 320 of file CopySnapshotRequest.h.

◆ SetPresignedUrl() [1/3]

void Aws::EC2::Model::CopySnapshotRequest::SetPresignedUrl ( const Aws::String value)
inline

When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query Requests.

The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

Definition at line 432 of file CopySnapshotRequest.h.

◆ SetPresignedUrl() [2/3]

void Aws::EC2::Model::CopySnapshotRequest::SetPresignedUrl ( Aws::String &&  value)
inline

When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query Requests.

The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

Definition at line 452 of file CopySnapshotRequest.h.

◆ SetPresignedUrl() [3/3]

void Aws::EC2::Model::CopySnapshotRequest::SetPresignedUrl ( const char *  value)
inline

When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query Requests.

The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

Definition at line 472 of file CopySnapshotRequest.h.

◆ SetSourceRegion() [1/3]

void Aws::EC2::Model::CopySnapshotRequest::SetSourceRegion ( const Aws::String value)
inline

The ID of the Region that contains the snapshot to be copied.

Definition at line 548 of file CopySnapshotRequest.h.

◆ SetSourceRegion() [2/3]

void Aws::EC2::Model::CopySnapshotRequest::SetSourceRegion ( Aws::String &&  value)
inline

The ID of the Region that contains the snapshot to be copied.

Definition at line 553 of file CopySnapshotRequest.h.

◆ SetSourceRegion() [3/3]

void Aws::EC2::Model::CopySnapshotRequest::SetSourceRegion ( const char *  value)
inline

The ID of the Region that contains the snapshot to be copied.

Definition at line 558 of file CopySnapshotRequest.h.

◆ SetSourceSnapshotId() [1/3]

void Aws::EC2::Model::CopySnapshotRequest::SetSourceSnapshotId ( const Aws::String value)
inline

The ID of the EBS snapshot to copy.

Definition at line 589 of file CopySnapshotRequest.h.

◆ SetSourceSnapshotId() [2/3]

void Aws::EC2::Model::CopySnapshotRequest::SetSourceSnapshotId ( Aws::String &&  value)
inline

The ID of the EBS snapshot to copy.

Definition at line 594 of file CopySnapshotRequest.h.

◆ SetSourceSnapshotId() [3/3]

void Aws::EC2::Model::CopySnapshotRequest::SetSourceSnapshotId ( const char *  value)
inline

The ID of the EBS snapshot to copy.

Definition at line 599 of file CopySnapshotRequest.h.

◆ SetTagSpecifications() [1/2]

void Aws::EC2::Model::CopySnapshotRequest::SetTagSpecifications ( const Aws::Vector< TagSpecification > &  value)
inline

Definition at line 624 of file CopySnapshotRequest.h.

◆ SetTagSpecifications() [2/2]

void Aws::EC2::Model::CopySnapshotRequest::SetTagSpecifications ( Aws::Vector< TagSpecification > &&  value)
inline

Definition at line 627 of file CopySnapshotRequest.h.

◆ SourceRegionHasBeenSet()

bool Aws::EC2::Model::CopySnapshotRequest::SourceRegionHasBeenSet ( ) const
inline

The ID of the Region that contains the snapshot to be copied.

Definition at line 543 of file CopySnapshotRequest.h.

◆ SourceSnapshotIdHasBeenSet()

bool Aws::EC2::Model::CopySnapshotRequest::SourceSnapshotIdHasBeenSet ( ) const
inline

The ID of the EBS snapshot to copy.

Definition at line 584 of file CopySnapshotRequest.h.

◆ TagSpecificationsHasBeenSet()

bool Aws::EC2::Model::CopySnapshotRequest::TagSpecificationsHasBeenSet ( ) const
inline

Definition at line 621 of file CopySnapshotRequest.h.

◆ WithDescription() [1/3]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithDescription ( const Aws::String value)
inline

A description for the EBS snapshot.

Definition at line 82 of file CopySnapshotRequest.h.

◆ WithDescription() [2/3]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithDescription ( Aws::String &&  value)
inline

A description for the EBS snapshot.

Definition at line 87 of file CopySnapshotRequest.h.

◆ WithDescription() [3/3]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithDescription ( const char *  value)
inline

A description for the EBS snapshot.

Definition at line 92 of file CopySnapshotRequest.h.

◆ WithDestinationRegion() [1/3]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithDestinationRegion ( const Aws::String value)
inline

The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.

The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the AWS CLI, this is specified using the –region parameter or the default Region in your AWS configuration file.

Definition at line 165 of file CopySnapshotRequest.h.

◆ WithDestinationRegion() [2/3]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithDestinationRegion ( Aws::String &&  value)
inline

The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.

The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the AWS CLI, this is specified using the –region parameter or the default Region in your AWS configuration file.

Definition at line 177 of file CopySnapshotRequest.h.

◆ WithDestinationRegion() [3/3]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithDestinationRegion ( const char *  value)
inline

The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.

The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the AWS CLI, this is specified using the –region parameter or the default Region in your AWS configuration file.

Definition at line 189 of file CopySnapshotRequest.h.

◆ WithDryRun()

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithDryRun ( bool  value)
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 672 of file CopySnapshotRequest.h.

◆ WithEncrypted()

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithEncrypted ( bool  value)
inline

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Definition at line 234 of file CopySnapshotRequest.h.

◆ WithKmsKeyId() [1/3]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithKmsKeyId ( const Aws::String value)
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 337 of file CopySnapshotRequest.h.

◆ WithKmsKeyId() [2/3]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithKmsKeyId ( Aws::String &&  value)
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 354 of file CopySnapshotRequest.h.

◆ WithKmsKeyId() [3/3]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithKmsKeyId ( const char *  value)
inline

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

Definition at line 371 of file CopySnapshotRequest.h.

◆ WithPresignedUrl() [1/3]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithPresignedUrl ( const Aws::String value)
inline

When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query Requests.

The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

Definition at line 492 of file CopySnapshotRequest.h.

◆ WithPresignedUrl() [2/3]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithPresignedUrl ( Aws::String &&  value)
inline

When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query Requests.

The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

Definition at line 512 of file CopySnapshotRequest.h.

◆ WithPresignedUrl() [3/3]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithPresignedUrl ( const char *  value)
inline

When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query Requests.

The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

Definition at line 532 of file CopySnapshotRequest.h.

◆ WithSourceRegion() [1/3]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithSourceRegion ( const Aws::String value)
inline

The ID of the Region that contains the snapshot to be copied.

Definition at line 563 of file CopySnapshotRequest.h.

◆ WithSourceRegion() [2/3]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithSourceRegion ( Aws::String &&  value)
inline

The ID of the Region that contains the snapshot to be copied.

Definition at line 568 of file CopySnapshotRequest.h.

◆ WithSourceRegion() [3/3]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithSourceRegion ( const char *  value)
inline

The ID of the Region that contains the snapshot to be copied.

Definition at line 573 of file CopySnapshotRequest.h.

◆ WithSourceSnapshotId() [1/3]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithSourceSnapshotId ( const Aws::String value)
inline

The ID of the EBS snapshot to copy.

Definition at line 604 of file CopySnapshotRequest.h.

◆ WithSourceSnapshotId() [2/3]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithSourceSnapshotId ( Aws::String &&  value)
inline

The ID of the EBS snapshot to copy.

Definition at line 609 of file CopySnapshotRequest.h.

◆ WithSourceSnapshotId() [3/3]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithSourceSnapshotId ( const char *  value)
inline

The ID of the EBS snapshot to copy.

Definition at line 614 of file CopySnapshotRequest.h.

◆ WithTagSpecifications() [1/2]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithTagSpecifications ( const Aws::Vector< TagSpecification > &  value)
inline

Definition at line 630 of file CopySnapshotRequest.h.

◆ WithTagSpecifications() [2/2]

CopySnapshotRequest& Aws::EC2::Model::CopySnapshotRequest::WithTagSpecifications ( Aws::Vector< TagSpecification > &&  value)
inline

Definition at line 633 of file CopySnapshotRequest.h.


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