software.amazon.awscdk.services.backup

Interface BackupSelectionOptions

All Known Subinterfaces:

BackupSelectionProps

All Known Implementing Classes:

BackupSelectionOptions.Jsii$Proxy, BackupSelectionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-11T17:58:53.138Z")
public interface BackupSelectionOptions

Options for a BackupSelection.

Example:

 BackupPlan plan;
 ITable myTable = Table.fromTableName(this, "Table", "myTableName");
 Construct myCoolConstruct = new Construct(this, "MyCoolConstruct");
 plan.addSelection("Selection", BackupSelectionOptions.builder()
         .resources(List.of(BackupResource.fromDynamoDbTable(myTable), BackupResource.fromTag("stage", "prod"), BackupResource.fromConstruct(myCoolConstruct)))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BackupSelectionOptions.Builder A builder for BackupSelectionOptions
static class	BackupSelectionOptions.Jsii$Proxy An implementation for BackupSelectionOptions

Method Summary

Modifier and Type	Method and Description
static BackupSelectionOptions.Builder	builder()
default java.lang.Boolean	getAllowRestores() Whether to automatically give restores permissions to the role that AWS Backup uses.
default java.lang.String	getBackupSelectionName() The name for this selection.
java.util.List<BackupResource>	getResources() The resources to backup.
default IRole	getRole() The role that AWS Backup uses to authenticate when backuping or restoring the resources.

Method Detail

getResources

java.util.List<BackupResource> getResources()

The resources to backup.

Use the helper static methods defined on BackupResource.

getAllowRestores

default java.lang.Boolean getAllowRestores()

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

getBackupSelectionName

default java.lang.String getBackupSelectionName()

The name for this selection.

Default: - a CDK generated name

getRole

default IRole getRole()

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

builder

static BackupSelectionOptions.Builder builder()

Returns:

a BackupSelectionOptions.Builder of BackupSelectionOptions