Class: AWSCDK::CUR::CfnReportDefinitionProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cur/cfn_report_definition_props.rb

Overview

Properties for defining a CfnReportDefinition.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(compression:, format:, refresh_closed_reports:, report_name:, report_versioning:, s3_bucket:, s3_prefix:, s3_region:, time_unit:, additional_artifacts: nil, additional_schema_elements: nil, billing_view_arn: nil, tags: nil) ⇒ CfnReportDefinitionProps

Returns a new instance of CfnReportDefinitionProps.

Parameters:

  • compression (String) —

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

  • format (String) —

    The format that Amazon Web Services saves the report in.

  • refresh_closed_reports (Boolean, AWSCDK::IResolvable) —

    Whether you want AWS to update your reports after they have been finalized if AWS 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 AWS to overwrite the previous version of each report or to deliver the report in addition to the previous versions.

  • s3_bucket (String, AWSCDK::Interfaces::AWSS3::IBucketRef) —

    The S3 bucket where Amazon Web Services delivers the report.

  • s3_prefix (String) —

    The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report.

  • s3_region (String) —

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

  • time_unit (String) —

    The granularity of the line items in the report.

  • additional_artifacts (Array<String>, nil) (defaults to: nil) —

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

  • additional_schema_elements (Array<String>, nil) (defaults to: nil) —

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

  • billing_view_arn (String, nil) (defaults to: nil) —

    The Amazon Resource Name (ARN) of the billing view.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    The tags to be assigned to the report definition resource.



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'cur/cfn_report_definition_props.rb', line 22

def initialize(compression:, format:, refresh_closed_reports:, report_name:, report_versioning:, s3_bucket:, s3_prefix:, s3_region:, time_unit:, additional_artifacts: nil, additional_schema_elements: nil, billing_view_arn: nil, tags: nil)
  @compression = compression
  Jsii::Type.check_type(@compression, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "compression")
  @format = format
  Jsii::Type.check_type(@format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "format")
  @refresh_closed_reports = refresh_closed_reports
  Jsii::Type.check_type(@refresh_closed_reports, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "refreshClosedReports")
  @report_name = report_name
  Jsii::Type.check_type(@report_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "reportName")
  @report_versioning = report_versioning
  Jsii::Type.check_type(@report_versioning, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "reportVersioning")
  @s3_bucket = s3_bucket
  Jsii::Type.check_type(@s3_bucket, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zMy5JQnVja2V0UmVmIn1dfX0=")), "s3Bucket")
  @s3_prefix = s3_prefix
  Jsii::Type.check_type(@s3_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3Prefix")
  @s3_region = s3_region
  Jsii::Type.check_type(@s3_region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "s3Region")
  @time_unit = time_unit
  Jsii::Type.check_type(@time_unit, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timeUnit")
  @additional_artifacts = additional_artifacts
  Jsii::Type.check_type(@additional_artifacts, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "additionalArtifacts") unless @additional_artifacts.nil?
  @additional_schema_elements = additional_schema_elements
  Jsii::Type.check_type(@additional_schema_elements, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "additionalSchemaElements") unless @additional_schema_elements.nil?
  @billing_view_arn = billing_view_arn
  Jsii::Type.check_type(@billing_view_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "billingViewArn") unless @billing_view_arn.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#additional_artifacts ⇒ Array<String>? (readonly)

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

Returns:

  • (Array<String>, nil)

See Also:



106
107
108
 
# File 'cur/cfn_report_definition_props.rb', line 106

def additional_artifacts
  @additional_artifacts
end

#additional_schema_elements ⇒ Array<String>? (readonly)

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

Returns:

  • (Array<String>, nil)

See Also:



111
112
113
 
# File 'cur/cfn_report_definition_props.rb', line 111

def additional_schema_elements
  @additional_schema_elements
end

#billing_view_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the billing view.

You can get this value by using the billing view service public APIs.

Returns:

  • (String, nil)

See Also:



118
119
120
 
# File 'cur/cfn_report_definition_props.rb', line 118

def billing_view_arn
  @billing_view_arn
end

#compression ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



55
56
57
 
# File 'cur/cfn_report_definition_props.rb', line 55

def compression
  @compression
end

#format ⇒ String (readonly)

The format that Amazon Web Services saves the report in.

Returns:

  • (String)

See Also:



60
61
62
 
# File 'cur/cfn_report_definition_props.rb', line 60

def format
  @format
end

#refresh_closed_reports ⇒ Boolean, AWSCDK::IResolvable (readonly)

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.

Returns:

See Also:



67
68
69
 
# File 'cur/cfn_report_definition_props.rb', line 67

def refresh_closed_reports
  @refresh_closed_reports
end

#report_name ⇒ String (readonly)

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)

See Also:



74
75
76
 
# File 'cur/cfn_report_definition_props.rb', line 74

def report_name
  @report_name
end

#report_versioning ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



79
80
81
 
# File 'cur/cfn_report_definition_props.rb', line 79

def report_versioning
  @report_versioning
end

#s3_bucket ⇒ String, AWSCDK::Interfaces::AWSS3::IBucketRef (readonly)

The S3 bucket where Amazon Web Services delivers the report.

Returns:

See Also:



84
85
86
 
# File 'cur/cfn_report_definition_props.rb', line 84

def s3_bucket
  @s3_bucket
end

#s3_prefix ⇒ String (readonly)

The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report.

Your prefix can't include spaces.

Returns:

  • (String)

See Also:



91
92
93
 
# File 'cur/cfn_report_definition_props.rb', line 91

def s3_prefix
  @s3_prefix
end

#s3_region ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



96
97
98
 
# File 'cur/cfn_report_definition_props.rb', line 96

def s3_region
  @s3_region
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

The tags to be assigned to the report definition resource.

Returns:

See Also:



123
124
125
 
# File 'cur/cfn_report_definition_props.rb', line 123

def tags
  @tags
end

#time_unit ⇒ String (readonly)

The granularity of the line items in the report.

Returns:

  • (String)

See Also:



101
102
103
 
# File 'cur/cfn_report_definition_props.rb', line 101

def time_unit
  @time_unit
end

Class Method Details

.jsii_properties ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'cur/cfn_report_definition_props.rb', line 125

def self.jsii_properties
  {
    :compression => "compression",
    :format => "format",
    :refresh_closed_reports => "refreshClosedReports",
    :report_name => "reportName",
    :report_versioning => "reportVersioning",
    :s3_bucket => "s3Bucket",
    :s3_prefix => "s3Prefix",
    :s3_region => "s3Region",
    :time_unit => "timeUnit",
    :additional_artifacts => "additionalArtifacts",
    :additional_schema_elements => "additionalSchemaElements",
    :billing_view_arn => "billingViewArn",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'cur/cfn_report_definition_props.rb', line 143

def to_jsii
  result = {}
  result.merge!({
    "compression" => @compression,
    "format" => @format,
    "refreshClosedReports" => @refresh_closed_reports,
    "reportName" => @report_name,
    "reportVersioning" => @report_versioning,
    "s3Bucket" => @s3_bucket,
    "s3Prefix" => @s3_prefix,
    "s3Region" => @s3_region,
    "timeUnit" => @time_unit,
    "additionalArtifacts" => @additional_artifacts,
    "additionalSchemaElements" => @additional_schema_elements,
    "billingViewArn" => @billing_view_arn,
    "tags" => @tags,
  })
  result.compact
end