ReportGroup

class aws_cdk.aws_codebuild.ReportGroup(scope, id, *, delete_reports=None, export_bucket=None, removal_policy=None, report_group_name=None, type=None, zip_export=None)

Bases: Resource

The ReportGroup resource class.

ExampleMetadata:: infused

Example:

# source: codebuild.Source


# create a new ReportGroup
report_group = codebuild.ReportGroup(self, "ReportGroup")

project = codebuild.Project(self, "Project",
    source=source,
    build_spec=codebuild.BuildSpec.from_object({
        # ...
        "reports": {
            "report_group.report_group_arn": {
                "files": "**/*",
                "base-directory": "build/test-results"
            }
        }
    })
)

Parameters:

scope (Construct)
id (str)
delete_reports (Optional[bool]) – 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. Default: false
export_bucket (Optional[IBucket]) – An optional S3 bucket to export the reports to. Default: - the reports will not be exported
removal_policy (Optional[RemovalPolicy]) – 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. Default: RemovalPolicy.RETAIN
report_group_name (Optional[str]) – The physical name of the report group. Default: - CloudFormation-generated name
type (Optional[ReportGroupType]) – 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. Default: TEST
zip_export (Optional[bool]) – 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. Default: - false (the files will not be ZIPped)

Methods

apply_removal_policy(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).

Parameters:: policy (RemovalPolicy)
Return type:: None

grant_write(identity)

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

Parameters:: identity (IGrantable)
Return type:: Grant

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

PROPERTY_INJECTION_ID = 'aws-cdk-lib.aws-codebuild.ReportGroup'

env

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

node: The tree node.

report_group_arn: The ARN of the ReportGroup.

report_group_name: The name of the ReportGroup.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_report_group_name(scope, id, report_group_name)

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

Parameters:

scope (Construct)
id (str)
report_group_name (str)

Return type:

IReportGroup

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:: construct (IConstruct)
Return type:: bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:: construct (IConstruct)
Return type:: bool