interface GitHubRepositoryProps 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.CodeStar.GitHubRepositoryProps`
Java	`software.amazon.awscdk.services.codestar.GitHubRepositoryProps`
Python	`aws_cdk.aws_codestar.GitHubRepositoryProps`
TypeScript (source)	`@aws-cdk/aws-codestar` » `GitHubRepositoryProps`

Construction properties of {@link GitHubRepository}.

Example

import * as codestar from '@aws-cdk/aws-codestar';
import * as s3 from '@aws-cdk/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

Name	Type	Description
accessToken🔹	`SecretValue`	The GitHub user's personal access token for the GitHub repository.
contentsBucket🔹	`IBucket`	The name of the Amazon S3 bucket that contains the ZIP file with the content to be committed to the new repository.
contentsKey🔹	`string`	The S3 object key or file name for the ZIP file.
owner🔹	`string`	The GitHub user name for the owner of the GitHub repository to be created.
repositoryName🔹	`string`	The name of the repository you want to create in GitHub with AWS CloudFormation stack creation.
contentsS3Version?🔹	`string`	The object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket.
description?🔹	`string`	A comment or description about the new repository.
enableIssues?🔹	`boolean`	Indicates whether to enable issues for the GitHub repository.
visibility?🔹	`RepositoryVisibility`	Indicates 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.