CloudFormationDeployStackSetActionProps Struct
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
Note that Action names must be unique within a single Stage.
cfnCapabilitiesCfnCapabilities[]cfn_capabilitiestyping.List[CfnCapabilities]cfnCapabilitiesList<CfnCapabilities>CfnCapabilitiesCfnCapabilities[]CfnCapabilities*[]CfnCapabilities= the StackSet will have no IAM ca…#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
Default: the StackSet will have no IAM capabilities
deploymentModelStackSetDeploymentModeldeployment_modelStackSetDeploymentModeldeploymentModelStackSetDeploymentModelDeploymentModelStackSetDeploymentModelDeploymentModelStackSetDeploymentModel= StackSetDeploymentModel.selfMana…#notes · default
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.
Default: StackSetDeploymentModel.selfManaged()
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= no description#You can use this to describe the stack set’s purpose or other relevant information.
failureTolerancePercentagenumberfailure_tolerance_percentageint | floatfailureTolerancePercentageNumberFailureTolerancePercentagedoubleFailureTolerancePercentage*float64= 0%#notes
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.
maxAccountConcurrencyPercentagenumbermax_account_concurrency_percentageint | floatmaxAccountConcurrencyPercentageNumberMaxAccountConcurrencyPercentagedoubleMaxAccountConcurrencyPercentage*float64= 1%#notes
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.
parametersStackSetParametersparametersStackSetParametersparametersStackSetParametersParametersStackSetParametersParametersStackSetParameters= no parameters will be used#These parameters are shared between all instances of the stack set.
notes
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 determines the relative order in which multiple Actions in the same Stage execute.
stackInstancesStackInstancesstack_instancesStackInstancesstackInstancesStackInstancesStackInstancesStackInstancesStackInstancesStackInstances= don't create or update any Stack…#You can specify either AWS Accounts Ids or AWS Organizations Organizational Units.
default
Default: don't create or update any Stack Instances
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.
stackSetRegionstringstack_set_regionstrstackSetRegionStringStackSetRegionstringStackSetRegion*string= same region as the Pipeline#notes
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.
templateStackSetTemplatetemplateStackSetTemplatetemplateStackSetTemplateTemplateStackSetTemplateTemplateStackSetTemplaterequired#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.
variablesNamespacestringvariables_namespacestrvariablesNamespaceStringVariablesNamespacestringVariablesNamespace*string= a name will be generated, based …#default
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