cur¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.cur.AwaitableGetReportDefinitionResult(additional_artifacts=None, additional_schema_elements=None, compression=None, format=None, id=None, report_name=None, s3_bucket=None, s3_prefix=None, s3_region=None, time_unit=None)¶

class pulumi_aws.cur.GetReportDefinitionResult(additional_artifacts=None, additional_schema_elements=None, compression=None, format=None, id=None, report_name=None, s3_bucket=None, s3_prefix=None, s3_region=None, time_unit=None)¶

A collection of values returned by getReportDefinition.

additional_artifacts = None¶

A list of additional artifacts.

additional_schema_elements = None¶

A list of schema elements.

compression = None¶

Preferred format for report.

format = None¶

Preferred compression format for report.

id = None¶

The provider-assigned unique ID for this managed resource.

s3_bucket = None¶

Name of customer S3 bucket.

s3_prefix = None¶

Preferred report path prefix.

s3_region = None¶

Region of customer S3 bucket.

time_unit = None¶

The frequency on which report data are measured and displayed.

class pulumi_aws.cur.ReportDefinition(resource_name, opts=None, additional_artifacts=None, additional_schema_elements=None, compression=None, format=None, report_name=None, s3_bucket=None, s3_prefix=None, s3_region=None, time_unit=None, __props__=None, __name__=None, __opts__=None)¶

Manages Cost and Usage Report Definitions.

NOTE: The AWS Cost and Usage Report service is only available in us-east-1 currently.

NOTE: If AWS Organizations is enabled, only the master account can use this resource.

import pulumi
import pulumi_aws as aws

example_cur_report_definition = aws.cur.ReportDefinition("exampleCurReportDefinition",
    additional_artifacts=[
        "REDSHIFT",
        "QUICKSIGHT",
    ],
    additional_schema_elements=["RESOURCES"],
    compression="GZIP",
    format="textORcsv",
    report_name="example-cur-report-definition",
    s3_bucket="example-bucket-name",
    s3_region="us-east-1",
    time_unit="HOURLY")

Parameters

• resource_name (str) – The name of the resource.

• opts (pulumi.ResourceOptions) – Options for the resource.

• additional_artifacts (pulumi.Input[list]) – A list of additional artifacts. Valid values are: REDSHIFT, QUICKSIGHT.

• additional_schema_elements (pulumi.Input[list]) – A list of schema elements. Valid values are: RESOURCES.

• compression (pulumi.Input[str]) – Compression format for report. Valid values are: GZIP, ZIP.

• format (pulumi.Input[str]) – Format for report. Valid values are: textORcsv.

• report_name (pulumi.Input[str]) – Unique name for the report. Must start with a number/letter and is case sensitive. Limited to 256 characters.

• s3_bucket (pulumi.Input[str]) – Name of the existing S3 bucket to hold generated reports.

• s3_prefix (pulumi.Input[str]) – Report path prefix. Limited to 256 characters.

• s3_region (pulumi.Input[str]) – Region of the existing S3 bucket to hold generated reports.

• time_unit (pulumi.Input[str]) – The frequency on which report data are measured and displayed. Valid values are: HOURLY, DAILY.

additional_artifacts: pulumi.Output[list] = None¶

A list of additional artifacts. Valid values are: REDSHIFT, QUICKSIGHT.

additional_schema_elements: pulumi.Output[list] = None¶

A list of schema elements. Valid values are: RESOURCES.

compression: pulumi.Output[str] = None¶

Compression format for report. Valid values are: GZIP, ZIP.

format: pulumi.Output[str] = None¶

Format for report. Valid values are: textORcsv.

report_name: pulumi.Output[str] = None¶

Unique name for the report. Must start with a number/letter and is case sensitive. Limited to 256 characters.

s3_bucket: pulumi.Output[str] = None¶

Name of the existing S3 bucket to hold generated reports.

s3_prefix: pulumi.Output[str] = None¶

Report path prefix. Limited to 256 characters.

s3_region: pulumi.Output[str] = None¶

Region of the existing S3 bucket to hold generated reports.

time_unit: pulumi.Output[str] = None¶

The frequency on which report data are measured and displayed. Valid values are: HOURLY, DAILY.

static get(resource_name, id, opts=None, additional_artifacts=None, additional_schema_elements=None, compression=None, format=None, report_name=None, s3_bucket=None, s3_prefix=None, s3_region=None, time_unit=None)¶

Get an existing ReportDefinition resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

• resource_name (str) – The unique name of the resulting resource.

• id (str) – The unique provider ID of the resource to lookup.

• opts (pulumi.ResourceOptions) – Options for the resource.

• additional_artifacts (pulumi.Input[list]) – A list of additional artifacts. Valid values are: REDSHIFT, QUICKSIGHT.

• additional_schema_elements (pulumi.Input[list]) – A list of schema elements. Valid values are: RESOURCES.

• compression (pulumi.Input[str]) – Compression format for report. Valid values are: GZIP, ZIP.

• format (pulumi.Input[str]) – Format for report. Valid values are: textORcsv.

• report_name (pulumi.Input[str]) – Unique name for the report. Must start with a number/letter and is case sensitive. Limited to 256 characters.

• s3_bucket (pulumi.Input[str]) – Name of the existing S3 bucket to hold generated reports.

• s3_prefix (pulumi.Input[str]) – Report path prefix. Limited to 256 characters.

• s3_region (pulumi.Input[str]) – Region of the existing S3 bucket to hold generated reports.

• time_unit (pulumi.Input[str]) – The frequency on which report data are measured and displayed. Valid values are: HOURLY, DAILY.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_aws.cur.get_report_definition(report_name=None, opts=None)¶

Use this data source to get information on an AWS Cost and Usage Report Definition.

NOTE: The AWS Cost and Usage Report service is only available in us-east-1 currently.

NOTE: If AWS Organizations is enabled, only the master account can use this resource.

import pulumi
import pulumi_aws as aws

report_definition = aws.cur.get_report_definition(report_name="example")

Parameters

report_name (str) – The name of the report definition to match.