class ReportGroup (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CodeBuild.ReportGroup |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscodebuild#ReportGroup |
![]() | software.amazon.awscdk.services.codebuild.ReportGroup |
![]() | aws_cdk.aws_codebuild.ReportGroup |
![]() | aws-cdk-lib » aws_codebuild » ReportGroup |
Implements
IConstruct
, IDependable
, IResource
, IReport
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
Report
Group Props
Construct Props
Name | Type | Description |
---|---|---|
delete | boolean | If true, deleting the report group force deletes the contents of the report group. |
export | IBucket | An optional S3 bucket to export the reports to. |
removal | Removal | What to do when this resource is deleted from a stack. |
report | string | The physical name of the report group. |
type? | Report | The type of report group. This can be one of the following values:. |
zip | boolean | Whether to output the report files into the export bucket as-is, or create a ZIP from them before doing the export. |
deleteReports?
Type:
boolean
(optional, default: false)
If true, deleting the report group force deletes the contents of the report group.
If false, the report group must be empty before attempting to delete it.
exportBucket?
Type:
IBucket
(optional, default: the reports will not be exported)
An optional S3 bucket to export the reports to.
removalPolicy?
Type:
Removal
(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:
Report
(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
Name | Type | Description |
---|---|---|
env | Resource | The environment this resource belongs to. |
node | Node | The tree node. |
report | string | The ARN of the ReportGroup. |
report | string | The name of the ReportGroup. |
stack | Stack | The stack in which this resource is defined. |
export | IBucket | |
type? | Report |
env
Type:
Resource
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:
Report
(optional)
Methods
Name | Description |
---|---|
apply | Apply the given removal policy to this resource. |
grant | Grants the given entity permissions to write (that is, upload reports to) this report group. |
to | Returns a string representation of this construct. |
static from | Reference an existing ReportGroup, defined outside of the CDK code, by name. |
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
Parameters
- policy
Removal
Policy
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
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
Reference an existing ReportGroup, defined outside of the CDK code, by name.