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

Class ComponentDocument.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<ComponentDocument>

Enclosing interface:

ComponentDocument

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

A builder for ComponentDocument

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ComponentDocument	build()	Builds the configured instance.
ComponentDocument.Builder	constants(Map<String,? extends ComponentConstantValue> constants)	Sets the value of ComponentDocument.getConstants()
ComponentDocument.Builder	description(String description)	Sets the value of ComponentDocument.getDescription()
ComponentDocument.Builder	name(String name)	Sets the value of ComponentDocument.getName()
ComponentDocument.Builder	parameters(Map<String,? extends ComponentDocumentParameterDefinition> parameters)	Sets the value of ComponentDocument.getParameters()
ComponentDocument.Builder	phases(List<? extends ComponentDocumentPhase> phases)	Sets the value of ComponentDocument.getPhases()
ComponentDocument.Builder	schemaVersion(ComponentSchemaVersion schemaVersion)	Sets the value of ComponentDocument.getSchemaVersion()

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

phases

@Stability(Experimental)
public ComponentDocument.Builder phases(List<? extends ComponentDocumentPhase> phases)

Sets the value of ComponentDocument.getPhases()

Parameters:

phases - The phases which define the grouping of steps to run in the build and test workflows of the image build. This parameter is required.

Returns:

this

schemaVersion

@Stability(Experimental)
public ComponentDocument.Builder schemaVersion(ComponentSchemaVersion schemaVersion)

Sets the value of ComponentDocument.getSchemaVersion()

Parameters:

schemaVersion - The schema version of the component. This parameter is required.

Returns:

this

constants

@Stability(Experimental)
public ComponentDocument.Builder constants(Map<String,? extends ComponentConstantValue> constants)

Sets the value of ComponentDocument.getConstants()

Parameters:

constants - The constants to define in the document.

Returns:

this

description

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

Sets the value of ComponentDocument.getDescription()

Parameters:

description - The description of the document.

Returns:

this

name

@Stability(Experimental)
public ComponentDocument.Builder name(String name)

Sets the value of ComponentDocument.getName()

Parameters:

name - The name of the document.

Returns:

this

parameters

@Stability(Experimental)
public ComponentDocument.Builder parameters(Map<String,? extends ComponentDocumentParameterDefinition> parameters)

Sets the value of ComponentDocument.getParameters()

Parameters:

parameters - The parameters to define in the document.

Returns:

this

build

@Stability(Experimental)
public ComponentDocument build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ComponentDocument

Throws:

NullPointerException - if any required attribute was not provided