Protected Readonly Internal _cfnAWS CloudFormation resource properties.
This object is returned via cfnProperties
Optional administrationThe Amazon Resource Number (ARN) of the IAM role to use to create this stack set.
Readonly attrThe ID of the stack that you're creating.
StackSetId
Optional auto[ Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
Optional call[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.
Optional capabilitiesThe capabilities that are allowed in the stack set.
Readonly cfnOptions for this resource, such as condition, update policy etc.
Readonly cfnAWS resource type.
Optional descriptionA description of the stack set.
Optional executionThe name of the IAM execution role to use to create the stack set.
Readonly logicalThe logical ID for this CloudFormation stack element. The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId).
the logical ID as a stringified token. This value will only get resolved during synthesis.
Optional managedDescribes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
Readonly nodeThe tree node.
Optional operationThe user-specified preferences for how AWS CloudFormation performs a stack set operation.
Optional parametersThe input parameters for the stack set template.
Describes how the IAM roles required for stack set operations are created.
Readonly stackThe stack in which this element is defined. CfnElements must be defined within a stack scope (directly or indirectly).
Optional stackA group of stack instances with parameters in some specific accounts and Regions.
The name to associate with the stack set.
Readonly tagsTag Manager which manages the tags for this resource
Optional tagsThe key-value pairs to associate with this stack set and the stacks created from it.
Optional templateThe structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
Optional templateLocation of file containing the template body.
Static Readonly CFN_The CloudFormation resource type name for this resource class.
Protected cfnthe stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
Return a string that will be resolved to a CloudFormation { Ref } for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
Protected updatedDeprecated
use updatedProperties
Return properties modified after initiation
Resources that expose mutable properties should override this function to collect and return the properties object for this resource.
Protected updatedReturn properties modified after initiation
Resources that expose mutable properties should override this function to collect and return the properties object for this resource.
Internal
Called by the addDependency helper function in order to realize a direct
dependency between two resources that are directly defined in the same
stacks.
Use resource.addDependency to define the dependency between two resources,
which also takes stack boundaries into account.
Internal
Lock the logicalId of the element and do not allow any updates (e.g. via overrideLogicalId)
This is needed in cases where you are consuming the LogicalID of an element prior to synthesis and you need to not allow future changes to the id since doing so would cause the value you just consumed to differ from the synth time value of the logicalId.
For example:
const bucket = new Bucket(stack, 'Bucket'); stack.exportValue(bucket.bucketArn) <--- consuming the logicalId bucket.overrideLogicalId('NewLogicalId') <--- updating logicalId
You should most likely never need to use this method, and if you are implementing a feature that requires this, make sure you actually require it.
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
Add a value to the CloudFormation Resource Metadata
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
Adds an override to the synthesized CloudFormation resource. To add a
property override, either use addPropertyOverride or prefix path with
"Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most
programming languages you will need to write this as "\\." because the
`` itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
The value. Could be primitive or complex.
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT). A list of resources that support this policy
can be found in the following link:
Optional options: RemovalPolicyOptionsReturns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility
in case there is no generated attribute.
The name of the attribute.
Optional typeHint: ResolutionTypeHintRetrieve a value value from the CloudFormation Resource Metadata
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
Protected renderProtected shouldProtected validateStatic _fromInternal
Build a CfnStackSet from CloudFormation properties
A factory method that creates a new instance of this class from an object containing the CloudFormation properties of this resource. Used in the @aws-cdk/cloudformation-include module.
Static isReturns true if a construct is a stack element (i.e. part of the
synthesized cloudformation template).
Uses duck-typing instead of instanceof to allow stack elements from different
versions of this library to be included in the same stack.
The construct as a stack element or undefined if it is not a stack element.
Static isStatic isChecks if x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
Any object
true if x is an object created from a class which extends Construct.
Generated using TypeDoc
A construct to create a
AWS::CloudFormation::StackSet.The stack set will be configured to automatically deploy into accounts when they join an AWS Organisation Unit. It's assumed stack sets are only provisioned for infrastructure, therefore the
STAGEvalue will always beINFRA.Usage:
This will produce a CloudFormation template like this:
See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html