CfnBackupPlanPropsMixin
- class aws_cdk.mixins_preview.aws_backup.mixins.CfnBackupPlanPropsMixin(props, *, strategy=None)
Bases:
MixinContains an optional backup plan display name and an array of
BackupRuleobjects, 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 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
- 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 # backup_options: Any cfn_backup_plan_props_mixin = backup_mixins.CfnBackupPlanPropsMixin(backup_mixins.CfnBackupPlanMixinProps( backup_plan=backup_mixins.CfnBackupPlanPropsMixin.BackupPlanResourceTypeProperty( advanced_backup_settings=[backup_mixins.CfnBackupPlanPropsMixin.AdvancedBackupSettingResourceTypeProperty( backup_options=backup_options, resource_type="resourceType" )], backup_plan_name="backupPlanName", backup_plan_rule=[backup_mixins.CfnBackupPlanPropsMixin.BackupRuleResourceTypeProperty( completion_window_minutes=123, copy_actions=[backup_mixins.CfnBackupPlanPropsMixin.CopyActionResourceTypeProperty( destination_backup_vault_arn="destinationBackupVaultArn", lifecycle=backup_mixins.CfnBackupPlanPropsMixin.LifecycleResourceTypeProperty( delete_after_days=123, move_to_cold_storage_after_days=123, opt_in_to_archive_for_supported_resources=False ) )], enable_continuous_backup=False, index_actions=[backup_mixins.CfnBackupPlanPropsMixin.IndexActionsResourceTypeProperty( resource_types=["resourceTypes"] )], lifecycle=backup_mixins.CfnBackupPlanPropsMixin.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" }, rule_name="ruleName", schedule_expression="scheduleExpression", schedule_expression_timezone="scheduleExpressionTimezone", start_window_minutes=123, target_backup_vault="targetBackupVault", target_logically_air_gapped_backup_vault_arn="targetLogicallyAirGappedBackupVaultArn" )] ), backup_plan_tags={ "backup_plan_tags_key": "backupPlanTags" } ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::Backup::BackupPlan.- Parameters:
props (
Union[CfnBackupPlanMixinProps,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:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['backupPlan', 'backupPlanTags']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
AdvancedBackupSettingResourceTypeProperty
- class CfnBackupPlanPropsMixin.AdvancedBackupSettingResourceTypeProperty(*, backup_options=None, resource_type=None)
Bases:
objectSpecifies 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 theWindowsVSSbackup option and create a Windows VSS backup. Set to"WindowsVSS":"disabled"to create a regular backup. TheWindowsVSSoption is not enabled by default. If you specify an invalid option, you get anInvalidParameterValueExceptionexception. For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup .resource_type (
Optional[str]) – The name of a resource type. The only supported resource type is EC2.
- See:
- 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 # backup_options: Any advanced_backup_setting_resource_type_property = backup_mixins.CfnBackupPlanPropsMixin.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 theWindowsVSSbackup option and create a Windows VSS backup.Set to
"WindowsVSS":"disabled"to create a regular backup. TheWindowsVSSoption is not enabled by default.If you specify an invalid option, you get an
InvalidParameterValueExceptionexception.For more information about Windows VSS backups, see Creating a VSS-Enabled Windows Backup .
- resource_type
The name of a resource type.
The only supported resource type is EC2.
BackupPlanResourceTypeProperty
- class CfnBackupPlanPropsMixin.BackupPlanResourceTypeProperty(*, advanced_backup_settings=None, backup_plan_name=None, backup_plan_rule=None)
Bases:
objectSpecifies an object containing properties used to create a backup plan.
- Parameters:
advanced_backup_settings (
Union[IResolvable,Sequence[Union[IResolvable,AdvancedBackupSettingResourceTypeProperty,Dict[str,Any]]],None]) – A list of backup options for each resource type.backup_plan_name (
Optional[str]) – The display name of a backup plan.backup_plan_rule (
Union[IResolvable,Sequence[Union[IResolvable,BackupRuleResourceTypeProperty,Dict[str,Any]]],None]) – An array ofBackupRuleobjects, each of which specifies a scheduled task that is used to back up a selection of resources.
- See:
- 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 # backup_options: Any backup_plan_resource_type_property = backup_mixins.CfnBackupPlanPropsMixin.BackupPlanResourceTypeProperty( advanced_backup_settings=[backup_mixins.CfnBackupPlanPropsMixin.AdvancedBackupSettingResourceTypeProperty( backup_options=backup_options, resource_type="resourceType" )], backup_plan_name="backupPlanName", backup_plan_rule=[backup_mixins.CfnBackupPlanPropsMixin.BackupRuleResourceTypeProperty( completion_window_minutes=123, copy_actions=[backup_mixins.CfnBackupPlanPropsMixin.CopyActionResourceTypeProperty( destination_backup_vault_arn="destinationBackupVaultArn", lifecycle=backup_mixins.CfnBackupPlanPropsMixin.LifecycleResourceTypeProperty( delete_after_days=123, move_to_cold_storage_after_days=123, opt_in_to_archive_for_supported_resources=False ) )], enable_continuous_backup=False, index_actions=[backup_mixins.CfnBackupPlanPropsMixin.IndexActionsResourceTypeProperty( resource_types=["resourceTypes"] )], lifecycle=backup_mixins.CfnBackupPlanPropsMixin.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" }, rule_name="ruleName", schedule_expression="scheduleExpression", schedule_expression_timezone="scheduleExpressionTimezone", start_window_minutes=123, target_backup_vault="targetBackupVault", target_logically_air_gapped_backup_vault_arn="targetLogicallyAirGappedBackupVaultArn" )] )
Attributes
- advanced_backup_settings
A list of backup options for each resource type.
- backup_plan_name
The display name of a backup plan.
- backup_plan_rule
An array of
BackupRuleobjects, each of which specifies a scheduled task that is used to back up a selection of resources.
BackupRuleResourceTypeProperty
- class CfnBackupPlanPropsMixin.BackupRuleResourceTypeProperty(*, completion_window_minutes=None, copy_actions=None, enable_continuous_backup=None, index_actions=None, lifecycle=None, recovery_point_tags=None, rule_name=None, schedule_expression=None, schedule_expression_timezone=None, start_window_minutes=None, target_backup_vault=None, target_logically_air_gapped_backup_vault_arn=None)
Bases:
objectSpecifies an object containing properties used to schedule a task to back up a selection of resources.
- Parameters:
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).index_actions (
Union[IResolvable,Sequence[Union[IResolvable,IndexActionsResourceTypeProperty,Dict[str,Any]]],None]) – There can up to one IndexAction in each BackupRule, as each backup can have 0 or 1 backup index associated with it. Within the array is ResourceTypes. Only 1 resource type will be accepted for each BackupRule. Valid values: -EBSfor Amazon Elastic Block Store -S3for Amazon Simple Storage Service (Amazon S3)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[Mapping[str,str],IResolvable,None]) – The tags to assign to the resources.rule_name (
Optional[str]) – A display name for a backup rule.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.target_backup_vault (
Optional[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.target_logically_air_gapped_backup_vault_arn (
Optional[str])
- See:
- 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 backup_rule_resource_type_property = backup_mixins.CfnBackupPlanPropsMixin.BackupRuleResourceTypeProperty( completion_window_minutes=123, copy_actions=[backup_mixins.CfnBackupPlanPropsMixin.CopyActionResourceTypeProperty( destination_backup_vault_arn="destinationBackupVaultArn", lifecycle=backup_mixins.CfnBackupPlanPropsMixin.LifecycleResourceTypeProperty( delete_after_days=123, move_to_cold_storage_after_days=123, opt_in_to_archive_for_supported_resources=False ) )], enable_continuous_backup=False, index_actions=[backup_mixins.CfnBackupPlanPropsMixin.IndexActionsResourceTypeProperty( resource_types=["resourceTypes"] )], lifecycle=backup_mixins.CfnBackupPlanPropsMixin.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" }, rule_name="ruleName", schedule_expression="scheduleExpression", schedule_expression_timezone="scheduleExpressionTimezone", start_window_minutes=123, target_backup_vault="targetBackupVault", target_logically_air_gapped_backup_vault_arn="targetLogicallyAirGappedBackupVaultArn" )
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 .
- copy_actions
An array of CopyAction objects, which contains the details of the copy operation.
- enable_continuous_backup
Enables continuous backup and point-in-time restores (PITR).
- index_actions
There can up to one IndexAction in each BackupRule, as each backup can have 0 or 1 backup index associated with it.
Within the array is ResourceTypes. Only 1 resource type will be accepted for each BackupRule. Valid values:
EBSfor Amazon Elastic Block StoreS3for Amazon Simple Storage Service (Amazon S3)
- 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.
- recovery_point_tags
The tags to assign to the resources.
- rule_name
A display name for a backup rule.
- schedule_expression
A CRON expression specifying when AWS Backup initiates a backup job.
- 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.
- 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.
- 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.
- target_logically_air_gapped_backup_vault_arn
-
- Type:
see
CopyActionResourceTypeProperty
- class CfnBackupPlanPropsMixin.CopyActionResourceTypeProperty(*, destination_backup_vault_arn=None, lifecycle=None)
Bases:
objectCopies backups created by a backup rule to another vault.
- Parameters:
destination_backup_vault_arn (
Optional[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:
- 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 copy_action_resource_type_property = backup_mixins.CfnBackupPlanPropsMixin.CopyActionResourceTypeProperty( destination_backup_vault_arn="destinationBackupVaultArn", lifecycle=backup_mixins.CfnBackupPlanPropsMixin.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.
- 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.
IndexActionsResourceTypeProperty
- class CfnBackupPlanPropsMixin.IndexActionsResourceTypeProperty(*, resource_types=None)
Bases:
objectSpecifies index actions.
- Parameters:
resource_types (
Optional[Sequence[str]]) – 0 or 1 index action will be accepted for each BackupRule. Valid values: -EBSfor Amazon Elastic Block Store -S3for Amazon Simple Storage Service (Amazon S3)- See:
- 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 index_actions_resource_type_property = backup_mixins.CfnBackupPlanPropsMixin.IndexActionsResourceTypeProperty( resource_types=["resourceTypes"] )
Attributes
- resource_types
0 or 1 index action will be accepted for each BackupRule.
Valid values:
EBSfor Amazon Elastic Block StoreS3for Amazon Simple Storage Service (Amazon S3)
LifecycleResourceTypeProperty
- class CfnBackupPlanPropsMixin.LifecycleResourceTypeProperty(*, delete_after_days=None, move_to_cold_storage_after_days=None, opt_in_to_archive_for_supported_resources=None)
Bases:
objectSpecifies an object containing an array of
Transitionobjects 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]) – The number of days after creation that a recovery point is deleted. This value must be at least 90 days after the number of days specified inMoveToColdStorageAfterDays.move_to_cold_storage_after_days (
Union[int,float,None]) – 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]) – If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.
- See:
- 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 lifecycle_resource_type_property = backup_mixins.CfnBackupPlanPropsMixin.LifecycleResourceTypeProperty( delete_after_days=123, move_to_cold_storage_after_days=123, opt_in_to_archive_for_supported_resources=False )
Attributes
- delete_after_days
The number of days after creation that a recovery point is deleted.
This value must be at least 90 days after the number of days specified in
MoveToColdStorageAfterDays.
- move_to_cold_storage_after_days
The number of days after creation that a recovery point is moved to cold storage.
- opt_in_to_archive_for_supported_resources
If the value is true, your backup plan transitions supported resources to archive (cold) storage tier in accordance with your lifecycle settings.