software.amazon.awscdk.services.backup

Class CfnReportPlan

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.backup.CfnReportPlan

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:36.864Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

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

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
	CfnReportPlan(software.constructs.Construct scope, String id, CfnReportPlanProps props) Create a new `AWS::Backup::ReportPlan`.
protected	CfnReportPlan(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnReportPlan(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrReportPlanArn() The Amazon Resource Name (ARN) of your report plan.
protected Map<String,Object>	getCfnProperties()
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.
String	getReportPlanDescription() An optional description of the report plan with a maximum 1,024 characters.
String	getReportPlanName() The unique name of the report plan.
Object	getReportPlanTags() A list of tags to tag your report plan.
Object	getReportSetting() Identifies the report template for the report.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setReportDeliveryChannel(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.
void	setReportPlanDescription(String value) An optional description of the report plan with a maximum 1,024 characters.
void	setReportPlanName(String value) The unique name of the report plan.
void	setReportPlanTags(IResolvable value) A list of tags to tag your report plan.
void	setReportPlanTags(List<Object> value) A list of tags to tag your report plan.
void	setReportSetting(Object value) Identifies the report template for 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

CfnReportPlan

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

CfnReportPlan

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

CfnReportPlan

@Stability(value=Stable)
public CfnReportPlan(@NotNull
                                              software.constructs.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 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.

getAttrReportPlanArn

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

The Amazon Resource Name (ARN) of your report plan.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getReportDeliveryChannel

@Stability(value=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(value=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(value=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(value=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(value=Stable)
 @Nullable
public String getReportPlanDescription()

An optional description of the report plan with a maximum 1,024 characters.

setReportPlanDescription

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

An optional description of the report plan with a maximum 1,024 characters.

getReportPlanName

@Stability(value=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(value=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(value=Stable)
 @Nullable
public Object getReportPlanTags()

A list of tags to tag your report plan.

setReportPlanTags

@Stability(value=Stable)
public void setReportPlanTags(@Nullable
                                                       IResolvable value)

A list of tags to tag your report plan.

setReportPlanTags

@Stability(value=Stable)
public void setReportPlanTags(@Nullable
                                                       List<Object> value)

A list of tags to tag your report plan.