L1 ConstructAWS::CodeGuruReviewer::RepositoryAssociation

CfnRepositoryAssociation

This resource configures how Amazon CodeGuru Reviewer retrieves the source code to be reviewed. You can use an AWS CloudFormation template to create an association with the following repository types: - AWS CodeCommit - For more information, see [Create an AWS CodeCommit repository association](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-codecommit-association.html) in the *Amazon CodeGuru Reviewer User Guide* . - Bitbucket - For more information, see [Create a Bitbucket repository association](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-bitbucket-association.html) in the *Amazon CodeGuru Reviewer User Guide* . - GitHub Enterprise Server - For more information, see [Create a GitHub Enterprise Server repository association](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-github-enterprise-association.html) in the *Amazon CodeGuru Reviewer User Guide* . - S3Bucket - For more information, see [Create code reviews with GitHub Actions](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/working-with-cicd.html) in the *Amazon CodeGuru Reviewer User Guide* . > You cannot use a CloudFormation template to create an association with a GitHub repository.

Import

import { CfnRepositoryAssociation } from 'aws-cdk-lib/aws-codegurureviewer';

Or use the module namespace:

import * as codegurureviewer from 'aws-cdk-lib/aws-codegurureviewer';
// codegurureviewer.CfnRepositoryAssociation

Properties

Configuration passed to the constructor as CfnRepositoryAssociationProps.

nameRequired

string

The name of the repository.

typeRequired

string

The type of repository that contains the source code to be reviewed. The valid values are:. - `CodeCommit` - `Bitbucket` - `GitHubEnterpriseServer` - `S3Bucket`

bucketNameOptional

string

The name of the bucket. This is required for your S3Bucket repository. The name must start with the prefix `codeguru-reviewer-*` .

connectionArnOptional

string

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](https://docs.aws.amazon.com/codestar-connections/latest/APIReference/API_Connection.html) 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.

ownerOptional

string

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.

tagsOptional

CfnTag[]

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.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::CodeGuruReviewer::RepositoryAssociationView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)

Moduleaws-codegurureviewer

CFN TypeAWS::CodeGuruReviewer::RepositoryAssociation

Properties6

Explore This Service

External Links

CDK API Documentation