CfnFrameworkPropsMixin

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

Bases: Mixin

Creates a framework with one or more controls.

A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html
CloudformationResource:: AWS::Backup::Framework
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

# control_scope: Any

cfn_framework_props_mixin = backup_mixins.CfnFrameworkPropsMixin(backup_mixins.CfnFrameworkMixinProps(
    framework_controls=[backup_mixins.CfnFrameworkPropsMixin.FrameworkControlProperty(
        control_input_parameters=[backup_mixins.CfnFrameworkPropsMixin.ControlInputParameterProperty(
            parameter_name="parameterName",
            parameter_value="parameterValue"
        )],
        control_name="controlName",
        control_scope=control_scope
    )],
    framework_description="frameworkDescription",
    framework_name="frameworkName",
    framework_tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnFrameworkMixinProps, 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 = ['frameworkControls', 'frameworkDescription', 'frameworkName', 'frameworkTags']

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

ControlInputParameterProperty

class CfnFrameworkPropsMixin.ControlInputParameterProperty(*, parameter_name=None, parameter_value=None)

Bases: object

The parameters for a control.

A control can have zero, one, or more than one parameter. An example of a control with two parameters is: “backup plan frequency is at least daily and the retention period is at least 1 year “. The first parameter is daily . The second parameter is 1 year .

Parameters:

parameter_name (Optional[str]) – The name of a parameter, for example, BackupPlanFrequency .
parameter_value (Optional[str]) – The value of parameter, for example, hourly .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlinputparameter.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

control_input_parameter_property = backup_mixins.CfnFrameworkPropsMixin.ControlInputParameterProperty(
    parameter_name="parameterName",
    parameter_value="parameterValue"
)

Attributes

parameter_name

The name of a parameter, for example, BackupPlanFrequency .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlinputparameter.html#cfn-backup-framework-controlinputparameter-parametername

parameter_value

The value of parameter, for example, hourly .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlinputparameter.html#cfn-backup-framework-controlinputparameter-parametervalue

FrameworkControlProperty

class CfnFrameworkPropsMixin.FrameworkControlProperty(*, control_input_parameters=None, control_name=None, control_scope=None)

Bases: object

Contains detailed information about all of the controls of a framework.

Each framework must contain at least one control.

Parameters:

control_input_parameters (Union[IResolvable, Sequence[Union[IResolvable, ControlInputParameterProperty, Dict[str, Any]]], None]) – The name/value pairs.
control_name (Optional[str]) – The name of a control. This name is between 1 and 256 characters.
control_scope (Any) – The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans. For more information, see `ControlScope . <https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ControlScope.html>`_

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-frameworkcontrol.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

# control_scope: Any

framework_control_property = backup_mixins.CfnFrameworkPropsMixin.FrameworkControlProperty(
    control_input_parameters=[backup_mixins.CfnFrameworkPropsMixin.ControlInputParameterProperty(
        parameter_name="parameterName",
        parameter_value="parameterValue"
    )],
    control_name="controlName",
    control_scope=control_scope
)

Attributes

control_input_parameters

The name/value pairs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-frameworkcontrol.html#cfn-backup-framework-frameworkcontrol-controlinputparameters

control_name

The name of a control.

This name is between 1 and 256 characters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-frameworkcontrol.html#cfn-backup-framework-frameworkcontrol-controlname

control_scope

The scope of a control.

The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans.

For more information, see `ControlScope . <https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ControlScope.html>`_

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-frameworkcontrol.html#cfn-backup-framework-frameworkcontrol-controlscope