Package software.amazon.awscdk.services.imagebuilder.alpha

Class ComponentProps.Builder

java.lang.Object

software.amazon.awscdk.services.imagebuilder.alpha.ComponentProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ComponentProps>

Enclosing interface:

ComponentProps

@Stability(Experimental)
public static final class ComponentProps.Builder
extends Object
implements software.amazon.jsii.Builder<ComponentProps>

A builder for ComponentProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ComponentProps	build()	Builds the configured instance.
ComponentProps.Builder	changeDescription(String changeDescription)	Sets the value of ComponentProps.getChangeDescription()
ComponentProps.Builder	componentName(String componentName)	Sets the value of ComponentProps.getComponentName()
ComponentProps.Builder	componentVersion(String componentVersion)	Sets the value of ComponentProps.getComponentVersion()
ComponentProps.Builder	data(ComponentData data)	Sets the value of ComponentProps.getData()
ComponentProps.Builder	description(String description)	Sets the value of ComponentProps.getDescription()
ComponentProps.Builder	kmsKey(IKey kmsKey)	Sets the value of ComponentProps.getKmsKey()
ComponentProps.Builder	platform(Platform platform)	Sets the value of ComponentProps.getPlatform()
ComponentProps.Builder	supportedOsVersions(List<? extends OSVersion> supportedOsVersions)	Sets the value of ComponentProps.getSupportedOsVersions()
ComponentProps.Builder	tags(Map<String,String> tags)	Sets the value of ComponentProps.getTags()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

data

@Stability(Experimental)
public ComponentProps.Builder data(ComponentData data)

Sets the value of ComponentProps.getData()

Parameters:

data - The component document content that defines the build, validation, or test steps to be executed during the image building process. This parameter is required.

Returns:

this

platform

@Stability(Experimental)
public ComponentProps.Builder platform(Platform platform)

Sets the value of ComponentProps.getPlatform()

Parameters:

platform - The operating system platform of the component. This parameter is required.

Returns:

this

changeDescription

@Stability(Experimental)
public ComponentProps.Builder changeDescription(String changeDescription)

Sets the value of ComponentProps.getChangeDescription()

Parameters:

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

Returns:

this

componentName

@Stability(Experimental)
public ComponentProps.Builder componentName(String componentName)

Sets the value of ComponentProps.getComponentName()

Parameters:

componentName - The name of the component.

Returns:

this

componentVersion

@Stability(Experimental)
public ComponentProps.Builder componentVersion(String componentVersion)

Sets the value of ComponentProps.getComponentVersion()

Parameters:

componentVersion - The version of the component.

Returns:

this

description

@Stability(Experimental)
public ComponentProps.Builder description(String description)

Sets the value of ComponentProps.getDescription()

Parameters:

description - The description of the component.

Returns:

this

kmsKey

@Stability(Experimental)
public ComponentProps.Builder kmsKey(IKey kmsKey)

Sets the value of ComponentProps.getKmsKey()

Parameters:

kmsKey - The KMS key used to encrypt this component.

Returns:

this

supportedOsVersions

@Stability(Experimental)
public ComponentProps.Builder supportedOsVersions(List<? extends OSVersion> supportedOsVersions)

Sets the value of ComponentProps.getSupportedOsVersions()

Parameters:

supportedOsVersions - The operating system versions supported by the component.

Returns:

this

tags

@Stability(Experimental)
public ComponentProps.Builder tags(Map<String,String> tags)

Sets the value of ComponentProps.getTags()

Parameters:

tags - The tags to apply to the component.

Returns:

this

build

@Stability(Experimental)
public ComponentProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ComponentProps>

Returns:

a new instance of ComponentProps

Throws:

NullPointerException - if any required attribute was not provided