CfnReportDefinitionProps

class aws_cdk.aws_cur.CfnReportDefinitionProps(*, compression, format, refresh_closed_reports, report_name, report_versioning, s3_bucket, s3_prefix, s3_region, time_unit, additional_artifacts=None, additional_schema_elements=None, billing_view_arn=None)

Bases: object

Properties for defining a CfnReportDefinition.

Parameters
  • compression (str) – The compression format that Amazon Web Services uses for the report.

  • format (str) – The format that Amazon Web Services saves the report in.

  • refresh_closed_reports (Union[bool, IResolvable]) – 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.

  • report_name (str) – The name of the report that you want to create. The name must be unique, is case sensitive, and can’t include spaces.

  • report_versioning (str) – 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 (str) – The S3 bucket where Amazon Web Services delivers the report.

  • s3_prefix (str) – The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report. Your prefix can’t include spaces.

  • s3_region (str) – The Region of the S3 bucket that Amazon Web Services delivers the report into.

  • time_unit (str) – The granularity of the line items in the report.

  • additional_artifacts (Optional[Sequence[str]]) – A list of manifests that you want AWS to create for this report.

  • additional_schema_elements (Optional[Sequence[str]]) – A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs.

  • billing_view_arn (Optional[str]) – The Amazon Resource Name (ARN) of the billing view. You can get this value by using the billing view service public APIs.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_cur as cur

cfn_report_definition_props = cur.CfnReportDefinitionProps(
    compression="compression",
    format="format",
    refresh_closed_reports=False,
    report_name="reportName",
    report_versioning="reportVersioning",
    s3_bucket="s3Bucket",
    s3_prefix="s3Prefix",
    s3_region="s3Region",
    time_unit="timeUnit",

    # the properties below are optional
    additional_artifacts=["additionalArtifacts"],
    additional_schema_elements=["additionalSchemaElements"],
    billing_view_arn="billingViewArn"
)

Attributes

additional_artifacts

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-additionalartifacts

Return type

Optional[List[str]]

additional_schema_elements

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-additionalschemaelements

Return type

Optional[List[str]]

billing_view_arn

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

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-billingviewarn

Return type

Optional[str]

compression

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-compression

Return type

str

format

The format that Amazon Web Services saves the report in.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-format

Return type

str

refresh_closed_reports

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-refreshclosedreports

Return type

Union[bool, IResolvable]

report_name

The name of the report that you want to create.

The name must be unique, is case sensitive, and can’t include spaces.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-reportname

Return type

str

report_versioning

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-reportversioning

Return type

str

s3_bucket

The S3 bucket where Amazon Web Services delivers the report.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-s3bucket

Return type

str

s3_prefix

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

Your prefix can’t include spaces.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-s3prefix

Return type

str

s3_region

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-s3region

Return type

str

time_unit

The granularity of the line items in the report.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-timeunit

Return type

str