AWS SDK for C++  1.8.183
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)
 
const Aws::StringGetDestinationOutpostArn () const
 
bool DestinationOutpostArnHasBeenSet () const
 
void SetDestinationOutpostArn (const Aws::String &value)
 
void SetDestinationOutpostArn (Aws::String &&value)
 
void SetDestinationOutpostArn (const char *value)
 
CopyImageRequestWithDestinationOutpostArn (const Aws::String &value)
 
CopyImageRequestWithDestinationOutpostArn (Aws::String &&value)
 
CopyImageRequestWithDestinationOutpostArn (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 24 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 Ensuring idempotency in the Amazon EC2 API Reference.

Definition at line 56 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 115 of file CopyImageRequest.h.

◆ DestinationOutpostArnHasBeenSet()

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

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

For more information, see Copying AMIs from an AWS Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 483 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 572 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 168 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 Ensuring idempotency in the Amazon EC2 API Reference.

Definition at line 48 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 110 of file CopyImageRequest.h.

◆ GetDestinationOutpostArn()

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

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

For more information, see Copying AMIs from an AWS Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 471 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 564 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 157 of file CopyImageRequest.h.

◆ GetKmsKeyId()

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

The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating encrypted volumes. If this parameter is not specified, your AWS managed CMK for EBS is used. If you specify a CMK, you must also set the encrypted state to true.

You can specify a CMK 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.

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

The specified CMK must exist in the destination Region.

Amazon EBS does not support asymmetric CMKs.

Definition at line 209 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 341 of file CopyImageRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 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 382 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 423 of file CopyImageRequest.h.

◆ KmsKeyIdHasBeenSet()

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

The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating encrypted volumes. If this parameter is not specified, your AWS managed CMK for EBS is used. If you specify a CMK, you must also set the encrypted state to true.

You can specify a CMK 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.

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

The specified CMK must exist in the destination Region.

Amazon EBS does not support asymmetric CMKs.

Definition at line 227 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 346 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 ( Aws::String &&  value)
inline

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Definition at line 72 of file CopyImageRequest.h.

◆ SetClientToken() [2/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 Ensuring idempotency in the Amazon EC2 API Reference.

Definition at line 64 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 Ensuring idempotency in the Amazon EC2 API Reference.

Definition at line 80 of file CopyImageRequest.h.

◆ SetDescription() [1/3]

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

A description for the new AMI in the destination Region.

Definition at line 125 of file CopyImageRequest.h.

◆ SetDescription() [2/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 120 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 130 of file CopyImageRequest.h.

◆ SetDestinationOutpostArn() [1/3]

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

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

For more information, see Copying AMIs from an AWS Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 507 of file CopyImageRequest.h.

◆ SetDestinationOutpostArn() [2/3]

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

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

For more information, see Copying AMIs from an AWS Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 495 of file CopyImageRequest.h.

◆ SetDestinationOutpostArn() [3/3]

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

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

For more information, see Copying AMIs from an AWS Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 519 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 580 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 179 of file CopyImageRequest.h.

◆ SetKmsKeyId() [1/3]

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

The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating encrypted volumes. If this parameter is not specified, your AWS managed CMK for EBS is used. If you specify a CMK, you must also set the encrypted state to true.

You can specify a CMK 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.

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

The specified CMK must exist in the destination Region.

Amazon EBS does not support asymmetric CMKs.

Definition at line 263 of file CopyImageRequest.h.

◆ SetKmsKeyId() [2/3]

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

The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating encrypted volumes. If this parameter is not specified, your AWS managed CMK for EBS is used. If you specify a CMK, you must also set the encrypted state to true.

You can specify a CMK 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.

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

The specified CMK must exist in the destination Region.

Amazon EBS does not support asymmetric CMKs.

Definition at line 245 of file CopyImageRequest.h.

◆ SetKmsKeyId() [3/3]

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

The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating encrypted volumes. If this parameter is not specified, your AWS managed CMK for EBS is used. If you specify a CMK, you must also set the encrypted state to true.

You can specify a CMK 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.

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

The specified CMK must exist in the destination Region.

Amazon EBS does not support asymmetric CMKs.

Definition at line 281 of file CopyImageRequest.h.

◆ SetName() [1/3]

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

The name of the new AMI in the destination Region.

Definition at line 356 of file CopyImageRequest.h.

◆ SetName() [2/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 351 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 361 of file CopyImageRequest.h.

◆ SetSourceImageId() [1/3]

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

The ID of the AMI to copy.

Definition at line 397 of file CopyImageRequest.h.

◆ SetSourceImageId() [2/3]

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

The ID of the AMI to copy.

Definition at line 392 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 402 of file CopyImageRequest.h.

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

◆ SetSourceRegion() [2/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 433 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 443 of file CopyImageRequest.h.

◆ SourceImageIdHasBeenSet()

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

The ID of the AMI to copy.

Definition at line 387 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 428 of file CopyImageRequest.h.

◆ WithClientToken() [1/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 Ensuring idempotency in the Amazon EC2 API Reference.

Definition at line 96 of file CopyImageRequest.h.

◆ WithClientToken() [2/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 Ensuring idempotency in the Amazon EC2 API Reference.

Definition at line 88 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 Ensuring idempotency in the Amazon EC2 API Reference.

Definition at line 104 of file CopyImageRequest.h.

◆ WithDescription() [1/3]

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

A description for the new AMI in the destination Region.

Definition at line 140 of file CopyImageRequest.h.

◆ WithDescription() [2/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 135 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 145 of file CopyImageRequest.h.

◆ WithDestinationOutpostArn() [1/3]

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

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

For more information, see Copying AMIs from an AWS Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 543 of file CopyImageRequest.h.

◆ WithDestinationOutpostArn() [2/3]

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

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

For more information, see Copying AMIs from an AWS Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 531 of file CopyImageRequest.h.

◆ WithDestinationOutpostArn() [3/3]

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

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

For more information, see Copying AMIs from an AWS Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

Definition at line 555 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 588 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 190 of file CopyImageRequest.h.

◆ WithKmsKeyId() [1/3]

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

The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating encrypted volumes. If this parameter is not specified, your AWS managed CMK for EBS is used. If you specify a CMK, you must also set the encrypted state to true.

You can specify a CMK 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.

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

The specified CMK must exist in the destination Region.

Amazon EBS does not support asymmetric CMKs.

Definition at line 317 of file CopyImageRequest.h.

◆ WithKmsKeyId() [2/3]

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

The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating encrypted volumes. If this parameter is not specified, your AWS managed CMK for EBS is used. If you specify a CMK, you must also set the encrypted state to true.

You can specify a CMK 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.

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

The specified CMK must exist in the destination Region.

Amazon EBS does not support asymmetric CMKs.

Definition at line 299 of file CopyImageRequest.h.

◆ WithKmsKeyId() [3/3]

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

The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating encrypted volumes. If this parameter is not specified, your AWS managed CMK for EBS is used. If you specify a CMK, you must also set the encrypted state to true.

You can specify a CMK 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.

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

The specified CMK must exist in the destination Region.

Amazon EBS does not support asymmetric CMKs.

Definition at line 335 of file CopyImageRequest.h.

◆ WithName() [1/3]

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

The name of the new AMI in the destination Region.

Definition at line 371 of file CopyImageRequest.h.

◆ WithName() [2/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 366 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 376 of file CopyImageRequest.h.

◆ WithSourceImageId() [1/3]

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

The ID of the AMI to copy.

Definition at line 412 of file CopyImageRequest.h.

◆ WithSourceImageId() [2/3]

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

The ID of the AMI to copy.

Definition at line 407 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 417 of file CopyImageRequest.h.

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

◆ WithSourceRegion() [2/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 448 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 458 of file CopyImageRequest.h.


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