CfnBackupPlan

class aws_cdk.aws_backup.CfnBackupPlan(scope, id, *, backup_plan, backup_plan_tags=None)

Bases: CfnResource

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule.

Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources.

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

See:

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

CloudformationResource:

AWS::Backup::BackupPlan

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

# backup_options: Any

cfn_backup_plan = backup.CfnBackupPlan(self, "MyCfnBackupPlan",
    backup_plan=backup.CfnBackupPlan.BackupPlanResourceTypeProperty(
        backup_plan_name="backupPlanName",
        backup_plan_rule=[backup.CfnBackupPlan.BackupRuleResourceTypeProperty(
            rule_name="ruleName",
            target_backup_vault="targetBackupVault",

            # the properties below are optional
            completion_window_minutes=123,
            copy_actions=[backup.CfnBackupPlan.CopyActionResourceTypeProperty(
                destination_backup_vault_arn="destinationBackupVaultArn",

                # the properties below are optional
                lifecycle=backup.CfnBackupPlan.LifecycleResourceTypeProperty(
                    delete_after_days=123,
                    move_to_cold_storage_after_days=123,
                    opt_in_to_archive_for_supported_resources=False
                )
            )],
            enable_continuous_backup=False,
            lifecycle=backup.CfnBackupPlan.LifecycleResourceTypeProperty(
                delete_after_days=123,
                move_to_cold_storage_after_days=123,
                opt_in_to_archive_for_supported_resources=False
            ),
            recovery_point_tags={
                "recovery_point_tags_key": "recoveryPointTags"
            },
            schedule_expression="scheduleExpression",
            schedule_expression_timezone="scheduleExpressionTimezone",
            start_window_minutes=123
        )],

        # the properties below are optional
        advanced_backup_settings=[backup.CfnBackupPlan.AdvancedBackupSettingResourceTypeProperty(
            backup_options=backup_options,
            resource_type="resourceType"
        )]
    ),

    # the properties below are optional
    backup_plan_tags={
        "backup_plan_tags_key": "backupPlanTags"
    }
)
Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • backup_plan (Union[IResolvable, BackupPlanResourceTypeProperty, Dict[str, Any]]) – Uniquely identifies the backup plan to be associated with the selection of resources.

  • backup_plan_tags (Optional[Mapping[str, str]]) – To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Backup::BackupPlan'
attr_backup_plan_arn

An Amazon Resource Name (ARN) that uniquely identifies a backup plan;

for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50 .

CloudformationAttribute:

BackupPlanArn

attr_backup_plan_id

Uniquely identifies a backup plan.

CloudformationAttribute:

BackupPlanId

attr_version_id

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long.

Version Ids cannot be edited.

CloudformationAttribute:

VersionId

backup_plan

Uniquely identifies the backup plan to be associated with the selection of resources.

backup_plan_tags

To help organize your resources, you can assign your own metadata to the resources that you create.

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

AdvancedBackupSettingResourceTypeProperty

class CfnBackupPlan.AdvancedBackupSettingResourceTypeProperty(*, backup_options, resource_type)

Bases: object

Specifies an object containing resource type and backup options.

This is only supported for Windows VSS backups.

Parameters:

  • backup_options (Any) – The backup option for the resource. Each option is a key-value pair. This option is only available for Windows VSS backup jobs. Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup. Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default. If you specify an invalid option, you get an InvalidParameterValueException exception. For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup .

  • resource_type (str) – The name of a resource type. The only supported resource type is EC2.

See:

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

# backup_options: Any

advanced_backup_setting_resource_type_property = backup.CfnBackupPlan.AdvancedBackupSettingResourceTypeProperty(
    backup_options=backup_options,
    resource_type="resourceType"
)

Attributes

backup_options

The backup option for the resource.

Each option is a key-value pair. This option is only available for Windows VSS backup jobs.

Valid values:

Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and create a Windows VSS backup.

Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS option is not enabled by default.

If you specify an invalid option, you get an InvalidParameterValueException exception.

For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-advancedbackupsettingresourcetype.html#cfn-backup-backupplan-advancedbackupsettingresourcetype-backupoptions

resource_type

The name of a resource type.

The only supported resource type is EC2.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-advancedbackupsettingresourcetype.html#cfn-backup-backupplan-advancedbackupsettingresourcetype-resourcetype

BackupPlanResourceTypeProperty

class CfnBackupPlan.BackupPlanResourceTypeProperty(*, backup_plan_name, backup_plan_rule, advanced_backup_settings=None)

Bases: object

Specifies an object containing properties used to create a backup plan.

Parameters:
See:

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

# backup_options: Any

backup_plan_resource_type_property = backup.CfnBackupPlan.BackupPlanResourceTypeProperty(
    backup_plan_name="backupPlanName",
    backup_plan_rule=[backup.CfnBackupPlan.BackupRuleResourceTypeProperty(
        rule_name="ruleName",
        target_backup_vault="targetBackupVault",

        # the properties below are optional
        completion_window_minutes=123,
        copy_actions=[backup.CfnBackupPlan.CopyActionResourceTypeProperty(
            destination_backup_vault_arn="destinationBackupVaultArn",

            # the properties below are optional
            lifecycle=backup.CfnBackupPlan.LifecycleResourceTypeProperty(
                delete_after_days=123,
                move_to_cold_storage_after_days=123,
                opt_in_to_archive_for_supported_resources=False
            )
        )],
        enable_continuous_backup=False,
        lifecycle=backup.CfnBackupPlan.LifecycleResourceTypeProperty(
            delete_after_days=123,
            move_to_cold_storage_after_days=123,
            opt_in_to_archive_for_supported_resources=False
        ),
        recovery_point_tags={
            "recovery_point_tags_key": "recoveryPointTags"
        },
        schedule_expression="scheduleExpression",
        schedule_expression_timezone="scheduleExpressionTimezone",
        start_window_minutes=123
    )],

    # the properties below are optional
    advanced_backup_settings=[backup.CfnBackupPlan.AdvancedBackupSettingResourceTypeProperty(
        backup_options=backup_options,
        resource_type="resourceType"
    )]
)

Attributes

advanced_backup_settings

A list of backup options for each resource type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupplanresourcetype.html#cfn-backup-backupplan-backupplanresourcetype-advancedbackupsettings

backup_plan_name

The display name of a backup plan.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupplanresourcetype.html#cfn-backup-backupplan-backupplanresourcetype-backupplanname

backup_plan_rule

An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupplanresourcetype.html#cfn-backup-backupplan-backupplanresourcetype-backupplanrule

BackupRuleResourceTypeProperty

class CfnBackupPlan.BackupRuleResourceTypeProperty(*, rule_name, target_backup_vault, completion_window_minutes=None, copy_actions=None, enable_continuous_backup=None, lifecycle=None, recovery_point_tags=None, schedule_expression=None, schedule_expression_timezone=None, start_window_minutes=None)

Bases: object

Specifies an object containing properties used to schedule a task to back up a selection of resources.

Parameters:

  • rule_name (str) – A display name for a backup rule.

  • target_backup_vault (str) – The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of letters, numbers, and hyphens.

  • completion_window_minutes (Union[int, float, None]) – A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup .

  • copy_actions (Union[IResolvable, Sequence[Union[IResolvable, CopyActionResourceTypeProperty, Dict[str, Any]]], None]) – An array of CopyAction objects, which contains the details of the copy operation.

  • enable_continuous_backup (Union[bool, IResolvable, None]) – Enables continuous backup and point-in-time restores (PITR).

  • lifecycle (Union[IResolvable, LifecycleResourceTypeProperty, Dict[str, Any], None]) – The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.

  • recovery_point_tags (Union[IResolvable, Mapping[str, str], None]) – To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

  • schedule_expression (Optional[str]) – A CRON expression specifying when AWS Backup initiates a backup job.

  • schedule_expression_timezone (Optional[str]) – This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

  • start_window_minutes (Union[int, float, None]) – An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn’t start successfully. If this value is included, it must be at least 60 minutes to avoid errors.

See:

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

backup_rule_resource_type_property = backup.CfnBackupPlan.BackupRuleResourceTypeProperty(
    rule_name="ruleName",
    target_backup_vault="targetBackupVault",

    # the properties below are optional
    completion_window_minutes=123,
    copy_actions=[backup.CfnBackupPlan.CopyActionResourceTypeProperty(
        destination_backup_vault_arn="destinationBackupVaultArn",

        # the properties below are optional
        lifecycle=backup.CfnBackupPlan.LifecycleResourceTypeProperty(
            delete_after_days=123,
            move_to_cold_storage_after_days=123,
            opt_in_to_archive_for_supported_resources=False
        )
    )],
    enable_continuous_backup=False,
    lifecycle=backup.CfnBackupPlan.LifecycleResourceTypeProperty(
        delete_after_days=123,
        move_to_cold_storage_after_days=123,
        opt_in_to_archive_for_supported_resources=False
    ),
    recovery_point_tags={
        "recovery_point_tags_key": "recoveryPointTags"
    },
    schedule_expression="scheduleExpression",
    schedule_expression_timezone="scheduleExpressionTimezone",
    start_window_minutes=123
)

Attributes

completion_window_minutes

A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-completionwindowminutes

copy_actions

An array of CopyAction objects, which contains the details of the copy operation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-copyactions

enable_continuous_backup

Enables continuous backup and point-in-time restores (PITR).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-enablecontinuousbackup

lifecycle

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.

AWS Backup transitions and expires backups automatically according to the lifecycle that you define.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-lifecycle

recovery_point_tags

To help organize your resources, you can assign your own metadata to the resources that you create.

Each tag is a key-value pair.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-recoverypointtags

rule_name

A display name for a backup rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-rulename

schedule_expression

A CRON expression specifying when AWS Backup initiates a backup job.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-scheduleexpression

schedule_expression_timezone

This is the timezone in which the schedule expression is set.

By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-scheduleexpressiontimezone

start_window_minutes

An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn’t start successfully.

If this value is included, it must be at least 60 minutes to avoid errors.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-startwindowminutes

target_backup_vault

The name of a logical container where backups are stored.

Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of letters, numbers, and hyphens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-targetbackupvault

CopyActionResourceTypeProperty

class CfnBackupPlan.CopyActionResourceTypeProperty(*, destination_backup_vault_arn, lifecycle=None)

Bases: object

Copies backups created by a backup rule to another vault.

Parameters:

  • destination_backup_vault_arn (str) – An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

  • lifecycle (Union[IResolvable, LifecycleResourceTypeProperty, Dict[str, Any], None]) – Defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, AWS Backup applies the lifecycle policy of the source backup to the destination backup. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.

See:

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

copy_action_resource_type_property = backup.CfnBackupPlan.CopyActionResourceTypeProperty(
    destination_backup_vault_arn="destinationBackupVaultArn",

    # the properties below are optional
    lifecycle=backup.CfnBackupPlan.LifecycleResourceTypeProperty(
        delete_after_days=123,
        move_to_cold_storage_after_days=123,
        opt_in_to_archive_for_supported_resources=False
    )
)

Attributes

destination_backup_vault_arn

An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup.

For example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-copyactionresourcetype.html#cfn-backup-backupplan-copyactionresourcetype-destinationbackupvaultarn

lifecycle

Defines when a protected resource is transitioned to cold storage and when it expires.

AWS Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, AWS Backup applies the lifecycle policy of the source backup to the destination backup.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-copyactionresourcetype.html#cfn-backup-backupplan-copyactionresourcetype-lifecycle

LifecycleResourceTypeProperty

class CfnBackupPlan.LifecycleResourceTypeProperty(*, delete_after_days=None, move_to_cold_storage_after_days=None, opt_in_to_archive_for_supported_resources=None)

Bases: object

Specifies an object containing an array of Transition objects that determine how long in days before a recovery point transitions to cold storage or is deleted.

Parameters:

  • delete_after_days (Union[int, float, None]) – Specifies the number of days after creation that a recovery point is deleted. Must be greater than MoveToColdStorageAfterDays .

  • move_to_cold_storage_after_days (Union[int, float, None]) – Specifies the number of days after creation that a recovery point is moved to cold storage.

  • opt_in_to_archive_for_supported_resources (Union[bool, IResolvable, None]) – Optional Boolean. If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.

See:

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

lifecycle_resource_type_property = backup.CfnBackupPlan.LifecycleResourceTypeProperty(
    delete_after_days=123,
    move_to_cold_storage_after_days=123,
    opt_in_to_archive_for_supported_resources=False
)

Attributes

delete_after_days

Specifies the number of days after creation that a recovery point is deleted.

Must be greater than MoveToColdStorageAfterDays .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-lifecycleresourcetype.html#cfn-backup-backupplan-lifecycleresourcetype-deleteafterdays

move_to_cold_storage_after_days

Specifies the number of days after creation that a recovery point is moved to cold storage.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-lifecycleresourcetype.html#cfn-backup-backupplan-lifecycleresourcetype-movetocoldstorageafterdays

opt_in_to_archive_for_supported_resources

Optional Boolean.

If this is true, this setting will instruct your backup plan to transition supported resources to archive (cold) storage tier in accordance with your lifecycle settings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-lifecycleresourcetype.html#cfn-backup-backupplan-lifecycleresourcetype-optintoarchiveforsupportedresources