AwsCloudformationStackSetArgs

interface AwsCloudformationStackSetArgs {
administrationRoleArn?: Input<string>;
autoDeployment?: AwsCloudformationStackSetAutoDeploymentArgs;
callAs?: Input<string>;
capabilities?: Input<Input<string>[]>;
deploymentTargets: AwsCloudformationStackSetDeploymentTargetsArgs;
description?: Input<string>;
executionRoleName?: Input<string>;
managedExecution?: Input<{ active?: Input<boolean> | undefined }>;
name: Input<string>;
operationPreferences?: AwsCloudformationStackSetOperationPreferencesArgs;
parameterOverrides?: Input<AwsCloudformationParameterArgs[]>;
parameters?: Input<AwsCloudformationParameterArgs[]>;
permissionModel?: Input<string>;
region?: Input<string>;
retainStacks?: Input<boolean>;
tags?: Input<Record<string, Input<string>>>;
targetRegions: Input<Input<string>[]>;
templateFile: AwsCloudformationTemplateFileArgs;
}

Input arguments for the CloudFormation stack-set capability.

Example

CODE

const stackSetArgs: AwsCloudformationStackSetArgs = {
  name: 'securityControls',
  templateFile: { path: './templates/security.cf' },
  targetRegions: ['eu-west-1'],
  deploymentTargets: { organizationalUnitIds: ['ou-xxxx-yyyy'] },
};

Properties

`administrationRoleArn: Input<string>`

Optional StackSet administration role ARN.

`autoDeployment: AwsCloudformationStackSetAutoDeploymentArgs`

Optional stack-set auto-deployment configuration.

`callAs: Input<string>`

Optional call context (SELF, DELEGATED_ADMIN).

`capabilities: Input<Input<string>[]>`

Optional CloudFormation capabilities.

`deploymentTargets: AwsCloudformationStackSetDeploymentTargetsArgs`

Deployment target settings for stack instances. When using organizationalUnitNamePaths, pass an explicit AWS provider in component options.

`description: Input<string>`

Optional description for the stack set.

`executionRoleName: Input<string>`

Optional execution role name in target accounts.

`managedExecution: Input<{ active?: Input<boolean> | undefined }>`

Optional managed execution configuration.

`name: Input<string>`

Required stack-set purpose used to build the AWS name ({env}-{projectHash}-{purpose}).

`operationPreferences: AwsCloudformationStackSetOperationPreferencesArgs`

Optional operation preferences.

`parameterOverrides: Input<AwsCloudformationParameterArgs[]>`

Optional per-instance parameter overrides.

`parameters: Input<AwsCloudformationParameterArgs[]>`

Optional key-value parameter list for the stack set template.

`permissionModel: Input<string>`

Permission model (SELF_MANAGED or SERVICE_MANAGED).

`region: Input<string>`

Optional provider region override for stack-set resources.

`retainStacks: Input<boolean>`

Optional retain stacks setting for instance deletion.

`tags: Input<Record<string, Input<string>>>`

Optional stack-set tags merged with runtime default tags.

`targetRegions: Input<Input<string>[]>`

Regions where stack instances should be deployed. Requires at least one region, and each entry must be a non-empty string.

`templateFile: AwsCloudformationTemplateFileArgs`

CloudFormation template file input.