CfnReportPlanPropsMixin

class aws_cdk.mixins_preview.aws_backup.mixins.CfnReportPlanPropsMixin(props, *, strategy=None)

Bases: Mixin

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 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
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_backup import mixins as backup_mixins

# report_delivery_channel: Any
# report_setting: Any

cfn_report_plan_props_mixin = backup_mixins.CfnReportPlanPropsMixin(backup_mixins.CfnReportPlanMixinProps(
    report_delivery_channel=report_delivery_channel,
    report_plan_description="reportPlanDescription",
    report_plan_name="reportPlanName",
    report_plan_tags=[CfnTag(
        key="key",
        value="value"
    )],
    report_setting=report_setting
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Backup::ReportPlan.

Parameters:

props (Union[CfnReportPlanMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['reportDeliveryChannel', 'reportPlanDescription', 'reportPlanName', 'reportPlanTags', 'reportSetting']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ReportDeliveryChannelProperty

class CfnReportPlanPropsMixin.ReportDeliveryChannelProperty(*, formats=None, s3_bucket_name=None, s3_key_prefix=None)

Bases: object

Contains information from your report plan about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

Parameters:

formats (Optional[Sequence[str]]) – The format of your reports: CSV , JSON , or both. If not specified, the default format is CSV .
s3_bucket_name (Optional[str]) – The unique name of the S3 bucket that receives your reports.
s3_key_prefix (Optional[str]) – The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/ prefix /Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportdeliverychannel.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_backup import mixins as backup_mixins

report_delivery_channel_property = backup_mixins.CfnReportPlanPropsMixin.ReportDeliveryChannelProperty(
    formats=["formats"],
    s3_bucket_name="s3BucketName",
    s3_key_prefix="s3KeyPrefix"
)

Attributes

formats

CSV , JSON , or both.

If not specified, the default format is CSV .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportdeliverychannel.html#cfn-backup-reportplan-reportdeliverychannel-formats
Type:: The format of your reports

s3_bucket_name

The unique name of the S3 bucket that receives your reports.

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

s3_key_prefix

The prefix for where AWS Backup Audit Manager delivers your reports to Amazon S3.

The prefix is this part of the following path: s3://your-bucket-name/ prefix /Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.

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

ReportSettingProperty

class CfnReportPlanPropsMixin.ReportSettingProperty(*, accounts=None, framework_arns=None, organization_units=None, regions=None, report_template=None)

Bases: object

Contains detailed information about a report setting.

Parameters:

accounts (Optional[Sequence[str]]) – These are the accounts to be included in the report. Use string value of ROOT to include all organizational units.
framework_arns (Optional[Sequence[str]]) – The Amazon Resource Names (ARNs) of the frameworks a report covers.
organization_units (Optional[Sequence[str]]) – These are the Organizational Units to be included in the report.
regions (Optional[Sequence[str]]) – These are the Regions to be included in the report. Use the wildcard as the string value to include all Regions.
report_template (Optional[str]) – 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 | SCAN_JOB_REPORT

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-reportplan-reportsetting.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_backup import mixins as backup_mixins

report_setting_property = backup_mixins.CfnReportPlanPropsMixin.ReportSettingProperty(
    accounts=["accounts"],
    framework_arns=["frameworkArns"],
    organization_units=["organizationUnits"],
    regions=["regions"],
    report_template="reportTemplate"
)