Interface StackDeploymentProps

Properties for a StackDeployment

interface StackDeploymentProps {
    absoluteTemplatePath: string;
    account?: string;
    assets?: StackAsset[];
    assumeRoleArn?: string;
    constructPath: string;
    executionRoleArn?: string;
    region?: string;
    stackArtifactId: string;
    stackName: string;
    tags?: Record<string, string>;
    templateS3Uri?: string;
}

Properties

absoluteTemplatePath account? assets? assumeRoleArn? constructPath executionRoleArn? region? stackArtifactId stackName tags? templateS3Uri?

Properties

ReadonlyabsoluteTemplatePath

absoluteTemplatePath: string

Template path on disk to cloud assembly (cdk.out)

Optional Readonlyaccount

account?: string

Account where the stack should be deployed

Default

- Pipeline account

Optional Readonlyassets

assets?: StackAsset[]

Assets referenced by this stack

Default

- No assets

Optional ReadonlyassumeRoleArn

assumeRoleArn?: string

Role to assume before deploying this stack

Default

- Don't assume any role

ReadonlyconstructPath

constructPath: string

Construct path for this stack

Optional ReadonlyexecutionRoleArn

executionRoleArn?: string

Execution role to pass to CloudFormation

Default

- No execution role

Optional Readonlyregion

region?: string

Region where the stack should be deployed

Default

- Pipeline region

ReadonlystackArtifactId

stackArtifactId: string

Artifact ID for this stack

ReadonlystackName

stackName: string

Name for this stack

Optional Readonlytags

tags?: Record<string, string>

Tags to apply to the stack

Default

- No tags

Optional ReadonlytemplateS3Uri

templateS3Uri?: string

The S3 URL which points to the template asset location in the publishing bucket.

Default

- Stack template is not published

Settings

Member Visibility

On This Page

Properties