@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
date="2022-05-13T01:13:40.846Z")
public interface GitHubSourceOptions
Example:
CodePipelineSource.gitHub("org/repo", "branch", GitHubSourceOptions.builder() // This is optional .authentication(SecretValue.secretsManager("my-token")) .build());
Modifier and Type | Interface and Description |
---|---|
static class |
GitHubSourceOptions.Builder
A builder for
GitHubSourceOptions |
static class |
GitHubSourceOptions.Jsii$Proxy
An implementation for
GitHubSourceOptions |
Modifier and Type | Method and Description |
---|---|
static GitHubSourceOptions.Builder |
builder() |
default SecretValue |
getAuthentication()
A GitHub OAuth token to use for authentication.
|
default GitHubTrigger |
getTrigger()
How AWS CodePipeline should be triggered.
|
default SecretValue getAuthentication()
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:
Default: - SecretValue.secretsManager('github-token')
https://docs.aws.amazon.com/codepipeline/latest/userguide/GitHub-create-personal-token-CLI.html
default GitHubTrigger getTrigger()
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
static GitHubSourceOptions.Builder builder()
GitHubSourceOptions.Builder
of GitHubSourceOptions