Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CloudFormationStackSetConfig

CustomizationsConfig / CustomizationConfig / CloudFormationStackSetConfig

Defines a custom CloudFormation StackSet to be deployed to the environment.

example
customizations:
  cloudFormationStackSets:
    - capabilities: [CAPABILITY_IAM, CAPABILITY_NAMED_IAM, CAPABILITY_AUTO_EXPAND]
      deploymentTargets:
        organizationalUnits:
          - Infrastructure
      description: sample desc4
      name: OrganizationalUnitStackSet
      regions:
      - us-east-1
      template: cloudformation/OUStackSet.yaml
    - capabilities: [CAPABILITY_IAM]
      deploymentTargets:
        accounts:
          - SharedServices
          - Management
      description:
      name: AccountStackSet
      regions:
      - us-east-1
      template: cloudformation/AccountStackSet.yaml

Hierarchy

  • CloudFormationStackSetConfig

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly capabilities

capabilities: undefined = undefined

The CloudFormation capabilities enabled to deploy the stackset.

see

https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStack.html

Readonly deploymentTargets

deploymentTargets: DeploymentTargets = ...

CloudFormation StackSet deployment targets

Readonly description

description: string = ''

The description is to used to provide more information about the stackset.

Readonly name

name: string = ''

The friendly name that will be used as a base for the created CloudFormation StackSet Name. The name should not contain any spaces as this isn't supported by the Accelerator.

Readonly regions

regions: ("af-south-1" | "ap-east-1" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ca-central-1" | "cn-north-1" | "cn-northwest-1" | "eu-central-1" | "eu-north-1" | "eu-south-1" | "eu-west-1" | "eu-west-2" | "eu-west-3" | "me-south-1" | "sa-east-1" | "us-east-1" | "us-east-2" | "us-gov-east-1" | "us-gov-west-1" | "us-west-1" | "us-west-2" | "us-iso-west-1" | "us-iso-east-1" | "us-isob-east-1")[] = ...

A list of regions to deploy the stackset.

Readonly template

template: string = ''

The file path to the template file used for deployment.

Generated using TypeDoc