software.amazon.awscdk.services.codepipeline

Class GitHubSourceActionProps.Builder

java.lang.Object

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

Enclosing interface:

GitHubSourceActionProps

public static final class GitHubSourceActionProps.Builder
extends Object

A builder for GitHubSourceActionProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
GitHubSourceActionProps	build() Builds the configured instance.
GitHubSourceActionProps.Builder	withBranch(String value) Sets the value of Branch
GitHubSourceActionProps.Builder	withOauthToken(software.amazon.awscdk.Secret value) Sets the value of OauthToken
GitHubSourceActionProps.Builder	withOutputArtifactName(String value) Sets the value of OutputArtifactName
GitHubSourceActionProps.Builder	withOwner(String value) Sets the value of Owner
GitHubSourceActionProps.Builder	withPollForSourceChanges(Boolean value) Sets the value of PollForSourceChanges
GitHubSourceActionProps.Builder	withRepo(String value) Sets the value of Repo
GitHubSourceActionProps.Builder	withRunOrder(Number value) Sets the value of RunOrder
GitHubSourceActionProps.Builder	withStage(software.amazon.awscdk.services.codepipeline.api.IStage value) Sets the value of Stage

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

withOauthToken

public GitHubSourceActionProps.Builder withOauthToken(software.amazon.awscdk.Secret value)

Sets the value of OauthToken

Parameters:

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

Returns:

this

withOwner

public GitHubSourceActionProps.Builder withOwner(String value)

Sets the value of Owner

Parameters:

value - The GitHub account/user that owns the repo.

Returns:

this

withRepo

public GitHubSourceActionProps.Builder withRepo(String value)

Sets the value of Repo

Parameters:

value - The name of the repo, without the username.

Returns:

this

withBranch

public GitHubSourceActionProps.Builder withBranch(@Nullable
                                                  String value)

Sets the value of Branch

Parameters:

value - The branch to use.

Returns:

this

withOutputArtifactName

public GitHubSourceActionProps.Builder withOutputArtifactName(@Nullable
                                                              String value)

Sets the value of OutputArtifactName

Parameters:

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

Returns:

this

withPollForSourceChanges

public GitHubSourceActionProps.Builder withPollForSourceChanges(@Nullable
                                                                Boolean value)

Sets the value of PollForSourceChanges

Parameters:

value - Whether or not AWS CodePipeline should poll for source changes

Returns:

this

withRunOrder

public GitHubSourceActionProps.Builder withRunOrder(@Nullable
                                                    Number value)

Sets the value of RunOrder

Parameters:

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

Returns:

this

withStage

public GitHubSourceActionProps.Builder withStage(software.amazon.awscdk.services.codepipeline.api.IStage value)

Sets the value of Stage

Parameters:

value - The Pipeline Stage to add this Action to.

Returns:

this

build

public GitHubSourceActionProps build()

Builds the configured instance.

Returns:

a new instance of GitHubSourceActionProps

Throws:

NullPointerException - if any required attribute was not provided