Experimental
@aws-cdk/aws-codestar-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
GitHubRepositoryProps Struct
Construction properties of GitHubRepository.
Example
ts
import * as codestar from '@aws-cdk/aws-codestar-alpha';
import * as s3 from 'aws-cdk-lib/aws-s3'
new codestar.GitHubRepository(this, 'GitHubRepo', {
owner: 'aws',
repositoryName: 'aws-cdk',
accessToken: SecretValue.secretsManager('my-github-token', {
jsonField: 'token',
}),
contentsBucket: s3.Bucket.fromBucketName(this, 'Bucket', 'amzn-s3-demo-bucket'),
contentsKey: 'import.zip',
});
Properties
accessTokenSecretValueaccess_tokenSecretValueaccessTokenSecretValueAccessTokenSecretValueAccessTokenSecretValuerequired#The GitHub user's personal access token for the GitHub repository.
contentsBucketIBucketRefcontents_bucketIBucketRefcontentsBucketIBucketRefContentsBucketIBucketRefContentsBucketIBucketRefrequired#The name of the Amazon S3 bucket that contains the ZIP file with the content to be committed to the new repository.
The S3 object key or file name for the ZIP file.
contentsS3Versionoptionalstringcontents_s3_versionoptionalstrcontentsS3VersionoptionalStringContentsS3VersionoptionalstringContentsS3Versionoptional*string#The object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket.
Default: not specified
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#A comment or description about the new repository.
Default: no description
This description is displayed in GitHub after the repository is created.
enableIssuesoptionalbooleanenable_issuesoptionalboolenableIssuesoptionalBooleanEnableIssuesoptionalboolEnableIssuesoptional*bool= true#Indicates whether to enable issues for the GitHub repository.
You can use GitHub issues to track information and bugs for your repository.
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
repositoryNamestringrepository_namestrrepositoryNameStringRepositoryNamestringRepositoryName*stringrequired#The name of the repository you want to create in GitHub with AWS CloudFormation stack creation.
visibilityoptionalRepositoryVisibilityvisibilityoptionalRepositoryVisibilityvisibilityoptionalRepositoryVisibilityVisibilityoptionalRepositoryVisibilityVisibilityoptionalRepositoryVisibility= RepositoryVisibility.PUBLIC#Indicates whether the GitHub repository is a private repository.
If so, you choose who can see and commit to this repository.