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

Class GitHubSourceActionProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<GitHubSourceActionProps>

Enclosing interface:

GitHubSourceActionProps

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

A builder for GitHubSourceActionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GitHubSourceActionProps.Builder	actionName(String actionName)	Sets the value of CommonActionProps.getActionName()
GitHubSourceActionProps.Builder	branch(String branch)	Sets the value of GitHubSourceActionProps.getBranch()
GitHubSourceActionProps	build()	Builds the configured instance.
GitHubSourceActionProps.Builder	oauthToken(SecretValue oauthToken)	Sets the value of GitHubSourceActionProps.getOauthToken()
GitHubSourceActionProps.Builder	output(Artifact output)	Sets the value of GitHubSourceActionProps.getOutput()
GitHubSourceActionProps.Builder	owner(String owner)	Sets the value of GitHubSourceActionProps.getOwner()
GitHubSourceActionProps.Builder	repo(String repo)	Sets the value of GitHubSourceActionProps.getRepo()
GitHubSourceActionProps.Builder	runOrder(Number runOrder)	Sets the value of CommonActionProps.getRunOrder()
GitHubSourceActionProps.Builder	trigger(GitHubTrigger trigger)	Sets the value of GitHubSourceActionProps.getTrigger()
GitHubSourceActionProps.Builder	variablesNamespace(String variablesNamespace)	Sets the value of CommonActionProps.getVariablesNamespace()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

oauthToken

@Stability(Stable)
public GitHubSourceActionProps.Builder oauthToken(SecretValue oauthToken)

Sets the value of GitHubSourceActionProps.getOauthToken()

Parameters:

oauthToken - A GitHub OAuth token to use for authentication. This parameter is required. It is recommended to use a Secrets Manager Secret to obtain the token:

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

If you rotate the value in the Secret, you must also change at least one property of the CodePipeline to force CloudFormation to re-read the secret.

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)

Returns:

this

output

@Stability(Stable)
public GitHubSourceActionProps.Builder output(Artifact output)

Sets the value of GitHubSourceActionProps.getOutput()

Parameters:

output - the value to be set. This parameter is required.

Returns:

this

owner

@Stability(Stable)
public GitHubSourceActionProps.Builder owner(String owner)

Sets the value of GitHubSourceActionProps.getOwner()

Parameters:

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

Returns:

this

repo

@Stability(Stable)
public GitHubSourceActionProps.Builder repo(String repo)

Sets the value of GitHubSourceActionProps.getRepo()

Parameters:

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

Returns:

this

branch

@Stability(Stable)
public GitHubSourceActionProps.Builder branch(String branch)

Sets the value of GitHubSourceActionProps.getBranch()

Parameters:

branch - The branch to use.

Returns:

this

trigger

@Stability(Stable)
public GitHubSourceActionProps.Builder trigger(GitHubTrigger trigger)

Sets the value of GitHubSourceActionProps.getTrigger()

Parameters:

trigger - 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).

Returns:

this

actionName

@Stability(Stable)
public GitHubSourceActionProps.Builder actionName(String actionName)

Sets the value of CommonActionProps.getActionName()

Parameters:

actionName - The physical, human-readable name of the Action. This parameter is required. Note that Action names must be unique within a single Stage.

Returns:

this

runOrder

@Stability(Stable)
public GitHubSourceActionProps.Builder runOrder(Number runOrder)

Sets the value of CommonActionProps.getRunOrder()

Parameters:

runOrder - The runOrder property for this Action. RunOrder determines the relative order in which multiple Actions in the same Stage execute.

Returns:

this

variablesNamespace

@Stability(Stable)
public GitHubSourceActionProps.Builder variablesNamespace(String variablesNamespace)

Sets the value of CommonActionProps.getVariablesNamespace()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public GitHubSourceActionProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of GitHubSourceActionProps

Throws:

NullPointerException - if any required attribute was not provided