CfnRestoreTestingPlanPropsMixin

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

Bases: Mixin

Creates a restore testing plan.

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

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

cfn_restore_testing_plan_props_mixin = backup_mixins.CfnRestoreTestingPlanPropsMixin(backup_mixins.CfnRestoreTestingPlanMixinProps(
    recovery_point_selection=backup_mixins.CfnRestoreTestingPlanPropsMixin.RestoreTestingRecoveryPointSelectionProperty(
        algorithm="algorithm",
        exclude_vaults=["excludeVaults"],
        include_vaults=["includeVaults"],
        recovery_point_types=["recoveryPointTypes"],
        selection_window_days=123
    ),
    restore_testing_plan_name="restoreTestingPlanName",
    schedule_expression="scheduleExpression",
    schedule_expression_timezone="scheduleExpressionTimezone",
    start_window_hours=123,
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnRestoreTestingPlanMixinProps, 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 = ['recoveryPointSelection', 'restoreTestingPlanName', 'scheduleExpression', 'scheduleExpressionTimezone', 'startWindowHours', 'tags']

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

RestoreTestingRecoveryPointSelectionProperty

class CfnRestoreTestingPlanPropsMixin.RestoreTestingRecoveryPointSelectionProperty(*, algorithm=None, exclude_vaults=None, include_vaults=None, recovery_point_types=None, selection_window_days=None)

Bases: object

RecoveryPointSelection has five parameters (three required and two optional).

The values you specify determine which recovery point is included in the restore test. You must indicate with Algorithm if you want the latest recovery point within your SelectionWindowDays or if you want a random recovery point, and you must indicate through IncludeVaults from which vaults the recovery points can be chosen.

Algorithm ( required ) Valid values: “ LATEST_WITHIN_WINDOW “ or “ RANDOM_WITHIN_WINDOW “.

Recovery point types ( required ) Valid values: “ SNAPSHOT “ and/or “ CONTINUOUS “. Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm .

IncludeVaults ( required ). You must include one or more backup vaults. Use the wildcard [“*”] or specific ARNs.

SelectionWindowDays ( optional ) Value must be an integer (in days) from 1 to 365. If not included, the value defaults to 30 .

ExcludeVaults ( optional ). You can choose to input one or more specific backup vault ARNs to exclude those vaults’ contents from restore eligibility. Or, you can include a list of selectors. If this parameter and its value are not included, it defaults to empty list.

Parameters:

algorithm (Optional[str]) – Acceptable values include “LATEST_WITHIN_WINDOW” or “RANDOM_WITHIN_WINDOW”.
exclude_vaults (Optional[Sequence[str]]) – Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.
include_vaults (Optional[Sequence[str]]) – Accepted values include wildcard [“*”] or by specific ARNs or ARN wilcard replacement [“arn:aws:backup:us-west-2:123456789012:backup-vault:asdf”, …] [“arn:aws:backup:::backup-vault:asdf-*”, …].
recovery_point_types (Optional[Sequence[str]]) – These are the types of recovery points. Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm .
selection_window_days (Union[int, float, None]) – Accepted values are integers from 1 to 365.

See:

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

restore_testing_recovery_point_selection_property = backup_mixins.CfnRestoreTestingPlanPropsMixin.RestoreTestingRecoveryPointSelectionProperty(
    algorithm="algorithm",
    exclude_vaults=["excludeVaults"],
    include_vaults=["includeVaults"],
    recovery_point_types=["recoveryPointTypes"],
    selection_window_days=123
)

Attributes

algorithm

Acceptable values include “LATEST_WITHIN_WINDOW” or “RANDOM_WITHIN_WINDOW”.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingplan-restoretestingrecoverypointselection.html#cfn-backup-restoretestingplan-restoretestingrecoverypointselection-algorithm

exclude_vaults

Accepted values include specific ARNs or list of selectors.

Defaults to empty list if not listed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingplan-restoretestingrecoverypointselection.html#cfn-backup-restoretestingplan-restoretestingrecoverypointselection-excludevaults

include_vaults

backup:us-west-2:123456789012:backup-vault:asdf”, …] [“arn:aws:backup:::backup-vault:asdf-*”, …].

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingplan-restoretestingrecoverypointselection.html#cfn-backup-restoretestingplan-restoretestingrecoverypointselection-includevaults
Type:: Accepted values include wildcard [“*”] or by specific ARNs or ARN wilcard replacement [“arn
Type:: aws

recovery_point_types

These are the types of recovery points.

Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingplan-restoretestingrecoverypointselection.html#cfn-backup-restoretestingplan-restoretestingrecoverypointselection-recoverypointtypes

selection_window_days

Accepted values are integers from 1 to 365.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingplan-restoretestingrecoverypointselection.html#cfn-backup-restoretestingplan-restoretestingrecoverypointselection-selectionwindowdays