CfnFrameworkProps

class aws_cdk.aws_backup.CfnFrameworkProps(*, framework_controls, framework_description=None, framework_name=None, framework_tags=None)

Bases: object

Properties for defining a CfnFramework.

Parameters
  • framework_controls (Union[IResolvable, Sequence[Union[FrameworkControlProperty, Dict[str, Any], IResolvable]]]) – Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.

  • framework_description (Optional[str]) – An optional description of the framework with a maximum 1,024 characters.

  • framework_name (Optional[str]) – The unique name of a framework. 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 (_).

  • framework_tags (Union[IResolvable, Sequence[Union[IResolvable, CfnTag, Dict[str, Any]]], None]) – A list of tags with which to tag your framework.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.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 import aws_backup as backup

# control_scope: Any

cfn_framework_props = backup.CfnFrameworkProps(
    framework_controls=[backup.CfnFramework.FrameworkControlProperty(
        control_name="controlName",

        # the properties below are optional
        control_input_parameters=[backup.CfnFramework.ControlInputParameterProperty(
            parameter_name="parameterName",
            parameter_value="parameterValue"
        )],
        control_scope=control_scope
    )],

    # the properties below are optional
    framework_description="frameworkDescription",
    framework_name="frameworkName",
    framework_tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

framework_controls

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

Each framework must contain at least one control.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-frameworkcontrols

framework_description

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-frameworkdescription

framework_name

The unique name of a framework.

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-frameworkname

framework_tags

A list of tags with which to tag your framework.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-frameworktags