Package io.github.cdklabs.cdkpipelines.github

Interface AddGitHubStageOptions

All Superinterfaces:

software.amazon.awscdk.pipelines.AddStageOpts, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AddGitHubStageOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.62.0 (build 293ac17)",
           date="2022-07-16T00:20:23.371Z")
@Stability(Stable)
public interface AddGitHubStageOptions
extends software.amazon.jsii.JsiiSerializable, software.amazon.awscdk.pipelines.AddStageOpts

Options to pass to `addStageWithGitHubOpts`.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AddGitHubStageOptions.Builder	A builder for AddGitHubStageOptions
static class	AddGitHubStageOptions.Jsii$Proxy	An implementation for AddGitHubStageOptions

Method Summary

Modifier and Type	Method	Description
static AddGitHubStageOptions.Builder	builder()
default String	getGitHubEnvironment()	Run the stage in a specific GitHub Environment.
default List<StackCapabilities>	getStackCapabilities()	In some cases, you must explicitly acknowledge that your CloudFormation stack template contains certain capabilities in order for CloudFormation to create the stack.

Methods inherited from interface software.amazon.awscdk.pipelines.AddStageOpts

getPost, getPre, getStackSteps

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getGitHubEnvironment

@Stability(Stable)
@Nullable
default String getGitHubEnvironment()

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.

Default: - no GitHub environment

See Also:

https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment

getStackCapabilities

@Stability(Stable)
@Nullable
default List<StackCapabilities> getStackCapabilities()

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.

Default: ['CAPABILITY_IAM']

builder

@Stability(Stable)
static AddGitHubStageOptions.Builder builder()

Returns:

a AddGitHubStageOptions.Builder of AddGitHubStageOptions