AWS SDK for C++  1.9.108
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::StringGetDestinationOutpostArn () const
 
bool DestinationOutpostArnHasBeenSet () const
 
void SetDestinationOutpostArn (const Aws::String &value)
 
void SetDestinationOutpostArn (Aws::String &&value)
 
void SetDestinationOutpostArn (const char *value)
 
CopySnapshotRequestWithDestinationOutpostArn (const Aws::String &value)
 
CopySnapshotRequestWithDestinationOutpostArn (Aws::String &&value)
 
CopySnapshotRequestWithDestinationOutpostArn (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

Definition at line 23 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

The tags to apply to the new snapshot.

Definition at line 750 of file CopySnapshotRequest.h.

◆ AddTagSpecifications() [2/2]

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

The tags to apply to the new snapshot.

Definition at line 755 of file CopySnapshotRequest.h.

◆ DescriptionHasBeenSet()

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

A description for the EBS snapshot.

Definition at line 49 of file CopySnapshotRequest.h.

◆ DestinationOutpostArnHasBeenSet()

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

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 106 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 CLI, this is specified using the –region parameter or the default Region in your Amazon Web Services configuration file.

Definition at line 209 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 772 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 304 of file CopySnapshotRequest.h.

◆ GetDescription()

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

A description for the EBS snapshot.

Definition at line 44 of file CopySnapshotRequest.h.

◆ GetDestinationOutpostArn()

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

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 93 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 CLI, this is specified using the –region parameter or the default Region in your Amazon Web Services configuration file.

Definition at line 197 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 764 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 293 of file CopySnapshotRequest.h.

◆ GetKmsKeyId()

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

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

You can specify the KMS key using any of the following:

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

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

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

Amazon Web Services authenticates the KMS key 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 344 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 Amazon Web Services 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: Using Query Parameters (Amazon Web Services 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 485 of file CopySnapshotRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 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 638 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 679 of file CopySnapshotRequest.h.

◆ GetTagSpecifications()

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

The tags to apply to the new snapshot.

Definition at line 720 of file CopySnapshotRequest.h.

◆ KmsKeyIdHasBeenSet()

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

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

You can specify the KMS key using any of the following:

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

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

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

Amazon Web Services authenticates the KMS key 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 361 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 Amazon Web Services 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: Using Query Parameters (Amazon Web Services 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 506 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 ( Aws::String &&  value)
inline

A description for the EBS snapshot.

Definition at line 59 of file CopySnapshotRequest.h.

◆ SetDescription() [2/3]

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

A description for the EBS snapshot.

Definition at line 54 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 64 of file CopySnapshotRequest.h.

◆ SetDestinationOutpostArn() [1/3]

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

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 132 of file CopySnapshotRequest.h.

◆ SetDestinationOutpostArn() [2/3]

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

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 119 of file CopySnapshotRequest.h.

◆ SetDestinationOutpostArn() [3/3]

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

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 145 of file CopySnapshotRequest.h.

◆ SetDestinationRegion() [1/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 CLI, this is specified using the –region parameter or the default Region in your Amazon Web Services configuration file.

Definition at line 233 of file CopySnapshotRequest.h.

◆ SetDestinationRegion() [2/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 CLI, this is specified using the –region parameter or the default Region in your Amazon Web Services configuration file.

Definition at line 221 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 CLI, this is specified using the –region parameter or the default Region in your Amazon Web Services configuration file.

Definition at line 245 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 780 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 315 of file CopySnapshotRequest.h.

◆ SetKmsKeyId() [1/3]

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

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

You can specify the KMS key using any of the following:

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

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

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

Amazon Web Services authenticates the KMS key 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 395 of file CopySnapshotRequest.h.

◆ SetKmsKeyId() [2/3]

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

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

You can specify the KMS key using any of the following:

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

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

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

Amazon Web Services authenticates the KMS key 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 378 of file CopySnapshotRequest.h.

◆ SetKmsKeyId() [3/3]

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

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

You can specify the KMS key using any of the following:

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

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

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

Amazon Web Services authenticates the KMS key 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 412 of file CopySnapshotRequest.h.

◆ SetPresignedUrl() [1/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 Amazon Web Services 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: Using Query Parameters (Amazon Web Services 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 548 of file CopySnapshotRequest.h.

◆ SetPresignedUrl() [2/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 Amazon Web Services 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: Using Query Parameters (Amazon Web Services 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 527 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 Amazon Web Services 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: Using Query Parameters (Amazon Web Services 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 569 of file CopySnapshotRequest.h.

◆ SetSourceRegion() [1/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 653 of file CopySnapshotRequest.h.

◆ SetSourceRegion() [2/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 648 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 658 of file CopySnapshotRequest.h.

◆ SetSourceSnapshotId() [1/3]

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

The ID of the EBS snapshot to copy.

Definition at line 694 of file CopySnapshotRequest.h.

◆ SetSourceSnapshotId() [2/3]

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

The ID of the EBS snapshot to copy.

Definition at line 689 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 699 of file CopySnapshotRequest.h.

◆ SetTagSpecifications() [1/2]

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

The tags to apply to the new snapshot.

Definition at line 735 of file CopySnapshotRequest.h.

◆ SetTagSpecifications() [2/2]

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

The tags to apply to the new snapshot.

Definition at line 730 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 643 of file CopySnapshotRequest.h.

◆ SourceSnapshotIdHasBeenSet()

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

The ID of the EBS snapshot to copy.

Definition at line 684 of file CopySnapshotRequest.h.

◆ TagSpecificationsHasBeenSet()

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

The tags to apply to the new snapshot.

Definition at line 725 of file CopySnapshotRequest.h.

◆ WithDescription() [1/3]

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

A description for the EBS snapshot.

Definition at line 74 of file CopySnapshotRequest.h.

◆ WithDescription() [2/3]

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

A description for the EBS snapshot.

Definition at line 69 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 79 of file CopySnapshotRequest.h.

◆ WithDestinationOutpostArn() [1/3]

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

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 171 of file CopySnapshotRequest.h.

◆ WithDestinationOutpostArn() [2/3]

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

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 158 of file CopySnapshotRequest.h.

◆ WithDestinationOutpostArn() [3/3]

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

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an Amazon Web Services Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copy snapshots from an Amazon Web Services Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 184 of file CopySnapshotRequest.h.

◆ WithDestinationRegion() [1/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 CLI, this is specified using the –region parameter or the default Region in your Amazon Web Services configuration file.

Definition at line 269 of file CopySnapshotRequest.h.

◆ WithDestinationRegion() [2/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 CLI, this is specified using the –region parameter or the default Region in your Amazon Web Services configuration file.

Definition at line 257 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 CLI, this is specified using the –region parameter or the default Region in your Amazon Web Services configuration file.

Definition at line 281 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 788 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 326 of file CopySnapshotRequest.h.

◆ WithKmsKeyId() [1/3]

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

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

You can specify the KMS key using any of the following:

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

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

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

Amazon Web Services authenticates the KMS key 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 446 of file CopySnapshotRequest.h.

◆ WithKmsKeyId() [2/3]

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

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

You can specify the KMS key using any of the following:

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

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

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

Amazon Web Services authenticates the KMS key 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 429 of file CopySnapshotRequest.h.

◆ WithKmsKeyId() [3/3]

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

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

You can specify the KMS key using any of the following:

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

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

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

Amazon Web Services authenticates the KMS key 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 463 of file CopySnapshotRequest.h.

◆ WithPresignedUrl() [1/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 Amazon Web Services 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: Using Query Parameters (Amazon Web Services 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 611 of file CopySnapshotRequest.h.

◆ WithPresignedUrl() [2/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 Amazon Web Services 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: Using Query Parameters (Amazon Web Services 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 590 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 Amazon Web Services 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: Using Query Parameters (Amazon Web Services 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 632 of file CopySnapshotRequest.h.

◆ WithSourceRegion() [1/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 668 of file CopySnapshotRequest.h.

◆ WithSourceRegion() [2/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 663 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 673 of file CopySnapshotRequest.h.

◆ WithSourceSnapshotId() [1/3]

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

The ID of the EBS snapshot to copy.

Definition at line 709 of file CopySnapshotRequest.h.

◆ WithSourceSnapshotId() [2/3]

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

The ID of the EBS snapshot to copy.

Definition at line 704 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 714 of file CopySnapshotRequest.h.

◆ WithTagSpecifications() [1/2]

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

The tags to apply to the new snapshot.

Definition at line 745 of file CopySnapshotRequest.h.

◆ WithTagSpecifications() [2/2]

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

The tags to apply to the new snapshot.

Definition at line 740 of file CopySnapshotRequest.h.


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