Package software.amazon.awscdk.services.cur

Class CfnReportDefinition

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.cur.CfnReportDefinition
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.039Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnReportDefinition

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

    • CfnReportDefinition

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

    • CfnReportDefinition

      @Stability(Stable) public CfnReportDefinition(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCompression

      @Stability(Stable) @NotNull public String getCompression()
      The compression format that Amazon Web Services uses for the report.

    • setCompression

      @Stability(Stable) public void setCompression(@NotNull String value)
      The compression format that Amazon Web Services uses for the report.

    • getFormat

      @Stability(Stable) @NotNull public String getFormat()
      The format that Amazon Web Services saves the report in.

    • setFormat

      @Stability(Stable) public void setFormat(@NotNull String value)
      The format that Amazon Web Services saves the report in.

    • getRefreshClosedReports

      @Stability(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(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(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(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(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(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(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(Stable) @NotNull public String getS3Bucket()
      The S3 bucket where Amazon Web Services delivers the report.

    • setS3Bucket

      @Stability(Stable) public void setS3Bucket(@NotNull String value)
      The S3 bucket where Amazon Web Services delivers the report.

    • getS3Prefix

      @Stability(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(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(Stable) @NotNull public String getS3Region()
      The Region of the S3 bucket that Amazon Web Services delivers the report into.

    • setS3Region

      @Stability(Stable) public void setS3Region(@NotNull String value)
      The Region of the S3 bucket that Amazon Web Services delivers the report into.

    • getTimeUnit

      @Stability(Stable) @NotNull public String getTimeUnit()
      The granularity of the line items in the report.

    • setTimeUnit

      @Stability(Stable) public void setTimeUnit(@NotNull String value)
      The granularity of the line items in the report.

    • getAdditionalArtifacts

      @Stability(Stable) @Nullable public List<String> getAdditionalArtifacts()
      A list of manifests that you want AWS to create for this report.

    • setAdditionalArtifacts

      @Stability(Stable) public void setAdditionalArtifacts(@Nullable List<String> value)
      A list of manifests that you want AWS to create for this report.

    • getAdditionalSchemaElements

      @Stability(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(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(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(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.