software.amazon.awscdk.services.codegurureviewer

Interface CfnRepositoryAssociationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRepositoryAssociationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-19T23:08:44.798Z")
 @Stability(value=Stable)
public interface CfnRepositoryAssociationProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.codegurureviewer.*;
 CfnRepositoryAssociationProps cfnRepositoryAssociationProps = CfnRepositoryAssociationProps.builder()
         .name("name")
         .type("type")
         // the properties below are optional
         .bucketName("bucketName")
         .connectionArn("connectionArn")
         .owner("owner")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnRepositoryAssociationProps.Builder A builder for CfnRepositoryAssociationProps
static class	CfnRepositoryAssociationProps.Jsii$Proxy An implementation for CfnRepositoryAssociationProps

Method Summary

Modifier and Type	Method and Description
static CfnRepositoryAssociationProps.Builder	builder()
default String	getBucketName() The name of the bucket.
default String	getConnectionArn() The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection.
String	getName() The name of the repository.
default String	getOwner() The owner of the repository.
default List<CfnTag>	getTags() An array of key-value pairs used to tag an associated repository.
String	getType() The type of repository that contains the source code to be reviewed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name of the repository.

getType

@Stability(value=Stable)
 @NotNull
String getType()

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

• CodeCommit
• Bitbucket
• GitHubEnterpriseServer
• S3Bucket

getBucketName

@Stability(value=Stable)
 @Nullable
default String getBucketName()

The name of the bucket.

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

getConnectionArn

@Stability(value=Stable)
 @Nullable
default String getConnectionArn()

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.

getOwner

@Stability(value=Stable)
 @Nullable
default String getOwner()

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.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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.

builder

@Stability(value=Stable)
static CfnRepositoryAssociationProps.Builder builder()

Returns:

a CfnRepositoryAssociationProps.Builder of CfnRepositoryAssociationProps