Class RegisterImageRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.ec2.model.RegisterImageRequest
All Implemented Interfaces:
ReadLimitInfo, DryRunSupportedRequest<RegisterImageRequest>, Serializable, Cloneable

public class RegisterImageRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<RegisterImageRequest>

Contains the parameters for RegisterImage.

See Also:
  • Constructor Details

    • 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.
  • Method Details

    • setImageLocation

      public void setImageLocation(String imageLocation)

      The full path to your AMI manifest in Amazon S3 storage.

      Parameters:
      imageLocation - The full path to your AMI manifest in Amazon S3 storage.
    • getImageLocation

      public String getImageLocation()

      The full path to your AMI manifest in Amazon S3 storage.

      Returns:
      The full path to your AMI manifest in Amazon S3 storage.
    • withImageLocation

      public RegisterImageRequest withImageLocation(String imageLocation)

      The full path to your AMI manifest in Amazon S3 storage.

      Parameters:
      imageLocation - The full path to your AMI manifest in Amazon S3 storage.
      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.
    • 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.
    • 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:
    • 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:
    • 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:
    • 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:
    • 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:
    • 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.
    • 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 name of the root device (for example, /dev/sda1, or /dev/xvda).

      Parameters:
      rootDeviceName - The name of the root device (for example, /dev/sda1, or /dev/xvda).
    • getRootDeviceName

      public String getRootDeviceName()

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

      Returns:
      The name of the root device (for example, /dev/sda1, or /dev/xvda).
    • withRootDeviceName

      public RegisterImageRequest withRootDeviceName(String rootDeviceName)

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

      Parameters:
      rootDeviceName - The name of the root device (for example, /dev/sda1, or /dev/xvda).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getBlockDeviceMappings

      public List<BlockDeviceMapping> getBlockDeviceMappings()

      One or more block device mapping entries.

      Returns:
      One or more block device mapping entries.
    • setBlockDeviceMappings

      public void setBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)

      One or more block device mapping entries.

      Parameters:
      blockDeviceMappings - One or more block device mapping entries.
    • withBlockDeviceMappings

      public RegisterImageRequest withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)

      One or more block device mapping entries.

      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 - One or more block device mapping entries.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withBlockDeviceMappings

      public RegisterImageRequest withBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)

      One or more block device mapping entries.

      Parameters:
      blockDeviceMappings - One or more block device mapping entries.
      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.

      Default: paravirtual

      Parameters:
      virtualizationType - The type of virtualization.

      Default: paravirtual

    • getVirtualizationType

      public String getVirtualizationType()

      The type of virtualization.

      Default: paravirtual

      Returns:
      The type of virtualization.

      Default: paravirtual

    • withVirtualizationType

      public RegisterImageRequest withVirtualizationType(String virtualizationType)

      The type of virtualization.

      Default: paravirtual

      Parameters:
      virtualizationType - The type of virtualization.

      Default: paravirtual

      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 for the AMI and any instances that you launch from the AMI.

      There is no way to disable enhanced networking 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 for the AMI and any instances that you launch from the AMI.

      There is no way to disable enhanced networking 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 for the AMI and any instances that you launch from the AMI.

      There is no way to disable enhanced networking 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 for the AMI and any instances that you launch from the AMI.

      There is no way to disable enhanced networking 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 for the AMI and any instances that you launch from the AMI.

      There is no way to disable enhanced networking 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 for the AMI and any instances that you launch from the AMI.

      There is no way to disable enhanced networking 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.
    • 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; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • 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 request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: