Skip to content
v2.274.0

BackupSelectionProps Struct ​

Properties for a BackupSelection.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_backup as backup } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_backup as interfaces_backup } from 'aws-cdk-lib/interfaces';

declare const backupPlanRef: interfaces_backup.IBackupPlanRef;
declare const backupResource: backup.BackupResource;
declare const role: iam.Role;
const backupSelectionProps: backup.BackupSelectionProps = {
  backupPlan: backupPlanRef,
  resources: [backupResource],

  // the properties below are optional
  allowRestores: false,
  backupSelectionName: 'backupSelectionName',
  disableDefaultBackupPolicy: false,
  role: role,
};

Properties ​

allowRestoresbooleanallow_restoresboolallowRestoresBooleanAllowRestoresboolAllowRestores*bool= false#
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.

backupPlanIBackupPlanRefbackup_planIBackupPlanRefbackupPlanIBackupPlanRefBackupPlanIBackupPlanRefBackupPlanIBackupPlanRefrequired#
The backup plan for this selection.
backupSelectionNamestringbackup_selection_namestrbackupSelectionNameStringBackupSelectionNamestringBackupSelectionName*string= a CDK generated name#
The name for this selection.
disableDefaultBackupPolicybooleandisable_default_backup_policybooldisableDefaultBackupPolicyBooleanDisableDefaultBackupPolicyboolDisableDefaultBackupPolicy*bool= false#
Whether to disable automatically assigning default backup permissions to the role that AWS Backup uses.

If false, the AWSBackupServiceRolePolicyForBackup managed policy will be attached to the role.

resourcesBackupResource[]resourcestyping.List[BackupResource]resourcesList<BackupResource>ResourcesBackupResource[]Resources*[]BackupResourcerequired#
The resources to backup.

Use the helper static methods defined on BackupResource.

roleIRoleroleIRoleroleIRoleRoleIRoleRoleIRole= a new role will be created#
The role that AWS Backup uses to authenticate when backuping or restoring the resources.

The AWSBackupServiceRolePolicyForBackup managed policy will be attached to this role unless disableDefaultBackupPolicy is set to true.

Used as props by ​