Package 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(Stable) public static final class CloudFormationStackArtifact.Builder extends Object implements software.amazon.jsii.Builder<CloudFormationStackArtifact>
A fluent builder for CloudFormationStackArtifact.

  • Method Details

    • create

      @Stability(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(Stable) public CloudFormationStackArtifact.Builder type(ArtifactType type)
      The type of artifact.

      Parameters:
      type - The type of artifact. This parameter is required.
      Returns:
      this

    • additionalMetadataFile

      @Stability(Stable) public CloudFormationStackArtifact.Builder additionalMetadataFile(String 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.

      Default: - no additional metadata

      Parameters:
      additionalMetadataFile - A file with additional metadata entries. This parameter is required.
      Returns:
      this

    • dependencies

      @Stability(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(Stable) public CloudFormationStackArtifact.Builder displayName(String 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.

      Default: - no display name

      Parameters:
      displayName - A string that can be shown to a user to uniquely identify this artifact inside a cloud assembly tree. This parameter is required.
      Returns:
      this

    • environment

      @Stability(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(Stable) public CloudFormationStackArtifact.Builder metadata(Map<String,? extends List<? extends MetadataEntry>> 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).

      Default: - no metadata.

      Parameters:
      metadata - Associated metadata. This parameter is required.
      Returns:
      this

    • properties

      @Stability(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(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(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(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

    • properties

      @Stability(Stable) public CloudFormationStackArtifact.Builder properties(FeatureFlagReportProperties 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(Stable) public CloudFormationStackArtifact build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CloudFormationStackArtifact>
      Returns:
      a newly built instance of CloudFormationStackArtifact.