Class CfnReportPlan
Creates a report plan.
Inherited Members
Namespace: Amazon.CDK.AWS.Backup
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnReportPlan : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnReportPlan
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
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 .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html
CloudformationResource: AWS::Backup::ReportPlan
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Backup;
var reportDeliveryChannel;
var reportSetting;
var cfnReportPlan = new CfnReportPlan(this, "MyCfnReportPlan", new CfnReportPlanProps {
ReportDeliveryChannel = reportDeliveryChannel,
ReportSetting = reportSetting,
// the properties below are optional
ReportPlanDescription = "reportPlanDescription",
ReportPlanName = "reportPlanName",
ReportPlanTags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnReportPlan(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnReportPlan(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnReportPlan(Construct, String, ICfnReportPlanProps) |
Properties
AttrReportPlanArn | The Amazon Resource Name (ARN) of your report plan. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ReportDeliveryChannel | 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. |
ReportPlanDescription | An optional description of the report plan with a maximum 1,024 characters. |
ReportPlanName | The unique name of the report plan. |
ReportPlanTags | A list of tags to tag your report plan. |
ReportSetting | Identifies the report template for the report. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnReportPlan(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnReportPlan(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnReportPlan(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnReportPlan(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnReportPlan(Construct, String, ICfnReportPlanProps)
public CfnReportPlan(Construct scope, string id, ICfnReportPlanProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnReportPlanProps
Resource properties.
Properties
AttrReportPlanArn
The Amazon Resource Name (ARN) of your report plan.
public virtual string AttrReportPlanArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ReportPlanArn
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ReportDeliveryChannel
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.
public virtual object ReportDeliveryChannel { get; set; }
Property Value
System.Object
ReportPlanDescription
An optional description of the report plan with a maximum 1,024 characters.
public virtual string ReportPlanDescription { get; set; }
Property Value
System.String
ReportPlanName
The unique name of the report plan.
public virtual string ReportPlanName { get; set; }
Property Value
System.String
ReportPlanTags
A list of tags to tag your report plan.
public virtual ICfnTag[] ReportPlanTags { get; set; }
Property Value
ICfnTag[]
ReportSetting
Identifies the report template for the report.
public virtual object ReportSetting { get; set; }
Property Value
System.Object
Remarks
Reports are built using a report template. The report templates are:.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>