com.amazonaws.services.ec2.model.ImportImageRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.ImportImageRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ImportImageRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* The architecture of the virtual machine.
*
*
* Valid values: i386 | x86_64
*
*/
private String architecture;
/**
*
* The client-specific data.
*
*/
private ClientData clientData;
/**
*
* The token to enable idempotency for VM import requests.
*
*/
private String clientToken;
/**
*
* A description string for the import image task.
*
*/
private String description;
/**
*
* Information about the disk containers.
*
*/
private com.amazonaws.internal.SdkInternalList diskContainers;
/**
*
* 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.
*
*/
private Boolean encrypted;
/**
*
* The target hypervisor platform.
*
*
* Valid values: xen
*
*/
private String hypervisor;
/**
*
* 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, the Encrypted flag must also be set.
*
*
* The KMS key 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 key, the
* Amazon Web Services account ID of the key owner, the alias namespace, and then the key 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 key,
* the Amazon Web Services account ID of the key owner, the key 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, the alias 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.
*
*/
private String kmsKeyId;
/**
*
* 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 or
* BYOL to retain the source-system license. Leaving this parameter undefined is the same as choosing
* AWS when importing a Windows Server operating system, and the same as choosing BYOL
* 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.
*
*/
private String licenseType;
/**
*
* The operating system of the virtual machine.
*
*
* Valid values: Windows | Linux
*
*/
private String platform;
/**
*
* The name of the role to use when not using the default role, 'vmimport'.
*
*/
private String roleName;
/**
*
* The ARNs of the license configurations.
*
*/
private com.amazonaws.internal.SdkInternalList licenseSpecifications;
/**
*
* The tags to apply to the import image task during creation.
*
*/
private com.amazonaws.internal.SdkInternalList tagSpecifications;
/**
*
* The usage operation value. For more information, see Licensing
* options in the VM Import/Export User Guide.
*
*/
private String usageOperation;
/**
*
* The boot mode of the virtual machine.
*
*/
private String bootMode;
/**
*
* The architecture of the virtual machine.
*
*
* Valid values: i386 | x86_64
*
*
* @param architecture
* The architecture of the virtual machine.
*
* Valid values: i386 | x86_64
*/
public void setArchitecture(String architecture) {
this.architecture = architecture;
}
/**
*
* The architecture of the virtual machine.
*
*
* Valid values: i386 | x86_64
*
*
* @return The architecture of the virtual machine.
*
* Valid values: i386 | x86_64
*/
public String getArchitecture() {
return this.architecture;
}
/**
*
* The architecture of the virtual machine.
*
*
* Valid values: i386 | x86_64
*
*
* @param architecture
* The architecture of the virtual machine.
*
* Valid values: i386 | x86_64
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportImageRequest withArchitecture(String architecture) {
setArchitecture(architecture);
return this;
}
/**
*
* The client-specific data.
*
*
* @param clientData
* The client-specific data.
*/
public void setClientData(ClientData clientData) {
this.clientData = clientData;
}
/**
*
* The client-specific data.
*
*
* @return The client-specific data.
*/
public ClientData getClientData() {
return this.clientData;
}
/**
*
* The client-specific data.
*
*
* @param clientData
* The client-specific data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportImageRequest withClientData(ClientData clientData) {
setClientData(clientData);
return this;
}
/**
*
* The token to enable idempotency for VM import requests.
*
*
* @param clientToken
* The token to enable idempotency for VM import requests.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* The token to enable idempotency for VM import requests.
*
*
* @return The token to enable idempotency for VM import requests.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* The token to enable idempotency for VM import requests.
*
*
* @param clientToken
* The token to enable idempotency for VM import requests.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportImageRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* A description string for the import image task.
*
*
* @param description
* A description string for the import image task.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A description string for the import image task.
*
*
* @return A description string for the import image task.
*/
public String getDescription() {
return this.description;
}
/**
*
* A description string for the import image task.
*
*
* @param description
* A description string for the import image task.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportImageRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* Information about the disk containers.
*
*
* @return Information about the disk containers.
*/
public java.util.List getDiskContainers() {
if (diskContainers == null) {
diskContainers = new com.amazonaws.internal.SdkInternalList();
}
return diskContainers;
}
/**
*
* Information about the disk containers.
*
*
* @param diskContainers
* Information about the disk containers.
*/
public void setDiskContainers(java.util.Collection diskContainers) {
if (diskContainers == null) {
this.diskContainers = null;
return;
}
this.diskContainers = new com.amazonaws.internal.SdkInternalList(diskContainers);
}
/**
*
* Information about the disk containers.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setDiskContainers(java.util.Collection)} or {@link #withDiskContainers(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param diskContainers
* Information about the disk containers.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportImageRequest withDiskContainers(ImageDiskContainer... diskContainers) {
if (this.diskContainers == null) {
setDiskContainers(new com.amazonaws.internal.SdkInternalList(diskContainers.length));
}
for (ImageDiskContainer ele : diskContainers) {
this.diskContainers.add(ele);
}
return this;
}
/**
*
* Information about the disk containers.
*
*
* @param diskContainers
* Information about the disk containers.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportImageRequest withDiskContainers(java.util.Collection diskContainers) {
setDiskContainers(diskContainers);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setEncrypted(Boolean encrypted) {
this.encrypted = 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.
*
*
* @return 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.
*/
public Boolean getEncrypted() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportImageRequest withEncrypted(Boolean encrypted) {
setEncrypted(encrypted);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public Boolean isEncrypted() {
return this.encrypted;
}
/**
*
* The target hypervisor platform.
*
*
* Valid values: xen
*
*
* @param hypervisor
* The target hypervisor platform.
*
* Valid values: xen
*/
public void setHypervisor(String hypervisor) {
this.hypervisor = hypervisor;
}
/**
*
* The target hypervisor platform.
*
*
* Valid values: xen
*
*
* @return The target hypervisor platform.
*
* Valid values: xen
*/
public String getHypervisor() {
return this.hypervisor;
}
/**
*
* The target hypervisor platform.
*
*
* Valid values: xen
*
*
* @param hypervisor
* The target hypervisor platform.
*
* Valid values: xen
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportImageRequest withHypervisor(String hypervisor) {
setHypervisor(hypervisor);
return this;
}
/**
*
* 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, the Encrypted flag must also be set.
*
*
* The KMS key 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 key, the
* Amazon Web Services account ID of the key owner, the alias namespace, and then the key 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 key,
* the Amazon Web Services account ID of the key owner, the key 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, the alias 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.
*
*
* @param 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, the Encrypted flag must also be
* set.
*
* The KMS key 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
* key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the
* key 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 key, the Amazon Web Services account ID of the key owner, the key 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, the alias 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.
*/
public void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = 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, the Encrypted flag must also be set.
*
*
* The KMS key 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 key, the
* Amazon Web Services account ID of the key owner, the alias namespace, and then the key 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 key,
* the Amazon Web Services account ID of the key owner, the key 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, the alias 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.
*
*
* @return 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, the Encrypted flag must also
* be set.
*
* The KMS key 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
* key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the
* key 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 key, the Amazon Web Services account ID of the key owner, the key 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, the alias 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.
*/
public String getKmsKeyId() {
return this.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, the Encrypted flag must also be set.
*
*
* The KMS key 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 key, the
* Amazon Web Services account ID of the key owner, the alias namespace, and then the key 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 key,
* the Amazon Web Services account ID of the key owner, the key 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, the alias 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.
*
*
* @param 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, the Encrypted flag must also be
* set.
*
* The KMS key 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
* key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the
* key 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 key, the Amazon Web Services account ID of the key owner, the key 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, the alias 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportImageRequest withKmsKeyId(String kmsKeyId) {
setKmsKeyId(kmsKeyId);
return this;
}
/**
*
* 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 or
* BYOL to retain the source-system license. Leaving this parameter undefined is the same as choosing
* AWS when importing a Windows Server operating system, and the same as choosing BYOL
* 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.
*
*
* @param 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 or
* BYOL to retain the source-system license. Leaving this parameter undefined is the same as
* choosing AWS when importing a Windows Server operating system, and the same as choosing
* BYOL 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.
*/
public void setLicenseType(String licenseType) {
this.licenseType = 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 or
* BYOL to retain the source-system license. Leaving this parameter undefined is the same as choosing
* AWS when importing a Windows Server operating system, and the same as choosing BYOL
* 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.
*
*
* @return 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 or
* BYOL to retain the source-system license. Leaving this parameter undefined is the same as
* choosing AWS when importing a Windows Server operating system, and the same as choosing
* BYOL 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.
*/
public String getLicenseType() {
return this.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 or
* BYOL to retain the source-system license. Leaving this parameter undefined is the same as choosing
* AWS when importing a Windows Server operating system, and the same as choosing BYOL
* 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.
*
*
* @param 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 or
* BYOL to retain the source-system license. Leaving this parameter undefined is the same as
* choosing AWS when importing a Windows Server operating system, and the same as choosing
* BYOL 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportImageRequest withLicenseType(String licenseType) {
setLicenseType(licenseType);
return this;
}
/**
*
* The operating system of the virtual machine.
*
*
* Valid values: Windows | Linux
*
*
* @param platform
* The operating system of the virtual machine.
*
* Valid values: Windows | Linux
*/
public void setPlatform(String platform) {
this.platform = platform;
}
/**
*
* The operating system of the virtual machine.
*
*
* Valid values: Windows | Linux
*
*
* @return The operating system of the virtual machine.
*
* Valid values: Windows | Linux
*/
public String getPlatform() {
return this.platform;
}
/**
*
* The operating system of the virtual machine.
*
*
* Valid values: Windows | Linux
*
*
* @param platform
* The operating system of the virtual machine.
*
* Valid values: Windows | Linux
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportImageRequest withPlatform(String platform) {
setPlatform(platform);
return this;
}
/**
*
* The name of the role to use when not using the default role, 'vmimport'.
*
*
* @param roleName
* The name of the role to use when not using the default role, 'vmimport'.
*/
public void setRoleName(String roleName) {
this.roleName = roleName;
}
/**
*
* The name of the role to use when not using the default role, 'vmimport'.
*
*
* @return The name of the role to use when not using the default role, 'vmimport'.
*/
public String getRoleName() {
return this.roleName;
}
/**
*
* The name of the role to use when not using the default role, 'vmimport'.
*
*
* @param roleName
* The name of the role to use when not using the default role, 'vmimport'.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportImageRequest withRoleName(String roleName) {
setRoleName(roleName);
return this;
}
/**
*
* The ARNs of the license configurations.
*
*
* @return The ARNs of the license configurations.
*/
public java.util.List getLicenseSpecifications() {
if (licenseSpecifications == null) {
licenseSpecifications = new com.amazonaws.internal.SdkInternalList();
}
return licenseSpecifications;
}
/**
*
* The ARNs of the license configurations.
*
*
* @param licenseSpecifications
* The ARNs of the license configurations.
*/
public void setLicenseSpecifications(java.util.Collection licenseSpecifications) {
if (licenseSpecifications == null) {
this.licenseSpecifications = null;
return;
}
this.licenseSpecifications = new com.amazonaws.internal.SdkInternalList(licenseSpecifications);
}
/**
*
* The ARNs of the license configurations.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setLicenseSpecifications(java.util.Collection)} or
* {@link #withLicenseSpecifications(java.util.Collection)} if you want to override the existing values.
*
*
* @param licenseSpecifications
* The ARNs of the license configurations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportImageRequest withLicenseSpecifications(ImportImageLicenseConfigurationRequest... licenseSpecifications) {
if (this.licenseSpecifications == null) {
setLicenseSpecifications(new com.amazonaws.internal.SdkInternalList(licenseSpecifications.length));
}
for (ImportImageLicenseConfigurationRequest ele : licenseSpecifications) {
this.licenseSpecifications.add(ele);
}
return this;
}
/**
*
* The ARNs of the license configurations.
*
*
* @param licenseSpecifications
* The ARNs of the license configurations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportImageRequest withLicenseSpecifications(java.util.Collection licenseSpecifications) {
setLicenseSpecifications(licenseSpecifications);
return this;
}
/**
*
* The tags to apply to the import image task during creation.
*
*
* @return The tags to apply to the import image task during creation.
*/
public java.util.List getTagSpecifications() {
if (tagSpecifications == null) {
tagSpecifications = new com.amazonaws.internal.SdkInternalList();
}
return tagSpecifications;
}
/**
*
* The tags to apply to the import image task during creation.
*
*
* @param tagSpecifications
* The tags to apply to the import image task during creation.
*/
public void setTagSpecifications(java.util.Collection tagSpecifications) {
if (tagSpecifications == null) {
this.tagSpecifications = null;
return;
}
this.tagSpecifications = new com.amazonaws.internal.SdkInternalList(tagSpecifications);
}
/**
*
* The tags to apply to the import image task during creation.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTagSpecifications(java.util.Collection)} or {@link #withTagSpecifications(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param tagSpecifications
* The tags to apply to the import image task during creation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportImageRequest withTagSpecifications(TagSpecification... tagSpecifications) {
if (this.tagSpecifications == null) {
setTagSpecifications(new com.amazonaws.internal.SdkInternalList(tagSpecifications.length));
}
for (TagSpecification ele : tagSpecifications) {
this.tagSpecifications.add(ele);
}
return this;
}
/**
*
* The tags to apply to the import image task during creation.
*
*
* @param tagSpecifications
* The tags to apply to the import image task during creation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportImageRequest withTagSpecifications(java.util.Collection tagSpecifications) {
setTagSpecifications(tagSpecifications);
return this;
}
/**
*
* The usage operation value. For more information, see Licensing
* options in the VM Import/Export User Guide.
*
*
* @param usageOperation
* The usage operation value. For more information, see Licensing
* options in the VM Import/Export User Guide.
*/
public void setUsageOperation(String usageOperation) {
this.usageOperation = usageOperation;
}
/**
*
* The usage operation value. For more information, see Licensing
* options in the VM Import/Export User Guide.
*
*
* @return The usage operation value. For more information, see Licensing
* options in the VM Import/Export User Guide.
*/
public String getUsageOperation() {
return this.usageOperation;
}
/**
*
* The usage operation value. For more information, see Licensing
* options in the VM Import/Export User Guide.
*
*
* @param usageOperation
* The usage operation value. For more information, see Licensing
* options in the VM Import/Export User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ImportImageRequest withUsageOperation(String usageOperation) {
setUsageOperation(usageOperation);
return this;
}
/**
*
* The boot mode of the virtual machine.
*
*
* @param bootMode
* The boot mode of the virtual machine.
* @see BootModeValues
*/
public void setBootMode(String bootMode) {
this.bootMode = bootMode;
}
/**
*
* The boot mode of the virtual machine.
*
*
* @return The boot mode of the virtual machine.
* @see BootModeValues
*/
public String getBootMode() {
return this.bootMode;
}
/**
*
* The boot mode of the virtual machine.
*
*
* @param bootMode
* The boot mode of the virtual machine.
* @return Returns a reference to this object so that method calls can be chained together.
* @see BootModeValues
*/
public ImportImageRequest withBootMode(String bootMode) {
setBootMode(bootMode);
return this;
}
/**
*
* The boot mode of the virtual machine.
*
*
* @param bootMode
* The boot mode of the virtual machine.
* @return Returns a reference to this object so that method calls can be chained together.
* @see BootModeValues
*/
public ImportImageRequest withBootMode(BootModeValues bootMode) {
this.bootMode = bootMode.toString();
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new ImportImageRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getArchitecture() != null)
sb.append("Architecture: ").append(getArchitecture()).append(",");
if (getClientData() != null)
sb.append("ClientData: ").append(getClientData()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getDiskContainers() != null)
sb.append("DiskContainers: ").append(getDiskContainers()).append(",");
if (getEncrypted() != null)
sb.append("Encrypted: ").append(getEncrypted()).append(",");
if (getHypervisor() != null)
sb.append("Hypervisor: ").append(getHypervisor()).append(",");
if (getKmsKeyId() != null)
sb.append("KmsKeyId: ").append(getKmsKeyId()).append(",");
if (getLicenseType() != null)
sb.append("LicenseType: ").append(getLicenseType()).append(",");
if (getPlatform() != null)
sb.append("Platform: ").append(getPlatform()).append(",");
if (getRoleName() != null)
sb.append("RoleName: ").append(getRoleName()).append(",");
if (getLicenseSpecifications() != null)
sb.append("LicenseSpecifications: ").append(getLicenseSpecifications()).append(",");
if (getTagSpecifications() != null)
sb.append("TagSpecifications: ").append(getTagSpecifications()).append(",");
if (getUsageOperation() != null)
sb.append("UsageOperation: ").append(getUsageOperation()).append(",");
if (getBootMode() != null)
sb.append("BootMode: ").append(getBootMode());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ImportImageRequest == false)
return false;
ImportImageRequest other = (ImportImageRequest) obj;
if (other.getArchitecture() == null ^ this.getArchitecture() == null)
return false;
if (other.getArchitecture() != null && other.getArchitecture().equals(this.getArchitecture()) == false)
return false;
if (other.getClientData() == null ^ this.getClientData() == null)
return false;
if (other.getClientData() != null && other.getClientData().equals(this.getClientData()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getDiskContainers() == null ^ this.getDiskContainers() == null)
return false;
if (other.getDiskContainers() != null && other.getDiskContainers().equals(this.getDiskContainers()) == false)
return false;
if (other.getEncrypted() == null ^ this.getEncrypted() == null)
return false;
if (other.getEncrypted() != null && other.getEncrypted().equals(this.getEncrypted()) == false)
return false;
if (other.getHypervisor() == null ^ this.getHypervisor() == null)
return false;
if (other.getHypervisor() != null && other.getHypervisor().equals(this.getHypervisor()) == false)
return false;
if (other.getKmsKeyId() == null ^ this.getKmsKeyId() == null)
return false;
if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == false)
return false;
if (other.getLicenseType() == null ^ this.getLicenseType() == null)
return false;
if (other.getLicenseType() != null && other.getLicenseType().equals(this.getLicenseType()) == false)
return false;
if (other.getPlatform() == null ^ this.getPlatform() == null)
return false;
if (other.getPlatform() != null && other.getPlatform().equals(this.getPlatform()) == false)
return false;
if (other.getRoleName() == null ^ this.getRoleName() == null)
return false;
if (other.getRoleName() != null && other.getRoleName().equals(this.getRoleName()) == false)
return false;
if (other.getLicenseSpecifications() == null ^ this.getLicenseSpecifications() == null)
return false;
if (other.getLicenseSpecifications() != null && other.getLicenseSpecifications().equals(this.getLicenseSpecifications()) == false)
return false;
if (other.getTagSpecifications() == null ^ this.getTagSpecifications() == null)
return false;
if (other.getTagSpecifications() != null && other.getTagSpecifications().equals(this.getTagSpecifications()) == false)
return false;
if (other.getUsageOperation() == null ^ this.getUsageOperation() == null)
return false;
if (other.getUsageOperation() != null && other.getUsageOperation().equals(this.getUsageOperation()) == false)
return false;
if (other.getBootMode() == null ^ this.getBootMode() == null)
return false;
if (other.getBootMode() != null && other.getBootMode().equals(this.getBootMode()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getArchitecture() == null) ? 0 : getArchitecture().hashCode());
hashCode = prime * hashCode + ((getClientData() == null) ? 0 : getClientData().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getDiskContainers() == null) ? 0 : getDiskContainers().hashCode());
hashCode = prime * hashCode + ((getEncrypted() == null) ? 0 : getEncrypted().hashCode());
hashCode = prime * hashCode + ((getHypervisor() == null) ? 0 : getHypervisor().hashCode());
hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode());
hashCode = prime * hashCode + ((getLicenseType() == null) ? 0 : getLicenseType().hashCode());
hashCode = prime * hashCode + ((getPlatform() == null) ? 0 : getPlatform().hashCode());
hashCode = prime * hashCode + ((getRoleName() == null) ? 0 : getRoleName().hashCode());
hashCode = prime * hashCode + ((getLicenseSpecifications() == null) ? 0 : getLicenseSpecifications().hashCode());
hashCode = prime * hashCode + ((getTagSpecifications() == null) ? 0 : getTagSpecifications().hashCode());
hashCode = prime * hashCode + ((getUsageOperation() == null) ? 0 : getUsageOperation().hashCode());
hashCode = prime * hashCode + ((getBootMode() == null) ? 0 : getBootMode().hashCode());
return hashCode;
}
@Override
public ImportImageRequest clone() {
return (ImportImageRequest) super.clone();
}
}