1. Docs
  2. Reference
  3. API
  4. AWS
  5. cur
  6. ReportDefinition

ReportDefinition

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.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleCurReportDefinition = new Aws.Cur.ReportDefinition("exampleCurReportDefinition", new Aws.Cur.ReportDefinitionArgs
        {
            AdditionalArtifacts = 
            {
                "REDSHIFT",
                "QUICKSIGHT",
            },
            AdditionalSchemaElements = 
            {
                "RESOURCES",
            },
            Compression = "GZIP",
            Format = "textORcsv",
            ReportName = "example-cur-report-definition",
            S3Bucket = "example-bucket-name",
            S3Region = "us-east-1",
            TimeUnit = "HOURLY",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/cur"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := cur.NewReportDefinition(ctx, "exampleCurReportDefinition", &cur.ReportDefinitionArgs{
            AdditionalArtifacts: pulumi.StringArray{
                pulumi.String("REDSHIFT"),
                pulumi.String("QUICKSIGHT"),
            },
            AdditionalSchemaElements: pulumi.StringArray{
                pulumi.String("RESOURCES"),
            },
            Compression: pulumi.String("GZIP"),
            Format:      pulumi.String("textORcsv"),
            ReportName:  pulumi.String("example-cur-report-definition"),
            S3Bucket:    pulumi.String("example-bucket-name"),
            S3Region:    pulumi.String("us-east-1"),
            TimeUnit:    pulumi.String("HOURLY"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
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")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleCurReportDefinition = new aws.cur.ReportDefinition("example_cur_report_definition", {
    additionalArtifacts: [
        "REDSHIFT",
        "QUICKSIGHT",
    ],
    additionalSchemaElements: ["RESOURCES"],
    compression: "GZIP",
    format: "textORcsv",
    reportName: "example-cur-report-definition",
    s3Bucket: "example-bucket-name",
    s3Region: "us-east-1",
    timeUnit: "HOURLY",
});

Create a ReportDefinition Resource

new ReportDefinition(name: string, args: ReportDefinitionArgs, opts?: CustomResourceOptions);
def 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);
func NewReportDefinition(ctx *Context, name string, args ReportDefinitionArgs, opts ...ResourceOption) (*ReportDefinition, error)
public ReportDefinition(string name, ReportDefinitionArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ReportDefinitionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ReportDefinitionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ReportDefinitionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

ReportDefinition Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The ReportDefinition resource accepts the following input properties:

AdditionalSchemaElements List<string>

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

Compression string

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

Format string

Format for report. Valid values are: textORcsv.

ReportName string

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

S3Bucket string

Name of the existing S3 bucket to hold generated reports.

S3Region string

Region of the existing S3 bucket to hold generated reports.

TimeUnit string

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

AdditionalArtifacts List<string>

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

S3Prefix string

Report path prefix. Limited to 256 characters.

AdditionalSchemaElements []string

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

Compression string

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

Format string

Format for report. Valid values are: textORcsv.

ReportName string

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

S3Bucket string

Name of the existing S3 bucket to hold generated reports.

S3Region string

Region of the existing S3 bucket to hold generated reports.

TimeUnit string

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

AdditionalArtifacts []string

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

S3Prefix string

Report path prefix. Limited to 256 characters.

additionalSchemaElements string[]

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

compression string

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

format string

Format for report. Valid values are: textORcsv.

reportName string

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

s3Bucket string

Name of the existing S3 bucket to hold generated reports.

s3Region string

Region of the existing S3 bucket to hold generated reports.

timeUnit string

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

additionalArtifacts string[]

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

s3Prefix string

Report path prefix. Limited to 256 characters.

additional_schema_elements List[str]

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

compression str

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

format str

Format for report. Valid values are: textORcsv.

report_name str

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

s3_bucket str

Name of the existing S3 bucket to hold generated reports.

s3_region str

Region of the existing S3 bucket to hold generated reports.

time_unit str

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

additional_artifacts List[str]

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

s3_prefix str

Report path prefix. Limited to 256 characters.

Outputs

All input properties are implicitly available as output properties. Additionally, the ReportDefinition resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing ReportDefinition Resource

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

public static get(name: string, id: Input<ID>, state?: ReportDefinitionState, opts?: CustomResourceOptions): ReportDefinition
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, __props__=None);
func GetReportDefinition(ctx *Context, name string, id IDInput, state *ReportDefinitionState, opts ...ResourceOption) (*ReportDefinition, error)
public static ReportDefinition Get(string name, Input<string> id, ReportDefinitionState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

AdditionalArtifacts List<string>

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

AdditionalSchemaElements List<string>

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

Compression string

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

Format string

Format for report. Valid values are: textORcsv.

ReportName string

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

S3Bucket string

Name of the existing S3 bucket to hold generated reports.

S3Prefix string

Report path prefix. Limited to 256 characters.

S3Region string

Region of the existing S3 bucket to hold generated reports.

TimeUnit string

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

AdditionalArtifacts []string

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

AdditionalSchemaElements []string

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

Compression string

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

Format string

Format for report. Valid values are: textORcsv.

ReportName string

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

S3Bucket string

Name of the existing S3 bucket to hold generated reports.

S3Prefix string

Report path prefix. Limited to 256 characters.

S3Region string

Region of the existing S3 bucket to hold generated reports.

TimeUnit string

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

additionalArtifacts string[]

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

additionalSchemaElements string[]

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

compression string

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

format string

Format for report. Valid values are: textORcsv.

reportName string

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

s3Bucket string

Name of the existing S3 bucket to hold generated reports.

s3Prefix string

Report path prefix. Limited to 256 characters.

s3Region string

Region of the existing S3 bucket to hold generated reports.

timeUnit string

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

additional_artifacts List[str]

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

additional_schema_elements List[str]

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

compression str

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

format str

Format for report. Valid values are: textORcsv.

report_name str

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

s3_bucket str

Name of the existing S3 bucket to hold generated reports.

s3_prefix str

Report path prefix. Limited to 256 characters.

s3_region str

Region of the existing S3 bucket to hold generated reports.

time_unit str

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

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.