Package software.amazon.awscdk.services.backup

Class CfnReportPlan

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.backup.CfnReportPlan
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:30:49.662Z") @Stability(Stable) public class CfnReportPlan extends CfnResource implements IInspectable
A CloudFormation AWS::Backup::ReportPlan.

Creates a report plan. A report plan is a document that contains information about the contents of the report and where AWS Backup will deliver it.

If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.

For a sample AWS CloudFormation template, see the AWS Backup Developer Guide .

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.backup.*;
 Object reportDeliveryChannel;
 Object reportSetting;
 CfnReportPlan cfnReportPlan = CfnReportPlan.Builder.create(this, "MyCfnReportPlan")
         .reportDeliveryChannel(reportDeliveryChannel)
         .reportSetting(reportSetting)
         // the properties below are optional
         .reportPlanDescription("reportPlanDescription")
         .reportPlanName("reportPlanName")
         .reportPlanTags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnReportPlan

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

    • CfnReportPlan

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

    • CfnReportPlan

      @Stability(Stable) public CfnReportPlan(@NotNull Construct scope, @NotNull String id, @NotNull CfnReportPlanProps props)
      Create a new AWS::Backup::ReportPlan.

      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.

    • getAttrReportPlanArn

      @Stability(Stable) @NotNull public String getAttrReportPlanArn()
      The Amazon Resource Name (ARN) of your report plan.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getReportDeliveryChannel

      @Stability(Stable) @NotNull public Object getReportDeliveryChannel()
      Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

    • setReportDeliveryChannel

      @Stability(Stable) public void setReportDeliveryChannel(@NotNull Object value)
      Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

    • getReportSetting

      @Stability(Stable) @NotNull public Object getReportSetting()
      Identifies the report template for the report. Reports are built using a report template. The report templates are:.

      RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

      If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT , this API resource also describes the report coverage by AWS Regions and frameworks.

    • setReportSetting

      @Stability(Stable) public void setReportSetting(@NotNull Object value)
      Identifies the report template for the report. Reports are built using a report template. The report templates are:.

      RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT

      If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT , this API resource also describes the report coverage by AWS Regions and frameworks.

    • getReportPlanDescription

      @Stability(Stable) @Nullable public String getReportPlanDescription()
      An optional description of the report plan with a maximum 1,024 characters.

    • setReportPlanDescription

      @Stability(Stable) public void setReportPlanDescription(@Nullable String value)
      An optional description of the report plan with a maximum 1,024 characters.

    • getReportPlanName

      @Stability(Stable) @Nullable public String getReportPlanName()
      The unique name of the report plan.

      This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

    • setReportPlanName

      @Stability(Stable) public void setReportPlanName(@Nullable String value)
      The unique name of the report plan.

      This name is between 1 and 256 characters starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

    • getReportPlanTags

      @Stability(Stable) @Nullable public Object getReportPlanTags()
      A list of tags to tag your report plan.

    • setReportPlanTags

      @Stability(Stable) public void setReportPlanTags(@Nullable IResolvable value)
      A list of tags to tag your report plan.

    • setReportPlanTags

      @Stability(Stable) public void setReportPlanTags(@Nullable List<Object> value)
      A list of tags to tag your report plan.