software.amazon.awssdk.services.imagebuilder.model

Interface CreateImageRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateImageRequest.Builder,CreateImageRequest>, ImagebuilderRequest.Builder, SdkBuilder<CreateImageRequest.Builder,CreateImageRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateImageRequest

public static interface CreateImageRequest.Builder
extends ImagebuilderRequest.Builder, SdkPojo, CopyableBuilder<CreateImageRequest.Builder,CreateImageRequest>

Method Summary

Modifier and Type	Method and Description
CreateImageRequest.Builder	clientToken(String clientToken) The idempotency token used to make this request idempotent.
CreateImageRequest.Builder	containerRecipeArn(String containerRecipeArn) The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
CreateImageRequest.Builder	distributionConfigurationArn(String distributionConfigurationArn) The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
CreateImageRequest.Builder	enhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled) Collects additional information about the image being created, including the operating system (OS) version and package list.
CreateImageRequest.Builder	imageRecipeArn(String imageRecipeArn) The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
default CreateImageRequest.Builder	imageTestsConfiguration(Consumer<ImageTestsConfiguration.Builder> imageTestsConfiguration) The image tests configuration of the image.
CreateImageRequest.Builder	imageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration) The image tests configuration of the image.
CreateImageRequest.Builder	infrastructureConfigurationArn(String infrastructureConfigurationArn) The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
CreateImageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateImageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateImageRequest.Builder	tags(Map<String,String> tags) The tags of the image.

Methods inherited from interface software.amazon.awssdk.services.imagebuilder.model.ImagebuilderRequest.Builder

build

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

overrideConfiguration

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

equalsBySdkFields, 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

imageRecipeArn

CreateImageRequest.Builder imageRecipeArn(String imageRecipeArn)

The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

Parameters:

imageRecipeArn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

Returns:

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

containerRecipeArn

CreateImageRequest.Builder containerRecipeArn(String containerRecipeArn)

The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

Parameters:

containerRecipeArn - The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

Returns:

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

distributionConfigurationArn

CreateImageRequest.Builder distributionConfigurationArn(String distributionConfigurationArn)

The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

Parameters:

distributionConfigurationArn - The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

Returns:

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

infrastructureConfigurationArn

CreateImageRequest.Builder infrastructureConfigurationArn(String infrastructureConfigurationArn)

The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

Parameters:

infrastructureConfigurationArn - The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

Returns:

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

imageTestsConfiguration

CreateImageRequest.Builder imageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)

The image tests configuration of the image.

Parameters:

imageTestsConfiguration - The image tests configuration of the image.

Returns:

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

imageTestsConfiguration

default CreateImageRequest.Builder imageTestsConfiguration(Consumer<ImageTestsConfiguration.Builder> imageTestsConfiguration)

The image tests configuration of the image.

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

Parameters:

imageTestsConfiguration - a consumer that will call methods on ImageTestsConfiguration.Builder

Returns:

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

See Also:

imageTestsConfiguration(ImageTestsConfiguration)

enhancedImageMetadataEnabled

CreateImageRequest.Builder enhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)

Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

Parameters:

enhancedImageMetadataEnabled - Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

Returns:

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

tags

CreateImageRequest.Builder tags(Map<String,String> tags)

The tags of the image.

Parameters:

tags - The tags of the image.

Returns:

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

clientToken

CreateImageRequest.Builder clientToken(String clientToken)

The idempotency token used to make this request idempotent.

Parameters:

clientToken - The idempotency token used to make this request idempotent.

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.