Class CfnRepositoryAssociation
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.codegurureviewer.CfnRepositoryAssociation
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-17T21:37:28.176Z")
@Stability(Stable)
public class CfnRepositoryAssociation
extends CfnResource
implements IInspectable, ITaggable
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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnRepositoryAssociation
.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnRepositoryAssociation
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnRepositoryAssociation
(software.amazon.jsii.JsiiObjectRef objRef) CfnRepositoryAssociation
(software.constructs.Construct scope, String id, CfnRepositoryAssociationProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of theRepositoryAssociation
object.The name of the bucket.The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection.getName()
The name of the repository.getOwner()
The owner of the repository.getTags()
Tag Manager which manages the tags for this resource.An array of key-value pairs used to tag an associated repository.getType()
The type of repository that contains the source code to be reviewed.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.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
The name of the repository.void
The owner of the repository.void
setTagsRaw
(List<CfnTag> value) An array of key-value pairs used to tag an associated repository.void
The type of repository that contains the source code to be reviewed.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnRepositoryAssociation
protected CfnRepositoryAssociation(software.amazon.jsii.JsiiObjectRef objRef) -
CfnRepositoryAssociation
protected CfnRepositoryAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnRepositoryAssociation
@Stability(Stable) public CfnRepositoryAssociation(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRepositoryAssociationProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrAssociationArn
The Amazon Resource Name (ARN) of theRepositoryAssociation
object. You can retrieve this ARN by callingListRepositories
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getName
The name of the repository. -
setName
The name of the repository. -
getType
The type of repository that contains the source code to be reviewed.The valid values are:.
-
setType
The type of repository that contains the source code to be reviewed.The valid values are:.
-
getBucketName
The name of the bucket. -
setBucketName
The name of the bucket. -
getConnectionArn
The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. -
setConnectionArn
The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. -
getOwner
The owner of the repository. -
setOwner
The owner of the repository. -
getTagsRaw
An array of key-value pairs used to tag an associated repository. -
setTagsRaw
An array of key-value pairs used to tag an associated repository.
-