You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CostandUsageReportService::Types::ReportDefinition

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ReportDefinition as input to an Aws::Client method, you can use a vanilla Hash:

{
  report_name: "ReportName", # required
  time_unit: "HOURLY", # required, accepts HOURLY, DAILY, MONTHLY
  format: "textORcsv", # required, accepts textORcsv, Parquet
  compression: "ZIP", # required, accepts ZIP, GZIP, Parquet
  additional_schema_elements: ["RESOURCES"], # required, accepts RESOURCES
  s3_bucket: "S3Bucket", # required
  s3_prefix: "S3Prefix", # required
  s3_region: "af-south-1", # required, accepts af-south-1, ap-east-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2, ap-northeast-3, ca-central-1, eu-central-1, eu-west-1, eu-west-2, eu-west-3, eu-north-1, eu-south-1, me-south-1, sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2, cn-north-1, cn-northwest-1
  additional_artifacts: ["REDSHIFT"], # accepts REDSHIFT, QUICKSIGHT, ATHENA
  refresh_closed_reports: false,
  report_versioning: "CREATE_NEW_REPORT", # accepts CREATE_NEW_REPORT, OVERWRITE_REPORT
}

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.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#additional_artifacts ⇒ Array<String>

A list of manifests that you want Amazon Web Services to create for this report.

Returns:

  • (Array<String>) —

    A list of manifests that you want Amazon Web Services to create for this report.

#additional_schema_elements ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#compression ⇒ String

The compression format that AWS uses for the report.

Possible values:

  • ZIP
  • GZIP
  • Parquet

Returns:

  • (String) —

    The compression format that AWS uses for the report.

    .

#format ⇒ String

The format that AWS saves the report in.

Possible values:

  • textORcsv
  • Parquet

Returns:

  • (String) —

    The format that AWS saves the report in.

    .

#refresh_closed_reports ⇒ Boolean

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

Returns:

  • (Boolean) —

    Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months.

#report_name ⇒ String

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

Returns:

  • (String) —

    The name of the report that you want to create.

#report_versioning ⇒ String

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

Possible values:

  • CREATE_NEW_REPORT
  • OVERWRITE_REPORT

Returns:

  • (String) —

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

#s3_bucket ⇒ String

The S3 bucket where AWS delivers the report.

Returns:

  • (String) —

    The S3 bucket where AWS delivers the report.

    .

#s3_prefix ⇒ String

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

Returns:

  • (String) —

    The prefix that AWS adds to the report name when AWS delivers the report.

#s3_region ⇒ String

The region of the S3 bucket that AWS delivers the report into.

Possible values:

  • af-south-1
  • ap-east-1
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • ap-northeast-1
  • ap-northeast-2
  • ap-northeast-3
  • ca-central-1
  • eu-central-1
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • eu-north-1
  • eu-south-1
  • me-south-1
  • sa-east-1
  • us-east-1
  • us-east-2
  • us-west-1
  • us-west-2
  • cn-north-1
  • cn-northwest-1

Returns:

  • (String) —

    The region of the S3 bucket that AWS delivers the report into.

    .

#time_unit ⇒ String

The length of time covered by the report.

Possible values:

  • HOURLY
  • DAILY
  • MONTHLY

Returns:

  • (String) —

    The length of time covered by the report.