CfnStackSetProps Struct
Properties for defining a CfnStackSet.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
declare const managedExecution: any;
const cfnStackSetProps: cdk.CfnStackSetProps = {
permissionModel: 'permissionModel',
stackSetName: 'stackSetName',
// the properties below are optional
administrationRoleArn: 'administrationRoleArn',
autoDeployment: {
dependsOn: ['dependsOn'],
enabled: false,
retainStacksOnAccountRemoval: false,
},
callAs: 'callAs',
capabilities: ['capabilities'],
description: 'description',
executionRoleName: 'executionRoleName',
managedExecution: managedExecution,
operationPreferences: {
concurrencyMode: 'concurrencyMode',
failureToleranceCount: 123,
failureTolerancePercentage: 123,
maxConcurrentCount: 123,
maxConcurrentPercentage: 123,
regionConcurrencyType: 'regionConcurrencyType',
regionOrder: ['regionOrder'],
},
parameters: [{
parameterKey: 'parameterKey',
parameterValue: 'parameterValue',
}],
stackInstancesGroup: [{
deploymentTargets: {
accountFilterType: 'accountFilterType',
accounts: ['accounts'],
accountsUrl: 'accountsUrl',
organizationalUnitIds: ['organizationalUnitIds'],
},
regions: ['regions'],
// the properties below are optional
parameterOverrides: [{
parameterKey: 'parameterKey',
parameterValue: 'parameterValue',
}],
}],
tags: [{
key: 'key',
value: 'value',
}],
templateBody: 'templateBody',
templateUrl: 'templateUrl',
};
Properties
administrationRoleArnstring | IRoleRefadministration_role_arntyping.Union[str, IRoleRef]administrationRoleArnStringAdministrationRoleArnstringAdministrationRoleArninterface{}#notes
Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account.
Use customized administrator roles to control which users or groups can manage specific StackSets within the same administrator account. For more information, see Grant self-managed permissions in the CloudFormation User Guide .
Valid only if the permissions model is SELF_MANAGED .
autoDeploymentIResolvable | CfnStackSet.AutoDeploymentPropertyauto_deploymenttyping.Union[IResolvable, AutoDeploymentProperty]autoDeploymentIResolvableAutoDeploymentIResolvableAutoDeploymentinterface{}#notes
For more information, see Enable or disable automatic deployments for StackSets in AWS Organizations in the CloudFormation User Guide .
Required if the permissions model is SERVICE_MANAGED . (Not used with self-managed permissions.)
notes
By default, SELF is specified. Use SELF for StackSets with self-managed permissions.
- To create a StackSet with service-managed permissions while signed in to the management account, specify
SELF. - To create a StackSet with service-managed permissions while signed in to a delegated administrator account, specify
DELEGATED_ADMIN.
Your AWS account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide .
StackSets with service-managed permissions are created in the management account, including StackSets that are created by delegated administrators.
Valid only if the permissions model is SERVICE_MANAGED .
capabilitiesstring[]capabilitiestyping.List[str]capabilitiesList<String>Capabilitiesstring[]Capabilities*[]*string#notes
Some StackSet templates might include resources that can affect permissions in your AWS account —for example, by creating new IAM users. For more information, see Acknowledging IAM resources in CloudFormation templates in the CloudFormation User Guide .
executionRoleNamestring | IRoleRefexecution_role_nametyping.Union[str, IRoleRef]executionRoleNameStringExecutionRoleNamestringExecutionRoleNameinterface{}#If you don't specify an execution role, CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the StackSet operation.
Valid only if the permissions model is SELF_MANAGED .
Pattern : [a-zA-Z_0-9+=,.@-]+
managedExecutionanymanaged_executionAnymanagedExecutionObjectManagedExecutionobjectManagedExecutioninterface{}#notes
When active, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order.
If there are already running or queued operations, StackSets queues all incoming operations even if they are non-conflicting.
You can't modify your StackSet's execution configuration while there are running or queued operations for that StackSet.
When inactive (default), StackSets performs one operation at a time in request order.
operationPreferencesIResolvable | CfnStackSet.OperationPreferencesPropertyoperation_preferencestyping.Union[IResolvable, OperationPreferencesProperty]operationPreferencesIResolvableOperationPreferencesIResolvableOperationPreferencesinterface{}#parametersIResolvable | IResolvable | CfnStackSet.ParameterProperty[]parameterstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ParameterProperty]]]parametersIResolvableParametersIResolvableParametersinterface{}#permissionModelstringpermission_modelstrpermissionModelStringPermissionModelstringPermissionModel*stringrequired#notes
- With
SELF_MANAGEDpermissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see Grant self-managed permissions in the CloudFormation User Guide . - With
SERVICE_MANAGEDpermissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations . For more information, see Activate trusted access for StackSets with AWS Organizations in the CloudFormation User Guide .
stackInstancesGroupIResolvable | IResolvable | CfnStackSet.StackInstancesProperty[]stack_instances_grouptyping.Union[IResolvable, typing.List[typing.Union[IResolvable, StackInstancesProperty]]]stackInstancesGroupIResolvableStackInstancesGroupIResolvableStackInstancesGroupinterface{}#The name must be unique in the Region where you create your StackSet.
notes
CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.
If you don't specify this parameter, CloudFormation doesn't modify the stack's tags. If you specify an empty value, CloudFormation removes all associated tags.
notes
You must include either TemplateURL or TemplateBody in a StackSet, but you can't use both. Dynamic references in the TemplateBody may not work correctly in all cases. It's recommended to pass templates that contain dynamic references through TemplateUrl instead.
notes
The URL must point to a template (max size: 1 MB) that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start with https:// .
Conditional: You must specify only one of the following parameters: TemplateBody , TemplateURL .