Package software.amazon.awscdk.services.codestar

Interface GitHubRepositoryProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
GitHubRepositoryProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.975Z") @Stability(Experimental) public interface GitHubRepositoryProps extends software.amazon.jsii.JsiiSerializable
(experimental) Construction properties of GitHubRepository.

Example: 

 import software.amazon.awscdk.services.codestar.*;
 import software.amazon.awscdk.services.s3.*;
 GitHubRepository.Builder.create(this, "GitHubRepo")
         .owner("aws")
         .repositoryName("aws-cdk")
         .accessToken(SecretValue.secretsManager("my-github-token", SecretsManagerSecretOptions.builder()
                 .jsonField("token")
                 .build()))
         .contentsBucket(Bucket.fromBucketName(this, "Bucket", "bucket-name"))
         .contentsKey("import.zip")
         .build();

  • Method Details

    • getAccessToken

      @Stability(Experimental) @NotNull SecretValue getAccessToken()
      (experimental) The GitHub user's personal access token for the GitHub repository.

    • getContentsBucket

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

    • getContentsKey

      @Stability(Experimental) @NotNull String getContentsKey()
      (experimental) The S3 object key or file name for the ZIP file.

    • getOwner

      @Stability(Experimental) @NotNull String getOwner()
      (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

    • getRepositoryName

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

    • getContentsS3Version

      @Stability(Experimental) @Nullable default String getContentsS3Version()
      (experimental) The object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket.

      Default: - not specified

    • getDescription

      @Stability(Experimental) @Nullable default String getDescription()
      (experimental) A comment or description about the new repository.

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

      Default: - no description

    • getEnableIssues

      @Stability(Experimental) @Nullable default Boolean getEnableIssues()
      (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

    • getVisibility

      @Stability(Experimental) @Nullable default RepositoryVisibility getVisibility()
      (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

    • builder

      @Stability(Experimental) static GitHubRepositoryProps.Builder builder()
      Returns:
      a GitHubRepositoryProps.Builder of GitHubRepositoryProps