Skip to content
v2.277.0

CfnReportGroupProps Struct ​

Properties for defining a CfnReportGroup.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codebuild as codebuild } from 'aws-cdk-lib';
const cfnReportGroupProps: codebuild.CfnReportGroupProps = {
  exportConfig: {
    exportConfigType: 'exportConfigType',

    // the properties below are optional
    s3Destination: {
      bucket: 'bucket',

      // the properties below are optional
      bucketOwner: 'bucketOwner',
      encryptionDisabled: false,
      encryptionKey: 'encryptionKey',
      packaging: 'packaging',
      path: 'path',
    },
  },
  type: 'type',

  // the properties below are optional
  deleteReports: false,
  name: 'name',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import 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"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.codebuild.*;

CfnReportGroupProps cfnReportGroupProps = CfnReportGroupProps.builder()
        .exportConfig(ReportExportConfigProperty.builder()
                .exportConfigType("exportConfigType")

                // the properties below are optional
                .s3Destination(S3ReportExportConfigProperty.builder()
                        .bucket("bucket")

                        // the properties below are optional
                        .bucketOwner("bucketOwner")
                        .encryptionDisabled(false)
                        .encryptionKey("encryptionKey")
                        .packaging("packaging")
                        .path("path")
                        .build())
                .build())
        .type("type")

        // the properties below are optional
        .deleteReports(false)
        .name("name")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodeBuild;

var cfnReportGroupProps = new CfnReportGroupProps {
    ExportConfig = new ReportExportConfigProperty {
        ExportConfigType = "exportConfigType",

        // the properties below are optional
        S3Destination = new S3ReportExportConfigProperty {
            Bucket = "bucket",

            // the properties below are optional
            BucketOwner = "bucketOwner",
            EncryptionDisabled = false,
            EncryptionKey = "encryptionKey",
            Packaging = "packaging",
            Path = "path"
        }
    },
    Type = "type",

    // the properties below are optional
    DeleteReports = false,
    Name = "name",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnReportGroupProps := &CfnReportGroupProps{
	ExportConfig: &ReportExportConfigProperty{
		ExportConfigType: jsii.String("exportConfigType"),

		// the properties below are optional
		S3Destination: &S3ReportExportConfigProperty{
			Bucket: jsii.String("bucket"),

			// the properties below are optional
			BucketOwner: jsii.String("bucketOwner"),
			EncryptionDisabled: jsii.Boolean(false),
			EncryptionKey: jsii.String("encryptionKey"),
			Packaging: jsii.String("packaging"),
			Path: jsii.String("path"),
		},
	},
	Type: jsii.String("type"),

	// the properties below are optional
	DeleteReports: jsii.Boolean(false),
	Name: jsii.String("name"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

deleteReportsoptionalboolean | IResolvabledelete_reportsoptionaltyping.Union[bool, IResolvable]deleteReportsoptionalBooleanDeleteReportsoptionalboolDeleteReportsoptionalinterface{}#
When deleting a report group, specifies if reports within the report group should be deleted.
notes
  • 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.
exportConfigIResolvable | CfnReportGroup.ReportExportConfigPropertyexport_configtyping.Union[IResolvable, ReportExportConfigProperty]exportConfigIResolvableExportConfigIResolvableExportConfiginterface{}required#
Information about the destination where the raw data of this `ReportGroup` is exported.
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
The name of the `ReportGroup` .
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
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.

typestringtypestrtypeStringTypestringType*stringrequired#
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.