software.amazon.awscdk.services.codepipeline.actions

Class GitHubSourceAction.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<GitHubSourceAction>

Enclosing class:

GitHubSourceAction

@Stability(value=Experimental)
public static final class GitHubSourceAction.Builder
extends Object
implements software.amazon.jsii.Builder<GitHubSourceAction>

(experimental) A fluent builder for GitHubSourceAction.

Method Summary

Modifier and Type	Method and Description
GitHubSourceAction.Builder	actionName(String actionName) (experimental) The physical, human-readable name of the Action.
GitHubSourceAction.Builder	branch(String branch) (experimental) The branch to use.
GitHubSourceAction	build()
static GitHubSourceAction.Builder	create()
GitHubSourceAction.Builder	oauthToken(SecretValue oauthToken) (experimental) A GitHub OAuth token to use for authentication.
GitHubSourceAction.Builder	output(Artifact output)
GitHubSourceAction.Builder	owner(String owner) (experimental) The GitHub account/user that owns the repo.
GitHubSourceAction.Builder	repo(String repo) (experimental) The name of the repo, without the username.
GitHubSourceAction.Builder	runOrder(Number runOrder) (experimental) The runOrder property for this Action.
GitHubSourceAction.Builder	trigger(GitHubTrigger trigger) (experimental) How AWS CodePipeline should be triggered.
GitHubSourceAction.Builder	variablesNamespace(String variablesNamespace) (experimental) The name of the namespace to use for variables emitted by this action.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static GitHubSourceAction.Builder create()

Returns:

a new instance of GitHubSourceAction.Builder.

actionName

@Stability(value=Experimental)
public GitHubSourceAction.Builder actionName(String actionName)

(experimental) 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(value=Experimental)
public GitHubSourceAction.Builder runOrder(Number runOrder)

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

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

variablesNamespace

@Stability(value=Experimental)
public GitHubSourceAction.Builder variablesNamespace(String variablesNamespace)

(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

Parameters:

variablesNamespace - The name of the namespace to use for variables emitted by this action. This parameter is required.

Returns:

this

oauthToken

@Stability(value=Experimental)
public GitHubSourceAction.Builder oauthToken(SecretValue oauthToken)

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

Parameters:

oauthToken - A GitHub OAuth token to use for authentication. This parameter is required.

Returns:

this

See Also:

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

output

@Stability(value=Experimental)
public GitHubSourceAction.Builder output(Artifact output)

Parameters:

output - This parameter is required.

Returns:

this

owner

@Stability(value=Experimental)
public GitHubSourceAction.Builder owner(String owner)

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

Parameters:

owner - The GitHub account/user that owns the repo. This parameter is required.

Returns:

this

repo

@Stability(value=Experimental)
public GitHubSourceAction.Builder repo(String repo)

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

Parameters:

repo - The name of the repo, without the username. This parameter is required.

Returns:

this

branch

@Stability(value=Experimental)
public GitHubSourceAction.Builder branch(String branch)

(experimental) The branch to use.

Default: "master"

Parameters:

branch - The branch to use. This parameter is required.

Returns:

this

trigger

@Stability(value=Experimental)
public GitHubSourceAction.Builder trigger(GitHubTrigger trigger)

(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

Parameters:

trigger - How AWS CodePipeline should be triggered. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public GitHubSourceAction build()

Specified by:

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