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.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:52.231Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GitHubRepositoryProps.Builder A builder for GitHubRepositoryProps
static class	GitHubRepositoryProps.Jsii$Proxy An implementation for GitHubRepositoryProps

Method Summary

Modifier and Type	Method and Description
static GitHubRepositoryProps.Builder	builder()
SecretValue	getAccessToken() (experimental) The GitHub user's personal access token for the GitHub repository.
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.
String	getContentsKey() (experimental) The S3 object key or file name for the ZIP file.
default String	getContentsS3Version() (experimental) The object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket.
default String	getDescription() (experimental) A comment or description about the new repository.
default Boolean	getEnableIssues() (experimental) Indicates whether to enable issues for the GitHub repository.
String	getOwner() (experimental) The GitHub user name for the owner of the GitHub repository to be created.
String	getRepositoryName() (experimental) The name of the repository you want to create in GitHub with AWS CloudFormation stack creation.
default RepositoryVisibility	getVisibility() (experimental) Indicates whether the GitHub repository is a private repository.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAccessToken

@Stability(value=Experimental)
 @NotNull
SecretValue getAccessToken()

(experimental) The GitHub user's personal access token for the GitHub repository.

getContentsBucket

@Stability(value=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(value=Experimental)
 @NotNull
String getContentsKey()

(experimental) The S3 object key or file name for the ZIP file.

getOwner

@Stability(value=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(value=Experimental)
 @NotNull
String getRepositoryName()

(experimental) The name of the repository you want to create in GitHub with AWS CloudFormation stack creation.

getContentsS3Version

@Stability(value=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(value=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(value=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(value=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(value=Experimental)
static GitHubRepositoryProps.Builder builder()

Returns:

a GitHubRepositoryProps.Builder of GitHubRepositoryProps