Package software.amazon.awscdk.services.backup

Interface CfnBackupPlanProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBackupPlanProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.637Z")
@Stability(Stable)
public interface CfnBackupPlanProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnBackupPlan.

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.*;
 Object backupOptions;
 CfnBackupPlanProps cfnBackupPlanProps = CfnBackupPlanProps.builder()
         .backupPlan(BackupPlanResourceTypeProperty.builder()
                 .backupPlanName("backupPlanName")
                 .backupPlanRule(List.of(BackupRuleResourceTypeProperty.builder()
                         .ruleName("ruleName")
                         .targetBackupVault("targetBackupVault")
                         // the properties below are optional
                         .completionWindowMinutes(123)
                         .copyActions(List.of(CopyActionResourceTypeProperty.builder()
                                 .destinationBackupVaultArn("destinationBackupVaultArn")
                                 // the properties below are optional
                                 .lifecycle(LifecycleResourceTypeProperty.builder()
                                         .deleteAfterDays(123)
                                         .moveToColdStorageAfterDays(123)
                                         .build())
                                 .build()))
                         .enableContinuousBackup(false)
                         .lifecycle(LifecycleResourceTypeProperty.builder()
                                 .deleteAfterDays(123)
                                 .moveToColdStorageAfterDays(123)
                                 .build())
                         .recoveryPointTags(Map.of(
                                 "recoveryPointTagsKey", "recoveryPointTags"))
                         .scheduleExpression("scheduleExpression")
                         .startWindowMinutes(123)
                         .build()))
                 // the properties below are optional
                 .advancedBackupSettings(List.of(AdvancedBackupSettingResourceTypeProperty.builder()
                         .backupOptions(backupOptions)
                         .resourceType("resourceType")
                         .build()))
                 .build())
         // the properties below are optional
         .backupPlanTags(Map.of(
                 "backupPlanTagsKey", "backupPlanTags"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnBackupPlanProps.Builder	builder()
Object	getBackupPlan()	Uniquely identifies the backup plan to be associated with the selection of resources.
default Object	getBackupPlanTags()	To help organize your resources, you can assign your own metadata to the resources that you create.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBackupPlan

@Stability(Stable)
@NotNull
Object getBackupPlan()

Uniquely identifies the backup plan to be associated with the selection of resources.

getBackupPlanTags

@Stability(Stable)
@Nullable
default Object getBackupPlanTags()

To help organize your resources, you can assign your own metadata to the resources that you create.

Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

builder

@Stability(Stable)
static CfnBackupPlanProps.Builder builder()

Returns:

a CfnBackupPlanProps.Builder of CfnBackupPlanProps