Interface AttiniCdkProps

interface AttiniCdkProps {
    app?: string;
    buildCommands?: string;
    buildExclude?: string[];
    context?: {
        [key: string]: string;
    };
    diff?: DiffProps;
    environment?: {
        [key: string]: string;
    };
    force?: boolean;
    notificationArns?: string[];
    path: string;
    plugins?: string[];
    roleArn?: string;
    runner?: string;
    stackConfiguration?: StackConfigurationProps[];
    stacks?: string[];
}

Properties

app? buildCommands? buildExclude? context? diff? environment? force? notificationArns? path plugins? roleArn? runner? stackConfiguration? stacks?

Properties

Optional Readonly app

app?: string

Passed to the CDK --app option.

Optional Readonly buildCommands

buildCommands?: string

Passed to the CDK --build option

Optional Readonly buildExclude

buildExclude?: string[]

Passed to the CDK --build-exclude option

Optional Readonly context

context?: {
    [key: string]: string;
}

Passed to the CDK --context option.

Type declaration

  • [key: string]: string

Optional Readonly diff

diff?: DiffProps

Configure if you want Attini to perform a diff check on the CDK app before any changes are applied. If there are any changes performed on the CDK app, then manual approval will be required before the changes are applied.

Optional Readonly environment

environment?: {
    [key: string]: string;
}

Environment variables that will be set in the shell for the runner job.

Type declaration

  • [key: string]: string

Optional Readonly force

force?: boolean

Passed to the CDK --force option

Optional Readonly notificationArns

notificationArns?: string[]

Passed to the CDK --notification-arns option

Readonly path

path: string

The path to the CDK project.

Optional Readonly plugins

plugins?: string[]

Passed to the CDK --plugins option

Optional Readonly roleArn

roleArn?: string

Passed to the CDK --role-arn option

Optional Readonly runner

runner?: string

A reference to an AttiniRunner to use for executing the job. Use AttiniRunner.runnerName to get a reference.

If omitted the Attini default runner will be used.

Optional Readonly stackConfiguration

stackConfiguration?: StackConfigurationProps[]

Passed to the CDK --parameters options.

Optional Readonly stacks

stacks?: string[]

Stacks to deploy.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc