software.amazon.awscdk.cxapi

Class CloudFormationStackArtifact.Builder

java.lang.Object

software.amazon.awscdk.cxapi.CloudFormationStackArtifact.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CloudFormationStackArtifact>

Enclosing class:

CloudFormationStackArtifact

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

A fluent builder for CloudFormationStackArtifact.

Method Summary

Modifier and Type	Method and Description
CloudFormationStackArtifact	build()
static CloudFormationStackArtifact.Builder	create(CloudAssembly assembly, String artifactId)
CloudFormationStackArtifact.Builder	dependencies(List<String> dependencies) IDs of artifacts that must be deployed before this artifact.
CloudFormationStackArtifact.Builder	displayName(String displayName) A string that represents this artifact.
CloudFormationStackArtifact.Builder	environment(String environment) The environment into which this artifact is deployed.
CloudFormationStackArtifact.Builder	metadata(Map<String,? extends List<? extends MetadataEntry>> metadata) Associated metadata.
CloudFormationStackArtifact.Builder	properties(AssetManifestProperties properties) The set of properties for this artifact (depends on type).
CloudFormationStackArtifact.Builder	properties(AwsCloudFormationStackProperties properties) The set of properties for this artifact (depends on type).
CloudFormationStackArtifact.Builder	properties(NestedCloudAssemblyProperties properties) The set of properties for this artifact (depends on type).
CloudFormationStackArtifact.Builder	properties(TreeArtifactProperties properties) The set of properties for this artifact (depends on type).
CloudFormationStackArtifact.Builder	type(ArtifactType type) The type of artifact.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CloudFormationStackArtifact.Builder create(CloudAssembly assembly,
                                                                                  String artifactId)

Parameters:

assembly - This parameter is required.

artifactId - This parameter is required.

Returns:

a new instance of CloudFormationStackArtifact.Builder.

type

@Stability(value=Stable)
public CloudFormationStackArtifact.Builder type(ArtifactType type)

The type of artifact.

Parameters:

type - The type of artifact. This parameter is required.

Returns:

this

dependencies

@Stability(value=Stable)
public CloudFormationStackArtifact.Builder dependencies(List<String> dependencies)

IDs of artifacts that must be deployed before this artifact.

Default: - no dependencies.

Parameters:

dependencies - IDs of artifacts that must be deployed before this artifact. This parameter is required.

Returns:

this

displayName

@Stability(value=Stable)
public CloudFormationStackArtifact.Builder displayName(String displayName)

A string that represents this artifact.

Should only be used in user interfaces.

Default: - no display name

Parameters:

displayName - A string that represents this artifact. This parameter is required.

Returns:

this

environment

@Stability(value=Stable)
public CloudFormationStackArtifact.Builder environment(String environment)

The environment into which this artifact is deployed.

Default: - no envrionment.

Parameters:

environment - The environment into which this artifact is deployed. This parameter is required.

Returns:

this

metadata

@Stability(value=Stable)
public CloudFormationStackArtifact.Builder metadata(Map<String,? extends List<? extends MetadataEntry>> metadata)

Associated metadata.

Default: - no metadata.

Parameters:

metadata - Associated metadata. This parameter is required.

Returns:

this

properties

@Stability(value=Stable)
public CloudFormationStackArtifact.Builder properties(AwsCloudFormationStackProperties properties)

The set of properties for this artifact (depends on type).

Default: - no properties.

Parameters:

properties - The set of properties for this artifact (depends on type). This parameter is required.

Returns:

this

properties

@Stability(value=Stable)
public CloudFormationStackArtifact.Builder properties(AssetManifestProperties properties)

The set of properties for this artifact (depends on type).

Default: - no properties.

Parameters:

properties - The set of properties for this artifact (depends on type). This parameter is required.

Returns:

this

properties

@Stability(value=Stable)
public CloudFormationStackArtifact.Builder properties(TreeArtifactProperties properties)

The set of properties for this artifact (depends on type).

Default: - no properties.

Parameters:

properties - The set of properties for this artifact (depends on type). This parameter is required.

Returns:

this

properties

@Stability(value=Stable)
public CloudFormationStackArtifact.Builder properties(NestedCloudAssemblyProperties properties)

The set of properties for this artifact (depends on type).

Default: - no properties.

Parameters:

properties - The set of properties for this artifact (depends on type). This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CloudFormationStackArtifact build()

Specified by:

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