software.amazon.awssdk.services.imagebuilder.model

Interface Image.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Image.Builder,Image>, SdkBuilder<Image.Builder,Image>, SdkPojo

Enclosing class:

Image

public static interface Image.Builder
extends SdkPojo, CopyableBuilder<Image.Builder,Image>

Method Summary

Modifier and Type	Method and Description
Image.Builder	arn(String arn) The Amazon Resource Name (ARN) of the image.
Image.Builder	dateCreated(String dateCreated) The date on which this image was created.
default Image.Builder	distributionConfiguration(Consumer<DistributionConfiguration.Builder> distributionConfiguration) The distribution configuration used when creating this image.
Image.Builder	distributionConfiguration(DistributionConfiguration distributionConfiguration) The distribution configuration used when creating this image.
Image.Builder	enhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled) Collects additional information about the image being created, including the operating system (OS) version and package list.
default Image.Builder	imageRecipe(Consumer<ImageRecipe.Builder> imageRecipe) The image recipe used when creating the image.
Image.Builder	imageRecipe(ImageRecipe imageRecipe) The image recipe used when creating the image.
default Image.Builder	imageTestsConfiguration(Consumer<ImageTestsConfiguration.Builder> imageTestsConfiguration) The image tests configuration used when creating this image.
Image.Builder	imageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration) The image tests configuration used when creating this image.
default Image.Builder	infrastructureConfiguration(Consumer<InfrastructureConfiguration.Builder> infrastructureConfiguration) The infrastructure used when creating this image.
Image.Builder	infrastructureConfiguration(InfrastructureConfiguration infrastructureConfiguration) The infrastructure used when creating this image.
Image.Builder	name(String name) The name of the image.
Image.Builder	osVersion(String osVersion) The operating system version of the instance.
default Image.Builder	outputResources(Consumer<OutputResources.Builder> outputResources) The output resources produced when creating this image.
Image.Builder	outputResources(OutputResources outputResources) The output resources produced when creating this image.
Image.Builder	platform(Platform platform) The platform of the image.
Image.Builder	platform(String platform) The platform of the image.
Image.Builder	sourcePipelineArn(String sourcePipelineArn) The Amazon Resource Name (ARN) of the image pipeline that created this image.
Image.Builder	sourcePipelineName(String sourcePipelineName) The name of the image pipeline that created this image.
default Image.Builder	state(Consumer<ImageState.Builder> state) The state of the image.
Image.Builder	state(ImageState state) The state of the image.
Image.Builder	tags(Map<String,String> tags) The tags of the image.
Image.Builder	version(String version) The semantic version of the image.

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

arn

Image.Builder arn(String arn)

The Amazon Resource Name (ARN) of the image.

Parameters:

arn - The Amazon Resource Name (ARN) of the image.

Returns:

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

name

Image.Builder name(String name)

The name of the image.

Parameters:

name - The name of the image.

Returns:

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

version

Image.Builder version(String version)

The semantic version of the image.

Parameters:

version - The semantic version of the image.

Returns:

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

platform

Image.Builder platform(String platform)

The platform of the image.

Parameters:

platform - The platform of the image.

Returns:

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

See Also:

Platform, Platform

platform

Image.Builder platform(Platform platform)

The platform of the image.

Parameters:

platform - The platform of the image.

Returns:

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

See Also:

Platform, Platform

enhancedImageMetadataEnabled

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

osVersion

Image.Builder osVersion(String osVersion)

The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

Parameters:

osVersion - The operating system version of the instance. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

Returns:

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

state

Image.Builder state(ImageState state)

The state of the image.

Parameters:

state - The state of the image.

Returns:

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

state

default Image.Builder state(Consumer<ImageState.Builder> state)

The state of the image.

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

Parameters:

state - a consumer that will call methods on ImageState.Builder

Returns:

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

See Also:

state(ImageState)

imageRecipe

Image.Builder imageRecipe(ImageRecipe imageRecipe)

The image recipe used when creating the image.

Parameters:

imageRecipe - The image recipe used when creating the image.

Returns:

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

imageRecipe

default Image.Builder imageRecipe(Consumer<ImageRecipe.Builder> imageRecipe)

The image recipe used when creating the image.

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

Parameters:

imageRecipe - a consumer that will call methods on ImageRecipe.Builder

Returns:

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

See Also:

imageRecipe(ImageRecipe)

sourcePipelineName

Image.Builder sourcePipelineName(String sourcePipelineName)

The name of the image pipeline that created this image.

Parameters:

sourcePipelineName - The name of the image pipeline that created this image.

Returns:

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

sourcePipelineArn

Image.Builder sourcePipelineArn(String sourcePipelineArn)

The Amazon Resource Name (ARN) of the image pipeline that created this image.

Parameters:

sourcePipelineArn - The Amazon Resource Name (ARN) of the image pipeline that created this image.

Returns:

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

infrastructureConfiguration

Image.Builder infrastructureConfiguration(InfrastructureConfiguration infrastructureConfiguration)

The infrastructure used when creating this image.

Parameters:

infrastructureConfiguration - The infrastructure used when creating this image.

Returns:

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

infrastructureConfiguration

default Image.Builder infrastructureConfiguration(Consumer<InfrastructureConfiguration.Builder> infrastructureConfiguration)

The infrastructure used when creating this image.

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

Parameters:

infrastructureConfiguration - a consumer that will call methods on InfrastructureConfiguration.Builder

Returns:

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

See Also:

infrastructureConfiguration(InfrastructureConfiguration)

distributionConfiguration

Image.Builder distributionConfiguration(DistributionConfiguration distributionConfiguration)

The distribution configuration used when creating this image.

Parameters:

distributionConfiguration - The distribution configuration used when creating this image.

Returns:

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

distributionConfiguration

default Image.Builder distributionConfiguration(Consumer<DistributionConfiguration.Builder> distributionConfiguration)

The distribution configuration used when creating this image.

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

Parameters:

distributionConfiguration - a consumer that will call methods on DistributionConfiguration.Builder

Returns:

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

See Also:

distributionConfiguration(DistributionConfiguration)

imageTestsConfiguration

Image.Builder imageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)

The image tests configuration used when creating this image.

Parameters:

imageTestsConfiguration - The image tests configuration used when creating this image.

Returns:

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

imageTestsConfiguration

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

The image tests configuration used when creating this 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)

dateCreated

Image.Builder dateCreated(String dateCreated)

The date on which this image was created.

Parameters:

dateCreated - The date on which this image was created.

Returns:

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

outputResources

Image.Builder outputResources(OutputResources outputResources)

The output resources produced when creating this image.

Parameters:

outputResources - The output resources produced when creating this image.

Returns:

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

outputResources

default Image.Builder outputResources(Consumer<OutputResources.Builder> outputResources)

The output resources produced when creating this image.

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

Parameters:

outputResources - a consumer that will call methods on OutputResources.Builder

Returns:

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

See Also:

outputResources(OutputResources)

tags

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