AWS Fundamentals Logo
AWS Fundamentals
AWS::CloudFormation::StackSet

CloudFormation StackSet

StackSet as a resource provides one-click experience for provisioning a StackSet and StackInstances

Properties

15 configurable properties. 2 required. Click a row to see details.

Filter:
PropertyTypeFlags
PermissionModel
string
RequiredCreate-only
StackSetName
string
RequiredCreate-only
AdministrationRoleARN
string
AutoDeployment
AutoDeployment
CallAs
string
Write-only
Capabilities
Array<string>
Description
string
ExecutionRoleName
string
ManagedExecution
object
OperationPreferences
OperationPreferences
Write-only
Parameters
Array<Parameter>
StackInstancesGroup
Array<StackInstances>
Write-only
Tags
Array<Tag>
TemplateBody
string
TemplateURL
string
Write-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
StackSetIdstringThe ID of the stack set that you're creating.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::CloudFormation::StackSet

Resources:
  MyResource:
    Type: AWS::CloudFormation::StackSet
    Properties:
      StackSetName: "my-stacksetname"
      PermissionModel: "SERVICE_MANAGED"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

cloudformation:GetTemplateSummarycloudformation:CreateStackSetcloudformation:CreateStackInstancescloudformation:DescribeStackSetOperationcloudformation:ListStackSetOperationResultscloudformation:TagResourceiam:PassRole

read

cloudformation:DescribeStackSetcloudformation:ListStackInstancescloudformation:DescribeStackInstance

update

cloudformation:GetTemplateSummarycloudformation:UpdateStackSetcloudformation:CreateStackInstancescloudformation:DeleteStackInstancescloudformation:UpdateStackInstancescloudformation:DescribeStackSetcloudformation:DescribeStackSetOperationcloudformation:ListStackSetOperationResultscloudformation:TagResourcecloudformation:UntagResourceiam:PassRole

delete

cloudformation:DeleteStackSetcloudformation:DeleteStackInstancescloudformation:DescribeStackSetcloudformation:DescribeStackSetOperationcloudformation:ListStackSetOperationResultscloudformation:UntagResource

list

cloudformation:ListStackSets

Get the CloudFormation Cheat Sheet

Everything you need to know about CloudFormation on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceCloudFormation
Properties16
Required2
TaggingSupported
Primary IDStackSetId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

PermissionModelStackSetName

Related Resources

External Links