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

#include <CopyImageRequest.h>

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

Public Member Functions

 CopyImageRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
CopyImageRequestWithClientToken (const Aws::String &value)
 
CopyImageRequestWithClientToken (Aws::String &&value)
 
CopyImageRequestWithClientToken (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CopyImageRequestWithDescription (const Aws::String &value)
 
CopyImageRequestWithDescription (Aws::String &&value)
 
CopyImageRequestWithDescription (const char *value)
 
bool GetEncrypted () const
 
bool EncryptedHasBeenSet () const
 
void SetEncrypted (bool value)
 
CopyImageRequestWithEncrypted (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)
 
CopyImageRequestWithKmsKeyId (const Aws::String &value)
 
CopyImageRequestWithKmsKeyId (Aws::String &&value)
 
CopyImageRequestWithKmsKeyId (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CopyImageRequestWithName (const Aws::String &value)
 
CopyImageRequestWithName (Aws::String &&value)
 
CopyImageRequestWithName (const char *value)
 
const Aws::StringGetSourceImageId () const
 
bool SourceImageIdHasBeenSet () const
 
void SetSourceImageId (const Aws::String &value)
 
void SetSourceImageId (Aws::String &&value)
 
void SetSourceImageId (const char *value)
 
CopyImageRequestWithSourceImageId (const Aws::String &value)
 
CopyImageRequestWithSourceImageId (Aws::String &&value)
 
CopyImageRequestWithSourceImageId (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)
 
CopyImageRequestWithSourceRegion (const Aws::String &value)
 
CopyImageRequestWithSourceRegion (Aws::String &&value)
 
CopyImageRequestWithSourceRegion (const char *value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
CopyImageRequestWithDryRun (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 CopyImage.

See Also:

AWS API Reference

Definition at line 34 of file CopyImageRequest.h.

Constructor & Destructor Documentation

◆ CopyImageRequest()

Aws::EC2::Model::CopyImageRequest::CopyImageRequest ( )

Member Function Documentation

◆ ClientTokenHasBeenSet()

bool Aws::EC2::Model::CopyImageRequest::ClientTokenHasBeenSet ( ) const
inline

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

Definition at line 68 of file CopyImageRequest.h.

◆ DescriptionHasBeenSet()

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

A description for the new AMI in the destination Region.

Definition at line 133 of file CopyImageRequest.h.

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::CopyImageRequest::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 517 of file CopyImageRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::CopyImageRequest::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::CopyImageRequest::EncryptedHasBeenSet ( ) const
inline

Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Definition at line 186 of file CopyImageRequest.h.

◆ GetClientToken()

const Aws::String& Aws::EC2::Model::CopyImageRequest::GetClientToken ( ) const
inline

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

Definition at line 59 of file CopyImageRequest.h.

◆ GetDescription()

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

A description for the new AMI in the destination Region.

Definition at line 128 of file CopyImageRequest.h.

◆ GetDryRun()

bool Aws::EC2::Model::CopyImageRequest::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 509 of file CopyImageRequest.h.

◆ GetEncrypted()

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

Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Definition at line 175 of file CopyImageRequest.h.

◆ GetKmsKeyId()

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

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified CMK must exist in the Region that the snapshot is being copied to.

Definition at line 230 of file CopyImageRequest.h.

◆ GetName()

const Aws::String& Aws::EC2::Model::CopyImageRequest::GetName ( ) const
inline

The name of the new AMI in the destination Region.

Definition at line 383 of file CopyImageRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 43 of file CopyImageRequest.h.

◆ GetSourceImageId()

const Aws::String& Aws::EC2::Model::CopyImageRequest::GetSourceImageId ( ) const
inline

The ID of the AMI to copy.

Definition at line 424 of file CopyImageRequest.h.

◆ GetSourceRegion()

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

The name of the Region that contains the AMI to copy.

Definition at line 465 of file CopyImageRequest.h.

◆ KmsKeyIdHasBeenSet()

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

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified CMK must exist in the Region that the snapshot is being copied to.

Definition at line 251 of file CopyImageRequest.h.

◆ NameHasBeenSet()

bool Aws::EC2::Model::CopyImageRequest::NameHasBeenSet ( ) const
inline

The name of the new AMI in the destination Region.

Definition at line 388 of file CopyImageRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientToken() [1/3]

void Aws::EC2::Model::CopyImageRequest::SetClientToken ( const Aws::String value)
inline

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

Definition at line 77 of file CopyImageRequest.h.

◆ SetClientToken() [2/3]

void Aws::EC2::Model::CopyImageRequest::SetClientToken ( Aws::String &&  value)
inline

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

Definition at line 86 of file CopyImageRequest.h.

◆ SetClientToken() [3/3]

void Aws::EC2::Model::CopyImageRequest::SetClientToken ( const char *  value)
inline

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

Definition at line 95 of file CopyImageRequest.h.

◆ SetDescription() [1/3]

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

A description for the new AMI in the destination Region.

Definition at line 138 of file CopyImageRequest.h.

◆ SetDescription() [2/3]

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

A description for the new AMI in the destination Region.

Definition at line 143 of file CopyImageRequest.h.

◆ SetDescription() [3/3]

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

A description for the new AMI in the destination Region.

Definition at line 148 of file CopyImageRequest.h.

◆ SetDryRun()

void Aws::EC2::Model::CopyImageRequest::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 525 of file CopyImageRequest.h.

◆ SetEncrypted()

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

Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Definition at line 197 of file CopyImageRequest.h.

◆ SetKmsKeyId() [1/3]

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

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified CMK must exist in the Region that the snapshot is being copied to.

Definition at line 272 of file CopyImageRequest.h.

◆ SetKmsKeyId() [2/3]

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

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified CMK must exist in the Region that the snapshot is being copied to.

Definition at line 293 of file CopyImageRequest.h.

◆ SetKmsKeyId() [3/3]

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

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified CMK must exist in the Region that the snapshot is being copied to.

Definition at line 314 of file CopyImageRequest.h.

◆ SetName() [1/3]

void Aws::EC2::Model::CopyImageRequest::SetName ( const Aws::String value)
inline

The name of the new AMI in the destination Region.

Definition at line 393 of file CopyImageRequest.h.

◆ SetName() [2/3]

void Aws::EC2::Model::CopyImageRequest::SetName ( Aws::String &&  value)
inline

The name of the new AMI in the destination Region.

Definition at line 398 of file CopyImageRequest.h.

◆ SetName() [3/3]

void Aws::EC2::Model::CopyImageRequest::SetName ( const char *  value)
inline

The name of the new AMI in the destination Region.

Definition at line 403 of file CopyImageRequest.h.

◆ SetSourceImageId() [1/3]

void Aws::EC2::Model::CopyImageRequest::SetSourceImageId ( const Aws::String value)
inline

The ID of the AMI to copy.

Definition at line 434 of file CopyImageRequest.h.

◆ SetSourceImageId() [2/3]

void Aws::EC2::Model::CopyImageRequest::SetSourceImageId ( Aws::String &&  value)
inline

The ID of the AMI to copy.

Definition at line 439 of file CopyImageRequest.h.

◆ SetSourceImageId() [3/3]

void Aws::EC2::Model::CopyImageRequest::SetSourceImageId ( const char *  value)
inline

The ID of the AMI to copy.

Definition at line 444 of file CopyImageRequest.h.

◆ SetSourceRegion() [1/3]

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

The name of the Region that contains the AMI to copy.

Definition at line 475 of file CopyImageRequest.h.

◆ SetSourceRegion() [2/3]

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

The name of the Region that contains the AMI to copy.

Definition at line 480 of file CopyImageRequest.h.

◆ SetSourceRegion() [3/3]

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

The name of the Region that contains the AMI to copy.

Definition at line 485 of file CopyImageRequest.h.

◆ SourceImageIdHasBeenSet()

bool Aws::EC2::Model::CopyImageRequest::SourceImageIdHasBeenSet ( ) const
inline

The ID of the AMI to copy.

Definition at line 429 of file CopyImageRequest.h.

◆ SourceRegionHasBeenSet()

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

The name of the Region that contains the AMI to copy.

Definition at line 470 of file CopyImageRequest.h.

◆ WithClientToken() [1/3]

CopyImageRequest& Aws::EC2::Model::CopyImageRequest::WithClientToken ( const Aws::String value)
inline

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

Definition at line 104 of file CopyImageRequest.h.

◆ WithClientToken() [2/3]

CopyImageRequest& Aws::EC2::Model::CopyImageRequest::WithClientToken ( Aws::String &&  value)
inline

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

Definition at line 113 of file CopyImageRequest.h.

◆ WithClientToken() [3/3]

CopyImageRequest& Aws::EC2::Model::CopyImageRequest::WithClientToken ( const char *  value)
inline

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

Definition at line 122 of file CopyImageRequest.h.

◆ WithDescription() [1/3]

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

A description for the new AMI in the destination Region.

Definition at line 153 of file CopyImageRequest.h.

◆ WithDescription() [2/3]

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

A description for the new AMI in the destination Region.

Definition at line 158 of file CopyImageRequest.h.

◆ WithDescription() [3/3]

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

A description for the new AMI in the destination Region.

Definition at line 163 of file CopyImageRequest.h.

◆ WithDryRun()

CopyImageRequest& Aws::EC2::Model::CopyImageRequest::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 533 of file CopyImageRequest.h.

◆ WithEncrypted()

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

Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

Definition at line 208 of file CopyImageRequest.h.

◆ WithKmsKeyId() [1/3]

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

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified CMK must exist in the Region that the snapshot is being copied to.

Definition at line 335 of file CopyImageRequest.h.

◆ WithKmsKeyId() [2/3]

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

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified CMK must exist in the Region that the snapshot is being copied to.

Definition at line 356 of file CopyImageRequest.h.

◆ WithKmsKeyId() [3/3]

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

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with "alias/". For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified CMK must exist in the Region that the snapshot is being copied to.

Definition at line 377 of file CopyImageRequest.h.

◆ WithName() [1/3]

CopyImageRequest& Aws::EC2::Model::CopyImageRequest::WithName ( const Aws::String value)
inline

The name of the new AMI in the destination Region.

Definition at line 408 of file CopyImageRequest.h.

◆ WithName() [2/3]

CopyImageRequest& Aws::EC2::Model::CopyImageRequest::WithName ( Aws::String &&  value)
inline

The name of the new AMI in the destination Region.

Definition at line 413 of file CopyImageRequest.h.

◆ WithName() [3/3]

CopyImageRequest& Aws::EC2::Model::CopyImageRequest::WithName ( const char *  value)
inline

The name of the new AMI in the destination Region.

Definition at line 418 of file CopyImageRequest.h.

◆ WithSourceImageId() [1/3]

CopyImageRequest& Aws::EC2::Model::CopyImageRequest::WithSourceImageId ( const Aws::String value)
inline

The ID of the AMI to copy.

Definition at line 449 of file CopyImageRequest.h.

◆ WithSourceImageId() [2/3]

CopyImageRequest& Aws::EC2::Model::CopyImageRequest::WithSourceImageId ( Aws::String &&  value)
inline

The ID of the AMI to copy.

Definition at line 454 of file CopyImageRequest.h.

◆ WithSourceImageId() [3/3]

CopyImageRequest& Aws::EC2::Model::CopyImageRequest::WithSourceImageId ( const char *  value)
inline

The ID of the AMI to copy.

Definition at line 459 of file CopyImageRequest.h.

◆ WithSourceRegion() [1/3]

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

The name of the Region that contains the AMI to copy.

Definition at line 490 of file CopyImageRequest.h.

◆ WithSourceRegion() [2/3]

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

The name of the Region that contains the AMI to copy.

Definition at line 495 of file CopyImageRequest.h.

◆ WithSourceRegion() [3/3]

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

The name of the Region that contains the AMI to copy.

Definition at line 500 of file CopyImageRequest.h.


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