software.amazon.awssdk.services.ec2.model

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

Modifier and Type	Method and Description
CreateImageRequest.Builder	blockDeviceMappings(BlockDeviceMapping... blockDeviceMappings) Information about one or more block device mappings.
CreateImageRequest.Builder	blockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings) Information about one or more block device mappings.
CreateImageRequest.Builder	blockDeviceMappings(Consumer<BlockDeviceMapping.Builder>... blockDeviceMappings) Information about one or more block device mappings.
CreateImageRequest.Builder	description(String description) A description for the new image.
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) By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image.
CreateImageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateImageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

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

copy

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

applyMutation, build

Method Detail

blockDeviceMappings

CreateImageRequest.Builder blockDeviceMappings(Collection<BlockDeviceMapping> blockDeviceMappings)

Information about one or more 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 - Information about one or more 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.

blockDeviceMappings

CreateImageRequest.Builder blockDeviceMappings(BlockDeviceMapping... blockDeviceMappings)

Information about one or more 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 - Information about one or more 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.

blockDeviceMappings

CreateImageRequest.Builder blockDeviceMappings(Consumer<BlockDeviceMapping.Builder>... blockDeviceMappings)

Information about one or more 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.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #blockDeviceMappings(List).

Parameters:

blockDeviceMappings - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#blockDeviceMappings(List)

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.

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)

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.

overrideConfiguration

CreateImageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateImageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.