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

Class CloudFormationDeployStackSetAction.Builder

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

  • Method Details

    • create

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

    • actionName

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

    • failureTolerancePercentage

      @Stability(Stable) public CloudFormationDeployStackSetAction.Builder failureTolerancePercentage(Number failureTolerancePercentage)
      The percentage of accounts per Region for which this stack operation can fail before AWS CloudFormation stops the operation in that Region.

      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.

      Default: 0%

      Parameters:
      failureTolerancePercentage - The percentage of accounts per Region for which this stack operation can fail before AWS CloudFormation stops the operation in that Region. This parameter is required.
      Returns:
      this

    • maxAccountConcurrencyPercentage

      @Stability(Stable) public CloudFormationDeployStackSetAction.Builder maxAccountConcurrencyPercentage(Number maxAccountConcurrencyPercentage)
      The maximum percentage of accounts in which to perform this operation at one time.

      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.

      Default: 1%

      Parameters:
      maxAccountConcurrencyPercentage - The maximum percentage of accounts in which to perform this operation at one time. This parameter is required.
      Returns:
      this

    • stackSetRegion

      @Stability(Stable) public CloudFormationDeployStackSetAction.Builder stackSetRegion(String stackSetRegion)
      The AWS Region the StackSet is 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: - same region as the Pipeline

      Parameters:
      stackSetRegion - The AWS Region the StackSet is in. This parameter is required.
      Returns:
      this

    • stackSetName

      @Stability(Stable) public CloudFormationDeployStackSetAction.Builder stackSetName(String stackSetName)
      The name to associate with the stack set.

      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.

      Parameters:
      stackSetName - The name to associate with the stack set. This parameter is required.
      Returns:
      this

    • template

      @Stability(Stable) public CloudFormationDeployStackSetAction.Builder template(StackSetTemplate template)
      The location of the template that defines the resources in the stack set.

      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.

      Parameters:
      template - The location of the template that defines the resources in the stack set. This parameter is required.
      Returns:
      this

    • cfnCapabilities

      @Stability(Stable) public CloudFormationDeployStackSetAction.Builder cfnCapabilities(List<? extends CfnCapabilities> cfnCapabilities)
      Indicates that the template can create and update resources, depending on the types of resources in the template.

      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: - the StackSet will have no IAM capabilities

      Parameters:
      cfnCapabilities - Indicates that the template can create and update resources, depending on the types of resources in the template. This parameter is required.
      Returns:
      this

    • deploymentModel

      @Stability(Stable) public CloudFormationDeployStackSetAction.Builder deploymentModel(StackSetDeploymentModel deploymentModel)
      Determines how IAM roles are created and managed.

      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()

      Parameters:
      deploymentModel - Determines how IAM roles are created and managed. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CloudFormationDeployStackSetAction.Builder description(String description)
      A description of the stack set.

      You can use this to describe the stack set’s purpose or other relevant information.

      Default: - no description

      Parameters:
      description - A description of the stack set. This parameter is required.
      Returns:
      this

    • parameters

      @Stability(Stable) public CloudFormationDeployStackSetAction.Builder parameters(StackSetParameters parameters)
      The template parameters for your stack set.

      These parameters are shared between all instances of the stack set.

      Default: - no parameters will be used

      Parameters:
      parameters - The template parameters for your stack set. This parameter is required.
      Returns:
      this

    • stackInstances

      @Stability(Stable) public CloudFormationDeployStackSetAction.Builder stackInstances(StackInstances stackInstances)
      Specify where to create or update Stack Instances.

      You can specify either AWS Accounts Ids or AWS Organizations Organizational Units.

      Default: - don't create or update any Stack Instances

      Parameters:
      stackInstances - Specify where to create or update Stack Instances. This parameter is required.
      Returns:
      this

    • build

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