Interface ICfnReportPlanProps

Properties for defining a CfnReportPlan.

Namespace: Amazon.CDK.AWS.Backup

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnReportPlanProps

Syntax (vb)

Public Interface ICfnReportPlanProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html

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 cfnReportPlanProps = new CfnReportPlanProps {
                 ReportDeliveryChannel = reportDeliveryChannel,
                 ReportSetting = reportSetting,

                 // the properties below are optional
                 ReportPlanDescription = "reportPlanDescription",
                 ReportPlanName = "reportPlanName",
                 ReportPlanTags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Properties

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	The tags to assign to your report plan.
ReportSetting	Identifies the report template for the report. Reports are built using a report template. The report templates are:.

Properties

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.

object ReportDeliveryChannel { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportdeliverychannel

ReportPlanDescription

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

string? ReportPlanDescription { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportplandescription

ReportPlanName

The unique name of the report plan.

string? ReportPlanName { get; }

Property Value

string

Remarks

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 (_).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportplanname

ReportPlanTags

The tags to assign to your report plan.

ICfnTag[]? ReportPlanTags { get; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportplantags

ReportSetting

Identifies the report template for the report. Reports are built using a report template. The report templates are:.

object ReportSetting { get; }

Property Value

object

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportsetting