software.amazon.awscdk.services.codegurureviewer

Class CfnRepositoryAssociation

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.codegurureviewer.CfnRepositoryAssociation

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:34.371Z")
 @Stability(value=Stable)
public class CfnRepositoryAssociation
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CodeGuruReviewer::RepositoryAssociation`.

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 in the Amazon CodeGuru Reviewer User Guide .
• Bitbucket - For more information, see Create a Bitbucket repository association in the Amazon CodeGuru Reviewer User Guide .
• GitHub Enterprise Server - For more information, see Create a GitHub Enterprise Server repository association in the Amazon CodeGuru Reviewer User Guide .
• S3Bucket - For more information, see Create code reviews with GitHub Actions in the Amazon CodeGuru Reviewer User Guide .

You cannot use a CloudFormation template to create an association with a GitHub repository.

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.*;
 CfnRepositoryAssociation cfnRepositoryAssociation = CfnRepositoryAssociation.Builder.create(this, "MyCfnRepositoryAssociation")
         .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	Class and Description
static class	CfnRepositoryAssociation.Builder A fluent builder for CfnRepositoryAssociation.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRepositoryAssociation(Construct scope, String id, CfnRepositoryAssociationProps props) Create a new `AWS::CodeGuruReviewer::RepositoryAssociation`.
protected	CfnRepositoryAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRepositoryAssociation(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrAssociationArn() The Amazon Resource Name (ARN) of the [`RepositoryAssociation`](https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) object.
String	getBucketName() The name of the bucket.
protected Map<String,Object>	getCfnProperties()
String	getConnectionArn() The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection.
String	getName() The name of the repository.
String	getOwner() The owner of the repository.
TagManager	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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBucketName(String value) The name of the bucket.
void	setConnectionArn(String value) The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection.
void	setName(String value) The name of the repository.
void	setOwner(String value) The owner of the repository.
void	setType(String value) The type of repository that contains the source code to be reviewed.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnRepositoryAssociation

protected CfnRepositoryAssociation(software.amazon.jsii.JsiiObjectRef objRef)

CfnRepositoryAssociation

protected CfnRepositoryAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnRepositoryAssociation

@Stability(value=Stable)
public CfnRepositoryAssociation(@NotNull
                                                         Construct scope,
                                                         @NotNull
                                                         String id,
                                                         @NotNull
                                                         CfnRepositoryAssociationProps props)

Create a new `AWS::CodeGuruReviewer::RepositoryAssociation`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAssociationArn

@Stability(value=Stable)
 @NotNull
public String getAttrAssociationArn()

The Amazon Resource Name (ARN) of the [`RepositoryAssociation`](https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) object. You can retrieve this ARN by calling `ListRepositories` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager 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.

getName

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

The name of the repository.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the repository.

getType

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

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

• CodeCommit
• Bitbucket
• GitHubEnterpriseServer
• S3Bucket

setType

@Stability(value=Stable)
public void setType(@NotNull
                                             String value)

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
public String getBucketName()

The name of the bucket.

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

setBucketName

@Stability(value=Stable)
public void setBucketName(@Nullable
                                                   String value)

The name of the bucket.

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

getConnectionArn

@Stability(value=Stable)
 @Nullable
public 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.

setConnectionArn

@Stability(value=Stable)
public void setConnectionArn(@Nullable
                                                      String value)

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
public 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.

setOwner

@Stability(value=Stable)
public void setOwner(@Nullable
                                              String value)

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.