interface IReportGroup

Language	Type name
.NET	Amazon.CDK.AWS.CodeBuild.IReportGroup
Java	software.amazon.awscdk.services.codebuild.IReportGroup
Python	aws_cdk.aws_codebuild.IReportGroup
TypeScript (source)	@aws-cdk/aws-codebuild » IReportGroup

Implemented by ReportGroup

Obtainable from ReportGroup.fromReportGroupName()

The interface representing the ReportGroup resource - either an existing one, imported using the {@link ReportGroup.fromReportGroupName} method, or a new one, created with the {@link ReportGroup} class.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	ConstructNode	The construct tree node for this construct.
reportGroupArn	string	The ARN of the ReportGroup.
reportGroupName	string	The name of the ReportGroup.
stack	Stack	The stack in which this resource is defined.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: ConstructNode

The construct tree node for this construct.

---

reportGroupArn

Type: string

The ARN of the ReportGroup.

---

reportGroupName

Type: string

The name of the ReportGroup.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
grantWrite(identity)	Grants the given entity permissions to write (that is, upload reports to) this report group.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

grantWrite(identity)

public grantWrite(identity: IGrantable): Grant

Parameters

• identity IGrantable

Returns

• Grant

Grants the given entity permissions to write (that is, upload reports to) this report group.