software.amazon.awscdk.pipelines

Class GitHubSourceOptions.Builder

java.lang.Object

software.amazon.awscdk.pipelines.GitHubSourceOptions.Builder

Enclosing interface:

GitHubSourceOptions

public static final class GitHubSourceOptions.Builder
extends java.lang.Object

A builder for GitHubSourceOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
GitHubSourceOptions.Builder	authentication(SecretValue authentication) Sets the value of GitHubSourceOptions.getAuthentication()
GitHubSourceOptions	build() Builds the configured instance.
GitHubSourceOptions.Builder	trigger(GitHubTrigger trigger) Sets the value of GitHubSourceOptions.getTrigger()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

authentication

public GitHubSourceOptions.Builder authentication(SecretValue authentication)

Sets the value of GitHubSourceOptions.getAuthentication()

Parameters:

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

                       SecretValue oauth = SecretValue.secretsManager("my-github-token");
                       

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

trigger

public GitHubSourceOptions.Builder trigger(GitHubTrigger trigger)

Sets the value of GitHubSourceOptions.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

build

public GitHubSourceOptions build()

Builds the configured instance.

Returns:

a new instance of GitHubSourceOptions

Throws:

java.lang.NullPointerException - if any required attribute was not provided