Class ImportImageRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.ImportImageRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ImportImageRequest.Builder,ImportImageRequest>
@Generated("software.amazon.awssdk:codegen") public final class ImportImageRequest extends Ec2Request implements ToCopyableBuilder<ImportImageRequest.Builder,ImportImageRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ImportImageRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
architecture()
The architecture of the virtual machine.BootModeValues
bootMode()
The boot mode of the virtual machine.String
bootModeAsString()
The boot mode of the virtual machine.static ImportImageRequest.Builder
builder()
ClientData
clientData()
The client-specific data.String
clientToken()
The token to enable idempotency for VM import requests.String
description()
A description string for the import image task.List<ImageDiskContainer>
diskContainers()
Information about the disk containers.Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.Boolean
encrypted()
Specifies whether the destination AMI of the imported image should be encrypted.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasDiskContainers()
For responses, this returns true if the service returned a value for the DiskContainers property.int
hashCode()
boolean
hasLicenseSpecifications()
For responses, this returns true if the service returned a value for the LicenseSpecifications property.boolean
hasTagSpecifications()
For responses, this returns true if the service returned a value for the TagSpecifications property.String
hypervisor()
The target hypervisor platform.String
kmsKeyId()
An identifier for the symmetric KMS key to use when creating the encrypted AMI.List<ImportImageLicenseConfigurationRequest>
licenseSpecifications()
The ARNs of the license configurations.String
licenseType()
The license type to be used for the Amazon Machine Image (AMI) after importing.String
platform()
The operating system of the virtual machine.String
roleName()
The name of the role to use when not using the default role, 'vmimport'.List<SdkField<?>>
sdkFields()
static Class<? extends ImportImageRequest.Builder>
serializableBuilderClass()
List<TagSpecification>
tagSpecifications()
The tags to apply to the import image task during creation.ImportImageRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
usageOperation()
The usage operation value.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
architecture
public final String architecture()
The architecture of the virtual machine.
Valid values:
i386
|x86_64
- Returns:
- The architecture of the virtual machine.
Valid values:
i386
|x86_64
-
clientData
public final ClientData clientData()
The client-specific data.
- Returns:
- The client-specific data.
-
clientToken
public final String clientToken()
The token to enable idempotency for VM import requests.
- Returns:
- The token to enable idempotency for VM import requests.
-
description
public final String description()
A description string for the import image task.
- Returns:
- A description string for the import image task.
-
hasDiskContainers
public final boolean hasDiskContainers()
For responses, this returns true if the service returned a value for the DiskContainers property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
diskContainers
public final List<ImageDiskContainer> diskContainers()
Information about the disk containers.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDiskContainers()
method.- Returns:
- Information about the disk containers.
-
dryRun
public final Boolean dryRun()
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 isUnauthorizedOperation
.- Returns:
- 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 isUnauthorizedOperation
.
-
encrypted
public final Boolean encrypted()
Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using
KmsKeyId
. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.- Returns:
- Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for
EBS is used unless you specify a non-default KMS key using
KmsKeyId
. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
-
hypervisor
public final String hypervisor()
The target hypervisor platform.
Valid values:
xen
- Returns:
- The target hypervisor platform.
Valid values:
xen
-
kmsKeyId
public final String kmsKeyId()
An identifier for the symmetric KMS key to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a
KmsKeyId
is specified, theEncrypted
flag must also be set.The KMS key identifier may be provided in any of the following formats:
-
Key ID
-
Key alias
-
ARN using key ID. The ID ARN contains the
arn:aws:kms
namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, thekey
namespace, and then the key 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 key, the Amazon Web Services account ID of the key owner, thealias
namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services 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 KMS key must exist in the Region that the AMI is being copied to.
Amazon EBS does not support asymmetric KMS keys.
- Returns:
- An identifier for the symmetric KMS key to use when creating the encrypted AMI. This parameter is only
required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS
key for EBS is used. If a
KmsKeyId
is specified, theEncrypted
flag must also be set.The KMS key identifier may be provided in any of the following formats:
-
Key ID
-
Key alias
-
ARN using key ID. The ID ARN contains the
arn:aws:kms
namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, thekey
namespace, and then the key 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 key, the Amazon Web Services account ID of the key owner, thealias
namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services 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 KMS key must exist in the Region that the AMI is being copied to.
Amazon EBS does not support asymmetric KMS keys.
-
-
-
licenseType
public final String licenseType()
The license type to be used for the Amazon Machine Image (AMI) after importing.
Specify
AWS
to replace the source-system license with an Amazon Web Services license orBYOL
to retain the source-system license. Leaving this parameter undefined is the same as choosingAWS
when importing a Windows Server operating system, and the same as choosingBYOL
when importing a Windows client operating system (such as Windows 10) or a Linux operating system.To use
BYOL
, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see Prerequisites in the VM Import/Export User Guide.- Returns:
- The license type to be used for the Amazon Machine Image (AMI) after importing.
Specify
AWS
to replace the source-system license with an Amazon Web Services license orBYOL
to retain the source-system license. Leaving this parameter undefined is the same as choosingAWS
when importing a Windows Server operating system, and the same as choosingBYOL
when importing a Windows client operating system (such as Windows 10) or a Linux operating system.To use
BYOL
, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see Prerequisites in the VM Import/Export User Guide.
-
platform
public final String platform()
The operating system of the virtual machine. If you import a VM that is compatible with Unified Extensible Firmware Interface (UEFI) using an EBS snapshot, you must specify a value for the platform.
Valid values:
Windows
|Linux
- Returns:
- The operating system of the virtual machine. If you import a VM that is compatible with Unified
Extensible Firmware Interface (UEFI) using an EBS snapshot, you must specify a value for the
platform.
Valid values:
Windows
|Linux
-
roleName
public final String roleName()
The name of the role to use when not using the default role, 'vmimport'.
- Returns:
- The name of the role to use when not using the default role, 'vmimport'.
-
hasLicenseSpecifications
public final boolean hasLicenseSpecifications()
For responses, this returns true if the service returned a value for the LicenseSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
licenseSpecifications
public final List<ImportImageLicenseConfigurationRequest> licenseSpecifications()
The ARNs of the license configurations.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasLicenseSpecifications()
method.- Returns:
- The ARNs of the license configurations.
-
hasTagSpecifications
public final boolean hasTagSpecifications()
For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tagSpecifications
public final List<TagSpecification> tagSpecifications()
The tags to apply to the import image task during creation.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTagSpecifications()
method.- Returns:
- The tags to apply to the import image task during creation.
-
usageOperation
public final String usageOperation()
The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.
- Returns:
- The usage operation value. For more information, see Licensing options in the VM Import/Export User Guide.
-
bootMode
public final BootModeValues bootMode()
The boot mode of the virtual machine.
The
uefi-preferred
boot mode isn't supported for importing images. For more information, see Boot modes in the VM Import/Export User Guide.If the service returns an enum value that is not available in the current SDK version,
bootMode
will returnBootModeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombootModeAsString()
.- Returns:
- The boot mode of the virtual machine.
The
uefi-preferred
boot mode isn't supported for importing images. For more information, see Boot modes in the VM Import/Export User Guide. - See Also:
BootModeValues
-
bootModeAsString
public final String bootModeAsString()
The boot mode of the virtual machine.
The
uefi-preferred
boot mode isn't supported for importing images. For more information, see Boot modes in the VM Import/Export User Guide.If the service returns an enum value that is not available in the current SDK version,
bootMode
will returnBootModeValues.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombootModeAsString()
.- Returns:
- The boot mode of the virtual machine.
The
uefi-preferred
boot mode isn't supported for importing images. For more information, see Boot modes in the VM Import/Export User Guide. - See Also:
BootModeValues
-
toBuilder
public ImportImageRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ImportImageRequest.Builder,ImportImageRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static ImportImageRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ImportImageRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-