class CfnReportDefinition (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.CUR.CfnReportDefinition`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscur#CfnReportDefinition`
Java	`software.amazon.awscdk.services.cur.CfnReportDefinition`
Python	`aws_cdk.aws_cur.CfnReportDefinition`
TypeScript	`aws-cdk-lib` » `aws_cur` » `CfnReportDefinition`

Implements IConstruct, IDependable, IInspectable

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cur as cur } from 'aws-cdk-lib';
const cfnReportDefinition = new cur.CfnReportDefinition(this, 'MyCfnReportDefinition', {
  compression: 'compression',
  format: 'format',
  refreshClosedReports: false,
  reportName: 'reportName',
  reportVersioning: 'reportVersioning',
  s3Bucket: 's3Bucket',
  s3Prefix: 's3Prefix',
  s3Region: 's3Region',
  timeUnit: 'timeUnit',

  // the properties below are optional
  additionalArtifacts: ['additionalArtifacts'],
  additionalSchemaElements: ['additionalSchemaElements'],
  billingViewArn: 'billingViewArn',
});

Initializer

new CfnReportDefinition(scope: Construct, id: string, props: CfnReportDefinitionProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnReportDefinitionProps — Resource properties.

Construct Props

Name	Type	Description
compression	`string`	The compression format that Amazon Web Services uses for the report.
format	`string`	The format that Amazon Web Services saves the report in.
refreshClosedReports	`boolean \|` `IResolvable`	Whether you want AWS to update your reports after they have been finalized if AWS detects charges related to previous months.
reportName	`string`	The name of the report that you want to create.
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.
s3Bucket	`string`	The S3 bucket where Amazon Web Services delivers the report.
s3Prefix	`string`	The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report.
s3Region	`string`	The Region of the S3 bucket that Amazon Web Services delivers the report into.
timeUnit	`string`	The granularity of the line items in the report.
additionalArtifacts?	`string[]`	A list of manifests that you want AWS to create for this report.
additionalSchemaElements?	`string[]`	A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs.
billingViewArn?	`string`	The Amazon Resource Name (ARN) of the billing view.

compression

Type: string

The compression format that Amazon Web Services uses for the report.

format

Type: string

The format that Amazon Web Services saves the report in.

refreshClosedReports

Type: boolean | IResolvable

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.

reportName

Type: string

The name of the report that you want to create.

The name must be unique, is case sensitive, and can't include spaces.

reportVersioning

Type: string

Whether you want AWS to overwrite the previous version of each report or to deliver the report in addition to the previous versions.

s3Bucket

Type: string

The S3 bucket where Amazon Web Services delivers the report.

s3Prefix

Type: 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.

s3Region

Type: string

The Region of the S3 bucket that Amazon Web Services delivers the report into.

timeUnit

Type: string

The granularity of the line items in the report.

additionalArtifacts?

Type: string[] (optional)

A list of manifests that you want AWS to create for this report.

additionalSchemaElements?

Type: string[] (optional)

A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs.

billingViewArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the billing view.

You can get this value by using the billing view service public APIs.

Properties

Name	Type	Description
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
compression	`string`	The compression format that Amazon Web Services uses for the report.
creationStack	`string[]`
format	`string`	The format that Amazon Web Services saves the report in.
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
refreshClosedReports	`boolean \|` `IResolvable`	Whether you want AWS to update your reports after they have been finalized if AWS detects charges related to previous months.
reportName	`string`	The name of the report that you want to create.
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.
s3Bucket	`string`	The S3 bucket where Amazon Web Services delivers the report.
s3Prefix	`string`	The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report.
s3Region	`string`	The Region of the S3 bucket that Amazon Web Services delivers the report into.
stack	`Stack`	The stack in which this element is defined.
timeUnit	`string`	The granularity of the line items in the report.
additionalArtifacts?	`string[]`	A list of manifests that you want AWS to create for this report.
additionalSchemaElements?	`string[]`	A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs.
billingViewArn?	`string`	The Amazon Resource Name (ARN) of the billing view.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

compression

Type: string

The compression format that Amazon Web Services uses for the report.

creationStack

Type: string[]

format

Type: string

The format that Amazon Web Services saves the report in.

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

refreshClosedReports

Type: boolean | IResolvable

Whether you want AWS to update your reports after they have been finalized if AWS detects charges related to previous months.

reportName

Type: string

The name of the report that you want to create.

reportVersioning

Type: string

Whether you want AWS to overwrite the previous version of each report or to deliver the report in addition to the previous versions.

s3Bucket

Type: string

The S3 bucket where Amazon Web Services delivers the report.

s3Prefix

Type: string

The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report.

s3Region

Type: string

The Region of the S3 bucket that Amazon Web Services delivers the report into.

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

timeUnit

Type: string

The granularity of the line items in the report.

additionalArtifacts?

Type: string[] (optional)

A list of manifests that you want AWS to create for this report.

additionalSchemaElements?

Type: string[] (optional)

A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs.

billingViewArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the billing view.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }