software.amazon.awscdk.services.cur

Class CfnReportDefinition

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.cur.CfnReportDefinition

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.780Z")
 @Stability(value=Stable)
public class CfnReportDefinition
extends CfnResource
implements IInspectable

A CloudFormation `AWS::CUR::ReportDefinition`.

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 software.amazon.awscdk.services.cur.*;
 CfnReportDefinition cfnReportDefinition = CfnReportDefinition.Builder.create(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(List.of("additionalArtifacts"))
         .additionalSchemaElements(List.of("additionalSchemaElements"))
         .billingViewArn("billingViewArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnReportDefinition.Builder A fluent builder for CfnReportDefinition.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnReportDefinition(software.constructs.Construct scope, String id, CfnReportDefinitionProps props) Create a new `AWS::CUR::ReportDefinition`.
protected	CfnReportDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnReportDefinition(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
List<String>	getAdditionalArtifacts() A list of manifests that you want AWS to create for this report.
List<String>	getAdditionalSchemaElements() A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs.
String	getBillingViewArn() The Amazon Resource Name (ARN) of the billing view.
protected Map<String,Object>	getCfnProperties()
String	getCompression() The compression format that Amazon Web Services uses for the report.
String	getFormat() The format that Amazon Web Services saves the report in.
Object	getRefreshClosedReports() Whether you want AWS to update your reports after they have been finalized if AWS detects charges related to previous months.
String	getReportName() The name of the report that you want to create.
String	getReportVersioning() Whether you want AWS to overwrite the previous version of each report or to deliver the report in addition to the previous versions.
String	getS3Bucket() The S3 bucket where Amazon Web Services delivers the report.
String	getS3Prefix() The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report.
String	getS3Region() The Region of the S3 bucket that Amazon Web Services delivers the report into.
String	getTimeUnit() The granularity of the line items in the report.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdditionalArtifacts(List<String> value) A list of manifests that you want AWS to create for this report.
void	setAdditionalSchemaElements(List<String> value) A list of strings that indicate additional content that AWS includes in the report, such as individual resource IDs.
void	setBillingViewArn(String value) The Amazon Resource Name (ARN) of the billing view.
void	setCompression(String value) The compression format that Amazon Web Services uses for the report.
void	setFormat(String value) The format that Amazon Web Services saves the report in.
void	setRefreshClosedReports(Boolean value) Whether you want AWS to update your reports after they have been finalized if AWS detects charges related to previous months.
void	setRefreshClosedReports(IResolvable value) Whether you want AWS to update your reports after they have been finalized if AWS detects charges related to previous months.
void	setReportName(String value) The name of the report that you want to create.
void	setReportVersioning(String value) Whether you want AWS to overwrite the previous version of each report or to deliver the report in addition to the previous versions.
void	setS3Bucket(String value) The S3 bucket where Amazon Web Services delivers the report.
void	setS3Prefix(String value) The prefix that Amazon Web Services adds to the report name when Amazon Web Services delivers the report.
void	setS3Region(String value) The Region of the S3 bucket that Amazon Web Services delivers the report into.
void	setTimeUnit(String value) The granularity of the line items in the report.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnReportDefinition

protected CfnReportDefinition(software.amazon.jsii.JsiiObjectRef objRef)

CfnReportDefinition

protected CfnReportDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnReportDefinition

@Stability(value=Stable)
public CfnReportDefinition(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @NotNull
                                                    CfnReportDefinitionProps props)

Create a new `AWS::CUR::ReportDefinition`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCompression

@Stability(value=Stable)
 @NotNull
public String getCompression()

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

setCompression

@Stability(value=Stable)
public void setCompression(@NotNull
                                                    String value)

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

getFormat

@Stability(value=Stable)
 @NotNull
public String getFormat()

The format that Amazon Web Services saves the report in.

setFormat

@Stability(value=Stable)
public void setFormat(@NotNull
                                               String value)

The format that Amazon Web Services saves the report in.

getRefreshClosedReports

@Stability(value=Stable)
 @NotNull
public Object getRefreshClosedReports()

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.

setRefreshClosedReports

@Stability(value=Stable)
public void setRefreshClosedReports(@NotNull
                                                             Boolean value)

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.

setRefreshClosedReports

@Stability(value=Stable)
public void setRefreshClosedReports(@NotNull
                                                             IResolvable value)

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.

getReportName

@Stability(value=Stable)
 @NotNull
public String getReportName()

The name of the report that you want to create.

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

setReportName

@Stability(value=Stable)
public void setReportName(@NotNull
                                                   String value)

The name of the report that you want to create.

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

getReportVersioning

@Stability(value=Stable)
 @NotNull
public String getReportVersioning()

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

setReportVersioning

@Stability(value=Stable)
public void setReportVersioning(@NotNull
                                                         String value)

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

getS3Bucket

@Stability(value=Stable)
 @NotNull
public String getS3Bucket()

The S3 bucket where Amazon Web Services delivers the report.

setS3Bucket

@Stability(value=Stable)
public void setS3Bucket(@NotNull
                                                 String value)

The S3 bucket where Amazon Web Services delivers the report.

getS3Prefix

@Stability(value=Stable)
 @NotNull
public String getS3Prefix()

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

Your prefix can't include spaces.

setS3Prefix

@Stability(value=Stable)
public void setS3Prefix(@NotNull
                                                 String value)

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

Your prefix can't include spaces.

getS3Region

@Stability(value=Stable)
 @NotNull
public String getS3Region()

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

setS3Region

@Stability(value=Stable)
public void setS3Region(@NotNull
                                                 String value)

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

getTimeUnit

@Stability(value=Stable)
 @NotNull
public String getTimeUnit()

The granularity of the line items in the report.

setTimeUnit

@Stability(value=Stable)
public void setTimeUnit(@NotNull
                                                 String value)

The granularity of the line items in the report.

getAdditionalArtifacts

@Stability(value=Stable)
 @Nullable
public List<String> getAdditionalArtifacts()

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

setAdditionalArtifacts

@Stability(value=Stable)
public void setAdditionalArtifacts(@Nullable
                                                            List<String> value)

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

getAdditionalSchemaElements

@Stability(value=Stable)
 @Nullable
public List<String> getAdditionalSchemaElements()

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

setAdditionalSchemaElements

@Stability(value=Stable)
public void setAdditionalSchemaElements(@Nullable
                                                                 List<String> value)

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

getBillingViewArn

@Stability(value=Stable)
 @Nullable
public String getBillingViewArn()

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

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

setBillingViewArn

@Stability(value=Stable)
public void setBillingViewArn(@Nullable
                                                       String value)

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

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