software.amazon.awscdk.services.codepipeline

Interface GitHubSourceActionProps

All Superinterfaces:

software.amazon.awscdk.services.codepipeline.api.CommonActionConstructProps, software.amazon.awscdk.services.codepipeline.api.CommonActionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GitHubSourceActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/0.7.8 (build 100f5ad)",
           date="2018-10-26T18:00:29.450Z")
public interface GitHubSourceActionProps
extends software.amazon.jsii.JsiiSerializable, software.amazon.awscdk.services.codepipeline.api.CommonActionProps, software.amazon.awscdk.services.codepipeline.api.CommonActionConstructProps

Construction properties of the GitHub source action.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GitHubSourceActionProps.Builder A builder for GitHubSourceActionProps
static class	GitHubSourceActionProps.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
static GitHubSourceActionProps.Builder	builder()
String	getBranch() The branch to use.
software.amazon.awscdk.Secret	getOauthToken() A GitHub OAuth token to use for authentication.
String	getOutputArtifactName() The name of the source's output artifact.
String	getOwner() The GitHub account/user that owns the repo.
Boolean	getPollForSourceChanges() Whether or not AWS CodePipeline should poll for source changes
String	getRepo() The name of the repo, without the username.
void	setBranch(String value) The branch to use.
void	setOauthToken(software.amazon.awscdk.Secret value) A GitHub OAuth token to use for authentication.
void	setOutputArtifactName(String value) The name of the source's output artifact.
void	setOwner(String value) The GitHub account/user that owns the repo.
void	setPollForSourceChanges(Boolean value) Whether or not AWS CodePipeline should poll for source changes
void	setRepo(String value) The name of the repo, without the username.

Methods inherited from interface software.amazon.awscdk.services.codepipeline.api.CommonActionProps

getRunOrder, setRunOrder

Methods inherited from interface software.amazon.awscdk.services.codepipeline.api.CommonActionConstructProps

getStage, setStage

Method Detail

getOauthToken

software.amazon.awscdk.Secret getOauthToken()

A GitHub OAuth token to use for authentication. It is recommended to use a `SecretParameter` to obtain the token from the SSM Parameter Store: const oauth = new SecretParameter(this, 'GitHubOAuthToken', { ssmParameter: 'my-github-token }); new GitHubSource(stage, 'GH' { oauthToken: oauth });

setOauthToken

void setOauthToken(software.amazon.awscdk.Secret value)

A GitHub OAuth token to use for authentication. It is recommended to use a `SecretParameter` to obtain the token from the SSM Parameter Store: const oauth = new SecretParameter(this, 'GitHubOAuthToken', { ssmParameter: 'my-github-token }); new GitHubSource(stage, 'GH' { oauthToken: oauth });

getOwner

String getOwner()

The GitHub account/user that owns the repo.

setOwner

void setOwner(String value)

The GitHub account/user that owns the repo.

getRepo

String getRepo()

The name of the repo, without the username.

setRepo

void setRepo(String value)

The name of the repo, without the username.

getBranch

String getBranch()

The branch to use.

setBranch

void setBranch(String value)

The branch to use.

getOutputArtifactName

String getOutputArtifactName()

The name of the source's output artifact. Output artifacts are used by CodePipeline as inputs into other actions.

setOutputArtifactName

void setOutputArtifactName(String value)

The name of the source's output artifact. Output artifacts are used by CodePipeline as inputs into other actions.

getPollForSourceChanges

Boolean getPollForSourceChanges()

Whether or not AWS CodePipeline should poll for source changes

setPollForSourceChanges

void setPollForSourceChanges(Boolean value)

Whether or not AWS CodePipeline should poll for source changes

builder

static GitHubSourceActionProps.Builder builder()

Specified by:

builder in interface software.amazon.awscdk.services.codepipeline.api.CommonActionConstructProps

Specified by:

builder in interface software.amazon.awscdk.services.codepipeline.api.CommonActionProps

Returns:

a GitHubSourceActionProps.Builder of GitHubSourceActionProps