Class CfnReportDefinition
The definition of AWS Cost and Usage Report.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.CUR
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnReportDefinition : CfnResource, IInspectable
Syntax (vb)
Public Class CfnReportDefinition
Inherits CfnResource
Implements IInspectable
Remarks
You can specify the report name, time unit, report format, compression format, S3 bucket, additional artifacts, and schema elements in the definition.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cur-reportdefinition.html
CloudformationResource: AWS::CUR::ReportDefinition
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CUR;
var cfnReportDefinition = new CfnReportDefinition(this, "MyCfnReportDefinition", new CfnReportDefinitionProps {
Compression = "compression",
Format = "format",
RefreshClosedReports = false,
ReportName = "reportName",
ReportVersioning = "reportVersioning",
S3Bucket = "s3Bucket",
S3Prefix = "s3Prefix",
S3Region = "s3Region",
TimeUnit = "timeUnit",
// the properties below are optional
AdditionalArtifacts = new [] { "additionalArtifacts" },
AdditionalSchemaElements = new [] { "additionalSchemaElements" },
BillingViewArn = "billingViewArn"
});
Synopsis
Constructors
CfnReportDefinition(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnReportDefinition(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnReportDefinition(Construct, String, ICfnReportDefinitionProps) |
Properties
AdditionalArtifacts | A list of manifests that you want AWS to create for this report. |
AdditionalSchemaElements | A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs. |
BillingViewArn | The Amazon Resource Name (ARN) of the billing view. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Compression | The compression format that Amazon Web Services uses for the report. |
Format | The format that Amazon Web Services saves the report in. |
RefreshClosedReports | Whether you want AWS to update your reports after they have been finalized if AWS detects charges related to previous months. |
ReportName | The name of the report that you want to create. |
ReportVersioning | Whether you want AWS to overwrite the previous version of each report or to deliver the report in addition to the previous versions. |
S3Bucket | The S3 bucket where Amazon Web Services delivers the report. |
S3Prefix | The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report. |
S3Region | The Region of the S3 bucket that Amazon Web Services delivers the report into. |
TimeUnit | The granularity of the line items in the report. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnReportDefinition(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnReportDefinition(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnReportDefinition(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnReportDefinition(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnReportDefinition(Construct, String, ICfnReportDefinitionProps)
public CfnReportDefinition(Construct scope, string id, ICfnReportDefinitionProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnReportDefinitionProps
Resource properties.
Properties
AdditionalArtifacts
A list of manifests that you want AWS to create for this report.
public virtual string[] AdditionalArtifacts { get; set; }
Property Value
System.String[]
AdditionalSchemaElements
A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs.
public virtual string[] AdditionalSchemaElements { get; set; }
Property Value
System.String[]
BillingViewArn
The Amazon Resource Name (ARN) of the billing view.
public virtual string BillingViewArn { get; set; }
Property Value
System.String
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Compression
The compression format that Amazon Web Services uses for the report.
public virtual string Compression { get; set; }
Property Value
System.String
Format
The format that Amazon Web Services saves the report in.
public virtual string Format { get; set; }
Property Value
System.String
RefreshClosedReports
Whether you want AWS to update your reports after they have been finalized if AWS detects charges related to previous months.
public virtual object RefreshClosedReports { get; set; }
Property Value
System.Object
ReportName
The name of the report that you want to create.
public virtual string ReportName { get; set; }
Property Value
System.String
ReportVersioning
Whether you want AWS to overwrite the previous version of each report or to deliver the report in addition to the previous versions.
public virtual string ReportVersioning { get; set; }
Property Value
System.String
S3Bucket
The S3 bucket where Amazon Web Services delivers the report.
public virtual string S3Bucket { get; set; }
Property Value
System.String
S3Prefix
The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report.
public virtual string S3Prefix { get; set; }
Property Value
System.String
S3Region
The Region of the S3 bucket that Amazon Web Services delivers the report into.
public virtual string S3Region { get; set; }
Property Value
System.String
TimeUnit
The granularity of the line items in the report.
public virtual string TimeUnit { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>