aws-cdk-lib/aws-cur/lib/cur.generated.d.ts

Version 2 of the AWS Cloud Development Kit library

import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { aws_s3 as s3Refs } from "../../interfaces";
import { IReportDefinitionRef, ReportDefinitionReference } from "../../interfaces/generated/aws-cur-interfaces.generated";
/**
 * The definition of AWS Cost and Usage Report.
 *
 * You can specify the report name, time unit, report format, compression format, S3 bucket, additional artifacts, and schema elements in the definition.
 *
 * @cloudformationResource AWS::CUR::ReportDefinition
 * @stability external
 * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html
 */
export declare class CfnReportDefinition extends cdk.CfnResource implements cdk.IInspectable, IReportDefinitionRef, cdk.ITaggableV2 {
    /**
     * The CloudFormation resource type name for this resource class.
     */
    static readonly CFN_RESOURCE_TYPE_NAME: string;
    /**
     * Build a CfnReportDefinition from CloudFormation properties
     *
     * A factory method that creates a new instance of this class from an object
     * containing the CloudFormation properties of this resource.
     * Used in the @aws-cdk/cloudformation-include module.
     *
     * @internal
     */
    static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnReportDefinition;
    /**
     * Checks whether the given object is a CfnReportDefinition
     */
    static isCfnReportDefinition(x: any): x is CfnReportDefinition;
    /**
     * Creates a new IReportDefinitionRef from a reportName
     */
    static fromReportName(scope: constructs.Construct, id: string, reportName: string): IReportDefinitionRef;
    static arnForReportDefinition(resource: IReportDefinitionRef): string;
    /**
     * A list of manifests that you want AWS to create for this report.
     */
    private _additionalArtifacts?;
    /**
     * A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs.
     */
    private _additionalSchemaElements?;
    /**
     * The Amazon Resource Name (ARN) of the billing view.
     */
    private _billingViewArn?;
    /**
     * Tag Manager which manages the tags for this resource
     */
    readonly cdkTagManager: cdk.TagManager;
    /**
     * The compression format that Amazon Web Services uses for the report.
     */
    private _compression;
    /**
     * The format that Amazon Web Services saves the report in.
     */
    private _format;
    /**
     * Whether you want AWS to update your reports after they have been finalized if AWS detects charges related to previous months.
     */
    private _refreshClosedReports;
    /**
     * The name of the report that you want to create.
     */
    private _reportName;
    /**
     * Whether you want AWS to overwrite the previous version of each report or to deliver the report in addition to the previous versions.
     */
    private _reportVersioning;
    /**
     * The S3 bucket where Amazon Web Services delivers the report.
     */
    private _s3Bucket;
    /**
     * The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report.
     */
    private _s3Prefix;
    /**
     * The Region of the S3 bucket that Amazon Web Services delivers the report into.
     */
    private _s3Region;
    /**
     * The tags to be assigned to the report definition resource.
     */
    private _tags?;
    /**
     * The granularity of the line items in the report.
     */
    private _timeUnit;
    /**
     * Create a new `AWS::CUR::ReportDefinition`.
     *
     * @param scope Scope in which this resource is defined
     * @param id Construct identifier for this resource (unique in its scope)
     * @param props Resource properties
     */
    constructor(scope: constructs.Construct, id: string, props: CfnReportDefinitionProps);
    get reportDefinitionRef(): ReportDefinitionReference;
    /**
     * A list of manifests that you want AWS to create for this report.
     */
    get additionalArtifacts(): Array<string> | undefined;
    /**
     * A list of manifests that you want AWS to create for this report.
     */
    set additionalArtifacts(value: Array<string> | undefined);
    /**
     * A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs.
     */
    get additionalSchemaElements(): Array<string> | undefined;
    /**
     * A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs.
     */
    set additionalSchemaElements(value: Array<string> | undefined);
    /**
     * The Amazon Resource Name (ARN) of the billing view.
     */
    get billingViewArn(): string | undefined;
    /**
     * The Amazon Resource Name (ARN) of the billing view.
     */
    set billingViewArn(value: string | undefined);
    /**
     * The compression format that Amazon Web Services uses for the report.
     */
    get compression(): string;
    /**
     * The compression format that Amazon Web Services uses for the report.
     */
    set compression(value: string);
    /**
     * The format that Amazon Web Services saves the report in.
     */
    get format(): string;
    /**
     * The format that Amazon Web Services saves the report in.
     */
    set format(value: string);
    /**
     * Whether you want AWS to update your reports after they have been finalized if AWS detects charges related to previous months.
     */
    get refreshClosedReports(): boolean | cdk.IResolvable;
    /**
     * Whether you want AWS to update your reports after they have been finalized if AWS detects charges related to previous months.
     */
    set refreshClosedReports(value: boolean | cdk.IResolvable);
    /**
     * The name of the report that you want to create.
     */
    get reportName(): string;
    /**
     * The name of the report that you want to create.
     */
    set reportName(value: string);
    /**
     * Whether you want AWS to overwrite the previous version of each report or to deliver the report in addition to the previous versions.
     */
    get reportVersioning(): string;
    /**
     * Whether you want AWS to overwrite the previous version of each report or to deliver the report in addition to the previous versions.
     */
    set reportVersioning(value: string);
    /**
     * The S3 bucket where Amazon Web Services delivers the report.
     */
    get s3Bucket(): string;
    /**
     * The S3 bucket where Amazon Web Services delivers the report.
     */
    set s3Bucket(value: string);
    /**
     * The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report.
     */
    get s3Prefix(): string;
    /**
     * The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report.
     */
    set s3Prefix(value: string);
    /**
     * The Region of the S3 bucket that Amazon Web Services delivers the report into.
     */
    get s3Region(): string;
    /**
     * The Region of the S3 bucket that Amazon Web Services delivers the report into.
     */
    set s3Region(value: string);
    /**
     * The tags to be assigned to the report definition resource.
     */
    get tags(): Array<cdk.CfnTag> | undefined;
    /**
     * The tags to be assigned to the report definition resource.
     */
    set tags(value: Array<cdk.CfnTag> | undefined);
    /**
     * The granularity of the line items in the report.
     */
    get timeUnit(): string;
    /**
     * The granularity of the line items in the report.
     */
    set timeUnit(value: string);
    protected get cfnProperties(): Record<string, any>;
    /**
     * Examines the CloudFormation resource and discloses attributes
     *
     * @param inspector tree inspector to collect and process attributes
     */
    inspect(inspector: cdk.TreeInspector): void;
    protected renderProperties(props: Record<string, any>): Record<string, any>;
}
/**
 * Properties for defining a `CfnReportDefinition`
 *
 * @struct
 * @stability external
 * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html
 */
export interface CfnReportDefinitionProps {
    /**
     * A list of manifests that you want AWS to create for this report.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-additionalartifacts
     */
    readonly additionalArtifacts?: Array<string>;
    /**
     * A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-additionalschemaelements
     */
    readonly additionalSchemaElements?: Array<string>;
    /**
     * The Amazon Resource Name (ARN) of the billing view.
     *
     * You can get this value by using the billing view service public APIs.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-billingviewarn
     */
    readonly billingViewArn?: string;
    /**
     * The compression format that Amazon Web Services uses for the report.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-compression
     */
    readonly compression: string;
    /**
     * The format that Amazon Web Services saves the report in.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-format
     */
    readonly format: string;
    /**
     * 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.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-refreshclosedreports
     */
    readonly refreshClosedReports: boolean | cdk.IResolvable;
    /**
     * The name of the report that you want to create.
     *
     * The name must be unique, is case sensitive, and can't include spaces.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-reportname
     */
    readonly reportName: string;
    /**
     * Whether you want AWS to overwrite the previous version of each report or to deliver the report in addition to the previous versions.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-reportversioning
     */
    readonly reportVersioning: string;
    /**
     * The S3 bucket where Amazon Web Services delivers the report.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-s3bucket
     */
    readonly s3Bucket: s3Refs.IBucketRef | string;
    /**
     * The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report.
     *
     * Your prefix can't include spaces.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-s3prefix
     */
    readonly s3Prefix: string;
    /**
     * The Region of the S3 bucket that Amazon Web Services delivers the report into.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-s3region
     */
    readonly s3Region: string;
    /**
     * The tags to be assigned to the report definition resource.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-tags
     */
    readonly tags?: Array<cdk.CfnTag>;
    /**
     * The granularity of the line items in the report.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html#cfn-cur-reportdefinition-timeunit
     */
    readonly timeUnit: string;
}
export type { IReportDefinitionRef, ReportDefinitionReference };