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

Inherits:

Struct

• Object
• Struct
• Aws::CostandUsageReportService::Types::ReportDefinition

Defined in:

gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb

Overview

Note:

When making an API call, you may pass ReportDefinition data as a 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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #additional_artifacts ⇒ 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.

• #compression ⇒ String

  The compression format that AWS uses for the report.

• #format ⇒ 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.

• #report_name ⇒ 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.

• #s3_bucket ⇒ 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.

• #s3_region ⇒ String

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

• #time_unit ⇒ String

  The length of time covered by the report.

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>)

# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 288

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning)
  SENSITIVE = []
  include Aws::Structure
end

#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>)

# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 288

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning)
  SENSITIVE = []
  include Aws::Structure
end

#compression ⇒ String

The compression format that AWS uses for the report.

Returns:

• (String)

# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 288

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ String

The format that AWS saves the report in.

Returns:

• (String)

# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 288

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 288

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 288

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 288

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket ⇒ String

The S3 bucket where AWS delivers the report.

Returns:

• (String)

# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 288

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 288

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning)
  SENSITIVE = []
  include Aws::Structure
end

#s3_region ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 288

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning)
  SENSITIVE = []
  include Aws::Structure
end

#time_unit ⇒ String

The length of time covered by the report.

Returns:

• (String)

# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 288

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts,
  :refresh_closed_reports,
  :report_versioning)
  SENSITIVE = []
  include Aws::Structure
end