1.204.0

interface CfnRepositoryAssociationProps

LanguageType name
.NETAmazon.CDK.AWS.CodeGuruReviewer.CfnRepositoryAssociationProps
Javasoftware.amazon.awscdk.services.codegurureviewer.CfnRepositoryAssociationProps
Pythonaws_cdk.aws_codegurureviewer.CfnRepositoryAssociationProps
TypeScript @aws-cdk/aws-codegurureviewer » CfnRepositoryAssociationProps

Properties for defining a CfnRepositoryAssociation.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as codegurureviewer from '@aws-cdk/aws-codegurureviewer';
const cfnRepositoryAssociationProps: codegurureviewer.CfnRepositoryAssociationProps = {
  name: 'name',
  type: 'type',

  // the properties below are optional
  bucketName: 'bucketName',
  connectionArn: 'connectionArn',
  owner: 'owner',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
namestringThe name of the repository.
typestringThe type of repository that contains the source code to be reviewed. The valid values are:.
bucketName?stringThe name of the bucket.
connectionArn?stringThe Amazon Resource Name (ARN) of an AWS CodeStar Connections connection.
owner?stringThe owner of the repository.
tags?CfnTag[]An array of key-value pairs used to tag an associated repository.

name

Type: string

The name of the repository.

type

Type: string

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

  • CodeCommit
  • Bitbucket
  • GitHubEnterpriseServer
  • S3Bucket

bucketName?

Type: string (optional)

The name of the bucket.

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

connectionArn?

Type: string (optional)

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?

Type: string (optional)

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?

Type: CfnTag[] (optional)

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.
← PreviousNext →