Class CreateImageRequest

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

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

Contains the parameters for CreateImage.

See Also:
  • Constructor Details

    • CreateImageRequest

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

      public CreateImageRequest(String instanceId, String name)
      Constructs a new CreateImageRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
      Parameters:
      instanceId - The ID of the instance.
      name - A name for the new image.

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

  • Method Details

    • setInstanceId

      public void setInstanceId(String instanceId)

      The ID of the instance.

      Parameters:
      instanceId - The ID of the instance.
    • getInstanceId

      public String getInstanceId()

      The ID of the instance.

      Returns:
      The ID of the instance.
    • withInstanceId

      public CreateImageRequest withInstanceId(String instanceId)

      The ID of the instance.

      Parameters:
      instanceId - The ID of the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setName

      public void setName(String name)

      A name for the new image.

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

      Parameters:
      name - A name for the new image.

      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 the new image.

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

      Returns:
      A name for the new image.

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

    • withName

      public CreateImageRequest withName(String name)

      A name for the new image.

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

      Parameters:
      name - A name for the new image.

      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 the new image.

      Parameters:
      description - A description for the new image.
    • getDescription

      public String getDescription()

      A description for the new image.

      Returns:
      A description for the new image.
    • withDescription

      public CreateImageRequest withDescription(String description)

      A description for the new image.

      Parameters:
      description - A description for the new image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setNoReboot

      public void setNoReboot(Boolean noReboot)

      By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

      Parameters:
      noReboot - By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.
    • getNoReboot

      public Boolean getNoReboot()

      By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

      Returns:
      By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.
    • withNoReboot

      public CreateImageRequest withNoReboot(Boolean noReboot)

      By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

      Parameters:
      noReboot - By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isNoReboot

      public Boolean isNoReboot()

      By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

      Returns:
      By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.
    • getBlockDeviceMappings

      public List<BlockDeviceMapping> getBlockDeviceMappings()

      Information about one or more block device mappings.

      Returns:
      Information about one or more block device mappings.
    • setBlockDeviceMappings

      public void setBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)

      Information about one or more block device mappings.

      Parameters:
      blockDeviceMappings - Information about one or more block device mappings.
    • withBlockDeviceMappings

      public CreateImageRequest withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)

      Information about one or more block device mappings.

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

      public CreateImageRequest withBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)

      Information about one or more block device mappings.

      Parameters:
      blockDeviceMappings - Information about one or more block device mappings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getDryRunRequest

      public Request<CreateImageRequest> 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<CreateImageRequest>
    • 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 CreateImageRequest 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: