Package io.github.cdklabs.cdkpipelines.github

Class AddGitHubStageOptions.Builder

java.lang.Object

io.github.cdklabs.cdkpipelines.github.AddGitHubStageOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AddGitHubStageOptions>

Enclosing interface:

AddGitHubStageOptions

@Stability(Stable)
public static final class AddGitHubStageOptions.Builder
extends Object
implements software.amazon.jsii.Builder<AddGitHubStageOptions>

A builder for AddGitHubStageOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AddGitHubStageOptions	build()	Builds the configured instance.
AddGitHubStageOptions.Builder	gitHubEnvironment(String gitHubEnvironment)	Sets the value of AddGitHubStageOptions.getGitHubEnvironment()
AddGitHubStageOptions.Builder	post(List<? extends software.amazon.awscdk.pipelines.Step> post)	Sets the value of AddStageOpts.getPost()
AddGitHubStageOptions.Builder	pre(List<? extends software.amazon.awscdk.pipelines.Step> pre)	Sets the value of AddStageOpts.getPre()
AddGitHubStageOptions.Builder	stackCapabilities(List<? extends StackCapabilities> stackCapabilities)	Sets the value of AddGitHubStageOptions.getStackCapabilities()
AddGitHubStageOptions.Builder	stackSteps(List<? extends software.amazon.awscdk.pipelines.StackSteps> stackSteps)	Sets the value of AddStageOpts.getStackSteps()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

gitHubEnvironment

@Stability(Stable)
public AddGitHubStageOptions.Builder gitHubEnvironment(String gitHubEnvironment)

Sets the value of AddGitHubStageOptions.getGitHubEnvironment()

Parameters:

gitHubEnvironment - Run the stage in a specific GitHub Environment. If specified, any protection rules configured for the environment must pass before the job is set to a runner. For example, if the environment has a manual approval rule configured, then the workflow will wait for the approval before sending the job to the runner.

Running a workflow that references an environment that does not exist will create an environment with the referenced name.

Returns:

this

stackCapabilities

@Stability(Stable)
public AddGitHubStageOptions.Builder stackCapabilities(List<? extends StackCapabilities> stackCapabilities)

Sets the value of AddGitHubStageOptions.getStackCapabilities()

Parameters:

stackCapabilities - In some cases, you must explicitly acknowledge that your CloudFormation stack template contains certain capabilities in order for CloudFormation to create the stack. If insufficiently specified, CloudFormation returns an InsufficientCapabilities error.

Returns:

this

post

@Stability(Stable)
public AddGitHubStageOptions.Builder post(List<? extends software.amazon.awscdk.pipelines.Step> post)

Sets the value of AddStageOpts.getPost()

Parameters:

post - Additional steps to run after all of the stacks in the stage.

Returns:

this

pre

@Stability(Stable)
public AddGitHubStageOptions.Builder pre(List<? extends software.amazon.awscdk.pipelines.Step> pre)

Sets the value of AddStageOpts.getPre()

Parameters:

pre - Additional steps to run before any of the stacks in the stage.

Returns:

this

stackSteps

@Stability(Stable)
public AddGitHubStageOptions.Builder stackSteps(List<? extends software.amazon.awscdk.pipelines.StackSteps> stackSteps)

Sets the value of AddStageOpts.getStackSteps()

Parameters:

stackSteps - Instructions for stack level steps.

Returns:

this

build

@Stability(Stable)
public AddGitHubStageOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<AddGitHubStageOptions>

Returns:

a new instance of AddGitHubStageOptions

Throws:

NullPointerException - if any required attribute was not provided