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

#include <ImportSnapshotRequest.h>

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

Public Member Functions

 ImportSnapshotRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const ClientDataGetClientData () const
 
bool ClientDataHasBeenSet () const
 
void SetClientData (const ClientData &value)
 
void SetClientData (ClientData &&value)
 
ImportSnapshotRequestWithClientData (const ClientData &value)
 
ImportSnapshotRequestWithClientData (ClientData &&value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
ImportSnapshotRequestWithClientToken (const Aws::String &value)
 
ImportSnapshotRequestWithClientToken (Aws::String &&value)
 
ImportSnapshotRequestWithClientToken (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)
 
ImportSnapshotRequestWithDescription (const Aws::String &value)
 
ImportSnapshotRequestWithDescription (Aws::String &&value)
 
ImportSnapshotRequestWithDescription (const char *value)
 
const SnapshotDiskContainerGetDiskContainer () const
 
bool DiskContainerHasBeenSet () const
 
void SetDiskContainer (const SnapshotDiskContainer &value)
 
void SetDiskContainer (SnapshotDiskContainer &&value)
 
ImportSnapshotRequestWithDiskContainer (const SnapshotDiskContainer &value)
 
ImportSnapshotRequestWithDiskContainer (SnapshotDiskContainer &&value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
ImportSnapshotRequestWithDryRun (bool value)
 
bool GetEncrypted () const
 
bool EncryptedHasBeenSet () const
 
void SetEncrypted (bool value)
 
ImportSnapshotRequestWithEncrypted (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)
 
ImportSnapshotRequestWithKmsKeyId (const Aws::String &value)
 
ImportSnapshotRequestWithKmsKeyId (Aws::String &&value)
 
ImportSnapshotRequestWithKmsKeyId (const char *value)
 
const Aws::StringGetRoleName () const
 
bool RoleNameHasBeenSet () const
 
void SetRoleName (const Aws::String &value)
 
void SetRoleName (Aws::String &&value)
 
void SetRoleName (const char *value)
 
ImportSnapshotRequestWithRoleName (const Aws::String &value)
 
ImportSnapshotRequestWithRoleName (Aws::String &&value)
 
ImportSnapshotRequestWithRoleName (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)
 
ImportSnapshotRequestWithTagSpecifications (const Aws::Vector< TagSpecification > &value)
 
ImportSnapshotRequestWithTagSpecifications (Aws::Vector< TagSpecification > &&value)
 
ImportSnapshotRequestAddTagSpecifications (const TagSpecification &value)
 
ImportSnapshotRequestAddTagSpecifications (TagSpecification &&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 25 of file ImportSnapshotRequest.h.

Constructor & Destructor Documentation

◆ ImportSnapshotRequest()

Aws::EC2::Model::ImportSnapshotRequest::ImportSnapshotRequest ( )

Member Function Documentation

◆ AddTagSpecifications() [1/2]

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

The tags to apply to the import snapshot task during creation.

Definition at line 568 of file ImportSnapshotRequest.h.

◆ AddTagSpecifications() [2/2]

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

The tags to apply to the import snapshot task during creation.

Definition at line 573 of file ImportSnapshotRequest.h.

◆ ClientDataHasBeenSet()

bool Aws::EC2::Model::ImportSnapshotRequest::ClientDataHasBeenSet ( ) const
inline

The client-specific data.

Definition at line 51 of file ImportSnapshotRequest.h.

◆ ClientTokenHasBeenSet()

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

Token to enable idempotency for VM import requests.

Definition at line 82 of file ImportSnapshotRequest.h.

◆ DescriptionHasBeenSet()

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

The description string for the import snapshot task.

Definition at line 123 of file ImportSnapshotRequest.h.

◆ DiskContainerHasBeenSet()

bool Aws::EC2::Model::ImportSnapshotRequest::DiskContainerHasBeenSet ( ) const
inline

Information about the disk container.

Definition at line 164 of file ImportSnapshotRequest.h.

◆ DryRunHasBeenSet()

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

◆ DumpBodyToUrl()

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

Specifies whether the destination snapshot of the imported image should be encrypted. 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 238 of file ImportSnapshotRequest.h.

◆ GetClientData()

const ClientData& Aws::EC2::Model::ImportSnapshotRequest::GetClientData ( ) const
inline

The client-specific data.

Definition at line 46 of file ImportSnapshotRequest.h.

◆ GetClientToken()

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

Token to enable idempotency for VM import requests.

Definition at line 77 of file ImportSnapshotRequest.h.

◆ GetDescription()

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

The description string for the import snapshot task.

Definition at line 118 of file ImportSnapshotRequest.h.

◆ GetDiskContainer()

const SnapshotDiskContainer& Aws::EC2::Model::ImportSnapshotRequest::GetDiskContainer ( ) const
inline

Information about the disk container.

Definition at line 159 of file ImportSnapshotRequest.h.

◆ GetDryRun()

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

◆ GetEncrypted()

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

Specifies whether the destination snapshot of the imported image should be encrypted. 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 228 of file ImportSnapshotRequest.h.

◆ GetKmsKeyId()

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

An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. 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.

The CMK identifier may be provided in any of the following formats:

  • Key ID

  • Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

  • ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910: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.

Amazon EBS does not support asymmetric CMKs.

Definition at line 288 of file ImportSnapshotRequest.h.

◆ GetRoleName()

const Aws::String& Aws::EC2::Model::ImportSnapshotRequest::GetRoleName ( ) const
inline

The name of the role to use when not using the default role, 'vmimport'.

Definition at line 497 of file ImportSnapshotRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file ImportSnapshotRequest.h.

◆ GetTagSpecifications()

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

The tags to apply to the import snapshot task during creation.

Definition at line 538 of file ImportSnapshotRequest.h.

◆ KmsKeyIdHasBeenSet()

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

An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. 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.

The CMK identifier may be provided in any of the following formats:

  • Key ID

  • Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

  • ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910: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.

Amazon EBS does not support asymmetric CMKs.

Definition at line 317 of file ImportSnapshotRequest.h.

◆ RoleNameHasBeenSet()

bool Aws::EC2::Model::ImportSnapshotRequest::RoleNameHasBeenSet ( ) const
inline

The name of the role to use when not using the default role, 'vmimport'.

Definition at line 502 of file ImportSnapshotRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientData() [1/2]

void Aws::EC2::Model::ImportSnapshotRequest::SetClientData ( ClientData &&  value)
inline

The client-specific data.

Definition at line 61 of file ImportSnapshotRequest.h.

◆ SetClientData() [2/2]

void Aws::EC2::Model::ImportSnapshotRequest::SetClientData ( const ClientData value)
inline

The client-specific data.

Definition at line 56 of file ImportSnapshotRequest.h.

◆ SetClientToken() [1/3]

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

Token to enable idempotency for VM import requests.

Definition at line 92 of file ImportSnapshotRequest.h.

◆ SetClientToken() [2/3]

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

Token to enable idempotency for VM import requests.

Definition at line 87 of file ImportSnapshotRequest.h.

◆ SetClientToken() [3/3]

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

Token to enable idempotency for VM import requests.

Definition at line 97 of file ImportSnapshotRequest.h.

◆ SetDescription() [1/3]

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

The description string for the import snapshot task.

Definition at line 133 of file ImportSnapshotRequest.h.

◆ SetDescription() [2/3]

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

The description string for the import snapshot task.

Definition at line 128 of file ImportSnapshotRequest.h.

◆ SetDescription() [3/3]

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

The description string for the import snapshot task.

Definition at line 138 of file ImportSnapshotRequest.h.

◆ SetDiskContainer() [1/2]

void Aws::EC2::Model::ImportSnapshotRequest::SetDiskContainer ( const SnapshotDiskContainer value)
inline

Information about the disk container.

Definition at line 169 of file ImportSnapshotRequest.h.

◆ SetDiskContainer() [2/2]

void Aws::EC2::Model::ImportSnapshotRequest::SetDiskContainer ( SnapshotDiskContainer &&  value)
inline

Information about the disk container.

Definition at line 174 of file ImportSnapshotRequest.h.

◆ SetDryRun()

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

◆ SetEncrypted()

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

Specifies whether the destination snapshot of the imported image should be encrypted. 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 248 of file ImportSnapshotRequest.h.

◆ SetKmsKeyId() [1/3]

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

An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. 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.

The CMK identifier may be provided in any of the following formats:

  • Key ID

  • Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

  • ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910: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.

Amazon EBS does not support asymmetric CMKs.

Definition at line 375 of file ImportSnapshotRequest.h.

◆ SetKmsKeyId() [2/3]

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

An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. 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.

The CMK identifier may be provided in any of the following formats:

  • Key ID

  • Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

  • ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910: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.

Amazon EBS does not support asymmetric CMKs.

Definition at line 346 of file ImportSnapshotRequest.h.

◆ SetKmsKeyId() [3/3]

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

An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. 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.

The CMK identifier may be provided in any of the following formats:

  • Key ID

  • Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

  • ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910: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.

Amazon EBS does not support asymmetric CMKs.

Definition at line 404 of file ImportSnapshotRequest.h.

◆ SetRoleName() [1/3]

void Aws::EC2::Model::ImportSnapshotRequest::SetRoleName ( Aws::String &&  value)
inline

The name of the role to use when not using the default role, 'vmimport'.

Definition at line 512 of file ImportSnapshotRequest.h.

◆ SetRoleName() [2/3]

void Aws::EC2::Model::ImportSnapshotRequest::SetRoleName ( const Aws::String value)
inline

The name of the role to use when not using the default role, 'vmimport'.

Definition at line 507 of file ImportSnapshotRequest.h.

◆ SetRoleName() [3/3]

void Aws::EC2::Model::ImportSnapshotRequest::SetRoleName ( const char *  value)
inline

The name of the role to use when not using the default role, 'vmimport'.

Definition at line 517 of file ImportSnapshotRequest.h.

◆ SetTagSpecifications() [1/2]

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

The tags to apply to the import snapshot task during creation.

Definition at line 553 of file ImportSnapshotRequest.h.

◆ SetTagSpecifications() [2/2]

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

The tags to apply to the import snapshot task during creation.

Definition at line 548 of file ImportSnapshotRequest.h.

◆ TagSpecificationsHasBeenSet()

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

The tags to apply to the import snapshot task during creation.

Definition at line 543 of file ImportSnapshotRequest.h.

◆ WithClientData() [1/2]

ImportSnapshotRequest& Aws::EC2::Model::ImportSnapshotRequest::WithClientData ( ClientData &&  value)
inline

The client-specific data.

Definition at line 71 of file ImportSnapshotRequest.h.

◆ WithClientData() [2/2]

ImportSnapshotRequest& Aws::EC2::Model::ImportSnapshotRequest::WithClientData ( const ClientData value)
inline

The client-specific data.

Definition at line 66 of file ImportSnapshotRequest.h.

◆ WithClientToken() [1/3]

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

Token to enable idempotency for VM import requests.

Definition at line 107 of file ImportSnapshotRequest.h.

◆ WithClientToken() [2/3]

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

Token to enable idempotency for VM import requests.

Definition at line 102 of file ImportSnapshotRequest.h.

◆ WithClientToken() [3/3]

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

Token to enable idempotency for VM import requests.

Definition at line 112 of file ImportSnapshotRequest.h.

◆ WithDescription() [1/3]

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

The description string for the import snapshot task.

Definition at line 148 of file ImportSnapshotRequest.h.

◆ WithDescription() [2/3]

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

The description string for the import snapshot task.

Definition at line 143 of file ImportSnapshotRequest.h.

◆ WithDescription() [3/3]

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

The description string for the import snapshot task.

Definition at line 153 of file ImportSnapshotRequest.h.

◆ WithDiskContainer() [1/2]

ImportSnapshotRequest& Aws::EC2::Model::ImportSnapshotRequest::WithDiskContainer ( const SnapshotDiskContainer value)
inline

Information about the disk container.

Definition at line 179 of file ImportSnapshotRequest.h.

◆ WithDiskContainer() [2/2]

ImportSnapshotRequest& Aws::EC2::Model::ImportSnapshotRequest::WithDiskContainer ( SnapshotDiskContainer &&  value)
inline

Information about the disk container.

Definition at line 184 of file ImportSnapshotRequest.h.

◆ WithDryRun()

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

◆ WithEncrypted()

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

Specifies whether the destination snapshot of the imported image should be encrypted. 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 258 of file ImportSnapshotRequest.h.

◆ WithKmsKeyId() [1/3]

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

An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. 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.

The CMK identifier may be provided in any of the following formats:

  • Key ID

  • Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

  • ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910: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.

Amazon EBS does not support asymmetric CMKs.

Definition at line 462 of file ImportSnapshotRequest.h.

◆ WithKmsKeyId() [2/3]

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

An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. 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.

The CMK identifier may be provided in any of the following formats:

  • Key ID

  • Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

  • ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910: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.

Amazon EBS does not support asymmetric CMKs.

Definition at line 433 of file ImportSnapshotRequest.h.

◆ WithKmsKeyId() [3/3]

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

An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. 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.

The CMK identifier may be provided in any of the following formats:

  • Key ID

  • Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

  • ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910: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.

Amazon EBS does not support asymmetric CMKs.

Definition at line 491 of file ImportSnapshotRequest.h.

◆ WithRoleName() [1/3]

ImportSnapshotRequest& Aws::EC2::Model::ImportSnapshotRequest::WithRoleName ( Aws::String &&  value)
inline

The name of the role to use when not using the default role, 'vmimport'.

Definition at line 527 of file ImportSnapshotRequest.h.

◆ WithRoleName() [2/3]

ImportSnapshotRequest& Aws::EC2::Model::ImportSnapshotRequest::WithRoleName ( const Aws::String value)
inline

The name of the role to use when not using the default role, 'vmimport'.

Definition at line 522 of file ImportSnapshotRequest.h.

◆ WithRoleName() [3/3]

ImportSnapshotRequest& Aws::EC2::Model::ImportSnapshotRequest::WithRoleName ( const char *  value)
inline

The name of the role to use when not using the default role, 'vmimport'.

Definition at line 532 of file ImportSnapshotRequest.h.

◆ WithTagSpecifications() [1/2]

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

The tags to apply to the import snapshot task during creation.

Definition at line 563 of file ImportSnapshotRequest.h.

◆ WithTagSpecifications() [2/2]

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

The tags to apply to the import snapshot task during creation.

Definition at line 558 of file ImportSnapshotRequest.h.


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