@aws-accelerator/config
    Preparing search index...

    Interface ICloudFormationStackSet

    CustomizationsConfig / CustomizationConfig / CloudFormationStackSetConfig

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

    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
    interface ICloudFormationStackSet {
        capabilities?: CapabilityTypeEnum[];
        deploymentTargets: IDeploymentTargets;
        description?: string;
        name: string;
        regions: string[];
        template: string;
        parameters?: ICfnParameter[];
        operationPreferences?: IOperationPreferences;
        dependsOn?: string[];
        administrationRoleArn?: string;
        executionRoleName?: string;
    }
    Index

    Properties

    capabilities? deploymentTargets description? name regions template parameters? operationPreferences? dependsOn? administrationRoleArn? executionRoleName?

    Properties

    capabilities?: CapabilityTypeEnum[]

    The CloudFormation capabilities enabled to deploy the stackset.

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

    deploymentTargets: IDeploymentTargets

    CloudFormation StackSet deployment targets

    description?: string

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

    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.

    regions: string[]

    A list of regions to deploy the stackset.

    template: string

    The file path to the template file used for deployment.

    parameters?: ICfnParameter[]

    The parameters to be passed to the stackset.

    operationPreferences?: IOperationPreferences

    The operational preferences of current stackset

    dependsOn?: string[]

    The other StackSets this StackSet depends on. For stackset names you define here, a CloudFormation DependsOn attribute will be added between the resources. Please note this does not guarantee the deployment order of the stack instances within the StackSet.

    administrationRoleArn?: string

    The Amazon Resource Name (ARN) of the IAM role to use when creating this stack set. This field is optional. If specified, it allows you to set a custom IAM role for stack set operations. If left blank, the default permissions associated with your account will be used.

    executionRoleName?: string

    The name of the IAM execution role to use when creating the stack set. This field is optional. If provided, it allows you to specify a custom execution role for stack set operations. If omitted, the default execution role associated with your account will be used.

    Settings

    Member Visibility

    On This Page

    Properties