Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-cloudformation-stackset.json
Parent schema serverless-framework-configuration
Type: object

StackSet as a resource provides one-click experience for provisioning a StackSet and StackInstances. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-cloudformation.git

Properties

StackSetName string | Aws_CF_FunctionString required

The name to associate with the stack set. The name must be unique in the Region where you create your stack set.

PermissionModel string | Aws_CF_FunctionString required

Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.

AdministrationRoleARN string | Aws_CF_FunctionString

The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.

AutoDeployment object
2 nested properties
Enabled boolean

If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.

RetainStacksOnAccountRemoval boolean

If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.

Capabilities Capability[]

In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.

uniqueItems=true
Description string | Aws_CF_FunctionString

A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

ExecutionRoleName string | Aws_CF_FunctionString

The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

OperationPreferences object

The user-specified preferences for how AWS CloudFormation performs a stack set operation.

6 nested properties
FailureToleranceCount integer
min=0
FailureTolerancePercentage integer
min=0max=100
MaxConcurrentCount integer
min=1
MaxConcurrentPercentage integer
min=0max=100
RegionOrder Region[]
RegionConcurrencyType string | Aws_CF_FunctionString

The concurrency type of deploying StackSets operations in regions, could be in parallel or one region at a time

StackInstancesGroup StackInstances[]

A group of stack instances with parameters in some specific accounts and regions.

uniqueItems=true
Parameters Parameter[]

The input parameters for the stack set template.

uniqueItems=true
Tags Tag[]

The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.

maxItems=50uniqueItems=true
TemplateBody string | Aws_CF_FunctionString

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.

TemplateURL string | Aws_CF_FunctionString

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket.

CallAs string | Aws_CF_FunctionString

Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

ManagedExecution object

Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.

1 nested properties
Active boolean

When true, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.

One of

1. variant
2. variant

Definitions

Tag object

Tag type enables you to specify a key-value pair that can be used to store information about an AWS CloudFormation StackSet.

Key string | Aws_CF_FunctionString required

A string used to identify this tag. You can specify a maximum of 127 characters for a tag key.

Value string | Aws_CF_FunctionString required

A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

AutoDeployment object
Enabled boolean

If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions.

RetainStacksOnAccountRemoval boolean

If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True.

Account string | Aws_CF_FunctionString

AWS account that you want to create stack instances in the specified Region(s) for.

Region string | Aws_CF_FunctionString
OrganizationalUnitId string | Aws_CF_FunctionString
Capability string | Aws_CF_FunctionString
RegionConcurrencyType string | Aws_CF_FunctionString

The concurrency type of deploying StackSets operations in regions, could be in parallel or one region at a time

Active boolean

When true, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.

OperationPreferences object

The user-specified preferences for how AWS CloudFormation performs a stack set operation.

FailureToleranceCount integer
min=0
FailureTolerancePercentage integer
min=0max=100
MaxConcurrentCount integer
min=1
MaxConcurrentPercentage integer
min=0max=100
RegionOrder Region[]
RegionConcurrencyType string | Aws_CF_FunctionString

The concurrency type of deploying StackSets operations in regions, could be in parallel or one region at a time

Parameter object
ParameterKey string | Aws_CF_FunctionString required

The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

ParameterValue string | Aws_CF_FunctionString required

The input value associated with the parameter.

DeploymentTargets object

The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.

Accounts Account[]

AWS accounts that you want to create stack instances in the specified Region(s) for.

minItems=1uniqueItems=true
OrganizationalUnitIds OrganizationalUnitId[]

The organization root ID or organizational unit (OU) IDs to which StackSets deploys.

minItems=1uniqueItems=true
AccountFilterType string | Aws_CF_FunctionString

The filter type you want to apply on organizational units and accounts.

StackInstances object

Stack instances in some specific accounts and Regions.

DeploymentTargets object required

The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions.

3 nested properties
Accounts Account[]

AWS accounts that you want to create stack instances in the specified Region(s) for.

minItems=1uniqueItems=true
OrganizationalUnitIds OrganizationalUnitId[]

The organization root ID or organizational unit (OU) IDs to which StackSets deploys.

minItems=1uniqueItems=true
AccountFilterType string | Aws_CF_FunctionString

The filter type you want to apply on organizational units and accounts.

Regions Region[] required

The names of one or more Regions where you want to create stack instances using the specified AWS account(s).

minItems=1uniqueItems=true
ParameterOverrides Parameter[]

A list of stack set parameters whose values you want to override in the selected stack instances.

uniqueItems=true