@cdk-x/core
    Preparing search index...

    Interface AddArtifactOptions

    Input shape for CloudAssemblyBuilder.addArtifact(). Carries the artifact ID alongside the artifact data.

    interface AddArtifactOptions {
        artifactType?: ArtifactType;
        dependencies?: string[];
        displayName?: string;
        id: string;
        outputKeys?: string[];
        templateFile: string;
    }
    Index

    Properties

    artifactType? dependencies? displayName? id outputKeys? templateFile

    Properties

    artifactType?: ArtifactType

    Artifact type. Defaults to 'cdkx:stack' when omitted. File-rendering synthesizers (e.g. YamlFileSynthesizer) pass 'cdkx:local-files'.

    dependencies?: string[]

    Artifact IDs of stacks this stack depends on (optional). Inferred at synthesis time from { stackRef } tokens in the resolved template. When present, the engine uses these to order deployment waves.

    displayName?: string

    Human-readable display name.

    id: string

    Unique artifact ID within the assembly. Used as the key in artifacts.

    outputKeys?: string[]

    Keys of all outputs declared in this stack (optional). When present, the engine can resolve cross-stack output dependencies from the manifest without reading the full stack template.

    templateFile: string

    Output file name.

    Settings

    Member Visibility

    On This Page

    Properties