BackupSelection

class aws_cdk.aws_backup.BackupSelection(scope, id, *, backup_plan, resources, allow_restores=None, backup_selection_name=None, role=None)

Bases: Resource

A backup selection.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_backup as backup
import aws_cdk.aws_iam as iam

# backup_plan: backup.BackupPlan
# backup_resource: backup.BackupResource
# role: iam.Role

backup_selection = backup.BackupSelection(self, "MyBackupSelection",
    backup_plan=backup_plan,
    resources=[backup_resource],

    # the properties below are optional
    allow_restores=False,
    backup_selection_name="backupSelectionName",
    role=role
)
Parameters:

  • scope (Construct) –

  • id (str) –

  • backup_plan (IBackupPlan) – The backup plan for this selection.

  • resources (Sequence[BackupResource]) – The resources to backup. Use the helper static methods defined on BackupResource.

  • allow_restores (Optional[bool]) – Whether to automatically give restores permissions to the role that AWS Backup uses. If true, the AWSBackupServiceRolePolicyForRestores managed policy will be attached to the role. Default: false

  • backup_selection_name (Optional[str]) – The name for this selection. Default: - a CDK generated name

  • role (Optional[IRole]) – The role that AWS Backup uses to authenticate when backuping or restoring the resources. The AWSBackupServiceRolePolicyForBackup managed policy will be attached to this role. Default: - a new role will be created

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

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

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

backup_plan_id

The identifier of the backup plan.

Attribute:

true

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

grant_principal

The principal to grant permissions to.

node

The construct tree node associated with this construct.

selection_id

The identifier of the backup selection.

Attribute:

true

stack

The stack in which this resource is defined.

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool