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

Interface Component.Builder

All Superinterfaces:

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

Enclosing class:

Component

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

Method Summary

Modifier and Type	Method	Description
Component.Builder	arn(String arn)	The Amazon Resource Name (ARN) of the component.
Component.Builder	changeDescription(String changeDescription)	Describes what change has been made in this version of the component, or what makes this version different from other versions of the component.
Component.Builder	data(String data)	Component data contains the YAML document content for the component.
Component.Builder	dateCreated(String dateCreated)	The date that Image Builder created the component.
Component.Builder	description(String description)	The description of the component.
Component.Builder	encrypted(Boolean encrypted)	The encryption status of the component.
Component.Builder	kmsKeyId(String kmsKeyId)	The KMS key identifier used to encrypt the component.
Component.Builder	name(String name)	The name of the component.
Component.Builder	obfuscate(Boolean obfuscate)	Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.
Component.Builder	owner(String owner)	The owner of the component.
Component.Builder	parameters(Collection<ComponentParameterDetail> parameters)	Contains parameter details for each of the parameters that the component document defined for the component.
Component.Builder	parameters(Consumer<ComponentParameterDetail.Builder>... parameters)	Contains parameter details for each of the parameters that the component document defined for the component.
Component.Builder	parameters(ComponentParameterDetail... parameters)	Contains parameter details for each of the parameters that the component document defined for the component.
Component.Builder	platform(String platform)	The operating system platform of the component.
Component.Builder	platform(Platform platform)	The operating system platform of the component.
Component.Builder	publisher(String publisher)	Contains the name of the publisher if this is a third-party component.
default Component.Builder	state(Consumer<ComponentState.Builder> state)	Describes the current status of the component.
Component.Builder	state(ComponentState state)	Describes the current status of the component.
Component.Builder	supportedOsVersions(String... supportedOsVersions)	The operating system (OS) version supported by the component.
Component.Builder	supportedOsVersions(Collection<String> supportedOsVersions)	The operating system (OS) version supported by the component.
Component.Builder	tags(Map<String,String> tags)	The tags that apply to the component.
Component.Builder	type(String type)	The component type specifies whether Image Builder uses the component to build the image or only to test it.
Component.Builder	type(ComponentType type)	The component type specifies whether Image Builder uses the component to build the image or only to test it.
Component.Builder	version(String version)	The version of the component.

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

Component.Builder arn(String arn)

The Amazon Resource Name (ARN) of the component.

Parameters:

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

Returns:

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

name

Component.Builder name(String name)

The name of the component.

Parameters:

name - The name of the component.

Returns:

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

version

Component.Builder version(String version)

The version of the component.

Parameters:

version - The version of the component.

Returns:

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

description

Component.Builder description(String description)

The description of the component.

Parameters:

description - The description of the component.

Returns:

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

changeDescription

Component.Builder changeDescription(String changeDescription)

Describes what change has been made in this version of the component, or what makes this version different from other versions of the component.

Parameters:

changeDescription - Describes what change has been made in this version of the component, or what makes this version different from other versions of the component.

Returns:

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

type

Component.Builder type(String type)

The component type specifies whether Image Builder uses the component to build the image or only to test it.

Parameters:

type - The component type specifies whether Image Builder uses the component to build the image or only to test it.

Returns:

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

See Also:

ComponentType, ComponentType

type

Component.Builder type(ComponentType type)

The component type specifies whether Image Builder uses the component to build the image or only to test it.

Parameters:

type - The component type specifies whether Image Builder uses the component to build the image or only to test it.

Returns:

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

See Also:

ComponentType, ComponentType

platform

Component.Builder platform(String platform)

The operating system platform of the component.

Parameters:

platform - The operating system platform of the component.

Returns:

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

See Also:

Platform, Platform

platform

Component.Builder platform(Platform platform)

The operating system platform of the component.

Parameters:

platform - The operating system platform of the component.

Returns:

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

See Also:

Platform, Platform

supportedOsVersions

Component.Builder supportedOsVersions(Collection<String> supportedOsVersions)

The operating system (OS) version supported by the component. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.

Parameters:

supportedOsVersions - The operating system (OS) version supported by the component. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.

Returns:

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

supportedOsVersions

Component.Builder supportedOsVersions(String... supportedOsVersions)

The operating system (OS) version supported by the component. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.

Parameters:

supportedOsVersions - The operating system (OS) version supported by the component. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.

Returns:

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

state

Component.Builder state(ComponentState state)

Describes the current status of the component. This is used for components that are no longer active.

Parameters:

state - Describes the current status of the component. This is used for components that are no longer active.

Returns:

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

state

default Component.Builder state(Consumer<ComponentState.Builder> state)

Describes the current status of the component. This is used for components that are no longer active.

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

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

Parameters:

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

Returns:

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

See Also:

state(ComponentState)

parameters

Component.Builder parameters(Collection<ComponentParameterDetail> parameters)

Contains parameter details for each of the parameters that the component document defined for the component.

Parameters:

parameters - Contains parameter details for each of the parameters that the component document defined for the component.

Returns:

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

parameters

Component.Builder parameters(ComponentParameterDetail... parameters)

Contains parameter details for each of the parameters that the component document defined for the component.

Parameters:

parameters - Contains parameter details for each of the parameters that the component document defined for the component.

Returns:

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

parameters

Component.Builder parameters(Consumer<ComponentParameterDetail.Builder>... parameters)

Contains parameter details for each of the parameters that the component document defined for the component.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #parameters(List).

Parameters:

parameters - a consumer that will call methods on ComponentParameterDetail.Builder

Returns:

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

See Also:

#parameters(java.util.Collection)

owner

Component.Builder owner(String owner)

The owner of the component.

Parameters:

owner - The owner of the component.

Returns:

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

data

Component.Builder data(String data)

Component data contains the YAML document content for the component.

Parameters:

data - Component data contains the YAML document content for the component.

Returns:

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

kmsKeyId

Component.Builder kmsKeyId(String kmsKeyId)

The KMS key identifier used to encrypt the component.

Parameters:

kmsKeyId - The KMS key identifier used to encrypt the component.

Returns:

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

encrypted

Component.Builder encrypted(Boolean encrypted)

The encryption status of the component.

Parameters:

encrypted - The encryption status of the component.

Returns:

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

dateCreated

Component.Builder dateCreated(String dateCreated)

The date that Image Builder created the component.

Parameters:

dateCreated - The date that Image Builder created the component.

Returns:

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

tags

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

The tags that apply to the component.

Parameters:

tags - The tags that apply to the component.

Returns:

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

publisher

Component.Builder publisher(String publisher)

Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.

Parameters:

publisher - Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.

Returns:

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

obfuscate

Component.Builder obfuscate(Boolean obfuscate)

Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.

Parameters:

obfuscate - Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.

Returns:

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