GitHubRepository

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

Bases: aws_cdk.core.Resource

(experimental) The GitHubRepository resource.

Stability

experimental

Parameters
  • scope (Construct) –

  • id (str) –

  • 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

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DELETE), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters

policy (RemovalPolicy) –

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type

ResourceEnvironment

node

The construct tree node associated with this construct.

Return type

ConstructNode

owner

(experimental) the repository owner.

Stability

experimental

Return type

str

repo

(experimental) the repository name.

Stability

experimental

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool