Interface ICloudFormationDeployStackSetActionProps
Properties for the CloudFormationDeployStackSetAction.
Inherited Members
Namespace: Amazon.CDK.AWS.CodePipeline.Actions
Assembly: Amazon.CDK.AWS.CodePipeline.Actions.dll
Syntax (csharp)
public interface ICloudFormationDeployStackSetActionProps : ICommonAwsActionProps, ICommonActionProps, ICommonCloudFormationStackSetOptions
Syntax (vb)
Public Interface ICloudFormationDeployStackSetActionProps
Inherits ICommonAwsActionProps, ICommonActionProps, ICommonCloudFormationStackSetOptions
Remarks
ExampleMetadata: infused
Examples
Pipeline pipeline;
Artifact sourceOutput;
pipeline.AddStage(new StageOptions {
StageName = "DeployStackSets",
Actions = new [] {
// First, update the StackSet itself with the newest template
new CloudFormationDeployStackSetAction(new CloudFormationDeployStackSetActionProps {
ActionName = "UpdateStackSet",
RunOrder = 1,
StackSetName = "MyStackSet",
Template = StackSetTemplate.FromArtifactPath(sourceOutput.AtPath("template.yaml")),
// Change this to 'StackSetDeploymentModel.organizations()' if you want to deploy to OUs
DeploymentModel = StackSetDeploymentModel.SelfManaged(),
// This deploys to a set of accounts
StackInstances = StackInstances.InAccounts(new [] { "111111111111" }, new [] { "us-east-1", "eu-west-1" })
}),
// Afterwards, update/create additional instances in other accounts
new CloudFormationDeployStackInstancesAction(new CloudFormationDeployStackInstancesActionProps {
ActionName = "AddMoreInstances",
RunOrder = 2,
StackSetName = "MyStackSet",
StackInstances = StackInstances.InAccounts(new [] { "222222222222", "333333333333" }, new [] { "us-east-1", "eu-west-1" })
}) }
});
Synopsis
Properties
CfnCapabilities | Indicates that the template can create and update resources, depending on the types of resources in the template. |
DeploymentModel | Determines how IAM roles are created and managed. |
Description | A description of the stack set. |
Parameters | The template parameters for your stack set. |
StackInstances | Specify where to create or update Stack Instances. |
StackSetName | The name to associate with the stack set. |
Template | The location of the template that defines the resources in the stack set. |
Properties
CfnCapabilities
Indicates that the template can create and update resources, depending on the types of resources in the template.
virtual CfnCapabilities[] CfnCapabilities { get; }
Property Value
Remarks
You must use this property if you have IAM resources in your stack template or you create a stack directly from a template containing macros.
Default: - the StackSet will have no IAM capabilities
DeploymentModel
Determines how IAM roles are created and managed.
virtual StackSetDeploymentModel DeploymentModel { get; }
Property Value
Remarks
The choices are:
If you want to deploy to all accounts that are a member of AWS Organizations Organizational Units (OUs), you must select Service Managed permissions.
Note: This parameter can only be changed when no stack instances exist in the stack set.
Default: StackSetDeploymentModel.selfManaged()
Description
A description of the stack set.
virtual string Description { get; }
Property Value
System.String
Remarks
You can use this to describe the stack set’s purpose or other relevant information.
Default: - no description
Parameters
The template parameters for your stack set.
virtual StackSetParameters Parameters { get; }
Property Value
Remarks
These parameters are shared between all instances of the stack set.
Default: - no parameters will be used
StackInstances
Specify where to create or update Stack Instances.
virtual StackInstances StackInstances { get; }
Property Value
Remarks
You can specify either AWS Accounts Ids or AWS Organizations Organizational Units.
Default: - don't create or update any Stack Instances
StackSetName
The name to associate with the stack set.
string StackSetName { get; }
Property Value
System.String
Remarks
This name must be unique in the Region where it is created.
The name may only contain alphanumeric and hyphen characters. It must begin with an alphabetic character and be 128 characters or fewer.
Template
The location of the template that defines the resources in the stack set.
StackSetTemplate Template { get; }
Property Value
Remarks
This must point to a template with a maximum size of 460,800 bytes.
Enter the path to the source artifact name and template file.