AWS CDK

2.168.0

interface CfnGitHubRepositoryProps

Language	Type name
.NET	`Amazon.CDK.AWS.Codestar.CfnGitHubRepositoryProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscodestar#CfnGitHubRepositoryProps`
Java	`software.amazon.awscdk.services.codestar.CfnGitHubRepositoryProps`
Python	`aws_cdk.aws_codestar.CfnGitHubRepositoryProps`
TypeScript	`aws-cdk-lib` » `aws_codestar` » `CfnGitHubRepositoryProps`

Properties for defining a CfnGitHubRepository.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html

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

Name	Type	Description
repositoryName	`string`	The name of the repository you want to create in GitHub with AWS CloudFormation stack creation.
repositoryOwner	`string`	The GitHub user name for the owner of the GitHub repository to be created.
code?	`IResolvable` `\|` `CodeProperty`	Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.
connectionArn?	`string`
enableIssues?	`boolean \|` `IResolvable`	Indicates whether to enable issues for the GitHub repository.
isPrivate?	`boolean \|` `IResolvable`	Indicates whether the GitHub repository is a private repository.
repositoryAccessToken?	`string`	The GitHub user's personal access token for the GitHub repository.
repositoryDescription?	`string`	A 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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositoryname

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositoryowner

code?

Type: IResolvable | CodeProperty (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-code

connectionArn?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-enableissues

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-isprivate

repositoryAccessToken?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositoryaccesstoken

repositoryDescription?

Type: string (optional)

A comment or description about the new repository.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositorydescription

← Previous Next →