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

#include <ImportImageRequest.h>

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

Public Member Functions

 ImportImageRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetArchitecture () const
 
bool ArchitectureHasBeenSet () const
 
void SetArchitecture (const Aws::String &value)
 
void SetArchitecture (Aws::String &&value)
 
void SetArchitecture (const char *value)
 
ImportImageRequestWithArchitecture (const Aws::String &value)
 
ImportImageRequestWithArchitecture (Aws::String &&value)
 
ImportImageRequestWithArchitecture (const char *value)
 
const ClientDataGetClientData () const
 
bool ClientDataHasBeenSet () const
 
void SetClientData (const ClientData &value)
 
void SetClientData (ClientData &&value)
 
ImportImageRequestWithClientData (const ClientData &value)
 
ImportImageRequestWithClientData (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)
 
ImportImageRequestWithClientToken (const Aws::String &value)
 
ImportImageRequestWithClientToken (Aws::String &&value)
 
ImportImageRequestWithClientToken (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)
 
ImportImageRequestWithDescription (const Aws::String &value)
 
ImportImageRequestWithDescription (Aws::String &&value)
 
ImportImageRequestWithDescription (const char *value)
 
const Aws::Vector< ImageDiskContainer > & GetDiskContainers () const
 
bool DiskContainersHasBeenSet () const
 
void SetDiskContainers (const Aws::Vector< ImageDiskContainer > &value)
 
void SetDiskContainers (Aws::Vector< ImageDiskContainer > &&value)
 
ImportImageRequestWithDiskContainers (const Aws::Vector< ImageDiskContainer > &value)
 
ImportImageRequestWithDiskContainers (Aws::Vector< ImageDiskContainer > &&value)
 
ImportImageRequestAddDiskContainers (const ImageDiskContainer &value)
 
ImportImageRequestAddDiskContainers (ImageDiskContainer &&value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
ImportImageRequestWithDryRun (bool value)
 
bool GetEncrypted () const
 
bool EncryptedHasBeenSet () const
 
void SetEncrypted (bool value)
 
ImportImageRequestWithEncrypted (bool value)
 
const Aws::StringGetHypervisor () const
 
bool HypervisorHasBeenSet () const
 
void SetHypervisor (const Aws::String &value)
 
void SetHypervisor (Aws::String &&value)
 
void SetHypervisor (const char *value)
 
ImportImageRequestWithHypervisor (const Aws::String &value)
 
ImportImageRequestWithHypervisor (Aws::String &&value)
 
ImportImageRequestWithHypervisor (const char *value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
ImportImageRequestWithKmsKeyId (const Aws::String &value)
 
ImportImageRequestWithKmsKeyId (Aws::String &&value)
 
ImportImageRequestWithKmsKeyId (const char *value)
 
const Aws::StringGetLicenseType () const
 
bool LicenseTypeHasBeenSet () const
 
void SetLicenseType (const Aws::String &value)
 
void SetLicenseType (Aws::String &&value)
 
void SetLicenseType (const char *value)
 
ImportImageRequestWithLicenseType (const Aws::String &value)
 
ImportImageRequestWithLicenseType (Aws::String &&value)
 
ImportImageRequestWithLicenseType (const char *value)
 
const Aws::StringGetPlatform () const
 
bool PlatformHasBeenSet () const
 
void SetPlatform (const Aws::String &value)
 
void SetPlatform (Aws::String &&value)
 
void SetPlatform (const char *value)
 
ImportImageRequestWithPlatform (const Aws::String &value)
 
ImportImageRequestWithPlatform (Aws::String &&value)
 
ImportImageRequestWithPlatform (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)
 
ImportImageRequestWithRoleName (const Aws::String &value)
 
ImportImageRequestWithRoleName (Aws::String &&value)
 
ImportImageRequestWithRoleName (const char *value)
 
const Aws::Vector< ImportImageLicenseConfigurationRequest > & GetLicenseSpecifications () const
 
bool LicenseSpecificationsHasBeenSet () const
 
void SetLicenseSpecifications (const Aws::Vector< ImportImageLicenseConfigurationRequest > &value)
 
void SetLicenseSpecifications (Aws::Vector< ImportImageLicenseConfigurationRequest > &&value)
 
ImportImageRequestWithLicenseSpecifications (const Aws::Vector< ImportImageLicenseConfigurationRequest > &value)
 
ImportImageRequestWithLicenseSpecifications (Aws::Vector< ImportImageLicenseConfigurationRequest > &&value)
 
ImportImageRequestAddLicenseSpecifications (const ImportImageLicenseConfigurationRequest &value)
 
ImportImageRequestAddLicenseSpecifications (ImportImageLicenseConfigurationRequest &&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 35 of file ImportImageRequest.h.

Constructor & Destructor Documentation

◆ ImportImageRequest()

Aws::EC2::Model::ImportImageRequest::ImportImageRequest ( )

Member Function Documentation

◆ AddDiskContainers() [1/2]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::AddDiskContainers ( const ImageDiskContainer value)
inline

Information about the disk containers.

Definition at line 248 of file ImportImageRequest.h.

◆ AddDiskContainers() [2/2]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::AddDiskContainers ( ImageDiskContainer &&  value)
inline

Information about the disk containers.

Definition at line 253 of file ImportImageRequest.h.

◆ AddLicenseSpecifications() [1/2]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::AddLicenseSpecifications ( const ImportImageLicenseConfigurationRequest value)
inline

The ARNs of the license configurations.

Definition at line 832 of file ImportImageRequest.h.

◆ AddLicenseSpecifications() [2/2]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::AddLicenseSpecifications ( ImportImageLicenseConfigurationRequest &&  value)
inline

The ARNs of the license configurations.

Definition at line 837 of file ImportImageRequest.h.

◆ ArchitectureHasBeenSet()

bool Aws::EC2::Model::ImportImageRequest::ArchitectureHasBeenSet ( ) const
inline

The architecture of the virtual machine.

Valid values: i386 | x86_64 | arm64

Definition at line 63 of file ImportImageRequest.h.

◆ ClientDataHasBeenSet()

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

The client-specific data.

Definition at line 110 of file ImportImageRequest.h.

◆ ClientTokenHasBeenSet()

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

The token to enable idempotency for VM import requests.

Definition at line 141 of file ImportImageRequest.h.

◆ DescriptionHasBeenSet()

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

A description string for the import image task.

Definition at line 182 of file ImportImageRequest.h.

◆ DiskContainersHasBeenSet()

bool Aws::EC2::Model::ImportImageRequest::DiskContainersHasBeenSet ( ) const
inline

Information about the disk containers.

Definition at line 223 of file ImportImageRequest.h.

◆ DryRunHasBeenSet()

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

◆ DumpBodyToUrl()

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

Specifies whether the destination AMI 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 307 of file ImportImageRequest.h.

◆ GetArchitecture()

const Aws::String& Aws::EC2::Model::ImportImageRequest::GetArchitecture ( ) const
inline

The architecture of the virtual machine.

Valid values: i386 | x86_64 | arm64

Definition at line 57 of file ImportImageRequest.h.

◆ GetClientData()

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

The client-specific data.

Definition at line 105 of file ImportImageRequest.h.

◆ GetClientToken()

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

The token to enable idempotency for VM import requests.

Definition at line 136 of file ImportImageRequest.h.

◆ GetDescription()

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

A description string for the import image task.

Definition at line 177 of file ImportImageRequest.h.

◆ GetDiskContainers()

const Aws::Vector<ImageDiskContainer>& Aws::EC2::Model::ImportImageRequest::GetDiskContainers ( ) const
inline

Information about the disk containers.

Definition at line 218 of file ImportImageRequest.h.

◆ GetDryRun()

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

◆ GetEncrypted()

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

Specifies whether the destination AMI 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 297 of file ImportImageRequest.h.

◆ GetHypervisor()

const Aws::String& Aws::EC2::Model::ImportImageRequest::GetHypervisor ( ) const
inline

The target hypervisor platform.

Valid values: xen

Definition at line 333 of file ImportImageRequest.h.

◆ GetKmsKeyId()

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

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

Amazon EBS does not support asymmetric CMKs.

Definition at line 398 of file ImportImageRequest.h.

◆ GetLicenseSpecifications()

const Aws::Vector<ImportImageLicenseConfigurationRequest>& Aws::EC2::Model::ImportImageRequest::GetLicenseSpecifications ( ) const
inline

The ARNs of the license configurations.

Definition at line 802 of file ImportImageRequest.h.

◆ GetLicenseType()

const Aws::String& Aws::EC2::Model::ImportImageRequest::GetLicenseType ( ) const
inline

The license type to be used for the Amazon Machine Image (AMI) after importing.

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify AWS to replace the source-system license with an AWS license, if appropriate. Specify BYOL to retain the source-system license, if appropriate.

To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as AWS. For more information, see Prerequisites in the VM Import/Export User Guide.

Definition at line 615 of file ImportImageRequest.h.

◆ GetPlatform()

const Aws::String& Aws::EC2::Model::ImportImageRequest::GetPlatform ( ) const
inline

The operating system of the virtual machine.

Valid values: Windows | Linux

Definition at line 713 of file ImportImageRequest.h.

◆ GetRoleName()

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

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

Definition at line 761 of file ImportImageRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 44 of file ImportImageRequest.h.

◆ HypervisorHasBeenSet()

bool Aws::EC2::Model::ImportImageRequest::HypervisorHasBeenSet ( ) const
inline

The target hypervisor platform.

Valid values: xen

Definition at line 338 of file ImportImageRequest.h.

◆ KmsKeyIdHasBeenSet()

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

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

Amazon EBS does not support asymmetric CMKs.

Definition at line 427 of file ImportImageRequest.h.

◆ LicenseSpecificationsHasBeenSet()

bool Aws::EC2::Model::ImportImageRequest::LicenseSpecificationsHasBeenSet ( ) const
inline

The ARNs of the license configurations.

Definition at line 807 of file ImportImageRequest.h.

◆ LicenseTypeHasBeenSet()

bool Aws::EC2::Model::ImportImageRequest::LicenseTypeHasBeenSet ( ) const
inline

The license type to be used for the Amazon Machine Image (AMI) after importing.

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify AWS to replace the source-system license with an AWS license, if appropriate. Specify BYOL to retain the source-system license, if appropriate.

To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as AWS. For more information, see Prerequisites in the VM Import/Export User Guide.

Definition at line 628 of file ImportImageRequest.h.

◆ PlatformHasBeenSet()

bool Aws::EC2::Model::ImportImageRequest::PlatformHasBeenSet ( ) const
inline

The operating system of the virtual machine.

Valid values: Windows | Linux

Definition at line 719 of file ImportImageRequest.h.

◆ RoleNameHasBeenSet()

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

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

Definition at line 766 of file ImportImageRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetArchitecture() [1/3]

void Aws::EC2::Model::ImportImageRequest::SetArchitecture ( const Aws::String value)
inline

The architecture of the virtual machine.

Valid values: i386 | x86_64 | arm64

Definition at line 69 of file ImportImageRequest.h.

◆ SetArchitecture() [2/3]

void Aws::EC2::Model::ImportImageRequest::SetArchitecture ( Aws::String &&  value)
inline

The architecture of the virtual machine.

Valid values: i386 | x86_64 | arm64

Definition at line 75 of file ImportImageRequest.h.

◆ SetArchitecture() [3/3]

void Aws::EC2::Model::ImportImageRequest::SetArchitecture ( const char *  value)
inline

The architecture of the virtual machine.

Valid values: i386 | x86_64 | arm64

Definition at line 81 of file ImportImageRequest.h.

◆ SetClientData() [1/2]

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

The client-specific data.

Definition at line 115 of file ImportImageRequest.h.

◆ SetClientData() [2/2]

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

The client-specific data.

Definition at line 120 of file ImportImageRequest.h.

◆ SetClientToken() [1/3]

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

The token to enable idempotency for VM import requests.

Definition at line 146 of file ImportImageRequest.h.

◆ SetClientToken() [2/3]

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

The token to enable idempotency for VM import requests.

Definition at line 151 of file ImportImageRequest.h.

◆ SetClientToken() [3/3]

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

The token to enable idempotency for VM import requests.

Definition at line 156 of file ImportImageRequest.h.

◆ SetDescription() [1/3]

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

A description string for the import image task.

Definition at line 187 of file ImportImageRequest.h.

◆ SetDescription() [2/3]

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

A description string for the import image task.

Definition at line 192 of file ImportImageRequest.h.

◆ SetDescription() [3/3]

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

A description string for the import image task.

Definition at line 197 of file ImportImageRequest.h.

◆ SetDiskContainers() [1/2]

void Aws::EC2::Model::ImportImageRequest::SetDiskContainers ( const Aws::Vector< ImageDiskContainer > &  value)
inline

Information about the disk containers.

Definition at line 228 of file ImportImageRequest.h.

◆ SetDiskContainers() [2/2]

void Aws::EC2::Model::ImportImageRequest::SetDiskContainers ( Aws::Vector< ImageDiskContainer > &&  value)
inline

Information about the disk containers.

Definition at line 233 of file ImportImageRequest.h.

◆ SetDryRun()

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

◆ SetEncrypted()

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

Specifies whether the destination AMI 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 317 of file ImportImageRequest.h.

◆ SetHypervisor() [1/3]

void Aws::EC2::Model::ImportImageRequest::SetHypervisor ( const Aws::String value)
inline

The target hypervisor platform.

Valid values: xen

Definition at line 343 of file ImportImageRequest.h.

◆ SetHypervisor() [2/3]

void Aws::EC2::Model::ImportImageRequest::SetHypervisor ( Aws::String &&  value)
inline

The target hypervisor platform.

Valid values: xen

Definition at line 348 of file ImportImageRequest.h.

◆ SetHypervisor() [3/3]

void Aws::EC2::Model::ImportImageRequest::SetHypervisor ( const char *  value)
inline

The target hypervisor platform.

Valid values: xen

Definition at line 353 of file ImportImageRequest.h.

◆ SetKmsKeyId() [1/3]

void Aws::EC2::Model::ImportImageRequest::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 AMI. 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 AMI is being copied to.

Amazon EBS does not support asymmetric CMKs.

Definition at line 456 of file ImportImageRequest.h.

◆ SetKmsKeyId() [2/3]

void Aws::EC2::Model::ImportImageRequest::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 AMI. 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 AMI is being copied to.

Amazon EBS does not support asymmetric CMKs.

Definition at line 485 of file ImportImageRequest.h.

◆ SetKmsKeyId() [3/3]

void Aws::EC2::Model::ImportImageRequest::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 AMI. 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 AMI is being copied to.

Amazon EBS does not support asymmetric CMKs.

Definition at line 514 of file ImportImageRequest.h.

◆ SetLicenseSpecifications() [1/2]

void Aws::EC2::Model::ImportImageRequest::SetLicenseSpecifications ( const Aws::Vector< ImportImageLicenseConfigurationRequest > &  value)
inline

The ARNs of the license configurations.

Definition at line 812 of file ImportImageRequest.h.

◆ SetLicenseSpecifications() [2/2]

void Aws::EC2::Model::ImportImageRequest::SetLicenseSpecifications ( Aws::Vector< ImportImageLicenseConfigurationRequest > &&  value)
inline

The ARNs of the license configurations.

Definition at line 817 of file ImportImageRequest.h.

◆ SetLicenseType() [1/3]

void Aws::EC2::Model::ImportImageRequest::SetLicenseType ( const Aws::String value)
inline

The license type to be used for the Amazon Machine Image (AMI) after importing.

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify AWS to replace the source-system license with an AWS license, if appropriate. Specify BYOL to retain the source-system license, if appropriate.

To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as AWS. For more information, see Prerequisites in the VM Import/Export User Guide.

Definition at line 641 of file ImportImageRequest.h.

◆ SetLicenseType() [2/3]

void Aws::EC2::Model::ImportImageRequest::SetLicenseType ( Aws::String &&  value)
inline

The license type to be used for the Amazon Machine Image (AMI) after importing.

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify AWS to replace the source-system license with an AWS license, if appropriate. Specify BYOL to retain the source-system license, if appropriate.

To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as AWS. For more information, see Prerequisites in the VM Import/Export User Guide.

Definition at line 654 of file ImportImageRequest.h.

◆ SetLicenseType() [3/3]

void Aws::EC2::Model::ImportImageRequest::SetLicenseType ( const char *  value)
inline

The license type to be used for the Amazon Machine Image (AMI) after importing.

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify AWS to replace the source-system license with an AWS license, if appropriate. Specify BYOL to retain the source-system license, if appropriate.

To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as AWS. For more information, see Prerequisites in the VM Import/Export User Guide.

Definition at line 667 of file ImportImageRequest.h.

◆ SetPlatform() [1/3]

void Aws::EC2::Model::ImportImageRequest::SetPlatform ( const Aws::String value)
inline

The operating system of the virtual machine.

Valid values: Windows | Linux

Definition at line 725 of file ImportImageRequest.h.

◆ SetPlatform() [2/3]

void Aws::EC2::Model::ImportImageRequest::SetPlatform ( Aws::String &&  value)
inline

The operating system of the virtual machine.

Valid values: Windows | Linux

Definition at line 731 of file ImportImageRequest.h.

◆ SetPlatform() [3/3]

void Aws::EC2::Model::ImportImageRequest::SetPlatform ( const char *  value)
inline

The operating system of the virtual machine.

Valid values: Windows | Linux

Definition at line 737 of file ImportImageRequest.h.

◆ SetRoleName() [1/3]

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

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

Definition at line 771 of file ImportImageRequest.h.

◆ SetRoleName() [2/3]

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

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

Definition at line 776 of file ImportImageRequest.h.

◆ SetRoleName() [3/3]

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

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

Definition at line 781 of file ImportImageRequest.h.

◆ WithArchitecture() [1/3]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::WithArchitecture ( const Aws::String value)
inline

The architecture of the virtual machine.

Valid values: i386 | x86_64 | arm64

Definition at line 87 of file ImportImageRequest.h.

◆ WithArchitecture() [2/3]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::WithArchitecture ( Aws::String &&  value)
inline

The architecture of the virtual machine.

Valid values: i386 | x86_64 | arm64

Definition at line 93 of file ImportImageRequest.h.

◆ WithArchitecture() [3/3]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::WithArchitecture ( const char *  value)
inline

The architecture of the virtual machine.

Valid values: i386 | x86_64 | arm64

Definition at line 99 of file ImportImageRequest.h.

◆ WithClientData() [1/2]

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

The client-specific data.

Definition at line 125 of file ImportImageRequest.h.

◆ WithClientData() [2/2]

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

The client-specific data.

Definition at line 130 of file ImportImageRequest.h.

◆ WithClientToken() [1/3]

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

The token to enable idempotency for VM import requests.

Definition at line 161 of file ImportImageRequest.h.

◆ WithClientToken() [2/3]

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

The token to enable idempotency for VM import requests.

Definition at line 166 of file ImportImageRequest.h.

◆ WithClientToken() [3/3]

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

The token to enable idempotency for VM import requests.

Definition at line 171 of file ImportImageRequest.h.

◆ WithDescription() [1/3]

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

A description string for the import image task.

Definition at line 202 of file ImportImageRequest.h.

◆ WithDescription() [2/3]

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

A description string for the import image task.

Definition at line 207 of file ImportImageRequest.h.

◆ WithDescription() [3/3]

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

A description string for the import image task.

Definition at line 212 of file ImportImageRequest.h.

◆ WithDiskContainers() [1/2]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::WithDiskContainers ( const Aws::Vector< ImageDiskContainer > &  value)
inline

Information about the disk containers.

Definition at line 238 of file ImportImageRequest.h.

◆ WithDiskContainers() [2/2]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::WithDiskContainers ( Aws::Vector< ImageDiskContainer > &&  value)
inline

Information about the disk containers.

Definition at line 243 of file ImportImageRequest.h.

◆ WithDryRun()

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

◆ WithEncrypted()

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

Specifies whether the destination AMI 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 327 of file ImportImageRequest.h.

◆ WithHypervisor() [1/3]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::WithHypervisor ( const Aws::String value)
inline

The target hypervisor platform.

Valid values: xen

Definition at line 358 of file ImportImageRequest.h.

◆ WithHypervisor() [2/3]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::WithHypervisor ( Aws::String &&  value)
inline

The target hypervisor platform.

Valid values: xen

Definition at line 363 of file ImportImageRequest.h.

◆ WithHypervisor() [3/3]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::WithHypervisor ( const char *  value)
inline

The target hypervisor platform.

Valid values: xen

Definition at line 368 of file ImportImageRequest.h.

◆ WithKmsKeyId() [1/3]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::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 AMI. 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 AMI is being copied to.

Amazon EBS does not support asymmetric CMKs.

Definition at line 543 of file ImportImageRequest.h.

◆ WithKmsKeyId() [2/3]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::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 AMI. 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 AMI is being copied to.

Amazon EBS does not support asymmetric CMKs.

Definition at line 572 of file ImportImageRequest.h.

◆ WithKmsKeyId() [3/3]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::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 AMI. 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 AMI is being copied to.

Amazon EBS does not support asymmetric CMKs.

Definition at line 601 of file ImportImageRequest.h.

◆ WithLicenseSpecifications() [1/2]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::WithLicenseSpecifications ( const Aws::Vector< ImportImageLicenseConfigurationRequest > &  value)
inline

The ARNs of the license configurations.

Definition at line 822 of file ImportImageRequest.h.

◆ WithLicenseSpecifications() [2/2]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::WithLicenseSpecifications ( Aws::Vector< ImportImageLicenseConfigurationRequest > &&  value)
inline

The ARNs of the license configurations.

Definition at line 827 of file ImportImageRequest.h.

◆ WithLicenseType() [1/3]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::WithLicenseType ( const Aws::String value)
inline

The license type to be used for the Amazon Machine Image (AMI) after importing.

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify AWS to replace the source-system license with an AWS license, if appropriate. Specify BYOL to retain the source-system license, if appropriate.

To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as AWS. For more information, see Prerequisites in the VM Import/Export User Guide.

Definition at line 680 of file ImportImageRequest.h.

◆ WithLicenseType() [2/3]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::WithLicenseType ( Aws::String &&  value)
inline

The license type to be used for the Amazon Machine Image (AMI) after importing.

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify AWS to replace the source-system license with an AWS license, if appropriate. Specify BYOL to retain the source-system license, if appropriate.

To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as AWS. For more information, see Prerequisites in the VM Import/Export User Guide.

Definition at line 693 of file ImportImageRequest.h.

◆ WithLicenseType() [3/3]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::WithLicenseType ( const char *  value)
inline

The license type to be used for the Amazon Machine Image (AMI) after importing.

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify AWS to replace the source-system license with an AWS license, if appropriate. Specify BYOL to retain the source-system license, if appropriate.

To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as AWS. For more information, see Prerequisites in the VM Import/Export User Guide.

Definition at line 706 of file ImportImageRequest.h.

◆ WithPlatform() [1/3]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::WithPlatform ( const Aws::String value)
inline

The operating system of the virtual machine.

Valid values: Windows | Linux

Definition at line 743 of file ImportImageRequest.h.

◆ WithPlatform() [2/3]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::WithPlatform ( Aws::String &&  value)
inline

The operating system of the virtual machine.

Valid values: Windows | Linux

Definition at line 749 of file ImportImageRequest.h.

◆ WithPlatform() [3/3]

ImportImageRequest& Aws::EC2::Model::ImportImageRequest::WithPlatform ( const char *  value)
inline

The operating system of the virtual machine.

Valid values: Windows | Linux

Definition at line 755 of file ImportImageRequest.h.

◆ WithRoleName() [1/3]

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

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

Definition at line 786 of file ImportImageRequest.h.

◆ WithRoleName() [2/3]

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

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

Definition at line 791 of file ImportImageRequest.h.

◆ WithRoleName() [3/3]

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

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

Definition at line 796 of file ImportImageRequest.h.


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