@Generated(value="software.amazon.awssdk:codegen") public final class CreateImageRequest extends Ec2Request implements ToCopyableBuilder<CreateImageRequest.Builder,CreateImageRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateImageRequest.Builder |
| 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()
For responses, this returns true if the service returned a value for the BlockDeviceMappings property.
|
int |
hashCode() |
boolean |
hasTagSpecifications()
For responses, this returns true if the service returned a value for the TagSpecifications property.
|
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.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final boolean hasBlockDeviceMappings()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasBlockDeviceMappings() method.
public final String description()
A description for the new image.
public final String instanceId()
The ID of the instance.
public final 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(_)
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
public final 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.
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.public final boolean hasTagSpecifications()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTagSpecifications() method.
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.
public CreateImageRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateImageRequest.Builder,CreateImageRequest>toBuilder in class Ec2Requestpublic static CreateImageRequest.Builder builder()
public static Class<? extends CreateImageRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2021. All rights reserved.