Class CfnStackSet

The AWS::CloudFormation::StackSet enables you to provision stacks into AWS accounts and across Regions by using a single CloudFormation template.

Inheritance
System.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

In the stack set, you specify the template to use, in addition to any parameters and capabilities that the template requires.

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(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnStackSet(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnStackSet(Construct, String, ICfnStackSetProps)

Properties

AdministrationRoleArn

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

The ID of the stack that you're creating.
AutoDeployment

[ Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
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.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
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

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

Location of file containing the template body.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnStackSet(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnStackSet(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnStackSet(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnStackSet(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnStackSet(Construct, String, ICfnStackSetProps)

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

Scope in which this resource is defined.

id System.String

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

props ICfnStackSetProps

Resource properties.

Properties

AdministrationRoleArn

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

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

System.String

AttrStackSetId

The ID of the stack that you're creating.

public virtual string AttrStackSetId { get; }
Property Value

System.String

Remarks

CloudformationAttribute: StackSetId

AutoDeployment

[ Service-managed permissions] 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

System.Object

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.

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

System.String

Capabilities

The capabilities that are allowed in the stack set.

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

System.String[]

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

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

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Description

A description of the stack set.

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

System.String

ExecutionRoleName

The name of the IAM execution role to use to create the stack set.

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

System.String

ManagedExecution

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

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

System.Object

OperationPreferences

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

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

System.Object

Parameters

The input parameters for the stack set template.

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

System.Object

PermissionModel

Describes how the IAM roles required for stack set operations are created.

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

System.String

StackInstancesGroup

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

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

System.Object

StackSetName

The name to associate with the stack set.

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

System.String

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

TagsRaw

Key-value pairs to associate with this stack.

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

ICfnTag[]

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

System.String

TemplateUrl

Location of file containing the template body.

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

System.String

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.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements