interface CloudFormationDeployStackSetActionProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CodePipeline.Actions.CloudFormationDeployStackSetActionProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscodepipelineactions#CloudFormationDeployStackSetActionProps |
![]() | software.amazon.awscdk.services.codepipeline.actions.CloudFormationDeployStackSetActionProps |
![]() | aws_cdk.aws_codepipeline_actions.CloudFormationDeployStackSetActionProps |
![]() | aws-cdk-lib » aws_codepipeline_actions » CloudFormationDeployStackSetActionProps |
Properties for the CloudFormationDeployStackSetAction.
Example
declare const pipeline: codepipeline.Pipeline;
declare const sourceOutput: codepipeline.Artifact;
pipeline.addStage({
stageName: 'DeployStackSets',
actions: [
// First, update the StackSet itself with the newest template
new codepipeline_actions.CloudFormationDeployStackSetAction({
actionName: 'UpdateStackSet',
runOrder: 1,
stackSetName: 'MyStackSet',
template: codepipeline_actions.StackSetTemplate.fromArtifactPath(sourceOutput.atPath('template.yaml')),
// Change this to 'StackSetDeploymentModel.organizations()' if you want to deploy to OUs
deploymentModel: codepipeline_actions.StackSetDeploymentModel.selfManaged(),
// This deploys to a set of accounts
stackInstances: codepipeline_actions.StackInstances.inAccounts(['111111111111'], ['us-east-1', 'eu-west-1']),
}),
// Afterwards, update/create additional instances in other accounts
new codepipeline_actions.CloudFormationDeployStackInstancesAction({
actionName: 'AddMoreInstances',
runOrder: 2,
stackSetName: 'MyStackSet',
stackInstances: codepipeline_actions.StackInstances.inAccounts(
['222222222222', '333333333333'],
['us-east-1', 'eu-west-1']
),
}),
],
});
Properties
Name | Type | Description |
---|---|---|
action | string | The physical, human-readable name of the Action. |
stack | string | The name to associate with the stack set. |
template | Stack | The location of the template that defines the resources in the stack set. |
cfn | Cfn [] | Indicates that the template can create and update resources, depending on the types of resources in the template. |
deployment | Stack | Determines how IAM roles are created and managed. |
description? | string | A description of the stack set. |
failure | number | The percentage of accounts per Region for which this stack operation can fail before AWS CloudFormation stops the operation in that Region. |
max | number | The maximum percentage of accounts in which to perform this operation at one time. |
parameters? | Stack | The template parameters for your stack set. |
role? | IRole | The Role in which context's this Action will be executing in. |
run | number | The runOrder property for this Action. |
stack | Stack | Specify where to create or update Stack Instances. |
stack | string | The AWS Region the StackSet is in. |
variables | string | The name of the namespace to use for variables emitted by this action. |
actionName
Type:
string
The physical, human-readable name of the Action.
Note that Action names must be unique within a single Stage.
stackSetName
Type:
string
The name to associate with the stack set.
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
Type:
Stack
The location of the template that defines the resources in the stack set.
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.
cfnCapabilities?
Type:
Cfn
[]
(optional, default: the StackSet will have no IAM capabilities)
Indicates that the template can create and update resources, depending on the types of resources in the template.
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.
deploymentModel?
Type:
Stack
(optional, default: StackSetDeploymentModel.selfManaged())
Determines how IAM roles are created and managed.
The choices are:
- Self Managed: you create IAM roles with the required permissions in the administration account and all target accounts.
- Service Managed: only available if the account and target accounts are part of an AWS Organization. The necessary roles will be created for you.
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.
description?
Type:
string
(optional, default: no description)
A description of the stack set.
You can use this to describe the stack set’s purpose or other relevant information.
failureTolerancePercentage?
Type:
number
(optional, default: 0%)
The percentage of accounts per Region for which this stack operation can fail before AWS CloudFormation stops the operation in that Region.
If the operation is stopped in a Region, AWS CloudFormation doesn't attempt the operation in subsequent Regions. When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number.
maxAccountConcurrencyPercentage?
Type:
number
(optional, default: 1%)
The maximum percentage of accounts in which to perform this operation at one time.
When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. If rounding down would result in zero, AWS CloudFormation sets the number as one instead. Although you use this setting to specify the maximum, for large deployments the actual number of accounts acted upon concurrently may be lower due to service throttling.
parameters?
Type:
Stack
(optional, default: no parameters will be used)
The template parameters for your stack set.
These parameters are shared between all instances of the stack set.
role?
Type:
IRole
(optional, default: a new Role will be generated)
The Role in which context's this Action will be executing in.
The Pipeline's Role will assume this Role
(the required permissions for that will be granted automatically)
right before executing this Action.
This Action will be passed into your IAction.bind
method in the ActionBindOptions.role
property.
runOrder?
Type:
number
(optional, default: 1)
The runOrder property for this Action.
RunOrder determines the relative order in which multiple Actions in the same Stage execute.
stackInstances?
Type:
Stack
(optional, default: don't create or update any Stack Instances)
Specify where to create or update Stack Instances.
You can specify either AWS Accounts Ids or AWS Organizations Organizational Units.
stackSetRegion?
Type:
string
(optional, default: same region as the Pipeline)
The AWS Region the StackSet is in.
Note that a cross-region Pipeline requires replication buckets to function correctly.
You can provide their names with the PipelineProps.crossRegionReplicationBuckets
property.
If you don't, the CodePipeline Construct will create new Stacks in your CDK app containing those buckets,
that you will need to cdk deploy
before deploying the main, Pipeline-containing Stack.
variablesNamespace?
Type:
string
(optional, default: a name will be generated, based on the stage and action names,
if any of the action's variables were referenced - otherwise,
no namespace will be set)
The name of the namespace to use for variables emitted by this action.