com.amazonaws.services.ec2.model

Class RegisterImageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.RegisterImageRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<RegisterImageRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RegisterImageRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<RegisterImageRequest>

Contains the parameters for RegisterImage.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RegisterImageRequest() Default constructor for RegisterImageRequest object.
RegisterImageRequest(String imageLocation) Constructs a new RegisterImageRequest object.

Method Summary

Modifier and Type	Method and Description
RegisterImageRequest	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 AMI.
List<String>	getBillingProducts() The billing product codes.
List<BlockDeviceMapping>	getBlockDeviceMappings() The block device mapping entries.
String	getBootMode() The boot mode of the AMI.
String	getDescription() A description for your AMI.
Request<RegisterImageRequest>	getDryRunRequest() This method is intended for internal use only.
Boolean	getEnaSupport() Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
String	getImageLocation() The full path to your AMI manifest in Amazon S3 storage.
String	getImdsSupport() Set to v2.0 to indicate that IMDSv2 is specified in the AMI.
String	getKernelId() The ID of the kernel.
String	getName() A name for your AMI.
String	getRamdiskId() The ID of the RAM disk.
String	getRootDeviceName() The device name of the root device volume (for example, /dev/sda1).
String	getSriovNetSupport() Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
List<TagSpecification>	getTagSpecifications() The tags to apply to the AMI.
String	getTpmSupport() Set to v2.0 to enable Trusted Platform Module (TPM) support.
String	getUefiData() Base64 representation of the non-volatile UEFI variable store.
String	getVirtualizationType() The type of virtualization (hvm | paravirtual).
int	hashCode()
Boolean	isEnaSupport() Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
void	setArchitecture(ArchitectureValues architecture) The architecture of the AMI.
void	setArchitecture(String architecture) The architecture of the AMI.
void	setBillingProducts(Collection<String> billingProducts) The billing product codes.
void	setBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings) The block device mapping entries.
void	setBootMode(BootModeValues bootMode) The boot mode of the AMI.
void	setBootMode(String bootMode) The boot mode of the AMI.
void	setDescription(String description) A description for your AMI.
void	setEnaSupport(Boolean enaSupport) Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
void	setImageLocation(String imageLocation) The full path to your AMI manifest in Amazon S3 storage.
void	setImdsSupport(ImdsSupportValues imdsSupport) Set to v2.0 to indicate that IMDSv2 is specified in the AMI.
void	setImdsSupport(String imdsSupport) Set to v2.0 to indicate that IMDSv2 is specified in the AMI.
void	setKernelId(String kernelId) The ID of the kernel.
void	setName(String name) A name for your AMI.
void	setRamdiskId(String ramdiskId) The ID of the RAM disk.
void	setRootDeviceName(String rootDeviceName) The device name of the root device volume (for example, /dev/sda1).
void	setSriovNetSupport(String sriovNetSupport) Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
void	setTagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to apply to the AMI.
void	setTpmSupport(String tpmSupport) Set to v2.0 to enable Trusted Platform Module (TPM) support.
void	setTpmSupport(TpmSupportValues tpmSupport) Set to v2.0 to enable Trusted Platform Module (TPM) support.
void	setUefiData(String uefiData) Base64 representation of the non-volatile UEFI variable store.
void	setVirtualizationType(String virtualizationType) The type of virtualization (hvm | paravirtual).
String	toString() Returns a string representation of this object.
RegisterImageRequest	withArchitecture(ArchitectureValues architecture) The architecture of the AMI.
RegisterImageRequest	withArchitecture(String architecture) The architecture of the AMI.
RegisterImageRequest	withBillingProducts(Collection<String> billingProducts) The billing product codes.
RegisterImageRequest	withBillingProducts(String... billingProducts) The billing product codes.
RegisterImageRequest	withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings) The block device mapping entries.
RegisterImageRequest	withBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings) The block device mapping entries.
RegisterImageRequest	withBootMode(BootModeValues bootMode) The boot mode of the AMI.
RegisterImageRequest	withBootMode(String bootMode) The boot mode of the AMI.
RegisterImageRequest	withDescription(String description) A description for your AMI.
RegisterImageRequest	withEnaSupport(Boolean enaSupport) Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
RegisterImageRequest	withImageLocation(String imageLocation) The full path to your AMI manifest in Amazon S3 storage.
RegisterImageRequest	withImdsSupport(ImdsSupportValues imdsSupport) Set to v2.0 to indicate that IMDSv2 is specified in the AMI.
RegisterImageRequest	withImdsSupport(String imdsSupport) Set to v2.0 to indicate that IMDSv2 is specified in the AMI.
RegisterImageRequest	withKernelId(String kernelId) The ID of the kernel.
RegisterImageRequest	withName(String name) A name for your AMI.
RegisterImageRequest	withRamdiskId(String ramdiskId) The ID of the RAM disk.
RegisterImageRequest	withRootDeviceName(String rootDeviceName) The device name of the root device volume (for example, /dev/sda1).
RegisterImageRequest	withSriovNetSupport(String sriovNetSupport) Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
RegisterImageRequest	withTagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to apply to the AMI.
RegisterImageRequest	withTagSpecifications(TagSpecification... tagSpecifications) The tags to apply to the AMI.
RegisterImageRequest	withTpmSupport(String tpmSupport) Set to v2.0 to enable Trusted Platform Module (TPM) support.
RegisterImageRequest	withTpmSupport(TpmSupportValues tpmSupport) Set to v2.0 to enable Trusted Platform Module (TPM) support.
RegisterImageRequest	withUefiData(String uefiData) Base64 representation of the non-volatile UEFI variable store.
RegisterImageRequest	withVirtualizationType(String virtualizationType) The type of virtualization (hvm | paravirtual).

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RegisterImageRequest

public RegisterImageRequest()

Default constructor for RegisterImageRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.

RegisterImageRequest

public RegisterImageRequest(String imageLocation)

Constructs a new RegisterImageRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

imageLocation - The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.

Method Detail

setImageLocation

public void setImageLocation(String imageLocation)

The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.

Parameters:

imageLocation - The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.

getImageLocation

public String getImageLocation()

The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.

Returns:

The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.

withImageLocation

public RegisterImageRequest withImageLocation(String imageLocation)

The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.

Parameters:

imageLocation - The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

setArchitecture

public void setArchitecture(String architecture)

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

Parameters:

architecture - The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

See Also:

ArchitectureValues

getArchitecture

public String getArchitecture()

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

Returns:

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

See Also:

ArchitectureValues

withArchitecture

public RegisterImageRequest withArchitecture(String architecture)

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

Parameters:

architecture - The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ArchitectureValues

setArchitecture

public void setArchitecture(ArchitectureValues architecture)

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

Parameters:

architecture - The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

See Also:

ArchitectureValues

withArchitecture

public RegisterImageRequest withArchitecture(ArchitectureValues architecture)

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

Parameters:

architecture - The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ArchitectureValues

getBlockDeviceMappings

public List<BlockDeviceMapping> getBlockDeviceMappings()

The block device mapping entries.

If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.

If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.

Returns:

The block device mapping entries.

If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.

If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.

setBlockDeviceMappings

public void setBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)

The block device mapping entries.

If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.

If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.

Parameters:

blockDeviceMappings - The block device mapping entries.

If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.

If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.

withBlockDeviceMappings

public RegisterImageRequest withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)

The block device mapping entries.

If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.

If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.

NOTE: This method appends the values to the existing list (if any). Use setBlockDeviceMappings(java.util.Collection) or withBlockDeviceMappings(java.util.Collection) if you want to override the existing values.

Parameters:

blockDeviceMappings - The block device mapping entries.

If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.

If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

withBlockDeviceMappings

public RegisterImageRequest withBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)

The block device mapping entries.

If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.

If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.

Parameters:

blockDeviceMappings - The block device mapping entries.

If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume.

If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

A description for your AMI.

Parameters:

description - A description for your AMI.

getDescription

public String getDescription()

A description for your AMI.

Returns:

A description for your AMI.

withDescription

public RegisterImageRequest withDescription(String description)

A description for your AMI.

Parameters:

description - A description for your AMI.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEnaSupport

public void setEnaSupport(Boolean enaSupport)

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

Parameters:

enaSupport - Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

getEnaSupport

public Boolean getEnaSupport()

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

Returns:

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

withEnaSupport

public RegisterImageRequest withEnaSupport(Boolean enaSupport)

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

Parameters:

enaSupport - Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

Returns:

Returns a reference to this object so that method calls can be chained together.

isEnaSupport

public Boolean isEnaSupport()

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

Returns:

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

setKernelId

public void setKernelId(String kernelId)

The ID of the kernel.

Parameters:

kernelId - The ID of the kernel.

getKernelId

public String getKernelId()

The ID of the kernel.

Returns:

The ID of the kernel.

withKernelId

public RegisterImageRequest withKernelId(String kernelId)

The ID of the kernel.

Parameters:

kernelId - The ID of the kernel.

Returns:

Returns a reference to this object so that method calls can be chained together.

setName

public void setName(String name)

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

Parameters:

name - A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

getName

public String getName()

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

Returns:

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

withName

public RegisterImageRequest withName(String name)

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

Parameters:

name - A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

Returns:

Returns a reference to this object so that method calls can be chained together.

getBillingProducts

public List<String> getBillingProducts()

The billing product codes. Your account must be authorized to specify billing product codes.

If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as a seller and AMI-based products in the Amazon Web Services Marketplace Seller Guide.

Returns:

The billing product codes. Your account must be authorized to specify billing product codes.

If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as a seller and AMI-based products in the Amazon Web Services Marketplace Seller Guide.

setBillingProducts

public void setBillingProducts(Collection<String> billingProducts)

The billing product codes. Your account must be authorized to specify billing product codes.

If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as a seller and AMI-based products in the Amazon Web Services Marketplace Seller Guide.

Parameters:

billingProducts - The billing product codes. Your account must be authorized to specify billing product codes.

If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as a seller and AMI-based products in the Amazon Web Services Marketplace Seller Guide.

withBillingProducts

public RegisterImageRequest withBillingProducts(String... billingProducts)

The billing product codes. Your account must be authorized to specify billing product codes.

If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as a seller and AMI-based products in the Amazon Web Services Marketplace Seller Guide.

NOTE: This method appends the values to the existing list (if any). Use setBillingProducts(java.util.Collection) or withBillingProducts(java.util.Collection) if you want to override the existing values.

Parameters:

billingProducts - The billing product codes. Your account must be authorized to specify billing product codes.

If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as a seller and AMI-based products in the Amazon Web Services Marketplace Seller Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

withBillingProducts

public RegisterImageRequest withBillingProducts(Collection<String> billingProducts)

The billing product codes. Your account must be authorized to specify billing product codes.

If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as a seller and AMI-based products in the Amazon Web Services Marketplace Seller Guide.

Parameters:

billingProducts - The billing product codes. Your account must be authorized to specify billing product codes.

If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as a seller and AMI-based products in the Amazon Web Services Marketplace Seller Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRamdiskId

public void setRamdiskId(String ramdiskId)

The ID of the RAM disk.

Parameters:

ramdiskId - The ID of the RAM disk.

getRamdiskId

public String getRamdiskId()

The ID of the RAM disk.

Returns:

The ID of the RAM disk.

withRamdiskId

public RegisterImageRequest withRamdiskId(String ramdiskId)

The ID of the RAM disk.

Parameters:

ramdiskId - The ID of the RAM disk.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRootDeviceName

public void setRootDeviceName(String rootDeviceName)

The device name of the root device volume (for example, /dev/sda1).

Parameters:

rootDeviceName - The device name of the root device volume (for example, /dev/sda1).

getRootDeviceName

public String getRootDeviceName()

The device name of the root device volume (for example, /dev/sda1).

Returns:

The device name of the root device volume (for example, /dev/sda1).

withRootDeviceName

public RegisterImageRequest withRootDeviceName(String rootDeviceName)

The device name of the root device volume (for example, /dev/sda1).

Parameters:

rootDeviceName - The device name of the root device volume (for example, /dev/sda1).

Returns:

Returns a reference to this object so that method calls can be chained together.

setSriovNetSupport

public void setSriovNetSupport(String sriovNetSupport)

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

Parameters:

sriovNetSupport - Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

getSriovNetSupport

public String getSriovNetSupport()

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

Returns:

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

withSriovNetSupport

public RegisterImageRequest withSriovNetSupport(String sriovNetSupport)

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

Parameters:

sriovNetSupport - Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVirtualizationType

public void setVirtualizationType(String virtualizationType)

The type of virtualization (hvm | paravirtual).

Default: paravirtual

Parameters:

virtualizationType - The type of virtualization (hvm | paravirtual).

Default: paravirtual

getVirtualizationType

public String getVirtualizationType()

The type of virtualization (hvm | paravirtual).

Default: paravirtual

Returns:

The type of virtualization (hvm | paravirtual).

Default: paravirtual

withVirtualizationType

public RegisterImageRequest withVirtualizationType(String virtualizationType)

The type of virtualization (hvm | paravirtual).

Default: paravirtual

Parameters:

virtualizationType - The type of virtualization (hvm | paravirtual).

Default: paravirtual

Returns:

Returns a reference to this object so that method calls can be chained together.

setBootMode

public void setBootMode(String bootMode)

The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.

The operating system contained in the AMI must be configured to support the specified boot mode.

For more information, see Boot modes in the Amazon EC2 User Guide.

Parameters:

bootMode - The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.

The operating system contained in the AMI must be configured to support the specified boot mode.

For more information, see Boot modes in the Amazon EC2 User Guide.

See Also:

BootModeValues

getBootMode

public String getBootMode()

The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.

The operating system contained in the AMI must be configured to support the specified boot mode.

For more information, see Boot modes in the Amazon EC2 User Guide.

Returns:

The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.

The operating system contained in the AMI must be configured to support the specified boot mode.

For more information, see Boot modes in the Amazon EC2 User Guide.

See Also:

BootModeValues

withBootMode

public RegisterImageRequest withBootMode(String bootMode)

The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.

The operating system contained in the AMI must be configured to support the specified boot mode.

For more information, see Boot modes in the Amazon EC2 User Guide.

Parameters:

bootMode - The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.

The operating system contained in the AMI must be configured to support the specified boot mode.

For more information, see Boot modes in the Amazon EC2 User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BootModeValues

setBootMode

public void setBootMode(BootModeValues bootMode)

The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.

The operating system contained in the AMI must be configured to support the specified boot mode.

For more information, see Boot modes in the Amazon EC2 User Guide.

Parameters:

bootMode - The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.

The operating system contained in the AMI must be configured to support the specified boot mode.

For more information, see Boot modes in the Amazon EC2 User Guide.

See Also:

BootModeValues

withBootMode

public RegisterImageRequest withBootMode(BootModeValues bootMode)

The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.

The operating system contained in the AMI must be configured to support the specified boot mode.

For more information, see Boot modes in the Amazon EC2 User Guide.

Parameters:

bootMode - The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.

The operating system contained in the AMI must be configured to support the specified boot mode.

For more information, see Boot modes in the Amazon EC2 User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BootModeValues

setTpmSupport

public void setTpmSupport(String tpmSupport)

Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.

Parameters:

tpmSupport - Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.

See Also:

TpmSupportValues

getTpmSupport

public String getTpmSupport()

Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.

Returns:

Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.

See Also:

TpmSupportValues

withTpmSupport

public RegisterImageRequest withTpmSupport(String tpmSupport)

Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.

Parameters:

tpmSupport - Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TpmSupportValues

setTpmSupport

public void setTpmSupport(TpmSupportValues tpmSupport)

Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.

Parameters:

tpmSupport - Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.

See Also:

TpmSupportValues

withTpmSupport

public RegisterImageRequest withTpmSupport(TpmSupportValues tpmSupport)

Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.

Parameters:

tpmSupport - Set to v2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TpmSupportValues

setUefiData

public void setUefiData(String uefiData)

Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.

Parameters:

uefiData - Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.

getUefiData

public String getUefiData()

Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.

Returns:

Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.

withUefiData

public RegisterImageRequest withUefiData(String uefiData)

Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.

Parameters:

uefiData - Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

setImdsSupport

public void setImdsSupport(String imdsSupport)

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

If you set the value to v2.0, make sure that your AMI software can support IMDSv2.

Parameters:

imdsSupport - Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

If you set the value to v2.0, make sure that your AMI software can support IMDSv2.

See Also:

ImdsSupportValues

getImdsSupport

public String getImdsSupport()

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

If you set the value to v2.0, make sure that your AMI software can support IMDSv2.

Returns:

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

If you set the value to v2.0, make sure that your AMI software can support IMDSv2.

See Also:

ImdsSupportValues

withImdsSupport

public RegisterImageRequest withImdsSupport(String imdsSupport)

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

If you set the value to v2.0, make sure that your AMI software can support IMDSv2.

Parameters:

imdsSupport - Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

If you set the value to v2.0, make sure that your AMI software can support IMDSv2.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ImdsSupportValues

setImdsSupport

public void setImdsSupport(ImdsSupportValues imdsSupport)

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

If you set the value to v2.0, make sure that your AMI software can support IMDSv2.

Parameters:

imdsSupport - Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

If you set the value to v2.0, make sure that your AMI software can support IMDSv2.

See Also:

ImdsSupportValues

withImdsSupport

public RegisterImageRequest withImdsSupport(ImdsSupportValues imdsSupport)

Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

If you set the value to v2.0, make sure that your AMI software can support IMDSv2.

Parameters:

imdsSupport - Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

If you set the value to v2.0, make sure that your AMI software can support IMDSv2.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ImdsSupportValues

getTagSpecifications

public List<TagSpecification> getTagSpecifications()

The tags to apply to the AMI.

To tag the AMI, the value for ResourceType must be image. If you specify another value for ResourceType, the request fails.

To tag an AMI after it has been registered, see CreateTags.

Returns:

The tags to apply to the AMI.

To tag the AMI, the value for ResourceType must be image. If you specify another value for ResourceType, the request fails.

To tag an AMI after it has been registered, see CreateTags.

setTagSpecifications

public void setTagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the AMI.

To tag the AMI, the value for ResourceType must be image. If you specify another value for ResourceType, the request fails.

To tag an AMI after it has been registered, see CreateTags.

Parameters:

tagSpecifications - The tags to apply to the AMI.

To tag the AMI, the value for ResourceType must be image. If you specify another value for ResourceType, the request fails.

To tag an AMI after it has been registered, see CreateTags.

withTagSpecifications

public RegisterImageRequest withTagSpecifications(TagSpecification... tagSpecifications)

The tags to apply to the AMI.

To tag the AMI, the value for ResourceType must be image. If you specify another value for ResourceType, the request fails.

To tag an AMI after it has been registered, see CreateTags.

NOTE: This method appends the values to the existing list (if any). Use setTagSpecifications(java.util.Collection) or withTagSpecifications(java.util.Collection) if you want to override the existing values.

Parameters:

tagSpecifications - The tags to apply to the AMI.

To tag the AMI, the value for ResourceType must be image. If you specify another value for ResourceType, the request fails.

To tag an AMI after it has been registered, see CreateTags.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTagSpecifications

public RegisterImageRequest withTagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the AMI.

To tag the AMI, the value for ResourceType must be image. If you specify another value for ResourceType, the request fails.

To tag an AMI after it has been registered, see CreateTags.

Parameters:

tagSpecifications - The tags to apply to the AMI.

To tag the AMI, the value for ResourceType must be image. If you specify another value for ResourceType, the request fails.

To tag an AMI after it has been registered, see CreateTags.

Returns:

Returns a reference to this object so that method calls can be chained together.

getDryRunRequest

public Request<RegisterImageRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<RegisterImageRequest>

toString

public 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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RegisterImageRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()