aws-cdk-lib.aws_codebuild.ReportGroup

class ReportGroup (construct)

LanguageType name
.NETAmazon.CDK.AWS.CodeBuild.ReportGroup
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodebuild#ReportGroup
Javasoftware.amazon.awscdk.services.codebuild.ReportGroup
Pythonaws_cdk.aws_codebuild.ReportGroup
TypeScript (source)aws-cdk-lib » aws_codebuild » ReportGroup

Implements IConstruct, IDependable, IResource, IReportGroup

The ReportGroup resource class.

Example

declare const source: codebuild.Source;

// create a new ReportGroup
const reportGroup = new codebuild.ReportGroup(this, 'ReportGroup');

const project = new codebuild.Project(this, 'Project', {
  source,
  buildSpec: codebuild.BuildSpec.fromObject({
    // ...
    reports: {
      [reportGroup.reportGroupArn]: {
        files: '**/*',
        'base-directory': 'build/test-results',
      },
    },
  }),
});

Initializer

new ReportGroup(scope: Construct, id: string, props?: ReportGroupProps)

Parameters

  • scope Construct
  • id string
  • props ReportGroupProps

Construct Props

NameTypeDescription
exportBucket?IBucketAn optional S3 bucket to export the reports to.
removalPolicy?RemovalPolicyWhat to do when this resource is deleted from a stack.
reportGroupName?stringThe physical name of the report group.
type?ReportGroupTypeThe type of report group. This can be one of the following values:.
zipExport?booleanWhether to output the report files into the export bucket as-is, or create a ZIP from them before doing the export.

exportBucket?

Type: IBucket (optional, default: the reports will not be exported)

An optional S3 bucket to export the reports to.


removalPolicy?

Type: RemovalPolicy (optional, default: RemovalPolicy.RETAIN)

What to do when this resource is deleted from a stack.

As CodeBuild does not allow deleting a ResourceGroup that has reports inside of it, this is set to retain the resource by default.


reportGroupName?

Type: string (optional, default: CloudFormation-generated name)

The physical name of the report group.


type?

Type: ReportGroupType (optional, default: TEST)

The type of report group. This can be one of the following values:.

  • TEST - The report group contains test reports.
  • CODE_COVERAGE - The report group contains code coverage reports.

zipExport?

Type: boolean (optional, default: false (the files will not be ZIPped))

Whether to output the report files into the export bucket as-is, or create a ZIP from them before doing the export.

Ignored if exportBucket has not been provided.

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
reportGroupArnstringThe ARN of the ReportGroup.
reportGroupNamestringThe name of the ReportGroup.
stackStackThe stack in which this resource is defined.
exportBucket?IBucket
type?ReportGroupType

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: Node

The tree node.


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.


exportBucket?

Type: IBucket (optional)


type?

Type: ReportGroupType (optional)

Methods

NameDescription
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.
toString()Returns a string representation of this construct.
static fromReportGroupName(scope, id, reportGroupName)Reference an existing ReportGroup, defined outside of the CDK code, by name.

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.


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


static fromReportGroupName(scope, id, reportGroupName)

public static fromReportGroupName(scope: Construct, id: string, reportGroupName: string): IReportGroup

Parameters

  • scope Construct
  • id string
  • reportGroupName string

Returns

  • IReportGroup

Reference an existing ReportGroup, defined outside of the CDK code, by name.