AWS::CodeBuild::ReportGroup

Represents a report group. A report group contains a collection of reports.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::CodeBuild::ReportGroup",
  "Properties" : {
      "DeleteReports" : Boolean,
      "ExportConfig" : ReportExportConfig,
      "Name" : String,
      "Tags" : [ Tag, ... ],
      "Type" : String
    }
}

YAML

Type: AWS::CodeBuild::ReportGroup
Properties:
  DeleteReports: Boolean
  ExportConfig: 
    ReportExportConfig
  Name: String
  Tags: 
    - Tag
  Type: String

Properties

DeleteReports

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.

Required: No

Type: Boolean

Update requires: No interruption

ExportConfig

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

Required: Yes

Type: ReportExportConfig

Update requires: No interruption

Name

The name of the ReportGroup.

Required: No

Type: String

Minimum: 2

Maximum: 128

Update requires: Replacement

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.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

Type

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.

Required: Yes

Type: String

Allowed values: TEST | CODE_COVERAGE

Update requires: Replacement

Return values

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the ARN of the AWS CodeBuild report group, such as arn:aws:codebuild:region:123456789012:report-group/myReportGroupName.

For more information about using the Ref function, see Ref.

Fn::GetAtt

Fn::GetAtt returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using Fn::GetAtt, see Fn::GetAtt.

Arn

The ARN of the AWS CodeBuild report group, such as arn:aws:codebuild:region:123456789012:report-group/myReportGroupName.