Class CfnStackSet

The AWS::CloudFormation::StackSet resource contains information about a StackSet.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnStackSet
Implements
Inherited Members
Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnStackSet : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnStackSet Inherits CfnResource Implements IInspectable, ITaggable
Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

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 cfnStackSet = new CfnStackSet(this, "MyCfnStackSet", 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 {
                     ConcurrencyMode = "concurrencyMode",
                     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

Constructors

CfnStackSet(Construct, string, ICfnStackSetProps)

The AWS::CloudFormation::StackSet resource contains information about a StackSet.

Properties

AdministrationRoleArn

The Amazon Resource Number (ARN) of the IAM role to use to create this StackSet.
AttrStackSetId

Returns the unique identifier of the resource.
AutoDeployment

Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CallAs

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 StackSet.
CfnProperties

The AWS::CloudFormation::StackSet resource contains information about a StackSet.
Description

A description of the StackSet.
ExecutionRoleName

The name of the IAM execution role to use to create the StackSet.
ManagedExecution

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

The user-specified preferences for how CloudFormation performs a StackSet operation.
Parameters

The input parameters for the StackSet template.
PermissionModel

Describes how the IAM roles required for StackSet operations are created.
StackInstancesGroup

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

The name to associate with the StackSet.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

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

The URL of a file that contains the template body.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)

The AWS::CloudFormation::StackSet resource contains information about a StackSet.

Constructors

CfnStackSet(Construct, string, ICfnStackSetProps)

The AWS::CloudFormation::StackSet resource contains information about a StackSet.

public CfnStackSet(Construct scope, string id, ICfnStackSetProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnStackSetProps

Resource properties.

Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

Properties

AdministrationRoleArn

The Amazon Resource Number (ARN) of the IAM role to use to create this StackSet.

public virtual string? AdministrationRoleArn { get; set; }
Property Value

string

Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

AttrStackSetId

Returns the unique identifier of the resource.

public virtual string AttrStackSetId { get; }
Property Value

string

Remarks

CloudformationAttribute: StackSetId

AutoDeployment

Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).

public virtual object? AutoDeployment { get; set; }
Property Value

object

Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

CallAs

Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

public virtual string? CallAs { get; set; }
Property Value

string

Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

Capabilities

The capabilities that are allowed in the StackSet.

public virtual string[]? Capabilities { get; set; }
Property Value

string[]

Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::CloudFormation::StackSet resource contains information about a StackSet.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

Description

A description of the StackSet.

public virtual string? Description { get; set; }
Property Value

string

Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

ExecutionRoleName

The name of the IAM execution role to use to create the StackSet.

public virtual string? ExecutionRoleName { get; set; }
Property Value

string

Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

ManagedExecution

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

public virtual object? ManagedExecution { get; set; }
Property Value

object

Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

OperationPreferences

The user-specified preferences for how CloudFormation performs a StackSet operation.

public virtual object? OperationPreferences { get; set; }
Property Value

object

Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

Parameters

The input parameters for the StackSet template.

public virtual object? Parameters { get; set; }
Property Value

object

Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

PermissionModel

Describes how the IAM roles required for StackSet operations are created.

public virtual string PermissionModel { get; set; }
Property Value

string

Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

StackInstancesGroup

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

public virtual object? StackInstancesGroup { get; set; }
Property Value

object

Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

StackSetName

The name to associate with the StackSet.

public virtual string StackSetName { get; set; }
Property Value

string

Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

TagsRaw

Key-value pairs to associate with this stack.

public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value

ICfnTag[]

Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

TemplateBody

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

public virtual string? TemplateBody { get; set; }
Property Value

string

Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

TemplateUrl

The URL of a file that contains the template body.

public virtual string? TemplateUrl { get; set; }
Property Value

string

Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::CloudFormation::StackSet resource contains information about a StackSet.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

With StackSets, you can provision stacks across AWS accounts and Regions from a single CloudFormation template. Each stack is based on the same CloudFormation template, but you can customize individual stacks using parameters.

Run deployments to nested StackSets from the parent stack, not directly through the StackSet API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html

CloudformationResource: AWS::CloudFormation::StackSet

ExampleMetadata: fixture=_generated

Implements