Interface BackupSelectionOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
BackupSelectionProps
All Known Implementing Classes:
BackupSelectionOptions.Jsii$Proxy, BackupSelectionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.94.0 (build b380f01)", date="2024-02-21T14:40:22.129Z") @Stability(Stable) public interface BackupSelectionOptions extends software.amazon.jsii.JsiiSerializable
Options for a BackupSelection.

Example:

 BackupPlan plan;
 Vpc vpc;
 ITable myTable = Table.fromTableName(this, "Table", "myTableName");
 DatabaseInstance myDatabaseInstance = DatabaseInstance.Builder.create(this, "DatabaseInstance")
         .engine(DatabaseInstanceEngine.mysql(MySqlInstanceEngineProps.builder().version(MysqlEngineVersion.VER_8_0_26).build()))
         .vpc(vpc)
         .build();
 DatabaseCluster myDatabaseCluster = DatabaseCluster.Builder.create(this, "DatabaseCluster")
         .engine(DatabaseClusterEngine.auroraMysql(AuroraMysqlClusterEngineProps.builder().version(AuroraMysqlEngineVersion.VER_2_08_1).build()))
         .credentials(Credentials.fromGeneratedSecret("clusteradmin"))
         .instanceProps(InstanceProps.builder()
                 .vpc(vpc)
                 .build())
         .build();
 ServerlessCluster myServerlessCluster = ServerlessCluster.Builder.create(this, "ServerlessCluster")
         .engine(DatabaseClusterEngine.AURORA_POSTGRESQL)
         .parameterGroup(ParameterGroup.fromParameterGroupName(this, "ParameterGroup", "default.aurora-postgresql10"))
         .vpc(vpc)
         .build();
 Construct myCoolConstruct = new Construct(this, "MyCoolConstruct");
 plan.addSelection("Selection", BackupSelectionOptions.builder()
         .resources(List.of(BackupResource.fromDynamoDbTable(myTable), BackupResource.fromRdsDatabaseInstance(myDatabaseInstance), BackupResource.fromRdsDatabaseCluster(myDatabaseCluster), BackupResource.fromRdsServerlessCluster(myServerlessCluster), BackupResource.fromTag("stage", "prod"), BackupResource.fromConstruct(myCoolConstruct)))
         .build());
 
  • Method Details

    • getResources

      @Stability(Stable) @NotNull List<BackupResource> getResources()
      The resources to backup.

      Use the helper static methods defined on BackupResource.

    • getAllowRestores

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) @Nullable default String getBackupSelectionName()
      The name for this selection.

      Default: - a CDK generated name

    • getDisableDefaultBackupPolicy

      @Stability(Stable) @Nullable default Boolean getDisableDefaultBackupPolicy()
      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.

      Default: false

    • getRole

      @Stability(Stable) @Nullable 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 unless disableDefaultBackupPolicy is set to true.

      Default: - a new role will be created

    • builder

      @Stability(Stable) static BackupSelectionOptions.Builder builder()
      Returns:
      a BackupSelectionOptions.Builder of BackupSelectionOptions