AWS::CUR::ReportDefinition

The definition of AWS Cost and Usage Report. You can specify the report name, time unit, report format, compression format, S3 bucket, additional artifacts, and schema elements in the definition.

Syntax

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

JSON

{
  "Type" : "AWS::CUR::ReportDefinition",
  "Properties" : {
      "AdditionalArtifacts" : [ String, ... ],
      "AdditionalSchemaElements" : [ String, ... ],
      "BillingViewArn" : String,
      "Compression" : String,
      "Format" : String,
      "RefreshClosedReports" : Boolean,
      "ReportName" : String,
      "ReportVersioning" : String,
      "S3Bucket" : String,
      "S3Prefix" : String,
      "S3Region" : String,
      "TimeUnit" : String
    }
}

YAML

Type: AWS::CUR::ReportDefinition
Properties:
  AdditionalArtifacts: 
    - String
  AdditionalSchemaElements: 
    - String
  BillingViewArn: String
  Compression: String
  Format: String
  RefreshClosedReports: Boolean
  ReportName: String
  ReportVersioning: String
  S3Bucket: String
  S3Prefix: String
  S3Region: String
  TimeUnit: String

Properties

AdditionalArtifacts

A list of manifests that you want AWS to create for this report.

Required: No

Type: Array of String

Allowed values: REDSHIFT | QUICKSIGHT | ATHENA

Update requires: No interruption

AdditionalSchemaElements

A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs.

Required: No

Type: Array of String

Allowed values: RESOURCES | SPLIT_COST_ALLOCATION_DATA | MANUAL_DISCOUNT_COMPATIBILITY

Update requires: Replacement

BillingViewArn

The Amazon Resource Name (ARN) of the billing view. You can get this value by using the billing view service public APIs.

Required: No

Type: String

Pattern: (arn:aws(-cn)?:billing::[0-9]{12}:billingview/)?[a-zA-Z0-9_\+=\.\-@].{1,30}

Minimum: 1

Maximum: 128

Update requires: Replacement

Compression

The compression format that Amazon Web Services uses for the report.

Required: Yes

Type: String

Allowed values: ZIP | GZIP | Parquet

Update requires: No interruption

Format

The format that Amazon Web Services saves the report in.

Required: Yes

Type: String

Allowed values: textORcsv | Parquet

Update requires: No interruption

RefreshClosedReports

Whether you want AWS to update your reports after they have been finalized if AWS detects charges related to previous months. These charges can include refunds, credits, or support fees.

Required: Yes

Type: Boolean

Update requires: No interruption

ReportName

The name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.

Required: Yes

Type: String

Pattern: [0-9A-Za-z!\-_.*\'()]+

Minimum: 1

Maximum: 256

Update requires: Replacement

ReportVersioning

Whether you want AWS to overwrite the previous version of each report or to deliver the report in addition to the previous versions.

Required: Yes

Type: String

Allowed values: CREATE_NEW_REPORT | OVERWRITE_REPORT

Update requires: Replacement

S3Bucket

The S3 bucket where Amazon Web Services delivers the report.

Required: Yes

Type: String

Pattern: [A-Za-z0-9_\.\-]+

Minimum: 1

Maximum: 256

Update requires: No interruption

S3Prefix

The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report. Your prefix can't include spaces.

Required: Yes

Type: String

Pattern: [0-9A-Za-z!\-_.*\'()/]*

Minimum: 1

Maximum: 256

Update requires: No interruption

S3Region

The Region of the S3 bucket that Amazon Web Services delivers the report into.

Required: Yes

Type: String

Update requires: No interruption

TimeUnit

The granularity of the line items in the report.

Required: Yes

Type: String

Allowed values: HOURLY | DAILY | MONTHLY

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns

{ "Ref": "ReportName" }

The name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.

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