CreateImageRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.ec2.model.CreateImageRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<CreateImageRequest>, Serializable, Cloneable

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

See Also:: Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description
`CreateImageRequest()` Default constructor for CreateImageRequest object.
`CreateImageRequest(String instanceId, String name)` Constructs a new CreateImageRequest object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateImageRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`List<BlockDeviceMapping>`	`getBlockDeviceMappings()` The block device mappings.
`String`	`getDescription()` A description for the new image.
`Request<CreateImageRequest>`	`getDryRunRequest()` This method is intended for internal use only.
`String`	`getInstanceId()` The ID of the instance.
`String`	`getName()` A name for the new image.
`Boolean`	`getNoReboot()` By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image.
`List<TagSpecification>`	`getTagSpecifications()` The tags to apply to the AMI and snapshots on creation.
`int`	`hashCode()`
`Boolean`	`isNoReboot()` By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image.
`void`	`setBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)` The block device mappings.
`void`	`setDescription(String description)` A description for the new image.
`void`	`setInstanceId(String instanceId)` The ID of the instance.
`void`	`setName(String name)` A name for the new image.
`void`	`setNoReboot(Boolean noReboot)` By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image.
`void`	`setTagSpecifications(Collection<TagSpecification> tagSpecifications)` The tags to apply to the AMI and snapshots on creation.
`String`	`toString()` Returns a string representation of this object.
`CreateImageRequest`	`withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)` The block device mappings.
`CreateImageRequest`	`withBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)` The block device mappings.
`CreateImageRequest`	`withDescription(String description)` A description for the new image.
`CreateImageRequest`	`withInstanceId(String instanceId)` The ID of the instance.
`CreateImageRequest`	`withName(String name)` A name for the new image.
`CreateImageRequest`	`withNoReboot(Boolean noReboot)` By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image.
`CreateImageRequest`	`withTagSpecifications(Collection<TagSpecification> tagSpecifications)` The tags to apply to the AMI and snapshots on creation.
`CreateImageRequest`	`withTagSpecifications(TagSpecification... tagSpecifications)` The tags to apply to the AMI and snapshots on creation.

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

- Constructor Detail
  - 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 Detail
  - getBlockDeviceMappings
```
public List<BlockDeviceMapping> getBlockDeviceMappings()
```
    The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.
    
    Returns:
    
    The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.
  - setBlockDeviceMappings
```
public void setBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
```
    The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.
    
    Parameters:
    
    blockDeviceMappings - The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.
  - withBlockDeviceMappings
```
public CreateImageRequest withBlockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
```
    The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.
    
    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 mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withBlockDeviceMappings
```
public CreateImageRequest withBlockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
```
    The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.
    
    Parameters:
    
    blockDeviceMappings - The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.
    
    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.
  - 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.
  - 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.
  - getTagSpecifications
```
public List<TagSpecification> getTagSpecifications()
```
    The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.
    - To tag the AMI, the value for ResourceType must be image.
    - To tag the snapshots that are created of the root volume and of other EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.
    If you specify other values for ResourceType, the request fails.
    
    To tag an AMI or snapshot after it has been created, see CreateTags.
    Returns:
    The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.
    
    To tag the AMI, the value for ResourceType must be image.
    
    To tag the snapshots that are created of the root volume and of other EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.
    
    If you specify other values for ResourceType, the request fails.
    
    To tag an AMI or snapshot after it has been created, see CreateTags.
  - setTagSpecifications
```
public void setTagSpecifications(Collection<TagSpecification> tagSpecifications)
```
    The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.
    - To tag the AMI, the value for ResourceType must be image.
    - To tag the snapshots that are created of the root volume and of other EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.
    If you specify other values for ResourceType, the request fails.
    
    To tag an AMI or snapshot after it has been created, see CreateTags.
    Parameters:
    tagSpecifications - The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.
    
    To tag the AMI, the value for ResourceType must be image.
    
    To tag the snapshots that are created of the root volume and of other EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.
    
    If you specify other values for ResourceType, the request fails.
    
    To tag an AMI or snapshot after it has been created, see CreateTags.
  - withTagSpecifications
```
public CreateImageRequest withTagSpecifications(TagSpecification... tagSpecifications)
```
    The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.
    - To tag the AMI, the value for ResourceType must be image.
    - To tag the snapshots that are created of the root volume and of other EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.
    If you specify other values for ResourceType, the request fails.
    
    To tag an AMI or snapshot after it has been created, 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 and snapshots on creation. You can tag the AMI, the snapshots, or both.
    
    To tag the AMI, the value for ResourceType must be image.
    
    To tag the snapshots that are created of the root volume and of other EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.
    
    If you specify other values for ResourceType, the request fails.
    
    To tag an AMI or snapshot after it has been created, see CreateTags.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTagSpecifications
```
public CreateImageRequest withTagSpecifications(Collection<TagSpecification> tagSpecifications)
```
    The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.
    - To tag the AMI, the value for ResourceType must be image.
    - To tag the snapshots that are created of the root volume and of other EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.
    If you specify other values for ResourceType, the request fails.
    
    To tag an AMI or snapshot after it has been created, see CreateTags.
    Parameters:
    tagSpecifications - The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.
    
    To tag the AMI, the value for ResourceType must be image.
    
    To tag the snapshots that are created of the root volume and of other EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.
    
    If you specify other values for ResourceType, the request fails.
    
    To tag an AMI or snapshot after it has been created, see CreateTags.
    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. 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 CreateImageRequest 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()

Did this page help you?

Class CreateImageRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateImageRequest

CreateImageRequest

Method Detail

getBlockDeviceMappings

setBlockDeviceMappings

withBlockDeviceMappings

withBlockDeviceMappings

setDescription

getDescription

withDescription

setInstanceId

getInstanceId

withInstanceId

setName

getName

withName

setNoReboot

getNoReboot

withNoReboot

isNoReboot

getTagSpecifications

setTagSpecifications

withTagSpecifications

withTagSpecifications

getDryRunRequest

toString

equals

hashCode

clone