CreateImageRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ec2.model.Ec2Request
    - - software.amazon.awssdk.services.ec2.model.CreateImageRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateImageRequest.Builder,CreateImageRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateImageRequest
extends Ec2Request
implements ToCopyableBuilder<CreateImageRequest.Builder,CreateImageRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateImageRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateImageRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<BlockDeviceMapping>`	`blockDeviceMappings()` The block device mappings.
`static CreateImageRequest.Builder`	`builder()`
`String`	`description()` A description for the new image.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasBlockDeviceMappings()` Returns true if the BlockDeviceMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTagSpecifications()` Returns true if the TagSpecifications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`instanceId()` The ID of the instance.
`String`	`name()` A name for the new image.
`Boolean`	`noReboot()` By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateImageRequest.Builder>`	`serializableBuilderClass()`
`List<TagSpecification>`	`tagSpecifications()` The tags to apply to the AMI and snapshots on creation.
`CreateImageRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasBlockDeviceMappings
```
public boolean hasBlockDeviceMappings()
```
    Returns true if the BlockDeviceMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - blockDeviceMappings
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasBlockDeviceMappings() to see if a value was sent in this field.
    
    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.
  - description
```
public String description()
```
    A description for the new image.
    
    Returns:
    
    A description for the new image.
  - instanceId
```
public String instanceId()
```
    The ID of the instance.
    
    Returns:
    
    The ID of the instance.
  - name
```
public 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(_)
    
    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(_)
  - noReboot
```
public 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.
    
    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.
  - hasTagSpecifications
```
public boolean hasTagSpecifications()
```
    Returns true if the TagSpecifications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tagSpecifications
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTagSpecifications() to see if a value was sent in this field.
    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.
  - toBuilder
```
public CreateImageRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateImageRequest.Builder,CreateImageRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static CreateImageRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateImageRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateImageRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasBlockDeviceMappings

blockDeviceMappings

description

instanceId

name

noReboot

hasTagSpecifications

tagSpecifications

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields