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

Class CloudFormationCreateUpdateStackAction.Builder

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

  • Method Details

    • create

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

    • actionName

      @Stability(Stable) public CloudFormationCreateUpdateStackAction.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 CloudFormationCreateUpdateStackAction.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 CloudFormationCreateUpdateStackAction.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 CloudFormationCreateUpdateStackAction.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

    • adminPermissions

      @Stability(Stable) public CloudFormationCreateUpdateStackAction.Builder adminPermissions(Boolean adminPermissions)
      Whether to grant full permissions to CloudFormation while deploying this template.

      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.

      Parameters:
      adminPermissions - Whether to grant full permissions to CloudFormation while deploying this template. This parameter is required.
      Returns:
      this

    • stackName

      @Stability(Stable) public CloudFormationCreateUpdateStackAction.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

    • templatePath

      @Stability(Stable) public CloudFormationCreateUpdateStackAction.Builder templatePath(ArtifactPath templatePath)
      Input artifact with the CloudFormation template to deploy.

      Parameters:
      templatePath - Input artifact with the CloudFormation template to deploy. This parameter is required.
      Returns:
      this

    • account

      @Stability(Stable) public CloudFormationCreateUpdateStackAction.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

    • cfnCapabilities

      @Stability(Stable) public CloudFormationCreateUpdateStackAction.Builder cfnCapabilities(List<? extends CfnCapabilities> cfnCapabilities)
      Acknowledge certain changes made as part of deployment.

      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.

      Default: None, unless `adminPermissions` is true

      Parameters:
      cfnCapabilities - Acknowledge certain changes made as part of deployment. This parameter is required.
      Returns:
      this
      See Also:

    • deploymentRole

      @Stability(Stable) public CloudFormationCreateUpdateStackAction.Builder deploymentRole(IRole deploymentRole)
      IAM role to assume when deploying changes.

      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.

      Default: A fresh role with full or no permissions (depending on the value of `adminPermissions`).

      Parameters:
      deploymentRole - IAM role to assume when deploying changes. This parameter is required.
      Returns:
      this

    • extraInputs

      @Stability(Stable) public CloudFormationCreateUpdateStackAction.Builder extraInputs(List<? extends Artifact> extraInputs)
      The list of additional input Artifacts for this Action.

      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.

      Parameters:
      extraInputs - The list of additional input Artifacts for this Action. This parameter is required.
      Returns:
      this

    • output

      @Stability(Stable) public CloudFormationCreateUpdateStackAction.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 CloudFormationCreateUpdateStackAction.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

    • parameterOverrides

      @Stability(Stable) public CloudFormationCreateUpdateStackAction.Builder parameterOverrides(Map<String,? extends Object> parameterOverrides)
      Additional template parameters.

      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: No overrides

      Parameters:
      parameterOverrides - Additional template parameters. This parameter is required.
      Returns:
      this

    • region

      @Stability(Stable) public CloudFormationCreateUpdateStackAction.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

    • replaceOnFailure

      @Stability(Stable) public CloudFormationCreateUpdateStackAction.Builder replaceOnFailure(Boolean replaceOnFailure)
      Replace the stack if it's in a failed state.

      If this is set to true and the stack is in a failed state (one of ROLLBACK_COMPLETE, ROLLBACK_FAILED, CREATE_FAILED, DELETE_FAILED, or UPDATE_ROLLBACK_FAILED), AWS CloudFormation deletes the stack and then creates a new stack.

      If this is not set to true and the stack is in a failed state, the deployment fails.

      Default: false

      Parameters:
      replaceOnFailure - Replace the stack if it's in a failed state. This parameter is required.
      Returns:
      this

    • templateConfiguration

      @Stability(Stable) public CloudFormationCreateUpdateStackAction.Builder templateConfiguration(ArtifactPath templateConfiguration)
      Input artifact to use for template parameters values and stack policy.

      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.

      Default: No template configuration based on input artifacts

      Parameters:
      templateConfiguration - Input artifact to use for template parameters values and stack policy. This parameter is required.
      Returns:
      this

    • build

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