Package software.amazon.awscdk.services.codestar

Class GitHubRepositoryProps.Builder

java.lang.Object

software.amazon.awscdk.services.codestar.GitHubRepositoryProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GitHubRepositoryProps>

Enclosing interface:

GitHubRepositoryProps

@Stability(Experimental)
public static final class GitHubRepositoryProps.Builder
extends Object
implements software.amazon.jsii.Builder<GitHubRepositoryProps>

A builder for GitHubRepositoryProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GitHubRepositoryProps.Builder	accessToken(SecretValue accessToken)	Sets the value of GitHubRepositoryProps.getAccessToken()
GitHubRepositoryProps	build()	Builds the configured instance.
GitHubRepositoryProps.Builder	contentsBucket(IBucket contentsBucket)	Sets the value of GitHubRepositoryProps.getContentsBucket()
GitHubRepositoryProps.Builder	contentsKey(String contentsKey)	Sets the value of GitHubRepositoryProps.getContentsKey()
GitHubRepositoryProps.Builder	contentsS3Version(String contentsS3Version)	Sets the value of GitHubRepositoryProps.getContentsS3Version()
GitHubRepositoryProps.Builder	description(String description)	Sets the value of GitHubRepositoryProps.getDescription()
GitHubRepositoryProps.Builder	enableIssues(Boolean enableIssues)	Sets the value of GitHubRepositoryProps.getEnableIssues()
GitHubRepositoryProps.Builder	owner(String owner)	Sets the value of GitHubRepositoryProps.getOwner()
GitHubRepositoryProps.Builder	repositoryName(String repositoryName)	Sets the value of GitHubRepositoryProps.getRepositoryName()
GitHubRepositoryProps.Builder	visibility(RepositoryVisibility visibility)	Sets the value of GitHubRepositoryProps.getVisibility()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

accessToken

@Stability(Experimental)
public GitHubRepositoryProps.Builder accessToken(SecretValue accessToken)

Sets the value of GitHubRepositoryProps.getAccessToken()

Parameters:

accessToken - The GitHub user's personal access token for the GitHub repository. This parameter is required.

Returns:

this

contentsBucket

@Stability(Experimental)
public GitHubRepositoryProps.Builder contentsBucket(IBucket contentsBucket)

Sets the value of GitHubRepositoryProps.getContentsBucket()

Parameters:

contentsBucket - The name of the Amazon S3 bucket that contains the ZIP file with the content to be committed to the new repository. This parameter is required.

Returns:

this

contentsKey

@Stability(Experimental)
public GitHubRepositoryProps.Builder contentsKey(String contentsKey)

Sets the value of GitHubRepositoryProps.getContentsKey()

Parameters:

contentsKey - The S3 object key or file name for the ZIP file. This parameter is required.

Returns:

this

owner

@Stability(Experimental)
public GitHubRepositoryProps.Builder owner(String owner)

Sets the value of GitHubRepositoryProps.getOwner()

Parameters:

owner - The GitHub user name for the owner of the GitHub repository to be created. This parameter is required. If this repository should be owned by a GitHub organization, provide its name

Returns:

this

repositoryName

@Stability(Experimental)
public GitHubRepositoryProps.Builder repositoryName(String repositoryName)

Sets the value of GitHubRepositoryProps.getRepositoryName()

Parameters:

repositoryName - The name of the repository you want to create in GitHub with AWS CloudFormation stack creation. This parameter is required.

Returns:

this

contentsS3Version

@Stability(Experimental)
public GitHubRepositoryProps.Builder contentsS3Version(String contentsS3Version)

Sets the value of GitHubRepositoryProps.getContentsS3Version()

Parameters:

contentsS3Version - The object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket.

Returns:

this

description

@Stability(Experimental)
public GitHubRepositoryProps.Builder description(String description)

Sets the value of GitHubRepositoryProps.getDescription()

Parameters:

description - A comment or description about the new repository. This description is displayed in GitHub after the repository is created.

Returns:

this

enableIssues

@Stability(Experimental)
public GitHubRepositoryProps.Builder enableIssues(Boolean enableIssues)

Sets the value of GitHubRepositoryProps.getEnableIssues()

Parameters:

enableIssues - Indicates whether to enable issues for the GitHub repository. You can use GitHub issues to track information and bugs for your repository.

Returns:

this

visibility

@Stability(Experimental)
public GitHubRepositoryProps.Builder visibility(RepositoryVisibility visibility)

Sets the value of GitHubRepositoryProps.getVisibility()

Parameters:

visibility - Indicates whether the GitHub repository is a private repository. If so, you choose who can see and commit to this repository.

Returns:

this

build

@Stability(Experimental)
public GitHubRepositoryProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<GitHubRepositoryProps>

Returns:

a new instance of GitHubRepositoryProps

Throws:

NullPointerException - if any required attribute was not provided