Package software.amazon.awssdk.services.imagebuilder.model

Interface ImageSummary.Builder

All Superinterfaces:

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

Enclosing class:

ImageSummary

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

Method Summary

Modifier and Type	Method	Description
ImageSummary.Builder	arn(String arn)	The Amazon Resource Name (ARN) of the image.
ImageSummary.Builder	buildType(String buildType)	Indicates the type of build that created this image.
ImageSummary.Builder	buildType(BuildType buildType)	Indicates the type of build that created this image.
ImageSummary.Builder	dateCreated(String dateCreated)	The date on which Image Builder created this image.
ImageSummary.Builder	deprecationTime(Instant deprecationTime)	The time when deprecation occurs for an image resource.
ImageSummary.Builder	imageSource(String imageSource)	The origin of the base image that Image Builder used to build this image.
ImageSummary.Builder	imageSource(ImageSource imageSource)	The origin of the base image that Image Builder used to build this image.
ImageSummary.Builder	lifecycleExecutionId(String lifecycleExecutionId)	Identifies the last runtime instance of the lifecycle policy to take action on the image.
ImageSummary.Builder	name(String name)	The name of the image.
ImageSummary.Builder	osVersion(String osVersion)	The operating system version of the instances that launch from this image.
default ImageSummary.Builder	outputResources(Consumer<OutputResources.Builder> outputResources)	The output resources that Image Builder produced when it created this image.
ImageSummary.Builder	outputResources(OutputResources outputResources)	The output resources that Image Builder produced when it created this image.
ImageSummary.Builder	owner(String owner)	The owner of the image.
ImageSummary.Builder	platform(String platform)	The image operating system platform, such as Linux or Windows.
ImageSummary.Builder	platform(Platform platform)	The image operating system platform, such as Linux or Windows.
default ImageSummary.Builder	state(Consumer<ImageState.Builder> state)	The state of the image.
ImageSummary.Builder	state(ImageState state)	The state of the image.
ImageSummary.Builder	tags(Map<String,String> tags)	The tags that apply to this image.
ImageSummary.Builder	type(String type)	Specifies whether this image produces an AMI or a container image.
ImageSummary.Builder	type(ImageType type)	Specifies whether this image produces an AMI or a container image.
ImageSummary.Builder	version(String version)	The version of the image.

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

copy

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

arn

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

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

type

ImageSummary.Builder type(String type)

Specifies whether this image produces an AMI or a container image.

Parameters:

type - Specifies whether this image produces an AMI or a container image.

Returns:

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

See Also:

ImageType, ImageType

type

ImageSummary.Builder type(ImageType type)

Specifies whether this image produces an AMI or a container image.

Parameters:

type - Specifies whether this image produces an AMI or a container image.

Returns:

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

See Also:

ImageType, ImageType

version

ImageSummary.Builder version(String version)

The version of the image.

Parameters:

version - The version of the image.

Returns:

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

platform

ImageSummary.Builder platform(String platform)

The image operating system platform, such as Linux or Windows.

Parameters:

platform - The image operating system platform, such as Linux or Windows.

Returns:

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

See Also:

Platform, Platform

platform

ImageSummary.Builder platform(Platform platform)

The image operating system platform, such as Linux or Windows.

Parameters:

platform - The image operating system platform, such as Linux or Windows.

Returns:

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

See Also:

Platform, Platform

osVersion

ImageSummary.Builder osVersion(String osVersion)

The operating system version of the instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

Parameters:

osVersion - The operating system version of the instances that launch from this image. 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

ImageSummary.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 ImageSummary.Builder state(Consumer<ImageState.Builder> state)

The state of the image.

This is a convenience method 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)

owner

ImageSummary.Builder owner(String owner)

The owner of the image.

Parameters:

owner - The owner of the image.

Returns:

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

dateCreated

ImageSummary.Builder dateCreated(String dateCreated)

The date on which Image Builder created this image.

Parameters:

dateCreated - The date on which Image Builder created this image.

Returns:

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

outputResources

ImageSummary.Builder outputResources(OutputResources outputResources)

The output resources that Image Builder produced when it created this image.

Parameters:

outputResources - The output resources that Image Builder produced when it created this image.

Returns:

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

outputResources

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

The output resources that Image Builder produced when it created this image.

This is a convenience method 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

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

The tags that apply to this image.

Parameters:

tags - The tags that apply to this image.

Returns:

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

buildType

ImageSummary.Builder buildType(String buildType)

Indicates the type of build that created this image. The build can be initiated in the following ways:

• USER_INITIATED – A manual pipeline build request.

• SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

• IMPORT – A VM import created the image to use as the base image for the recipe.

Parameters:

buildType - Indicates the type of build that created this image. The build can be initiated in the following ways:

• USER_INITIATED – A manual pipeline build request.

• SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

• IMPORT – A VM import created the image to use as the base image for the recipe.

Returns:

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

See Also:

BuildType, BuildType

buildType

ImageSummary.Builder buildType(BuildType buildType)

Indicates the type of build that created this image. The build can be initiated in the following ways:

• USER_INITIATED – A manual pipeline build request.

• SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

• IMPORT – A VM import created the image to use as the base image for the recipe.

Parameters:

buildType - Indicates the type of build that created this image. The build can be initiated in the following ways:

• USER_INITIATED – A manual pipeline build request.

• SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

• IMPORT – A VM import created the image to use as the base image for the recipe.

Returns:

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

See Also:

BuildType, BuildType

imageSource

ImageSummary.Builder imageSource(String imageSource)

The origin of the base image that Image Builder used to build this image.

Parameters:

imageSource - The origin of the base image that Image Builder used to build this image.

Returns:

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

See Also:

ImageSource, ImageSource

imageSource

ImageSummary.Builder imageSource(ImageSource imageSource)

The origin of the base image that Image Builder used to build this image.

Parameters:

imageSource - The origin of the base image that Image Builder used to build this image.

Returns:

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

See Also:

ImageSource, ImageSource

deprecationTime

ImageSummary.Builder deprecationTime(Instant deprecationTime)

The time when deprecation occurs for an image resource. This can be a past or future date.

Parameters:

deprecationTime - The time when deprecation occurs for an image resource. This can be a past or future date.

Returns:

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

lifecycleExecutionId

ImageSummary.Builder lifecycleExecutionId(String lifecycleExecutionId)

Identifies the last runtime instance of the lifecycle policy to take action on the image.

Parameters:

lifecycleExecutionId - Identifies the last runtime instance of the lifecycle policy to take action on the image.

Returns:

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