@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ImportImageRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<ImportImageRequest>
NOOP
Constructor and Description |
---|
ImportImageRequest() |
Modifier and Type | Method and Description |
---|---|
ImportImageRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getArchitecture()
The architecture of the virtual machine.
|
ClientData |
getClientData()
The client-specific data.
|
String |
getClientToken()
The token to enable idempotency for VM import requests.
|
String |
getDescription()
A description string for the import image task.
|
List<ImageDiskContainer> |
getDiskContainers()
Information about the disk containers.
|
Request<ImportImageRequest> |
getDryRunRequest()
This method is intended for internal use only.
|
Boolean |
getEncrypted()
Specifies whether the destination AMI of the imported image should be encrypted.
|
String |
getHypervisor()
The target hypervisor platform.
|
String |
getKmsKeyId()
An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the
encrypted AMI.
|
List<ImportImageLicenseConfigurationRequest> |
getLicenseSpecifications()
The ARNs of the license configurations.
|
String |
getLicenseType()
The license type to be used for the Amazon Machine Image (AMI) after importing.
|
String |
getPlatform()
The operating system of the virtual machine.
|
String |
getRoleName()
The name of the role to use when not using the default role, 'vmimport'.
|
int |
hashCode() |
Boolean |
isEncrypted()
Specifies whether the destination AMI of the imported image should be encrypted.
|
void |
setArchitecture(String architecture)
The architecture of the virtual machine.
|
void |
setClientData(ClientData clientData)
The client-specific data.
|
void |
setClientToken(String clientToken)
The token to enable idempotency for VM import requests.
|
void |
setDescription(String description)
A description string for the import image task.
|
void |
setDiskContainers(Collection<ImageDiskContainer> diskContainers)
Information about the disk containers.
|
void |
setEncrypted(Boolean encrypted)
Specifies whether the destination AMI of the imported image should be encrypted.
|
void |
setHypervisor(String hypervisor)
The target hypervisor platform.
|
void |
setKmsKeyId(String kmsKeyId)
An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the
encrypted AMI.
|
void |
setLicenseSpecifications(Collection<ImportImageLicenseConfigurationRequest> licenseSpecifications)
The ARNs of the license configurations.
|
void |
setLicenseType(String licenseType)
The license type to be used for the Amazon Machine Image (AMI) after importing.
|
void |
setPlatform(String platform)
The operating system of the virtual machine.
|
void |
setRoleName(String roleName)
The name of the role to use when not using the default role, 'vmimport'.
|
String |
toString()
Returns a string representation of this object.
|
ImportImageRequest |
withArchitecture(String architecture)
The architecture of the virtual machine.
|
ImportImageRequest |
withClientData(ClientData clientData)
The client-specific data.
|
ImportImageRequest |
withClientToken(String clientToken)
The token to enable idempotency for VM import requests.
|
ImportImageRequest |
withDescription(String description)
A description string for the import image task.
|
ImportImageRequest |
withDiskContainers(Collection<ImageDiskContainer> diskContainers)
Information about the disk containers.
|
ImportImageRequest |
withDiskContainers(ImageDiskContainer... diskContainers)
Information about the disk containers.
|
ImportImageRequest |
withEncrypted(Boolean encrypted)
Specifies whether the destination AMI of the imported image should be encrypted.
|
ImportImageRequest |
withHypervisor(String hypervisor)
The target hypervisor platform.
|
ImportImageRequest |
withKmsKeyId(String kmsKeyId)
An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the
encrypted AMI.
|
ImportImageRequest |
withLicenseSpecifications(Collection<ImportImageLicenseConfigurationRequest> licenseSpecifications)
The ARNs of the license configurations.
|
ImportImageRequest |
withLicenseSpecifications(ImportImageLicenseConfigurationRequest... licenseSpecifications)
The ARNs of the license configurations.
|
ImportImageRequest |
withLicenseType(String licenseType)
The license type to be used for the Amazon Machine Image (AMI) after importing.
|
ImportImageRequest |
withPlatform(String platform)
The operating system of the virtual machine.
|
ImportImageRequest |
withRoleName(String roleName)
The name of the role to use when not using the default role, 'vmimport'.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setArchitecture(String architecture)
The architecture of the virtual machine.
Valid values: i386
| x86_64
| arm64
architecture
- The architecture of the virtual machine.
Valid values: i386
| x86_64
| arm64
public String getArchitecture()
The architecture of the virtual machine.
Valid values: i386
| x86_64
| arm64
Valid values: i386
| x86_64
| arm64
public ImportImageRequest withArchitecture(String architecture)
The architecture of the virtual machine.
Valid values: i386
| x86_64
| arm64
architecture
- The architecture of the virtual machine.
Valid values: i386
| x86_64
| arm64
public void setClientData(ClientData clientData)
The client-specific data.
clientData
- The client-specific data.public ClientData getClientData()
The client-specific data.
public ImportImageRequest withClientData(ClientData clientData)
The client-specific data.
clientData
- The client-specific data.public void setClientToken(String clientToken)
The token to enable idempotency for VM import requests.
clientToken
- The token to enable idempotency for VM import requests.public String getClientToken()
The token to enable idempotency for VM import requests.
public ImportImageRequest withClientToken(String clientToken)
The token to enable idempotency for VM import requests.
clientToken
- The token to enable idempotency for VM import requests.public void setDescription(String description)
A description string for the import image task.
description
- A description string for the import image task.public String getDescription()
A description string for the import image task.
public ImportImageRequest withDescription(String description)
A description string for the import image task.
description
- A description string for the import image task.public List<ImageDiskContainer> getDiskContainers()
Information about the disk containers.
public void setDiskContainers(Collection<ImageDiskContainer> diskContainers)
Information about the disk containers.
diskContainers
- Information about the disk containers.public ImportImageRequest withDiskContainers(ImageDiskContainer... diskContainers)
Information about the disk containers.
NOTE: This method appends the values to the existing list (if any). Use
setDiskContainers(java.util.Collection)
or withDiskContainers(java.util.Collection)
if you want
to override the existing values.
diskContainers
- Information about the disk containers.public ImportImageRequest withDiskContainers(Collection<ImageDiskContainer> diskContainers)
Information about the disk containers.
diskContainers
- Information about the disk containers.public void setEncrypted(Boolean encrypted)
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.
encrypted
- 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.public Boolean getEncrypted()
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.
KmsKeyId
. For more information, see Amazon EBS Encryption
in the Amazon Elastic Compute Cloud User Guide.public ImportImageRequest withEncrypted(Boolean encrypted)
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.
encrypted
- 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.public Boolean isEncrypted()
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.
KmsKeyId
. For more information, see Amazon EBS Encryption
in the Amazon Elastic Compute Cloud User Guide.public void setHypervisor(String hypervisor)
The target hypervisor platform.
Valid values: xen
hypervisor
- The target hypervisor platform.
Valid values: xen
public String getHypervisor()
The target hypervisor platform.
Valid values: xen
Valid values: xen
public ImportImageRequest withHypervisor(String hypervisor)
The target hypervisor platform.
Valid values: xen
hypervisor
- The target hypervisor platform.
Valid values: xen
public void setKmsKeyId(String kmsKeyId)
An identifier for the 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.
kmsKeyId
- An identifier for the 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.
public String getKmsKeyId()
An identifier for the 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.
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.
public ImportImageRequest withKmsKeyId(String kmsKeyId)
An identifier for the 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.
kmsKeyId
- An identifier for the 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.
public void setLicenseType(String licenseType)
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.
licenseType
- 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.
public String getLicenseType()
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.
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.
public ImportImageRequest withLicenseType(String licenseType)
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.
licenseType
- 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.
public void setPlatform(String platform)
The operating system of the virtual machine.
Valid values: Windows
| Linux
platform
- The operating system of the virtual machine.
Valid values: Windows
| Linux
public String getPlatform()
The operating system of the virtual machine.
Valid values: Windows
| Linux
Valid values: Windows
| Linux
public ImportImageRequest withPlatform(String platform)
The operating system of the virtual machine.
Valid values: Windows
| Linux
platform
- The operating system of the virtual machine.
Valid values: Windows
| Linux
public void setRoleName(String roleName)
The name of the role to use when not using the default role, 'vmimport'.
roleName
- The name of the role to use when not using the default role, 'vmimport'.public String getRoleName()
The name of the role to use when not using the default role, 'vmimport'.
public ImportImageRequest withRoleName(String roleName)
The name of the role to use when not using the default role, 'vmimport'.
roleName
- The name of the role to use when not using the default role, 'vmimport'.public List<ImportImageLicenseConfigurationRequest> getLicenseSpecifications()
The ARNs of the license configurations.
public void setLicenseSpecifications(Collection<ImportImageLicenseConfigurationRequest> licenseSpecifications)
The ARNs of the license configurations.
licenseSpecifications
- The ARNs of the license configurations.public ImportImageRequest withLicenseSpecifications(ImportImageLicenseConfigurationRequest... licenseSpecifications)
The ARNs of the license configurations.
NOTE: This method appends the values to the existing list (if any). Use
setLicenseSpecifications(java.util.Collection)
or
withLicenseSpecifications(java.util.Collection)
if you want to override the existing values.
licenseSpecifications
- The ARNs of the license configurations.public ImportImageRequest withLicenseSpecifications(Collection<ImportImageLicenseConfigurationRequest> licenseSpecifications)
The ARNs of the license configurations.
licenseSpecifications
- The ARNs of the license configurations.public Request<ImportImageRequest> getDryRunRequest()
getDryRunRequest
in interface DryRunSupportedRequest<ImportImageRequest>
public String toString()
toString
in class Object
Object.toString()
public ImportImageRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.