Interface AttiniCfnProps

interface AttiniCfnProps {
    action?: CfnAction;
    configFile?: string;
    enableTerminationProtection?: boolean;
    executionRoleArn?: string;
    outputPath?: string;
    parameters?: {
        [key: string]: string;
    };
    region?: string;
    stackName?: string;
    stackRoleArn?: string;
    tags?: {
        [key: string]: string;
    };
    template?: string;
    variables?: {
        [key: string]: string;
    };
}

Properties

action? configFile? enableTerminationProtection? executionRoleArn? outputPath? parameters? region? stackName? stackRoleArn? tags? template? variables?

Properties

Optional Readonly action

action?: CfnAction

Specify if the stack should be created/updated or deleted.

Optional Readonly configFile

configFile?: string

Specifies a path to a configuration file for the stack.

For more information, see the documentation

Optional Readonly enableTerminationProtection

enableTerminationProtection?: boolean

Specify if termination protection should be enabled for the stack.

For more information, see the AWS documentation.

Optional Readonly executionRoleArn

executionRoleArn?: string

The role that should be assumed when the Attini Framework deploys the CloudFormation stack.

The ExecutionRole has to trust the following role so that it can be assumed:

arn:aws:iam::{AccountId}:role/attini/attini-action-role-{Region}

Optional Readonly outputPath

outputPath?: string

An optional field name that the CloudFormations output should be placed under in the deployment plan payload.

Optional Readonly parameters

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

The CloudFormation parameters

Type declaration

  • [key: string]: string

Optional Readonly region

region?: string

The region that the template should be deployed to.

Optional Readonly stackName

stackName?: string

The name that should be given to the stack when deployed. The name must be unique in the Region in which you are creating the stack.

Required if it is not specified in configFile

Optional Readonly stackRoleArn

stackRoleArn?: string

The arn of the StackRole, find more info here: AWS CloudFormation service role

Optional Readonly tags

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

The CloudFormation tags

Type declaration

  • [key: string]: string

Optional Readonly template

template?: string

The path to the CloudFormation template. Can either be:

  1. A path to a file in the distribution. The path should be from the root of the project and start with a "/".
  2. A URL to a public S3 file, starting with "https://".
  3. An S3 path, starting with "s3://".

Required if it is not specified in configFile

Optional Readonly variables

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

Variables that should be passed to any configFile that is configured. Variables can be referenced in the configuration file and can be used to pass data from the payload to the configuration.

Type declaration

  • [key: string]: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc