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

Class CodeCommitSourceAction.Builder

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

  • Method Details

    • create

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

    • actionName

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

    • output

      @Stability(Stable) public CodeCommitSourceAction.Builder output(Artifact output)
      Parameters:
      output - This parameter is required.
      Returns:
      this

    • repository

      @Stability(Stable) public CodeCommitSourceAction.Builder repository(IRepository repository)
      The CodeCommit repository.

      Parameters:
      repository - The CodeCommit repository. This parameter is required.
      Returns:
      this

    • branch

      @Stability(Stable) public CodeCommitSourceAction.Builder branch(String branch)
      Default: 'master'

      Parameters:
      branch - This parameter is required.
      Returns:
      this

    • codeBuildCloneOutput

      @Stability(Stable) public CodeCommitSourceAction.Builder codeBuildCloneOutput(Boolean codeBuildCloneOutput)
      Whether the output should be the contents of the repository (which is the default), or a link that allows CodeBuild to clone the repository before building.

      Note: if this option is true, then only CodeBuild actions can use the resulting output.

      Default: false

      Parameters:
      codeBuildCloneOutput - Whether the output should be the contents of the repository (which is the default), or a link that allows CodeBuild to clone the repository before building. This parameter is required.
      Returns:
      this
      See Also:

    • customEventRule

      @Stability(Stable) public CodeCommitSourceAction.Builder customEventRule(ICustomEventRule customEventRule)
      You can pass a customEventRule to set up a custom event rule for the CodeCommit source action.

      You must provide the eventPattern and target properties in the customEventRule object. Check which eventPattern to use: https://docs.aws.amazon.com/codecommit/latest/userguide/monitoring-events.html

      Default: Event rule which is triggered by CodeCommit repository on commit

      Parameters:
      customEventRule - You can pass a customEventRule to set up a custom event rule for the CodeCommit source action. This parameter is required.
      Returns:
      this

    • eventRole

      @Stability(Stable) public CodeCommitSourceAction.Builder eventRole(IRole eventRole)
      Role to be used by on commit event rule.

      Used only when trigger value is CodeCommitTrigger.EVENTS.

      Default: a new role will be created.

      Parameters:
      eventRole - Role to be used by on commit event rule. This parameter is required.
      Returns:
      this

    • trigger

      @Stability(Stable) public CodeCommitSourceAction.Builder trigger(CodeCommitTrigger trigger)
      How should CodePipeline detect source changes for this Action.

      Default: CodeCommitTrigger.EVENTS

      Parameters:
      trigger - How should CodePipeline detect source changes for this Action. This parameter is required.
      Returns:
      this

    • build

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