awscodegurureviewer

Documentation

Index

• func CfnRepositoryAssociation_CFN_RESOURCE_TYPE_NAME() *string
• func CfnRepositoryAssociation_IsCfnElement(x interface{}) *bool
• func CfnRepositoryAssociation_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnRepositoryAssociation_IsConstruct(x interface{}) *bool
• func NewCfnRepositoryAssociation_Override(c CfnRepositoryAssociation, scope constructs.Construct, id *string, ...)
• type CfnRepositoryAssociation
  • func NewCfnRepositoryAssociation(scope constructs.Construct, id *string, props *CfnRepositoryAssociationProps) CfnRepositoryAssociation
• type CfnRepositoryAssociationProps

Functions

func CfnRepositoryAssociation_CFN_RESOURCE_TYPE_NAME

func CfnRepositoryAssociation_CFN_RESOURCE_TYPE_NAME() *string

func CfnRepositoryAssociation_IsCfnElement

func CfnRepositoryAssociation_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnRepositoryAssociation_IsCfnResource

func CfnRepositoryAssociation_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnRepositoryAssociation_IsConstruct

func CfnRepositoryAssociation_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnRepositoryAssociation_Override

func NewCfnRepositoryAssociation_Override(c CfnRepositoryAssociation, scope constructs.Construct, id *string, props *CfnRepositoryAssociationProps)

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

Types

type CfnRepositoryAssociation

type CfnRepositoryAssociation interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrAssociationArn() *string
	BucketName() *string
	SetBucketName(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ConnectionArn() *string
	SetConnectionArn(val *string)
	CreationStack() *[]*string
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Owner() *string
	SetOwner(val *string)
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	Type() *string
	SetType(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

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](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.

TODO: EXAMPLE

func NewCfnRepositoryAssociation

func NewCfnRepositoryAssociation(scope constructs.Construct, id *string, props *CfnRepositoryAssociationProps) CfnRepositoryAssociation

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

type CfnRepositoryAssociationProps

type CfnRepositoryAssociationProps struct {
	// The name of the repository.
	Name *string `json:"name"`
	// The type of repository that contains the source code to be reviewed. The valid values are:.
	//
	// - `CodeCommit`
	// - `Bitbucket`
	// - `GitHubEnterpriseServer`
	// - `S3Bucket`
	Type *string `json:"type"`
	// The name of the bucket.
	//
	// This is required for your S3Bucket repositoryThe name must start with the prefix, `codeguru-reviewer-*` .
	BucketName *string `json:"bucketName"`
	// 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.
	ConnectionArn *string `json:"connectionArn"`
	// 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.
	Owner *string `json:"owner"`
	// 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.
	Tags *[]*awscdk.CfnTag `json:"tags"`
}

Properties for defining a `CfnRepositoryAssociation`.

TODO: EXAMPLE