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

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

Inherits:
Struct
  • Object
show all
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
  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.

Instance Attribute Summary collapse

Instance Attribute Details

#additional_artifactsArray<String>

A list of additional artifacts.

Returns:

  • (Array<String>)


186
187
188
189
190
191
192
193
194
195
196
197
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 186

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts)
  include Aws::Structure
end

#additional_schema_elementsArray<String>

A list of schema elements.

Returns:

  • (Array<String>)


186
187
188
189
190
191
192
193
194
195
196
197
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 186

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts)
  include Aws::Structure
end

#compressionString

Preferred compression format for report.

Returns:

  • (String)


186
187
188
189
190
191
192
193
194
195
196
197
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 186

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts)
  include Aws::Structure
end

#formatString

Preferred format for report.

Returns:

  • (String)


186
187
188
189
190
191
192
193
194
195
196
197
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 186

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts)
  include Aws::Structure
end

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


186
187
188
189
190
191
192
193
194
195
196
197
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 186

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts)
  include Aws::Structure
end

#s3_bucketString

Name of customer S3 bucket.

Returns:

  • (String)


186
187
188
189
190
191
192
193
194
195
196
197
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 186

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts)
  include Aws::Structure
end

#s3_prefixString

Preferred report path prefix. Limited to 256 characters.

Returns:

  • (String)


186
187
188
189
190
191
192
193
194
195
196
197
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 186

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts)
  include Aws::Structure
end

#s3_regionString

Region of customer S3 bucket.

Returns:

  • (String)


186
187
188
189
190
191
192
193
194
195
196
197
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 186

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts)
  include Aws::Structure
end

#time_unitString

The frequency on which report data are measured and displayed.

Returns:

  • (String)


186
187
188
189
190
191
192
193
194
195
196
197
# File 'gems/aws-sdk-costandusagereportservice/lib/aws-sdk-costandusagereportservice/types.rb', line 186

class ReportDefinition < Struct.new(
  :report_name,
  :time_unit,
  :format,
  :compression,
  :additional_schema_elements,
  :s3_bucket,
  :s3_prefix,
  :s3_region,
  :additional_artifacts)
  include Aws::Structure
end