Interface ICfnStackSetProps
Properties for defining a CfnStackSet
.
Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnStackSetProps
Syntax (vb)
Public Interface ICfnStackSetProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
var managedExecution;
var cfnStackSetProps = new CfnStackSetProps {
PermissionModel = "permissionModel",
StackSetName = "stackSetName",
// the properties below are optional
AdministrationRoleArn = "administrationRoleArn",
AutoDeployment = new AutoDeploymentProperty {
Enabled = false,
RetainStacksOnAccountRemoval = false
},
CallAs = "callAs",
Capabilities = new [] { "capabilities" },
Description = "description",
ExecutionRoleName = "executionRoleName",
ManagedExecution = managedExecution,
OperationPreferences = new OperationPreferencesProperty {
FailureToleranceCount = 123,
FailureTolerancePercentage = 123,
MaxConcurrentCount = 123,
MaxConcurrentPercentage = 123,
RegionConcurrencyType = "regionConcurrencyType",
RegionOrder = new [] { "regionOrder" }
},
Parameters = new [] { new ParameterProperty {
ParameterKey = "parameterKey",
ParameterValue = "parameterValue"
} },
StackInstancesGroup = new [] { new StackInstancesProperty {
DeploymentTargets = new DeploymentTargetsProperty {
AccountFilterType = "accountFilterType",
Accounts = new [] { "accounts" },
AccountsUrl = "accountsUrl",
OrganizationalUnitIds = new [] { "organizationalUnitIds" }
},
Regions = new [] { "regions" },
// the properties below are optional
ParameterOverrides = new [] { new ParameterProperty {
ParameterKey = "parameterKey",
ParameterValue = "parameterValue"
} }
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TemplateBody = "templateBody",
TemplateUrl = "templateUrl"
};
Synopsis
Properties
AdministrationRoleArn | The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. |
AutoDeployment | [ |
CallAs | [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. |
Capabilities | The capabilities that are allowed in the stack set. |
Description | A description of the stack set. |
ExecutionRoleName | The name of the IAM execution role to use to create the stack set. |
ManagedExecution | Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations. |
OperationPreferences | The user-specified preferences for how AWS CloudFormation performs a stack set operation. |
Parameters | The input parameters for the stack set template. |
PermissionModel | Describes how the IAM roles required for stack set operations are created. |
StackInstancesGroup | A group of stack instances with parameters in some specific accounts and Regions. |
StackSetName | The name to associate with the stack set. |
Tags | Key-value pairs to associate with this stack. |
TemplateBody | The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. |
TemplateUrl | Location of file containing the template body. |
Properties
AdministrationRoleArn
The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.
virtual string AdministrationRoleArn { get; }
Property Value
System.String
Remarks
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.
Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide .
Minimum : 20
Maximum : 2048
AutoDeployment
[ Service-managed
permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
virtual object AutoDeployment { get; }
Property Value
System.Object
Remarks
CallAs
[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.
virtual string CallAs { get; }
Property Value
System.String
Remarks
By default, SELF
is specified. Use SELF
for stack sets with self-managed permissions.
Your AWS account must be registered as a delegated admin in the management account. For more information, see Register a delegated administrator in the AWS CloudFormation User Guide .
Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.
Valid Values : SELF
| DELEGATED_ADMIN
Capabilities
The capabilities that are allowed in the stack set.
virtual string[] Capabilities { get; }
Property Value
System.String[]
Remarks
Some stack set templates might include resources that can affect permissions in your AWS account —for example, by creating new AWS Identity and Access Management ( IAM ) users. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates .
Description
A description of the stack set.
virtual string Description { get; }
Property Value
System.String
Remarks
ExecutionRoleName
The name of the IAM execution role to use to create the stack set.
virtual string ExecutionRoleName { get; }
Property Value
System.String
Remarks
If you don't specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole
role for the stack set operation.
Minimum : 1
Maximum : 64
Pattern : [a-zA-Z_0-9+=,.@-]+
ManagedExecution
Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
virtual object ManagedExecution { get; }
Property Value
System.Object
Remarks
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 stack set's execution configuration while there are running or queued operations for that stack set.
When inactive (default), StackSets performs one operation at a time in request order.
OperationPreferences
The user-specified preferences for how AWS CloudFormation performs a stack set operation.
virtual object OperationPreferences { get; }
Property Value
System.Object
Remarks
Parameters
The input parameters for the stack set template.
virtual object Parameters { get; }
Property Value
System.Object
Remarks
PermissionModel
Describes how the IAM roles required for stack set operations are created.
string PermissionModel { get; }
Property Value
System.String
Remarks
StackInstancesGroup
A group of stack instances with parameters in some specific accounts and Regions.
virtual object StackInstancesGroup { get; }
Property Value
System.Object
Remarks
StackSetName
The name to associate with the stack set.
string StackSetName { get; }
Property Value
System.String
Remarks
The name must be unique in the Region where you create your stack set.
The StackSetName
property is required.
Tags
Key-value pairs to associate with this stack.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
AWS 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, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
TemplateBody
The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
virtual string TemplateBody { get; }
Property Value
System.String
Remarks
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 containing dynamic references through TemplateUrl
instead.
TemplateUrl
Location of file containing the template body.
virtual string TemplateUrl { get; }
Property Value
System.String
Remarks
The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify only one of the following parameters: TemplateBody
, TemplateURL
.