interface BackupSelectionProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Backup.BackupSelectionProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsbackup#BackupSelectionProps |
![]() | software.amazon.awscdk.services.backup.BackupSelectionProps |
![]() | aws_cdk.aws_backup.BackupSelectionProps |
![]() | aws-cdk-lib » aws_backup » BackupSelectionProps |
Properties for a BackupSelection.
Example
// 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';
declare const backupPlan: backup.BackupPlan;
declare const backupResource: backup.BackupResource;
declare const role: iam.Role;
const backupSelectionProps: backup.BackupSelectionProps = {
backupPlan: backupPlan,
resources: [backupResource],
// the properties below are optional
allowRestores: false,
backupSelectionName: 'backupSelectionName',
disableDefaultBackupPolicy: false,
role: role,
};
Properties
Name | Type | Description |
---|---|---|
backup | IBackup | The backup plan for this selection. |
resources | Backup [] | The resources to backup. |
allow | boolean | Whether to automatically give restores permissions to the role that AWS Backup uses. |
backup | string | The name for this selection. |
disable | boolean | Whether to disable automatically assigning default backup permissions to the role that AWS Backup uses. |
role? | IRole | The role that AWS Backup uses to authenticate when backuping or restoring the resources. |
backupPlan
Type:
IBackup
The backup plan for this selection.
resources
Type:
Backup
[]
The resources to backup.
Use the helper static methods defined on BackupResource
.
allowRestores?
Type:
boolean
(optional, default: 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.
backupSelectionName?
Type:
string
(optional, default: a CDK generated name)
The name for this selection.
disableDefaultBackupPolicy?
Type:
boolean
(optional, default: 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.
role?
Type:
IRole
(optional, default: 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
.