software.amazon.awscdk.services.codepipeline.actions

Class GitHubSourceActionProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.codepipeline.actions.GitHubSourceActionProps.Jsii$Proxy

All Implemented Interfaces:

GitHubSourceActionProps, CommonActionProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

GitHubSourceActionProps

@Stability(value=Experimental)
 @Internal
public static final class GitHubSourceActionProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements GitHubSourceActionProps

An implementation for GitHubSourceActionProps

Nested Class Summary

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.actions.GitHubSourceActionProps

GitHubSourceActionProps.Builder, GitHubSourceActionProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.
protected	Jsii$Proxy(SecretValue oauthToken, Artifact output, String owner, String repo, String branch, GitHubTrigger trigger, String actionName, Number runOrder, String variablesNamespace) Constructor that initializes the object based on literal property values passed by the GitHubSourceActionProps.Builder.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
String	getActionName() (experimental) The physical, human-readable name of the Action.
String	getBranch() (experimental) The branch to use.
SecretValue	getOauthToken() (experimental) A GitHub OAuth token to use for authentication.
Artifact	getOutput()
String	getOwner() (experimental) The GitHub account/user that owns the repo.
String	getRepo() (experimental) The name of the repo, without the username.
Number	getRunOrder() (experimental) The runOrder property for this Action.
GitHubTrigger	getTrigger() (experimental) How AWS CodePipeline should be triggered.
String	getVariablesNamespace() (experimental) The name of the namespace to use for variables emitted by this action.
int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.codepipeline.actions.GitHubSourceActionProps

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(SecretValue oauthToken,
                     Artifact output,
                     String owner,
                     String repo,
                     String branch,
                     GitHubTrigger trigger,
                     String actionName,
                     Number runOrder,
                     String variablesNamespace)

Constructor that initializes the object based on literal property values passed by the GitHubSourceActionProps.Builder.

Method Detail

getOauthToken

public final SecretValue getOauthToken()

Description copied from interface: GitHubSourceActionProps

(experimental) A GitHub OAuth token to use for authentication.

It is recommended to use a Secrets Manager Secret to obtain the token:

const oauth = cdk.SecretValue.secretsManager('my-github-token'); new GitHubSource(this, 'GitHubAction', { oauthToken: oauth, ... });

The GitHub Personal Access Token should have these scopes:

• repo - to read the repository
• admin:repo_hook - if you plan to use webhooks (true by default)

Specified by:

getOauthToken in interface GitHubSourceActionProps

See Also:

https://docs.aws.amazon.com/codepipeline/latest/userguide/appendix-github-oauth.html#GitHub-create-personal-token-CLI

getOutput

public final Artifact getOutput()

Specified by:

getOutput in interface GitHubSourceActionProps

getOwner

public final String getOwner()

Description copied from interface: GitHubSourceActionProps

(experimental) The GitHub account/user that owns the repo.

Specified by:

getOwner in interface GitHubSourceActionProps

getRepo

public final String getRepo()

Description copied from interface: GitHubSourceActionProps

(experimental) The name of the repo, without the username.

Specified by:

getRepo in interface GitHubSourceActionProps

getBranch

public final String getBranch()

Description copied from interface: GitHubSourceActionProps

(experimental) The branch to use.

Default: "master"

Specified by:

getBranch in interface GitHubSourceActionProps

getTrigger

public final GitHubTrigger getTrigger()

Description copied from interface: GitHubSourceActionProps

(experimental) How AWS CodePipeline should be triggered.

With the default value "WEBHOOK", a webhook is created in GitHub that triggers the action With "POLL", CodePipeline periodically checks the source for changes With "None", the action is not triggered through changes in the source

To use WEBHOOK, your GitHub Personal Access Token should have admin:repo_hook scope (in addition to the regular repo scope).

Default: GitHubTrigger.WEBHOOK

Specified by:

getTrigger in interface GitHubSourceActionProps

getActionName

public final String getActionName()

Description copied from interface: CommonActionProps

(experimental) The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.

Specified by:

getActionName in interface CommonActionProps

getRunOrder

public final Number getRunOrder()

Description copied from interface: CommonActionProps

(experimental) The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Default: 1

Specified by:

getRunOrder in interface CommonActionProps

See Also:

https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html

getVariablesNamespace

public final String getVariablesNamespace()

Description copied from interface: CommonActionProps

(experimental) 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

Specified by:

getVariablesNamespace in interface CommonActionProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object