Package software.amazon.awscdk.cloud_assembly_schema

Class ArtifactManifest.Builder

java.lang.Object

software.amazon.awscdk.cloud_assembly_schema.ArtifactManifest.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ArtifactManifest>

Enclosing interface:

ArtifactManifest

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

A builder for ArtifactManifest

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ArtifactManifest.Builder	additionalMetadataFile(String additionalMetadataFile)	Sets the value of ArtifactManifest.getAdditionalMetadataFile()
ArtifactManifest	build()	Builds the configured instance.
ArtifactManifest.Builder	dependencies(List<String> dependencies)	Sets the value of ArtifactManifest.getDependencies()
ArtifactManifest.Builder	displayName(String displayName)	Sets the value of ArtifactManifest.getDisplayName()
ArtifactManifest.Builder	environment(String environment)	Sets the value of ArtifactManifest.getEnvironment()
ArtifactManifest.Builder	metadata(Map<String,? extends List<? extends MetadataEntry>> metadata)	Sets the value of ArtifactManifest.getMetadata()
ArtifactManifest.Builder	properties(AssetManifestProperties properties)	Sets the value of ArtifactManifest.getProperties()
ArtifactManifest.Builder	properties(AwsCloudFormationStackProperties properties)	Sets the value of ArtifactManifest.getProperties()
ArtifactManifest.Builder	properties(FeatureFlagReportProperties properties)	Sets the value of ArtifactManifest.getProperties()
ArtifactManifest.Builder	properties(NestedCloudAssemblyProperties properties)	Sets the value of ArtifactManifest.getProperties()
ArtifactManifest.Builder	properties(TreeArtifactProperties properties)	Sets the value of ArtifactManifest.getProperties()
ArtifactManifest.Builder	type(ArtifactType type)	Sets the value of ArtifactManifest.getType()

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

type

@Stability(Stable)
public ArtifactManifest.Builder type(ArtifactType type)

Sets the value of ArtifactManifest.getType()

Parameters:

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

Returns:

this

additionalMetadataFile

@Stability(Stable)
public ArtifactManifest.Builder additionalMetadataFile(String additionalMetadataFile)

Sets the value of ArtifactManifest.getAdditionalMetadataFile()

Parameters:

additionalMetadataFile - A file with additional metadata entries. The schema of this file is exactly the same as the type of the metadata field. In other words, that file contains an object mapping construct paths to arrays of metadata entries.

Returns:

this

dependencies

@Stability(Stable)
public ArtifactManifest.Builder dependencies(List<String> dependencies)

Sets the value of ArtifactManifest.getDependencies()

Parameters:

dependencies - IDs of artifacts that must be deployed before this artifact.

Returns:

this

displayName

@Stability(Stable)
public ArtifactManifest.Builder displayName(String displayName)

Sets the value of ArtifactManifest.getDisplayName()

Parameters:

displayName - A string that can be shown to a user to uniquely identify this artifact inside a cloud assembly tree. Is used by the CLI to present a list of stacks to the user in a way that makes sense to them. Even though the property name "display name" doesn't imply it, this field is used to select stacks as well, so all stacks should have a unique display name.

Returns:

this

environment

@Stability(Stable)
public ArtifactManifest.Builder environment(String environment)

Sets the value of ArtifactManifest.getEnvironment()

Parameters:

environment - The environment into which this artifact is deployed.

Returns:

this

metadata

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

Sets the value of ArtifactManifest.getMetadata()

Parameters:

metadata - Associated metadata. Metadata can be stored directly in the assembly manifest, as well as in a separate file (see additionalMetadataFile). It should prefer to be stored in the additional file, as that will reduce the size of the assembly manifest in cases of a lot of metdata (which CDK does emit by default).

Returns:

this

properties

@Stability(Stable)
public ArtifactManifest.Builder properties(AwsCloudFormationStackProperties properties)

Sets the value of ArtifactManifest.getProperties()

Parameters:

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

Returns:

this

properties

@Stability(Stable)
public ArtifactManifest.Builder properties(AssetManifestProperties properties)

Sets the value of ArtifactManifest.getProperties()

Parameters:

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

Returns:

this

properties

@Stability(Stable)
public ArtifactManifest.Builder properties(TreeArtifactProperties properties)

Sets the value of ArtifactManifest.getProperties()

Parameters:

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

Returns:

this

properties

@Stability(Stable)
public ArtifactManifest.Builder properties(NestedCloudAssemblyProperties properties)

Sets the value of ArtifactManifest.getProperties()

Parameters:

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

Returns:

this

properties

@Stability(Stable)
public ArtifactManifest.Builder properties(FeatureFlagReportProperties properties)

Sets the value of ArtifactManifest.getProperties()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public ArtifactManifest build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ArtifactManifest

Throws:

NullPointerException - if any required attribute was not provided