Class CloudFormationExecuteChangeSetActionProps

Properties for the CloudFormationExecuteChangeSetAction.

Inheritance
System.Object
CloudFormationExecuteChangeSetActionProps
Namespace: Amazon.CDK.AWS.CodePipeline.Actions
Assembly: Amazon.CDK.AWS.CodePipeline.Actions.dll
Syntax (csharp)
public class CloudFormationExecuteChangeSetActionProps : Object, ICloudFormationExecuteChangeSetActionProps, ICommonAwsActionProps, ICommonActionProps
Syntax (vb)
Public Class CloudFormationExecuteChangeSetActionProps
    Inherits Object
    Implements ICloudFormationExecuteChangeSetActionProps, ICommonAwsActionProps, ICommonActionProps
Remarks

ExampleMetadata: lit=test/integ.cfn-template-from-repo.lit.ts infused

Examples
// Source stage: read from repository
var repo = new Repository(stack, "TemplateRepo", new RepositoryProps {
    RepositoryName = "template-repo"
});
var sourceOutput = new Artifact("SourceArtifact");
var source = new CodeCommitSourceAction(new CodeCommitSourceActionProps {
    ActionName = "Source",
    Repository = repo,
    Output = sourceOutput,
    Trigger = CodeCommitTrigger.POLL
});
IDictionary<string, object> sourceStage = new Dictionary<string, object> {
    { "stageName", "Source" },
    { "actions", new [] { source } }
};

// Deployment stage: create and deploy changeset with manual approval
var stackName = "OurStack";
var changeSetName = "StagedChangeSet";

IDictionary<string, object> prodStage = new Dictionary<string, object> {
    { "stageName", "Deploy" },
    { "actions", new [] {
        new CloudFormationCreateReplaceChangeSetAction(new CloudFormationCreateReplaceChangeSetActionProps {
            ActionName = "PrepareChanges",
            StackName = stackName,
            ChangeSetName = changeSetName,
            AdminPermissions = true,
            TemplatePath = sourceOutput.AtPath("template.yaml"),
            RunOrder = 1
        }),
        new ManualApprovalAction(new ManualApprovalActionProps {
            ActionName = "ApproveChanges",
            RunOrder = 2
        }),
        new CloudFormationExecuteChangeSetAction(new CloudFormationExecuteChangeSetActionProps {
            ActionName = "ExecuteChanges",
            StackName = stackName,
            ChangeSetName = changeSetName,
            RunOrder = 3
        }) } }
};

new Pipeline(stack, "Pipeline", new PipelineProps {
    Stages = new [] { sourceStage, prodStage }
});

Synopsis

Constructors

CloudFormationExecuteChangeSetActionProps()

Properties

Account

The AWS account this Action is supposed to operate in.
ActionName

The physical, human-readable name of the Action.
ChangeSetName

Name of the change set to execute.
Output

The name of the output artifact to generate.
OutputFileName

A name for the filename in the output artifact to store the AWS CloudFormation call's result.
Region

The AWS region the given Action resides in.
Role

The Role in which context's this Action will be executing in.
RunOrder

The runOrder property for this Action.
StackName

The name of the stack to apply this action to.
VariablesNamespace

The name of the namespace to use for variables emitted by this action.

Constructors

CloudFormationExecuteChangeSetActionProps()

public CloudFormationExecuteChangeSetActionProps()

Properties

Account

The AWS account this Action is supposed to operate in.

public string Account { get; set; }
Property Value

System.String

Remarks

Note: if you specify the role property, this is ignored - the action will operate in the same region the passed role does.

Default: - action resides in the same account as the pipeline

ActionName

The physical, human-readable name of the Action.

public string ActionName { get; set; }
Property Value

System.String

Remarks

Note that Action names must be unique within a single Stage.

ChangeSetName

Name of the change set to execute.

public string ChangeSetName { get; set; }
Property Value

System.String

Output

The name of the output artifact to generate.

public Artifact_ Output { get; set; }
Property Value

Artifact_

Remarks

Only applied if outputFileName is set as well.

Default: Automatically generated artifact name.

OutputFileName

A name for the filename in the output artifact to store the AWS CloudFormation call's result.

public string OutputFileName { get; set; }
Property Value

System.String

Remarks

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.

Default: No output artifact generated

Region

The AWS region the given Action resides in.

public string Region { get; set; }
Property Value

System.String

Remarks

Note that a cross-region Pipeline requires replication buckets to function correctly. You can provide their names with the {@link 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: the Action resides in the same region as the Pipeline

Role

The Role in which context's this Action will be executing in.

public IRole Role { get; set; }
Property Value

IRole

Remarks

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 {@link IAction.bind} method in the {@link ActionBindOptions.role} property.

Default: a new Role will be generated

RunOrder

The runOrder property for this Action.

public Nullable<double> RunOrder { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Default: 1

See: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html

StackName

The name of the stack to apply this action to.

public string StackName { get; set; }
Property Value

System.String

VariablesNamespace

The name of the namespace to use for variables emitted by this action.

public string VariablesNamespace { get; set; }
Property Value

System.String

Remarks

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

Implements