Package software.amazon.awscdk.services.codepipeline

Class CfnPipelineProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • roleArn

      @Stability(Stable) public CfnPipelineProps.Builder roleArn(String roleArn)
      Sets the value of CfnPipelineProps.getRoleArn()
      Parameters:
      roleArn - The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn , or to use to assume roles for actions with an actionRoleArn . This parameter is required.
      Returns:
      this

    • stages

      @Stability(Stable) public CfnPipelineProps.Builder stages(IResolvable stages)
      Sets the value of CfnPipelineProps.getStages()
      Parameters:
      stages - Represents information about a stage and its definition. This parameter is required.
      Returns:
      this

    • stages

      @Stability(Stable) public CfnPipelineProps.Builder stages(List<? extends Object> stages)
      Sets the value of CfnPipelineProps.getStages()
      Parameters:
      stages - Represents information about a stage and its definition. This parameter is required.
      Returns:
      this

    • artifactStore

      @Stability(Stable) public CfnPipelineProps.Builder artifactStore(IResolvable artifactStore)
      Sets the value of CfnPipelineProps.getArtifactStore()
      Parameters:
      artifactStore - The S3 bucket where artifacts for the pipeline are stored.

      You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores .

      Returns:
      this

    • artifactStore

      @Stability(Stable) public CfnPipelineProps.Builder artifactStore(CfnPipeline.ArtifactStoreProperty artifactStore)
      Sets the value of CfnPipelineProps.getArtifactStore()
      Parameters:
      artifactStore - The S3 bucket where artifacts for the pipeline are stored.

      You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores .

      Returns:
      this

    • artifactStores

      @Stability(Stable) public CfnPipelineProps.Builder artifactStores(IResolvable artifactStores)
      Sets the value of CfnPipelineProps.getArtifactStores()
      Parameters:
      artifactStores - A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

      You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores .

      Returns:
      this

    • artifactStores

      @Stability(Stable) public CfnPipelineProps.Builder artifactStores(List<? extends Object> artifactStores)
      Sets the value of CfnPipelineProps.getArtifactStores()
      Parameters:
      artifactStores - A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

      You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores .

      Returns:
      this

    • disableInboundStageTransitions

      @Stability(Stable) public CfnPipelineProps.Builder disableInboundStageTransitions(IResolvable disableInboundStageTransitions)
      Sets the value of CfnPipelineProps.getDisableInboundStageTransitions()
      Parameters:
      disableInboundStageTransitions - Represents the input of a DisableStageTransition action.
      Returns:
      this

    • disableInboundStageTransitions

      @Stability(Stable) public CfnPipelineProps.Builder disableInboundStageTransitions(List<? extends Object> disableInboundStageTransitions)
      Sets the value of CfnPipelineProps.getDisableInboundStageTransitions()
      Parameters:
      disableInboundStageTransitions - Represents the input of a DisableStageTransition action.
      Returns:
      this

    • executionMode

      @Stability(Stable) public CfnPipelineProps.Builder executionMode(String executionMode)
      Sets the value of CfnPipelineProps.getExecutionMode()
      Parameters:
      executionMode - The method that the pipeline will use to handle multiple executions. The default mode is SUPERSEDED.
      Returns:
      this

    • name

      @Stability(Stable) public CfnPipelineProps.Builder name(String name)
      Sets the value of CfnPipelineProps.getName()
      Parameters:
      name - The name of the pipeline.
      Returns:
      this

    • pipelineType

      @Stability(Stable) public CfnPipelineProps.Builder pipelineType(String pipelineType)
      Sets the value of CfnPipelineProps.getPipelineType()
      Parameters:
      pipelineType - CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.
      • V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.
      • V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.

      Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.

      For information about pricing for CodePipeline, see Pricing .

      For information about which type of pipeline to choose, see What type of pipeline is right for me? .

      Returns:
      this

    • restartExecutionOnUpdate

      @Stability(Stable) public CfnPipelineProps.Builder restartExecutionOnUpdate(Boolean restartExecutionOnUpdate)
      Sets the value of CfnPipelineProps.getRestartExecutionOnUpdate()
      Parameters:
      restartExecutionOnUpdate - Indicates whether to rerun the CodePipeline pipeline after you update it.
      Returns:
      this

    • restartExecutionOnUpdate

      @Stability(Stable) public CfnPipelineProps.Builder restartExecutionOnUpdate(IResolvable restartExecutionOnUpdate)
      Sets the value of CfnPipelineProps.getRestartExecutionOnUpdate()
      Parameters:
      restartExecutionOnUpdate - Indicates whether to rerun the CodePipeline pipeline after you update it.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnPipelineProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnPipelineProps.getTags()
      Parameters:
      tags - Specifies the tags applied to the pipeline.
      Returns:
      this

    • triggers

      @Stability(Stable) public CfnPipelineProps.Builder triggers(IResolvable triggers)
      Sets the value of CfnPipelineProps.getTriggers()
      Parameters:
      triggers - The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

      When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

      Returns:
      this

    • triggers

      @Stability(Stable) public CfnPipelineProps.Builder triggers(List<? extends Object> triggers)
      Sets the value of CfnPipelineProps.getTriggers()
      Parameters:
      triggers - The trigger configuration specifying a type of event, such as Git tags, that starts the pipeline.

      When a trigger configuration is specified, default change detection for repository and branch commits is disabled.

      Returns:
      this

    • variables

      @Stability(Stable) public CfnPipelineProps.Builder variables(IResolvable variables)
      Sets the value of CfnPipelineProps.getVariables()
      Parameters:
      variables - A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+ .
      Returns:
      this

    • variables

      @Stability(Stable) public CfnPipelineProps.Builder variables(List<? extends Object> variables)
      Sets the value of CfnPipelineProps.getVariables()
      Parameters:
      variables - A list that defines the pipeline variables for a pipeline resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+ .
      Returns:
      this

    • build

      @Stability(Stable) public CfnPipelineProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnPipelineProps>
      Returns:
      a new instance of CfnPipelineProps
      Throws:
      NullPointerException - if any required attribute was not provided