GitHubRepositoryProps

class aws_cdk.aws_codestar.GitHubRepositoryProps(*, access_token, contents_bucket, contents_key, owner, repository_name, contents_s3_version=None, description=None, enable_issues=None, visibility=None)

Bases: object

(experimental) Construction properties of {@link GitHubRepository}.

Parameters
  • access_token (SecretValue) – (experimental) The GitHub user’s personal access token for the GitHub repository.

  • contents_bucket (IBucket) – (experimental) The name of the Amazon S3 bucket that contains the ZIP file with the content to be committed to the new repository.

  • contents_key (str) – (experimental) The S3 object key or file name for the ZIP file.

  • owner (str) – (experimental) 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

  • repository_name (str) – (experimental) The name of the repository you want to create in GitHub with AWS CloudFormation stack creation.

  • contents_s3_version (Optional[str]) – (experimental) The object version of the ZIP file, if versioning is enabled for the Amazon S3 bucket. Default: - not specified

  • description (Optional[str]) – (experimental) A comment or description about the new repository. This description is displayed in GitHub after the repository is created. Default: - no description

  • enable_issues (Optional[bool]) – (experimental) Indicates whether to enable issues for the GitHub repository. You can use GitHub issues to track information and bugs for your repository. Default: true

  • visibility (Optional[RepositoryVisibility]) – (experimental) Indicates whether the GitHub repository is a private repository. If so, you choose who can see and commit to this repository. Default: RepositoryVisibility.PUBLIC

Stability

experimental

Attributes

access_token

(experimental) The GitHub user’s personal access token for the GitHub repository.

Stability

experimental

Return type

SecretValue

contents_bucket

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

Stability

experimental

Return type

IBucket

contents_key

(experimental) The S3 object key or file name for the ZIP file.

Stability

experimental

Return type

str

contents_s3_version

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

Default
  • not specified

Stability

experimental

Return type

Optional[str]

description

(experimental) A comment or description about the new repository.

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

Default
  • no description

Stability

experimental

Return type

Optional[str]

enable_issues

(experimental) Indicates whether to enable issues for the GitHub repository.

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

Default

true

Stability

experimental

Return type

Optional[bool]

owner

(experimental) 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

Stability

experimental

Return type

str

repository_name

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

Stability

experimental

Return type

str

visibility

(experimental) Indicates whether the GitHub repository is a private repository.

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

Default

RepositoryVisibility.PUBLIC

Stability

experimental

Return type

Optional[RepositoryVisibility]