CfnGitHubRepositoryProps

class aws_cdk.aws_codestar.CfnGitHubRepositoryProps(*, repository_name, repository_owner, code=None, connection_arn=None, enable_issues=None, is_private=None, repository_access_token=None, repository_description=None)

Bases: object

Properties for defining a CfnGitHubRepository.

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

  • repository_owner (str) – 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 (Union[CodeProperty, Dict[str, Any], IResolvable, None]) – Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.

  • connection_arn (Optional[str]) – AWS::CodeStar::GitHubRepository.ConnectionArn.

  • enable_issues (Union[bool, IResolvable, None]) – Indicates whether to enable issues for the GitHub repository. You can use GitHub issues to track information and bugs for your repository.

  • is_private (Union[bool, IResolvable, None]) – Indicates whether the GitHub repository is a private repository. If so, you choose who can see and commit to this repository.

  • repository_access_token (Optional[str]) – The GitHub user’s personal access token for the GitHub repository.

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

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_codestar as codestar

cfn_git_hub_repository_props = codestar.CfnGitHubRepositoryProps(
    repository_name="repositoryName",
    repository_owner="repositoryOwner",

    # the properties below are optional
    code=codestar.CfnGitHubRepository.CodeProperty(
        s3=codestar.CfnGitHubRepository.S3Property(
            bucket="bucket",
            key="key",

            # the properties below are optional
            object_version="objectVersion"
        )
    ),
    connection_arn="connectionArn",
    enable_issues=False,
    is_private=False,
    repository_access_token="repositoryAccessToken",
    repository_description="repositoryDescription"
)

Attributes

code

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

Link

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

Return type

Union[CodeProperty, IResolvable, None]

connection_arn

AWS::CodeStar::GitHubRepository.ConnectionArn.

Link

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

Return type

Optional[str]

enable_issues

Indicates whether to enable issues for the GitHub repository.

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

Link

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

Return type

Union[bool, IResolvable, None]

is_private

Indicates whether the GitHub repository is a private repository.

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

Link

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

Return type

Union[bool, IResolvable, None]

repository_access_token

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

Link

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

Return type

Optional[str]

repository_description

A comment or description about the new repository.

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

Link

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

Return type

Optional[str]

repository_name

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

Link

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

Return type

str

repository_owner

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.

Link

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

Return type

str