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
  format: "textORcsv", # required, accepts textORcsv
  compression: "ZIP", # required, accepts ZIP, GZIP
  additional_schema_elements: ["RESOURCES"], # required, accepts RESOURCES
  s3_bucket: "S3Bucket", # required
  s3_prefix: "S3Prefix", # required
  s3_region: "us-east-1", # required, accepts us-east-1, us-west-1, us-west-2, eu-central-1, eu-west-1, ap-southeast-1, ap-southeast-2, ap-northeast-1
  additional_artifacts: ["REDSHIFT"], # accepts REDSHIFT, QUICKSIGHT
}

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#additional_artifactsArray<String>

A list of additional artifacts.

Returns:

  • (Array<String>)

    A list of additional artifacts.

#additional_schema_elementsArray<String>

A list of schema elements.

Returns:

  • (Array<String>)

    A list of schema elements.

#compressionString

Preferred compression format for report.

Possible values:

  • ZIP
  • GZIP

Returns:

  • (String)

    Preferred compression format for report.

#formatString

Preferred format for report.

Possible values:

  • textORcsv

Returns:

  • (String)

    Preferred format for report.

#report_nameString

Preferred name for a report, it has to be unique. Must starts with a number/letter, case sensitive. Limited to 256 characters.

Returns:

  • (String)

    Preferred name for a report, it has to be unique.

#s3_bucketString

Name of customer S3 bucket.

Returns:

  • (String)

    Name of customer S3 bucket.

#s3_prefixString

Preferred report path prefix. Limited to 256 characters.

Returns:

  • (String)

    Preferred report path prefix.

#s3_regionString

Region of customer S3 bucket.

Possible values:

  • us-east-1
  • us-west-1
  • us-west-2
  • eu-central-1
  • eu-west-1
  • ap-southeast-1
  • ap-southeast-2
  • ap-northeast-1

Returns:

  • (String)

    Region of customer S3 bucket.

#time_unitString

The frequency on which report data are measured and displayed.

Possible values:

  • HOURLY
  • DAILY

Returns:

  • (String)

    The frequency on which report data are measured and displayed.