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

Class GitHubSourceAction

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.codepipeline.Action

software.amazon.awscdk.services.codepipeline.actions.Action

software.amazon.awscdk.services.codepipeline.actions.GitHubSourceAction

All Implemented Interfaces:

IAction, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:24:56.703Z")
@Stability(Stable)
public class GitHubSourceAction
extends Action

Source that is provided by a GitHub repository.

Example:

 // Read the secret from Secrets Manager
 Pipeline pipeline = new Pipeline(this, "MyPipeline");
 Artifact sourceOutput = new Artifact();
 GitHubSourceAction sourceAction = GitHubSourceAction.Builder.create()
         .actionName("GitHub_Source")
         .owner("awslabs")
         .repo("aws-cdk")
         .oauthToken(SecretValue.secretsManager("my-github-token"))
         .output(sourceOutput)
         .branch("develop")
         .build();
 pipeline.addStage(StageOptions.builder()
         .stageName("Source")
         .actions(List.of(sourceAction))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GitHubSourceAction.Builder	A fluent builder for GitHubSourceAction.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codepipeline.IAction

IAction.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
	GitHubSourceAction(GitHubSourceActionProps props)
protected	GitHubSourceAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	GitHubSourceAction(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
protected ActionConfig	bound(software.constructs.Construct scope, IStage stage, ActionBindOptions _options)	This is a renamed version of the IAction.bind method.
GitHubSourceVariables	getVariables()	The variables emitted by this action.

Methods inherited from class software.amazon.awscdk.services.codepipeline.actions.Action

getProvidedActionProperties

Methods inherited from class software.amazon.awscdk.services.codepipeline.Action

bind, getActionProperties, onStateChange, onStateChange, onStateChange, variableExpression

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

GitHubSourceAction

protected GitHubSourceAction(software.amazon.jsii.JsiiObjectRef objRef)

GitHubSourceAction

protected GitHubSourceAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

GitHubSourceAction

@Stability(Stable)
public GitHubSourceAction(@NotNull
 GitHubSourceActionProps props)

Parameters:

props - This parameter is required.

Method Details

bound

@Stability(Stable)
@NotNull
protected ActionConfig bound(@NotNull
 software.constructs.Construct scope,
 @NotNull
 IStage stage,
 @NotNull
 ActionBindOptions _options)

This is a renamed version of the IAction.bind method.

Specified by:

bound in class Action

Parameters:

scope - This parameter is required.

stage - This parameter is required.

_options - This parameter is required.

getVariables

@Stability(Stable)
@NotNull
public GitHubSourceVariables getVariables()

The variables emitted by this action.