@aws-cdk_aws-codestar-alpha.GitHubRepositoryProps

interface GitHubRepositoryProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Codestar.Alpha.GitHubRepositoryProps
Gogithub.com/aws/aws-cdk-go/awscdkcodestaralpha/v2#GitHubRepositoryProps
Javasoftware.amazon.awscdk.services.codestar.alpha.GitHubRepositoryProps
Pythonaws_cdk.aws_codestar_alpha.GitHubRepositoryProps
TypeScript (source)@aws-cdk/aws-codestar-alpha ยป GitHubRepositoryProps

Construction properties of GitHubRepository.

Example

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', 'bucket-name'),
  contentsKey: 'import.zip',
});

Properties

NameTypeDescription
accessToken๐Ÿ”นSecretValueThe GitHub user's personal access token for the GitHub repository.
contentsBucket๐Ÿ”นIBucketThe name of the Amazon S3 bucket that contains the ZIP file with the content to be committed to the new repository.
contentsKey๐Ÿ”นstringThe S3 object key or file name for the ZIP file.
owner๐Ÿ”นstringThe GitHub user name for the owner of the GitHub repository to be created.
repositoryName๐Ÿ”นstringThe name of the repository you want to create in GitHub with AWS CloudFormation stack creation.
contentsS3Version?๐Ÿ”นstringThe object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket.
description?๐Ÿ”นstringA comment or description about the new repository.
enableIssues?๐Ÿ”นbooleanIndicates whether to enable issues for the GitHub repository.
visibility?๐Ÿ”นRepositoryVisibilityIndicates whether the GitHub repository is a private repository.

accessToken๐Ÿ”น

Type: SecretValue

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


contentsBucket๐Ÿ”น

Type: IBucket

The name of the Amazon S3 bucket that contains the ZIP file with the content to be committed to the new repository.


contentsKey๐Ÿ”น

Type: string

The S3 object key or file name for the ZIP file.


owner๐Ÿ”น

Type: string

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


repositoryName๐Ÿ”น

Type: string

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


contentsS3Version?๐Ÿ”น

Type: string (optional, default: not specified)

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


description?๐Ÿ”น

Type: string (optional, default: no description)

A comment or description about the new repository.

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


enableIssues?๐Ÿ”น

Type: boolean (optional, default: true)

Indicates whether to enable issues for the GitHub repository.

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


visibility?๐Ÿ”น

Type: RepositoryVisibility (optional, default: RepositoryVisibility.PUBLIC)

Indicates whether the GitHub repository is a private repository.

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