AWS CDK

2.233.0

interface CfnGitHubRepositoryMixinProps

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.CodeStar.Mixins.CfnGitHubRepositoryMixinProps`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awscodestar/mixins#CfnGitHubRepositoryMixinProps`
Java	`software.amazon.awscdk.mixins.preview.services.codestar.mixins.CfnGitHubRepositoryMixinProps`
Python	`aws_cdk.mixins_preview.aws_codestar.mixins.CfnGitHubRepositoryMixinProps`
TypeScript	`@aws-cdk/mixins-preview` » `aws_codestar` » `mixins` » `CfnGitHubRepositoryMixinProps`

Properties for CfnGitHubRepositoryPropsMixin.

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 { mixins as codestar_mixins } from '@aws-cdk/mixins-preview/aws-codestar';
const cfnGitHubRepositoryMixinProps: codestar_mixins.CfnGitHubRepositoryMixinProps = {
  code: {
    s3: {
      bucket: 'bucket',
      key: 'key',
      objectVersion: 'objectVersion',
    },
  },
  connectionArn: 'connectionArn',
  enableIssues: false,
  isPrivate: false,
  repositoryAccessToken: 'repositoryAccessToken',
  repositoryDescription: 'repositoryDescription',
  repositoryName: 'repositoryName',
  repositoryOwner: 'repositoryOwner',
};

Properties

Name	Type	Description
code?	`IResolvable` `\|` `CodeProperty`	Information about code to be committed to a repository after it is created in an 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?	`string`	The name of the repository you want to create in GitHub with CloudFormation stack creation.
repositoryOwner?	`string`	The GitHub user name for the owner of the GitHub repository to be created.

code?

Type: IResolvable | CodeProperty (optional)

Information about code to be committed to a repository after it is created in an 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

repositoryName?

Type: string (optional)

The name of the repository you want to create in GitHub with 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 (optional)

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

← Previous Next →