CfnRepositoryAssociationProps

class aws_cdk.aws_codegurureviewer.CfnRepositoryAssociationProps(*, name, type, bucket_name=None, connection_arn=None, owner=None, tags=None)

Bases: object

Properties for defining a CfnRepositoryAssociation.

Parameters
  • name (str) – The name of the repository.

  • type (str) – The type of repository that contains the source code to be reviewed. The valid values are:. - CodeCommit - Bitbucket - GitHubEnterpriseServer - S3Bucket

  • bucket_name (Optional[str]) – The name of the bucket. This is required for your S3Bucket repositoryThe name must start with the prefix, codeguru-reviewer-* .

  • connection_arn (Optional[str]) – The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its format is arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id . For more information, see Connection in the AWS CodeStar Connections API Reference . ConnectionArn must be specified for Bitbucket and GitHub Enterprise Server repositories. It has no effect if it is specified for an AWS CodeCommit repository.

  • owner (Optional[str]) – The owner of the repository. For a GitHub Enterprise Server or Bitbucket repository, this is the username for the account that owns the repository. Owner must be specified for Bitbucket and GitHub Enterprise Server repositories. It has no effect if it is specified for an AWS CodeCommit repository.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs used to tag an associated repository. A tag is a custom attribute label with two parts: - A tag key (for example, CostCenter , Environment , Project , or Secret ). Tag keys are case sensitive. - An optional field known as a tag value (for example, 111122223333 , Production , or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codegurureviewer-repositoryassociation.html

ExampleMetadata

fixture=_generated

Example:

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

cfn_repository_association_props = codegurureviewer.CfnRepositoryAssociationProps(
    name="name",
    type="type",

    # the properties below are optional
    bucket_name="bucketName",
    connection_arn="connectionArn",
    owner="owner",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

bucket_name

The name of the bucket.

This is required for your S3Bucket repositoryThe name must start with the prefix, codeguru-reviewer-* .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codegurureviewer-repositoryassociation.html#cfn-codegurureviewer-repositoryassociation-bucketname

Return type

Optional[str]

connection_arn

The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection.

Its format is arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id . For more information, see Connection in the AWS CodeStar Connections API Reference .

ConnectionArn must be specified for Bitbucket and GitHub Enterprise Server repositories. It has no effect if it is specified for an AWS CodeCommit repository.

Link

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

Return type

Optional[str]

name

The name of the repository.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codegurureviewer-repositoryassociation.html#cfn-codegurureviewer-repositoryassociation-name

Return type

str

owner

The owner of the repository.

For a GitHub Enterprise Server or Bitbucket repository, this is the username for the account that owns the repository.

Owner must be specified for Bitbucket and GitHub Enterprise Server repositories. It has no effect if it is specified for an AWS CodeCommit repository.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codegurureviewer-repositoryassociation.html#cfn-codegurureviewer-repositoryassociation-owner

Return type

Optional[str]

tags

An array of key-value pairs used to tag an associated repository.

A tag is a custom attribute label with two parts:

  • A tag key (for example, CostCenter , Environment , Project , or Secret ). Tag keys are case sensitive.

  • An optional field known as a tag value (for example, 111122223333 , Production , or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codegurureviewer-repositoryassociation.html#cfn-codegurureviewer-repositoryassociation-tags

Return type

Optional[List[CfnTag]]

type

.

  • CodeCommit

  • Bitbucket

  • GitHubEnterpriseServer

  • S3Bucket

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codegurureviewer-repositoryassociation.html#cfn-codegurureviewer-repositoryassociation-type

Type

The type of repository that contains the source code to be reviewed. The valid values are

Return type

str