Interface CreateImageRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateImageRequest.Builder,CreateImageRequest>
,Ec2Request.Builder
,SdkBuilder<CreateImageRequest.Builder,CreateImageRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- CreateImageRequest
public static interface CreateImageRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CreateImageRequest.Builder,CreateImageRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CreateImageRequest.Builder
blockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
The block device mappings.CreateImageRequest.Builder
blockDeviceMappings(Consumer<BlockDeviceMapping.Builder>... blockDeviceMappings)
The block device mappings.CreateImageRequest.Builder
blockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
The block device mappings.CreateImageRequest.Builder
description(String description)
A description for the new image.CreateImageRequest.Builder
dryRun(Boolean dryRun)
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.CreateImageRequest.Builder
instanceId(String instanceId)
The ID of the instance.CreateImageRequest.Builder
name(String name)
A name for the new image.CreateImageRequest.Builder
noReboot(Boolean noReboot)
Indicates whether or not the instance should be automatically rebooted before creating the image.CreateImageRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateImageRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateImageRequest.Builder
tagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to apply to the AMI and snapshots on creation.CreateImageRequest.Builder
tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)
The tags to apply to the AMI and snapshots on creation.CreateImageRequest.Builder
tagSpecifications(TagSpecification... tagSpecifications)
The tags to apply to the AMI and snapshots on creation.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
blockDeviceMappings
CreateImageRequest.Builder blockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)
The block device mappings.
When using the CreateImage action:
-
You can't change the volume size using the VolumeSize parameter. If you want a different volume size, you must first change the volume size of the source instance.
-
You can't modify the encryption status of existing volumes or snapshots. To create an AMI with volumes or snapshots that have a different encryption status (for example, where the source volume and snapshots are unencrypted, and you want to create an AMI with encrypted volumes or snapshots), use the CopyImage action.
-
The only option that can be changed for existing mappings or snapshots is
DeleteOnTermination
.
- Parameters:
blockDeviceMappings
- The block device mappings.When using the CreateImage action:
-
You can't change the volume size using the VolumeSize parameter. If you want a different volume size, you must first change the volume size of the source instance.
-
You can't modify the encryption status of existing volumes or snapshots. To create an AMI with volumes or snapshots that have a different encryption status (for example, where the source volume and snapshots are unencrypted, and you want to create an AMI with encrypted volumes or snapshots), use the CopyImage action.
-
The only option that can be changed for existing mappings or snapshots is
DeleteOnTermination
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
blockDeviceMappings
CreateImageRequest.Builder blockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)
The block device mappings.
When using the CreateImage action:
-
You can't change the volume size using the VolumeSize parameter. If you want a different volume size, you must first change the volume size of the source instance.
-
You can't modify the encryption status of existing volumes or snapshots. To create an AMI with volumes or snapshots that have a different encryption status (for example, where the source volume and snapshots are unencrypted, and you want to create an AMI with encrypted volumes or snapshots), use the CopyImage action.
-
The only option that can be changed for existing mappings or snapshots is
DeleteOnTermination
.
- Parameters:
blockDeviceMappings
- The block device mappings.When using the CreateImage action:
-
You can't change the volume size using the VolumeSize parameter. If you want a different volume size, you must first change the volume size of the source instance.
-
You can't modify the encryption status of existing volumes or snapshots. To create an AMI with volumes or snapshots that have a different encryption status (for example, where the source volume and snapshots are unencrypted, and you want to create an AMI with encrypted volumes or snapshots), use the CopyImage action.
-
The only option that can be changed for existing mappings or snapshots is
DeleteOnTermination
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
blockDeviceMappings
CreateImageRequest.Builder blockDeviceMappings(Consumer<BlockDeviceMapping.Builder>... blockDeviceMappings)
The block device mappings.
When using the CreateImage action:
-
You can't change the volume size using the VolumeSize parameter. If you want a different volume size, you must first change the volume size of the source instance.
-
You can't modify the encryption status of existing volumes or snapshots. To create an AMI with volumes or snapshots that have a different encryption status (for example, where the source volume and snapshots are unencrypted, and you want to create an AMI with encrypted volumes or snapshots), use the CopyImage action.
-
The only option that can be changed for existing mappings or snapshots is
DeleteOnTermination
.
BlockDeviceMapping.Builder
avoiding the need to create one manually viaBlockDeviceMapping.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#blockDeviceMappings(List
.) - Parameters:
blockDeviceMappings
- a consumer that will call methods onBlockDeviceMapping.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#blockDeviceMappings(java.util.Collection
)
-
-
description
CreateImageRequest.Builder description(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.
-
dryRun
CreateImageRequest.Builder dryRun(Boolean dryRun)
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Parameters:
dryRun
- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceId
CreateImageRequest.Builder instanceId(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.
-
name
CreateImageRequest.Builder name(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.
-
noReboot
CreateImageRequest.Builder noReboot(Boolean noReboot)
Indicates whether or not the instance should be automatically rebooted before creating the image. Specify one of the following values:
-
true
- The instance is not rebooted before creating the image. This creates crash-consistent snapshots that include only the data that has been written to the volumes at the time the snapshots are created. Buffered data and data in memory that has not yet been written to the volumes is not included in the snapshots. -
false
- The instance is rebooted before creating the image. This ensures that all buffered data and data in memory is written to the volumes before the snapshots are created.
Default:
false
- Parameters:
noReboot
- Indicates whether or not the instance should be automatically rebooted before creating the image. Specify one of the following values:-
true
- The instance is not rebooted before creating the image. This creates crash-consistent snapshots that include only the data that has been written to the volumes at the time the snapshots are created. Buffered data and data in memory that has not yet been written to the volumes is not included in the snapshots. -
false
- The instance is rebooted before creating the image. This ensures that all buffered data and data in memory is written to the volumes before the snapshots are created.
Default:
false
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
tagSpecifications
CreateImageRequest.Builder tagSpecifications(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 beimage
. -
To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for
ResourceType
must besnapshot
. 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 beimage
. -
To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for
ResourceType
must besnapshot
. 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.
-
-
tagSpecifications
CreateImageRequest.Builder tagSpecifications(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 beimage
. -
To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for
ResourceType
must besnapshot
. 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 beimage
. -
To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for
ResourceType
must besnapshot
. 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.
-
-
tagSpecifications
CreateImageRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... 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 beimage
. -
To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for
ResourceType
must besnapshot
. 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.
This is a convenience method that creates an instance of theTagSpecification.Builder
avoiding the need to create one manually viaTagSpecification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#tagSpecifications(List
.) - Parameters:
tagSpecifications
- a consumer that will call methods onTagSpecification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tagSpecifications(java.util.Collection
)
-
-
overrideConfiguration
CreateImageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
CreateImageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-