Module cur

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

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.

Resources

Resource ReportDefinition

class ReportDefinition extends CustomResource

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

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",
});

constructor

new ReportDefinition(name: string, args: ReportDefinitionArgs, opts?: pulumi.CustomResourceOptions)

Create a ReportDefinition resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ReportDefinitionState, opts?: pulumi.CustomResourceOptions): ReportDefinition

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ReportDefinition

Returns true if the given object is an instance of ReportDefinition. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property additionalArtifacts

public additionalArtifacts: pulumi.Output<string[] | undefined>;

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

property additionalSchemaElements

public additionalSchemaElements: pulumi.Output<string[]>;

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

property compression

public compression: pulumi.Output<string>;

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

property format

public format: pulumi.Output<string>;

Format for report. Valid values are: textORcsv.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property reportName

public reportName: pulumi.Output<string>;

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

property s3Bucket

public s3Bucket: pulumi.Output<string>;

Name of the existing S3 bucket to hold generated reports.

property s3Prefix

public s3Prefix: pulumi.Output<string | undefined>;

Report path prefix. Limited to 256 characters.

property s3Region

public s3Region: pulumi.Output<string>;

Region of the existing S3 bucket to hold generated reports.

property timeUnit

public timeUnit: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getReportDefinition

getReportDefinition(args: GetReportDefinitionArgs, opts?: pulumi.InvokeOptions): Promise<GetReportDefinitionResult>

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.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const reportDefinition = pulumi.output(aws.cur.getReportDefinition({
    reportName: "example",
}, { async: true }));

Others

interface GetReportDefinitionArgs

interface GetReportDefinitionArgs

A collection of arguments for invoking getReportDefinition.

property reportName

reportName: string;

The name of the report definition to match.

interface GetReportDefinitionResult

interface GetReportDefinitionResult

A collection of values returned by getReportDefinition.

property additionalArtifacts

additionalArtifacts: string[];

A list of additional artifacts.

property additionalSchemaElements

additionalSchemaElements: string[];

A list of schema elements.

property compression

compression: string;

Preferred format for report.

property format

format: string;

Preferred compression format for report.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property reportName

reportName: string;

property s3Bucket

s3Bucket: string;

Name of customer S3 bucket.

property s3Prefix

s3Prefix: string;

Preferred report path prefix.

property s3Region

s3Region: string;

Region of customer S3 bucket.

property timeUnit

timeUnit: string;

The frequency on which report data are measured and displayed.

interface ReportDefinitionArgs

interface ReportDefinitionArgs

The set of arguments for constructing a ReportDefinition resource.

property additionalArtifacts

additionalArtifacts?: pulumi.Input<pulumi.Input<string>[]>;

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

property additionalSchemaElements

additionalSchemaElements: pulumi.Input<pulumi.Input<string>[]>;

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

property compression

compression: pulumi.Input<string>;

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

property format

format: pulumi.Input<string>;

Format for report. Valid values are: textORcsv.

property reportName

reportName: pulumi.Input<string>;

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

property s3Bucket

s3Bucket: pulumi.Input<string>;

Name of the existing S3 bucket to hold generated reports.

property s3Prefix

s3Prefix?: pulumi.Input<string>;

Report path prefix. Limited to 256 characters.

property s3Region

s3Region: pulumi.Input<string>;

Region of the existing S3 bucket to hold generated reports.

property timeUnit

timeUnit: pulumi.Input<string>;

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

interface ReportDefinitionState

interface ReportDefinitionState

Input properties used for looking up and filtering ReportDefinition resources.

property additionalArtifacts

additionalArtifacts?: pulumi.Input<pulumi.Input<string>[]>;

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

property additionalSchemaElements

additionalSchemaElements?: pulumi.Input<pulumi.Input<string>[]>;

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

property compression

compression?: pulumi.Input<string>;

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

property format

format?: pulumi.Input<string>;

Format for report. Valid values are: textORcsv.

property reportName

reportName?: pulumi.Input<string>;

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

property s3Bucket

s3Bucket?: pulumi.Input<string>;

Name of the existing S3 bucket to hold generated reports.

property s3Prefix

s3Prefix?: pulumi.Input<string>;

Report path prefix. Limited to 256 characters.

property s3Region

s3Region?: pulumi.Input<string>;

Region of the existing S3 bucket to hold generated reports.

property timeUnit

timeUnit?: pulumi.Input<string>;

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module cur

Resources

Functions

Others

Resources

Example Usage

Functions

Example Usage

Others