software.amazon.awscdk.services.backup

Interface BackupPlanProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

BackupPlanProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:05.194Z")
 @Stability(value=Experimental)
public interface BackupPlanProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for a BackupPlan.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.backup.*;
 BackupPlanRule backupPlanRule;
 BackupVault backupVault;
 BackupPlanProps backupPlanProps = BackupPlanProps.builder()
         .backupPlanName("backupPlanName")
         .backupPlanRules(List.of(backupPlanRule))
         .backupVault(backupVault)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static BackupPlanProps.Builder	builder()
default String	getBackupPlanName() (experimental) The display name of the backup plan.
default List<BackupPlanRule>	getBackupPlanRules() (experimental) Rules for the backup plan.
default IBackupVault	getBackupVault() (experimental) The backup vault where backups are stored.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBackupPlanName

@Stability(value=Experimental)
 @Nullable
default String getBackupPlanName()

(experimental) The display name of the backup plan.

Default: - A CDK generated name

getBackupPlanRules

@Stability(value=Experimental)
 @Nullable
default List<BackupPlanRule> getBackupPlanRules()

(experimental) Rules for the backup plan.

Use addRule() to add rules after instantiation.

Default: - use `addRule()` to add rules

getBackupVault

@Stability(value=Experimental)
 @Nullable
default IBackupVault getBackupVault()

(experimental) The backup vault where backups are stored.

Default: - use the vault defined at the rule level. If not defined a new common vault for the plan will be created

builder

@Stability(value=Experimental)
static BackupPlanProps.Builder builder()

Returns:

a BackupPlanProps.Builder of BackupPlanProps