ImportImageRequest (AWS SDK for Java

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(value="software.amazon.awssdk:codegen")
public final class ImportImageRequest
extends Ec2Request
implements ToCopyableBuilder<ImportImageRequest.Builder,ImportImageRequest>

Contains the parameters for ImportImage.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ImportImageRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ImportImageRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`architecture()` The architecture 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`	`encrypted()` Specifies whether the destination AMI of the imported image should be encrypted.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`hypervisor()` The target hypervisor platform.
`String`	`kmsKeyId()` An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted AMI.
`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()`
`ImportImageRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - architecture
```
public 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 ClientData clientData()
```
    The client-specific data.
    
    Returns:
    
    The client-specific data.
  - clientToken
```
public String clientToken()
```
    The token to enable idempotency for VM import requests.
    
    Returns:
    
    The token to enable idempotency for VM import requests.
  - description
```
public String description()
```
    A description string for the import image task.
    
    Returns:
    
    A description string for the import image task.
  - diskContainers
```
public List<ImageDiskContainer> diskContainers()
```
    Information about the disk containers.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Information about the disk containers.
  - encrypted
```
public 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.
    
    Returns:
    
    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.
  - hypervisor
```
public String hypervisor()
```
    The target hypervisor platform.
    
    Valid values: xen
    
    Returns:
    
    The target hypervisor platform.
    
    Valid values: xen
  - kmsKeyId
```
public 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, in the form 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.
    Returns:
    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, in the form 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.
  - licenseType
```
public String licenseType()
```
    The license type to be used for the Amazon Machine Image (AMI) after importing.
    
    Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see Prerequisites in the VM Import/Export User Guide.
    
    Valid values: AWS | BYOL
    
    Returns:
    
    The license type to be used for the Amazon Machine Image (AMI) after importing.
    
    Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see Prerequisites in the VM Import/Export User Guide.
    
    Valid values: AWS | BYOL
  - platform
```
public String platform()
```
    The operating system of the virtual machine.
    
    Valid values: Windows | Linux
    
    Returns:
    
    The operating system of the virtual machine.
    
    Valid values: Windows | Linux
  - roleName
```
public 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'.
  - toBuilder
```
public ImportImageRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ImportImageRequest.Builder,ImportImageRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
    
    Returns:
    
    a builder for type T
  - builder
```
public static ImportImageRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ImportImageRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class ImportImageRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

architecture

clientData

clientToken

description

diskContainers

encrypted

hypervisor

kmsKeyId

licenseType

platform

roleName

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields