Show / Hide Table of Contents

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

}
Inheritance
System.Object
Resource
CustomResource
ReportDefinition
Inherited Members
CustomResource.Id
Resource.GetResourceType()
Resource.GetResourceName()
Resource.Urn
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Aws.Cur
Assembly: Pulumi.Aws.dll
Syntax
public class ReportDefinition : CustomResource

Constructors

View Source

ReportDefinition(String, ReportDefinitionArgs, CustomResourceOptions)

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

Declaration
public ReportDefinition(string name, ReportDefinitionArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource

ReportDefinitionArgs args

The arguments used to populate this resource's properties

CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

AdditionalArtifacts

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

Declaration
public Output<ImmutableArray<string>> AdditionalArtifacts { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

AdditionalSchemaElements

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

Declaration
public Output<ImmutableArray<string>> AdditionalSchemaElements { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

Compression

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

Declaration
public Output<string> Compression { get; }
Property Value
Type Description
Output<System.String>
View Source

Format

Format for report. Valid values are: textORcsv.

Declaration
public Output<string> Format { get; }
Property Value
Type Description
Output<System.String>
View Source

ReportName

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

Declaration
public Output<string> ReportName { get; }
Property Value
Type Description
Output<System.String>
View Source

S3Bucket

Name of the existing S3 bucket to hold generated reports.

Declaration
public Output<string> S3Bucket { get; }
Property Value
Type Description
Output<System.String>
View Source

S3Prefix

Report path prefix. Limited to 256 characters.

Declaration
public Output<string> S3Prefix { get; }
Property Value
Type Description
Output<System.String>
View Source

S3Region

Region of the existing S3 bucket to hold generated reports.

Declaration
public Output<string> S3Region { get; }
Property Value
Type Description
Output<System.String>
View Source

TimeUnit

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

Declaration
public Output<string> TimeUnit { get; }
Property Value
Type Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, ReportDefinitionState, CustomResourceOptions)

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

Declaration
public static ReportDefinition Get(string name, Input<string> id, ReportDefinitionState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.

Input<System.String> id

The unique provider ID of the resource to lookup.

ReportDefinitionState state

Any extra arguments used during the lookup.

CustomResourceOptions options

A bag of options that control this resource's behavior

Returns
Type Description
ReportDefinition
  • View Source
Back to top Copyright 2016-2020, Pulumi Corporation.