This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::CodeBuild::ReportGroup
<a name="aws-resource-codebuild-reportgroup"></a>

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

## Syntax
<a name="aws-resource-codebuild-reportgroup-syntax"></a>

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

### JSON
<a name="aws-resource-codebuild-reportgroup-syntax.json"></a>

```
{
  "Type" : "AWS::CodeBuild::ReportGroup",
  "Properties" : {
      "[DeleteReports](#cfn-codebuild-reportgroup-deletereports)" : Boolean,
      "[ExportConfig](#cfn-codebuild-reportgroup-exportconfig)" : ReportExportConfig,
      "[Name](#cfn-codebuild-reportgroup-name)" : String,
      "[Tags](#cfn-codebuild-reportgroup-tags)" : [ Tag, ... ],
      "[Type](#cfn-codebuild-reportgroup-type)" : String
    }
}
```

### YAML
<a name="aws-resource-codebuild-reportgroup-syntax.yaml"></a>

```
Type: AWS::CodeBuild::ReportGroup
Properties:
  [DeleteReports](#cfn-codebuild-reportgroup-deletereports): Boolean
  [ExportConfig](#cfn-codebuild-reportgroup-exportconfig): 
    ReportExportConfig
  [Name](#cfn-codebuild-reportgroup-name): String
  [Tags](#cfn-codebuild-reportgroup-tags): 
    - Tag
  [Type](#cfn-codebuild-reportgroup-type): String
```

## Properties
<a name="aws-resource-codebuild-reportgroup-properties"></a>

`DeleteReports`  <a name="cfn-codebuild-reportgroup-deletereports"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExportConfig`  <a name="cfn-codebuild-reportgroup-exportconfig"></a>
Information about the destination where the raw data of this `ReportGroup` is exported.   
*Required*: Yes  
*Type*: [ReportExportConfig](aws-properties-codebuild-reportgroup-reportexportconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-codebuild-reportgroup-name"></a>
The name of the `ReportGroup`.   
*Required*: No  
*Type*: String  
*Minimum*: `2`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-codebuild-reportgroup-tags"></a>
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](aws-properties-codebuild-reportgroup-tag.md)  
*Minimum*: `0`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-codebuild-reportgroup-type"></a>
The type of the `ReportGroup`. This can be one of the following values:    
CODE\$1COVERAGE  
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-codebuild-reportgroup-return-values"></a>

### Ref
<a name="aws-resource-codebuild-reportgroup-return-values-ref"></a>

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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-codebuild-reportgroup-return-values-fn--getatt"></a>

`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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-codebuild-reportgroup-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The ARN of the AWS CodeBuild report group, such as `arn:aws:codebuild:region:123456789012:report-group/myReportGroupName`. 

# AWS::CodeBuild::ReportGroup ReportExportConfig
<a name="aws-properties-codebuild-reportgroup-reportexportconfig"></a>

 Information about the location where the run of a report is exported. 

## Syntax
<a name="aws-properties-codebuild-reportgroup-reportexportconfig-syntax"></a>

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

### JSON
<a name="aws-properties-codebuild-reportgroup-reportexportconfig-syntax.json"></a>

```
{
  "[ExportConfigType](#cfn-codebuild-reportgroup-reportexportconfig-exportconfigtype)" : String,
  "[S3Destination](#cfn-codebuild-reportgroup-reportexportconfig-s3destination)" : S3ReportExportConfig
}
```

### YAML
<a name="aws-properties-codebuild-reportgroup-reportexportconfig-syntax.yaml"></a>

```
  [ExportConfigType](#cfn-codebuild-reportgroup-reportexportconfig-exportconfigtype): String
  [S3Destination](#cfn-codebuild-reportgroup-reportexportconfig-s3destination): 
    S3ReportExportConfig
```

## Properties
<a name="aws-properties-codebuild-reportgroup-reportexportconfig-properties"></a>

`ExportConfigType`  <a name="cfn-codebuild-reportgroup-reportexportconfig-exportconfigtype"></a>
 The export configuration type. Valid values are:   
+ `S3`: The report results are exported to an S3 bucket. 
+ `NO_EXPORT`: The report results are not exported. 
*Required*: Yes  
*Type*: String  
*Allowed values*: `S3 | NO_EXPORT`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3Destination`  <a name="cfn-codebuild-reportgroup-reportexportconfig-s3destination"></a>
 A `S3ReportExportConfig` object that contains information about the S3 bucket where the run of a report is exported.   
*Required*: No  
*Type*: [S3ReportExportConfig](aws-properties-codebuild-reportgroup-s3reportexportconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::ReportGroup S3ReportExportConfig
<a name="aws-properties-codebuild-reportgroup-s3reportexportconfig"></a>

 Information about the S3 bucket where the raw data of a report are exported. 

## Syntax
<a name="aws-properties-codebuild-reportgroup-s3reportexportconfig-syntax"></a>

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

### JSON
<a name="aws-properties-codebuild-reportgroup-s3reportexportconfig-syntax.json"></a>

```
{
  "[Bucket](#cfn-codebuild-reportgroup-s3reportexportconfig-bucket)" : String,
  "[BucketOwner](#cfn-codebuild-reportgroup-s3reportexportconfig-bucketowner)" : String,
  "[EncryptionDisabled](#cfn-codebuild-reportgroup-s3reportexportconfig-encryptiondisabled)" : Boolean,
  "[EncryptionKey](#cfn-codebuild-reportgroup-s3reportexportconfig-encryptionkey)" : String,
  "[Packaging](#cfn-codebuild-reportgroup-s3reportexportconfig-packaging)" : String,
  "[Path](#cfn-codebuild-reportgroup-s3reportexportconfig-path)" : String
}
```

### YAML
<a name="aws-properties-codebuild-reportgroup-s3reportexportconfig-syntax.yaml"></a>

```
  [Bucket](#cfn-codebuild-reportgroup-s3reportexportconfig-bucket): String
  [BucketOwner](#cfn-codebuild-reportgroup-s3reportexportconfig-bucketowner): String
  [EncryptionDisabled](#cfn-codebuild-reportgroup-s3reportexportconfig-encryptiondisabled): Boolean
  [EncryptionKey](#cfn-codebuild-reportgroup-s3reportexportconfig-encryptionkey): String
  [Packaging](#cfn-codebuild-reportgroup-s3reportexportconfig-packaging): String
  [Path](#cfn-codebuild-reportgroup-s3reportexportconfig-path): String
```

## Properties
<a name="aws-properties-codebuild-reportgroup-s3reportexportconfig-properties"></a>

`Bucket`  <a name="cfn-codebuild-reportgroup-s3reportexportconfig-bucket"></a>
 The name of the S3 bucket where the raw data of a report are exported.   
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BucketOwner`  <a name="cfn-codebuild-reportgroup-s3reportexportconfig-bucketowner"></a>
The AWS account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket that is owned by an account other than the account running the build.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EncryptionDisabled`  <a name="cfn-codebuild-reportgroup-s3reportexportconfig-encryptiondisabled"></a>
 A boolean value that specifies if the results of a report are encrypted.   
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EncryptionKey`  <a name="cfn-codebuild-reportgroup-s3reportexportconfig-encryptionkey"></a>
 The encryption key for the report's encrypted raw data.   
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Packaging`  <a name="cfn-codebuild-reportgroup-s3reportexportconfig-packaging"></a>
 The type of build output artifact to create. Valid values include:   
+ `NONE`: CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified. 
+ `ZIP`: CodeBuild creates a ZIP file with the raw data in the output bucket. 
*Required*: No  
*Type*: String  
*Allowed values*: `ZIP | NONE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Path`  <a name="cfn-codebuild-reportgroup-s3reportexportconfig-path"></a>
 The path to the exported report's raw data results.   
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::ReportGroup Tag
<a name="aws-properties-codebuild-reportgroup-tag"></a>

A tag, consisting of a key and a value.

This tag is available for use by AWS services that support tags in AWS CodeBuild.

## Syntax
<a name="aws-properties-codebuild-reportgroup-tag-syntax"></a>

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

### JSON
<a name="aws-properties-codebuild-reportgroup-tag-syntax.json"></a>

```
{
  "[Key](#cfn-codebuild-reportgroup-tag-key)" : String,
  "[Value](#cfn-codebuild-reportgroup-tag-value)" : String
}
```

### YAML
<a name="aws-properties-codebuild-reportgroup-tag-syntax.yaml"></a>

```
  [Key](#cfn-codebuild-reportgroup-tag-key): String
  [Value](#cfn-codebuild-reportgroup-tag-value): String
```

## Properties
<a name="aws-properties-codebuild-reportgroup-tag-properties"></a>

`Key`  <a name="cfn-codebuild-reportgroup-tag-key"></a>
The tag's key.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=@+\-]*)$`  
*Minimum*: `1`  
*Maximum*: `127`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-codebuild-reportgroup-tag-value"></a>
The tag's value.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=@+\-]*)$`  
*Minimum*: `0`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)