@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
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();
| Modifier and Type | Class and Description |
|---|---|
static class |
CfnReportDefinition.Builder
A fluent builder for
CfnReportDefinition. |
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| 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) |
| 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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnReportDefinition(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnReportDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnReportDefinition(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
CfnReportDefinitionProps props)
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.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public String getCompression()
@Stability(value=Stable)
public void setCompression(@NotNull
String value)
@Stability(value=Stable) @NotNull public String getFormat()
@Stability(value=Stable)
public void setFormat(@NotNull
String value)
@Stability(value=Stable) @NotNull public Object getRefreshClosedReports()
These charges can include refunds, credits, or support fees.
@Stability(value=Stable)
public void setRefreshClosedReports(@NotNull
Boolean value)
These charges can include refunds, credits, or support fees.
@Stability(value=Stable)
public void setRefreshClosedReports(@NotNull
IResolvable value)
These charges can include refunds, credits, or support fees.
@Stability(value=Stable) @NotNull public String getReportName()
The name must be unique, is case sensitive, and can't include spaces.
@Stability(value=Stable)
public void setReportName(@NotNull
String value)
The name must be unique, is case sensitive, and can't include spaces.
@Stability(value=Stable) @NotNull public String getReportVersioning()
@Stability(value=Stable)
public void setReportVersioning(@NotNull
String value)
@Stability(value=Stable) @NotNull public String getS3Bucket()
@Stability(value=Stable)
public void setS3Bucket(@NotNull
String value)
@Stability(value=Stable) @NotNull public String getS3Prefix()
Your prefix can't include spaces.
@Stability(value=Stable)
public void setS3Prefix(@NotNull
String value)
Your prefix can't include spaces.
@Stability(value=Stable) @NotNull public String getS3Region()
@Stability(value=Stable)
public void setS3Region(@NotNull
String value)
@Stability(value=Stable) @NotNull public String getTimeUnit()
@Stability(value=Stable)
public void setTimeUnit(@NotNull
String value)
@Stability(value=Stable) @Nullable public List<String> getAdditionalArtifacts()
@Stability(value=Stable)
public void setAdditionalArtifacts(@Nullable
List<String> value)
@Stability(value=Stable) @Nullable public List<String> getAdditionalSchemaElements()
@Stability(value=Stable)
public void setAdditionalSchemaElements(@Nullable
List<String> value)
@Stability(value=Stable) @Nullable public String getBillingViewArn()
You can get this value by using the billing view service public APIs.
@Stability(value=Stable)
public void setBillingViewArn(@Nullable
String value)
You can get this value by using the billing view service public APIs.
Copyright © 2022. All rights reserved.