Interface AttiniSamProps

interface AttiniSamProps {
    action?: CfnAction;
    configFile?: string;
    enableTerminationProtection?: boolean;
    executionRoleArn?: string;
    parameters?: {
        [key: string]: string;
    };
    project: Project;
    stackName: string;
    stackRoleArn?: string;
    tags?: {
        [key: string]: string;
    };
    variables?: {
        [key: string]: string;
    };
}

Properties

action? configFile? enableTerminationProtection? executionRoleArn? parameters? project stackName stackRoleArn? tags? 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 parameters

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

The parameters for the stack.

For more information, see the documentation

Type declaration

  • [key: string]: string

Readonly project

project: Project

SAM project config

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.

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 tags for the stack

Type declaration

  • [key: string]: string

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