Package software.amazon.awssdk.services.ec2.model

Interface ExportImageRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ExportImageRequest.Builder,ExportImageRequest>, Ec2Request.Builder, SdkBuilder<ExportImageRequest.Builder,ExportImageRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ExportImageRequest

public static interface ExportImageRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<ExportImageRequest.Builder,ExportImageRequest>

Method Summary

Modifier and Type	Method	Description
ExportImageRequest.Builder	clientToken(String clientToken)	Token to enable idempotency for export image requests.
ExportImageRequest.Builder	description(String description)	A description of the image being exported.
ExportImageRequest.Builder	diskImageFormat(String diskImageFormat)	The disk image format.
ExportImageRequest.Builder	diskImageFormat(DiskImageFormat diskImageFormat)	The disk image format.
ExportImageRequest.Builder	dryRun(Boolean dryRun)	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
ExportImageRequest.Builder	imageId(String imageId)	The ID of the image.
ExportImageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ExportImageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
ExportImageRequest.Builder	roleName(String roleName)	The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket.
default ExportImageRequest.Builder	s3ExportLocation(Consumer<ExportTaskS3LocationRequest.Builder> s3ExportLocation)	The Amazon S3 bucket for the destination image.
ExportImageRequest.Builder	s3ExportLocation(ExportTaskS3LocationRequest s3ExportLocation)	The Amazon S3 bucket for the destination image.
ExportImageRequest.Builder	tagSpecifications(Collection<TagSpecification> tagSpecifications)	The tags to apply to the export image task during creation.
ExportImageRequest.Builder	tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)	The tags to apply to the export image task during creation.
ExportImageRequest.Builder	tagSpecifications(TagSpecification... tagSpecifications)	The tags to apply to the export image task during 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 Details

clientToken

ExportImageRequest.Builder clientToken(String clientToken)

Token to enable idempotency for export image requests.

Parameters:

clientToken - Token to enable idempotency for export image requests.

Returns:

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

description

ExportImageRequest.Builder description(String description)

A description of the image being exported. The maximum length is 255 characters.

Parameters:

description - A description of the image being exported. The maximum length is 255 characters.

Returns:

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

diskImageFormat

ExportImageRequest.Builder diskImageFormat(String diskImageFormat)

The disk image format.

Parameters:

diskImageFormat - The disk image format.

Returns:

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

See Also:

• DiskImageFormat
• DiskImageFormat

diskImageFormat

ExportImageRequest.Builder diskImageFormat(DiskImageFormat diskImageFormat)

The disk image format.

Parameters:

diskImageFormat - The disk image format.

Returns:

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

See Also:

• DiskImageFormat
• DiskImageFormat

dryRun

ExportImageRequest.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 is UnauthorizedOperation.

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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

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

imageId

ExportImageRequest.Builder imageId(String imageId)

The ID of the image.

Parameters:

imageId - The ID of the image.

Returns:

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

s3ExportLocation

ExportImageRequest.Builder s3ExportLocation(ExportTaskS3LocationRequest s3ExportLocation)

The Amazon S3 bucket for the destination image. The destination bucket must exist.

Parameters:

s3ExportLocation - The Amazon S3 bucket for the destination image. The destination bucket must exist.

Returns:

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

s3ExportLocation

default ExportImageRequest.Builder s3ExportLocation(Consumer<ExportTaskS3LocationRequest.Builder> s3ExportLocation)

The Amazon S3 bucket for the destination image. The destination bucket must exist.

This is a convenience method that creates an instance of the ExportTaskS3LocationRequest.Builder avoiding the need to create one manually via ExportTaskS3LocationRequest.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3ExportLocation(ExportTaskS3LocationRequest).

Parameters:

s3ExportLocation - a consumer that will call methods on ExportTaskS3LocationRequest.Builder

Returns:

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

See Also:

• s3ExportLocation(ExportTaskS3LocationRequest)

roleName

ExportImageRequest.Builder roleName(String roleName)

The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

Parameters:

roleName - The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

Returns:

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

tagSpecifications

ExportImageRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

The tags to apply to the export image task during creation.

Parameters:

tagSpecifications - The tags to apply to the export image task during creation.

Returns:

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

tagSpecifications

ExportImageRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

The tags to apply to the export image task during creation.

Parameters:

tagSpecifications - The tags to apply to the export image task during creation.

Returns:

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

tagSpecifications

ExportImageRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)

The tags to apply to the export image task during creation.

This is a convenience method that creates an instance of the TagSpecification.Builder avoiding the need to create one manually via TagSpecification.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagSpecifications(List<TagSpecification>).

Parameters:

tagSpecifications - a consumer that will call methods on TagSpecification.Builder

Returns:

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

See Also:

• tagSpecifications(java.util.Collection<TagSpecification>)

overrideConfiguration

ExportImageRequest.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

ExportImageRequest.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.