aws-cdk-lib.aws_codestar.CfnGitHubRepositoryProps

interface CfnGitHubRepositoryProps

LanguageType name
.NETAmazon.CDK.AWS.Codestar.CfnGitHubRepositoryProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodestar#CfnGitHubRepositoryProps
Javasoftware.amazon.awscdk.services.codestar.CfnGitHubRepositoryProps
Pythonaws_cdk.aws_codestar.CfnGitHubRepositoryProps
TypeScript aws-cdk-lib » aws_codestar » CfnGitHubRepositoryProps

Properties for defining a CfnGitHubRepository.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codestar as codestar } from 'aws-cdk-lib';
const cfnGitHubRepositoryProps: codestar.CfnGitHubRepositoryProps = {
  repositoryName: 'repositoryName',
  repositoryOwner: 'repositoryOwner',

  // the properties below are optional
  code: {
    s3: {
      bucket: 'bucket',
      key: 'key',

      // the properties below are optional
      objectVersion: 'objectVersion',
    },
  },
  connectionArn: 'connectionArn',
  enableIssues: false,
  isPrivate: false,
  repositoryAccessToken: 'repositoryAccessToken',
  repositoryDescription: 'repositoryDescription',
};

Properties

NameTypeDescription
repositoryNamestringThe name of the repository you want to create in GitHub with AWS CloudFormation stack creation.
repositoryOwnerstringThe GitHub user name for the owner of the GitHub repository to be created.
code?IResolvable | CodePropertyInformation about code to be committed to a repository after it is created in an AWS CloudFormation stack.
connectionArn?stringAWS::CodeStar::GitHubRepository.ConnectionArn.
enableIssues?boolean | IResolvableIndicates whether to enable issues for the GitHub repository.
isPrivate?boolean | IResolvableIndicates whether the GitHub repository is a private repository.
repositoryAccessToken?stringThe GitHub user's personal access token for the GitHub repository.
repositoryDescription?stringA comment or description about the new repository.

repositoryName

Type: string

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


repositoryOwner

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.


code?

Type: IResolvable | CodeProperty (optional)

Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.


connectionArn?

Type: string (optional)

AWS::CodeStar::GitHubRepository.ConnectionArn.


enableIssues?

Type: boolean | IResolvable (optional)

Indicates whether to enable issues for the GitHub repository.

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


isPrivate?

Type: boolean | IResolvable (optional)

Indicates whether the GitHub repository is a private repository.

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


repositoryAccessToken?

Type: string (optional)

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


repositoryDescription?

Type: string (optional)

A comment or description about the new repository.

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