CfnReportGroupProps

class aws_cdk.aws_codebuild.CfnReportGroupProps(*, export_config, type, delete_reports=None, name=None, tags=None)

Bases: object

Properties for defining a CfnReportGroup.

Parameters
  • export_config (Union[IResolvable, ReportExportConfigProperty, Dict[str, Any]]) – Information about the destination where the raw data of this ReportGroup is exported.

  • type (str) – The type of the ReportGroup . This can be one of the following values:. - CODE_COVERAGE - The report group contains code coverage reports. - TEST - The report group contains test reports.

  • delete_reports (Union[bool, IResolvable, None]) – When deleting a report group, specifies if reports within the report group should be deleted. - true - Deletes any reports that belong to the report group before deleting the report group. - false - You must delete any reports in the report group. This is the default value. If you delete a report group that contains one or more reports, an exception is thrown.

  • name (Optional[str]) – The name of the ReportGroup .

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of tag key and value pairs associated with this report group. These tags are available for use by AWS services that support AWS CodeBuild report group tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_codebuild as codebuild

cfn_report_group_props = codebuild.CfnReportGroupProps(
    export_config=codebuild.CfnReportGroup.ReportExportConfigProperty(
        export_config_type="exportConfigType",

        # the properties below are optional
        s3_destination=codebuild.CfnReportGroup.S3ReportExportConfigProperty(
            bucket="bucket",

            # the properties below are optional
            bucket_owner="bucketOwner",
            encryption_disabled=False,
            encryption_key="encryptionKey",
            packaging="packaging",
            path="path"
        )
    ),
    type="type",

    # the properties below are optional
    delete_reports=False,
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

delete_reports

When deleting a report group, specifies if reports within the report group should be deleted.

  • true - Deletes any reports that belong to the report group before deleting the report group.

  • false - You must delete any reports in the report group. This is the default value. If you delete a report group that contains one or more reports, an exception is thrown.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-deletereports

Return type

Union[bool, IResolvable, None]

export_config

Information about the destination where the raw data of this ReportGroup is exported.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-exportconfig

Return type

Union[IResolvable, ReportExportConfigProperty]

name

The name of the ReportGroup .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-name

Return type

Optional[str]

tags

A list of tag key and value pairs associated with this report group.

These tags are available for use by AWS services that support AWS CodeBuild report group tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-tags

Return type

Optional[List[CfnTag]]

type

.

  • CODE_COVERAGE - The report group contains code coverage reports.

  • TEST - The report group contains test reports.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-type

Type

The type of the ReportGroup . This can be one of the following values

Return type

str