CloudFormationCreateReplaceChangeSetActionProps Struct
Properties for the CloudFormationCreateReplaceChangeSetAction.
Example
// Source stage: read from repository
const repo = new codecommit.Repository(stack, 'TemplateRepo', {
repositoryName: 'template-repo',
});
const sourceOutput = new codepipeline.Artifact('SourceArtifact');
const source = new cpactions.CodeCommitSourceAction({
actionName: 'Source',
repository: repo,
output: sourceOutput,
trigger: cpactions.CodeCommitTrigger.POLL,
});
const sourceStage = {
stageName: 'Source',
actions: [source],
};
// Deployment stage: create and deploy changeset with manual approval
const stackName = 'OurStack';
const changeSetName = 'StagedChangeSet';
const prodStage = {
stageName: 'Deploy',
actions: [
new cpactions.CloudFormationCreateReplaceChangeSetAction({
actionName: 'PrepareChanges',
stackName,
changeSetName,
adminPermissions: true,
templatePath: sourceOutput.atPath('template.yaml'),
runOrder: 1,
}),
new cpactions.ManualApprovalAction({
actionName: 'ApproveChanges',
runOrder: 2,
}),
new cpactions.CloudFormationExecuteChangeSetAction({
actionName: 'ExecuteChanges',
stackName,
changeSetName,
runOrder: 3,
}),
],
};
new codepipeline.Pipeline(stack, 'Pipeline', {
crossAccountKeys: true,
stages: [
sourceStage,
prodStage,
],
});
Properties
accountoptionalstringaccountoptionalstraccountoptionalStringAccountoptionalstringAccountoptional*string#Default: action resides in the same account as the pipeline
Note: if you specify the role property, this is ignored - the action will operate in the same region the passed role does.
Note that Action names must be unique within a single Stage.
adminPermissionsbooleanadmin_permissionsbooladminPermissionsBooleanAdminPermissionsboolAdminPermissions*boolrequired#notes
Setting this to true affects the defaults for role and capabilities, if you don't specify any alternatives.
The default role that will be created for you will have full (i.e., *) permissions on all resources, and the deployment will have named IAM capabilities (i.e., able to create all IAM resources).
This is a shorthand that you can use if you fully trust the templates that are deployed in this pipeline. If you want more fine-grained permissions, use addToRolePolicy and capabilities to control what the CloudFormation deployment is allowed to do.
cfnCapabilitiesoptionalCfnCapabilities[]cfn_capabilitiesoptionaltyping.List[CfnCapabilities]cfnCapabilitiesoptionalList<CfnCapabilities>CfnCapabilitiesoptionalCfnCapabilities[]CfnCapabilitiesoptional*[]CfnCapabilities#Default: None, unless adminPermissions is true
notes
For stacks that contain certain resources, explicit acknowledgement is required that AWS CloudFormation might create or update those resources. For example, you must specify ANONYMOUS_IAM or NAMED_IAM if your stack template contains AWS Identity and Access Management (IAM) resources. For more information, see the link below.
changeSetNamestringchange_set_namestrchangeSetNameStringChangeSetNamestringChangeSetName*stringrequired#deploymentRoleoptionalIRoledeployment_roleoptionalIRoledeploymentRoleoptionalIRoleDeploymentRoleoptionalIRoleDeploymentRoleoptionalIRole#Default: A fresh role with full or no permissions (depending on the value of adminPermissions).
If not specified, a fresh role is created. The role is created with zero permissions unless adminPermissions is true, in which case the role will have full permissions.
extraInputsoptionalArtifact[]extra_inputsoptionaltyping.List[Artifact]extraInputsoptionalList<Artifact>ExtraInputsoptionalArtifact[]ExtraInputsoptional*[]Artifact#notes
This is especially useful when used in conjunction with the parameterOverrides property. For example, if you have:
parameterOverrides: { 'Param1': action1.outputArtifact.bucketName, 'Param2': action2.outputArtifact.objectKey, }
, if the output Artifacts of action1 and action2 were not used to set either the templateConfiguration or the templatePath properties, you need to make sure to include them in the extraInputs - otherwise, you'll get an "unrecognized Artifact" error during your Pipeline's execution.
outputoptionalArtifactoutputoptionalArtifactoutputoptionalArtifactOutputoptionalArtifactOutputoptionalArtifact#Default: Automatically generated artifact name.
Only applied if outputFileName is set as well.
outputFileNameoptionalstringoutput_file_nameoptionalstroutputFileNameoptionalStringOutputFileNameoptionalstringOutputFileNameoptional*string#Default: No output artifact generated
The file will contain the result of the call to AWS CloudFormation (for example the call to UpdateStack or CreateChangeSet).
AWS CodePipeline adds the file to the output artifact after performing the specified action.
parameterOverridesoptional{ [key: string]: any }parameter_overridesoptionaltyping.Mapping[str, Any]parameterOverridesoptionalMap<String, Object>ParameterOverridesoptionalIDictionary<string, object>ParameterOverridesoptional*map[string]interface{}#Default: No overrides
notes
Template parameters specified here take precedence over template parameters found in the artifact specified by the templateConfiguration property.
We recommend that you use the template configuration file to specify most of your parameter values. Use parameter overrides to specify only dynamic parameter values (values that are unknown until you run the pipeline).
All parameter names must be present in the stack template.
Note: the entire object cannot be more than 1kB.
Default: the Action resides in the 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.
Default: a new Role will be generated
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.
runOrderoptionalnumberrun_orderoptionalint | floatrunOrderoptionalNumberRunOrderoptionaldoubleRunOrderoptional*float64= 1#RunOrder determines the relative order in which multiple Actions in the same Stage execute.
templateConfigurationoptionalArtifactPathtemplate_configurationoptionalArtifactPathtemplateConfigurationoptionalArtifactPathTemplateConfigurationoptionalArtifactPathTemplateConfigurationoptionalArtifactPath#Default: No template configuration based on input artifacts
notes
The template configuration file should contain a JSON object that should look like this: { "Parameters": {...}, "Tags": {...}, "StackPolicy": {... }}. For more information, see AWS CloudFormation Artifacts.
Note that if you include sensitive information, such as passwords, restrict access to this file.
templatePathArtifactPathtemplate_pathArtifactPathtemplatePathArtifactPathTemplatePathArtifactPathTemplatePathArtifactPathrequired#variablesNamespaceoptionalstringvariables_namespaceoptionalstrvariablesNamespaceoptionalStringVariablesNamespaceoptionalstringVariablesNamespaceoptional*string#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