Package software.amazon.awscdk.services.codepipeline.actions

Class CloudFormationExecuteChangeSetAction.Builder

java.lang.Object
software.amazon.awscdk.services.codepipeline.actions.CloudFormationExecuteChangeSetAction.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CloudFormationExecuteChangeSetAction>
Enclosing class:
CloudFormationExecuteChangeSetAction
@Stability(Stable) public static final class CloudFormationExecuteChangeSetAction.Builder extends Object implements software.amazon.jsii.Builder<CloudFormationExecuteChangeSetAction>
A fluent builder for CloudFormationExecuteChangeSetAction.

  • Method Details

    • create

      @Stability(Stable) public static CloudFormationExecuteChangeSetAction.Builder create()
      Returns:
      a new instance of CloudFormationExecuteChangeSetAction.Builder.

    • actionName

      @Stability(Stable) public CloudFormationExecuteChangeSetAction.Builder actionName(String actionName)
      The physical, human-readable name of the Action.

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

      Parameters:
      actionName - The physical, human-readable name of the Action. This parameter is required.
      Returns:
      this

    • runOrder

      @Stability(Stable) public CloudFormationExecuteChangeSetAction.Builder runOrder(Number runOrder)
      The runOrder property for this Action.

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

      Default: 1

      Parameters:
      runOrder - The runOrder property for this Action. This parameter is required.
      Returns:
      this
      See Also:

    • variablesNamespace

      @Stability(Stable) public CloudFormationExecuteChangeSetAction.Builder variablesNamespace(String variablesNamespace)
      The name of the namespace to use for variables emitted by this action.

      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

      Parameters:
      variablesNamespace - The name of the namespace to use for variables emitted by this action. This parameter is required.
      Returns:
      this

    • role

      @Stability(Stable) public CloudFormationExecuteChangeSetAction.Builder role(IRole role)
      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.

      Default: a new Role will be generated

      Parameters:
      role - The Role in which context's this Action will be executing in. This parameter is required.
      Returns:
      this

    • changeSetName

      @Stability(Stable) public CloudFormationExecuteChangeSetAction.Builder changeSetName(String changeSetName)
      Name of the change set to execute.

      Parameters:
      changeSetName - Name of the change set to execute. This parameter is required.
      Returns:
      this

    • stackName

      @Stability(Stable) public CloudFormationExecuteChangeSetAction.Builder stackName(String stackName)
      The name of the stack to apply this action to.

      Parameters:
      stackName - The name of the stack to apply this action to. This parameter is required.
      Returns:
      this

    • account

      @Stability(Stable) public CloudFormationExecuteChangeSetAction.Builder account(String account)
      The AWS account this Action is supposed to operate in.

      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

      Parameters:
      account - The AWS account this Action is supposed to operate in. This parameter is required.
      Returns:
      this

    • output

      @Stability(Stable) public CloudFormationExecuteChangeSetAction.Builder output(Artifact output)
      The name of the output artifact to generate.

      Only applied if outputFileName is set as well.

      Default: Automatically generated artifact name.

      Parameters:
      output - The name of the output artifact to generate. This parameter is required.
      Returns:
      this

    • outputFileName

      @Stability(Stable) public CloudFormationExecuteChangeSetAction.Builder outputFileName(String outputFileName)
      A name for the filename in the output artifact to store the AWS CloudFormation call's result.

      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

      Parameters:
      outputFileName - A name for the filename in the output artifact to store the AWS CloudFormation call's result. This parameter is required.
      Returns:
      this

    • region

      @Stability(Stable) public CloudFormationExecuteChangeSetAction.Builder region(String region)
      The AWS region the given Action resides 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.

      Default: the Action resides in the same region as the Pipeline

      Parameters:
      region - The AWS region the given Action resides in. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CloudFormationExecuteChangeSetAction build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CloudFormationExecuteChangeSetAction>
      Returns:
      a newly built instance of CloudFormationExecuteChangeSetAction.