ReportGroup

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

Bases: aws_cdk.core.Resource

The ReportGroup resource class.

Parameters
  • scope (Construct) –

  • id (str) –

  • 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

  • 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 {@link exportBucket} has not been provided. Default: - false (the files will not be ZIPped)

Methods

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

env

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.

Return type

ResourceEnvironment

node

The construct tree node associated with this construct.

Return type

ConstructNode

report_group_arn

The ARN of the ReportGroup.

Return type

str

report_group_name

The name of the ReportGroup.

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack

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)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool