Package software.amazon.awscdk.cxapi

Class CloudAssembly.Builder

java.lang.Object

software.amazon.awscdk.cxapi.CloudAssembly.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CloudAssembly>

Enclosing class:

CloudAssembly

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

A fluent builder for CloudAssembly.

Method Summary

Modifier and Type	Method	Description
CloudAssembly	build()
static CloudAssembly.Builder	create(String directory)
CloudAssembly.Builder	skipEnumCheck(Boolean skipEnumCheck)	Skip enum checks.
CloudAssembly.Builder	skipVersionCheck(Boolean skipVersionCheck)	Skip the version check.
CloudAssembly.Builder	topoSort(Boolean topoSort)	Topologically sort all artifacts.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CloudAssembly.Builder create(String directory)

Parameters:

directory - The root directory of the assembly. This parameter is required.

Returns:

a new instance of CloudAssembly.Builder.

skipEnumCheck

@Stability(Stable)
public CloudAssembly.Builder skipEnumCheck(Boolean skipEnumCheck)

Skip enum checks.

This means you may read enum values you don't know about yet. Make sure to always check the values of enums you encounter in the manifest.

Default: false

Parameters:

skipEnumCheck - Skip enum checks. This parameter is required.

Returns:

this

skipVersionCheck

@Stability(Stable)
public CloudAssembly.Builder skipVersionCheck(Boolean skipVersionCheck)

Skip the version check.

This means you may read a newer cloud assembly than the CX API is designed to support, and your application may not be aware of all features that in use in the Cloud Assembly.

Default: false

Parameters:

skipVersionCheck - Skip the version check. This parameter is required.

Returns:

this

topoSort

@Stability(Stable)
public CloudAssembly.Builder topoSort(Boolean topoSort)

Topologically sort all artifacts.

This parameter is only respected by the constructor of CloudAssembly. The property lives here for backwards compatibility reasons.

Default: true

Parameters:

topoSort - Topologically sort all artifacts. This parameter is required.

Returns:

this

build

@Stability(Stable)
public CloudAssembly build()

Specified by:

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

Returns:

a newly built instance of CloudAssembly.