Interface GitHubSourceOptions

Options for GitHub sources

interface GitHubSourceOptions {
    actionName?: string;
    authentication?: SecretValue;
    trigger?: GitHubTrigger;
}

Properties

actionName? authentication? trigger?

Properties

Optional ReadonlyactionName

actionName?: string

The action name used for this source in the CodePipeline

Default

- The repository string

Optional Readonlyauthentication

authentication?: SecretValue

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');

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)

See

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

Default

- SecretValue.secretsManager('github-token')

Optional Readonlytrigger

trigger?: GitHubTrigger

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

Settings

Member Visibility

On This Page

Properties