Package software.amazon.awscdk.services.codestar

Class GitHubRepository.Builder

java.lang.Object
software.amazon.awscdk.services.codestar.GitHubRepository.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<GitHubRepository>
Enclosing class:
GitHubRepository
@Stability(Experimental) public static final class GitHubRepository.Builder extends Object implements software.amazon.jsii.Builder<GitHubRepository>
(experimental) A fluent builder for GitHubRepository.

  • Method Details

    • create

      @Stability(Experimental) public static GitHubRepository.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of GitHubRepository.Builder.

    • accessToken

      @Stability(Experimental) public GitHubRepository.Builder accessToken(SecretValue accessToken)
      (experimental) The GitHub user's personal access token for the GitHub repository.

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

    • contentsBucket

      @Stability(Experimental) public GitHubRepository.Builder contentsBucket(IBucket contentsBucket)
      (experimental) The name of the Amazon S3 bucket that contains the ZIP file with the content to be committed to the new repository.

      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 GitHubRepository.Builder contentsKey(String contentsKey)
      (experimental) The S3 object key or file name for the ZIP file.

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

    • owner

      @Stability(Experimental) public GitHubRepository.Builder owner(String owner)
      (experimental) The GitHub user name for the owner of the GitHub repository to be created.

      If this repository should be owned by a GitHub organization, provide its name

      Parameters:
      owner - The GitHub user name for the owner of the GitHub repository to be created. This parameter is required.
      Returns:
      this

    • repositoryName

      @Stability(Experimental) public GitHubRepository.Builder repositoryName(String repositoryName)
      (experimental) The name of the repository you want to create in GitHub with AWS CloudFormation stack creation.

      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 GitHubRepository.Builder contentsS3Version(String contentsS3Version)
      (experimental) The object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket.

      Default: - not specified

      Parameters:
      contentsS3Version - The object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket. This parameter is required.
      Returns:
      this

    • description

      @Stability(Experimental) public GitHubRepository.Builder description(String description)
      (experimental) A comment or description about the new repository.

      This description is displayed in GitHub after the repository is created.

      Default: - no description

      Parameters:
      description - A comment or description about the new repository. This parameter is required.
      Returns:
      this

    • enableIssues

      @Stability(Experimental) public GitHubRepository.Builder enableIssues(Boolean enableIssues)
      (experimental) Indicates whether to enable issues for the GitHub repository.

      You can use GitHub issues to track information and bugs for your repository.

      Default: true

      Parameters:
      enableIssues - Indicates whether to enable issues for the GitHub repository. This parameter is required.
      Returns:
      this

    • visibility

      @Stability(Experimental) public GitHubRepository.Builder visibility(RepositoryVisibility visibility)
      (experimental) Indicates whether the GitHub repository is a private repository.

      If so, you choose who can see and commit to this repository.

      Default: RepositoryVisibility.PUBLIC

      Parameters:
      visibility - Indicates whether the GitHub repository is a private repository. This parameter is required.
      Returns:
      this

    • build

      @Stability(Experimental) public GitHubRepository build()
      Specified by:
      build in interface software.amazon.jsii.Builder<GitHubRepository>
      Returns:
      a newly built instance of GitHubRepository.