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.126.0 (build 206d44b)",
           date="2026-02-09T14:39:04.629Z")
@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)
                                         .optInToArchiveForSupportedResources(false)
                                         .build())
                                 .build()))
                         .enableContinuousBackup(false)
                         .indexActions(List.of(IndexActionsResourceTypeProperty.builder()
                                 .resourceTypes(List.of("resourceTypes"))
                                 .build()))
                         .lifecycle(LifecycleResourceTypeProperty.builder()
                                 .deleteAfterDays(123)
                                 .moveToColdStorageAfterDays(123)
                                 .optInToArchiveForSupportedResources(false)
                                 .build())
                         .recoveryPointTags(Map.of(
                                 "recoveryPointTagsKey", "recoveryPointTags"))
                         .scanActions(List.of(ScanActionResourceTypeProperty.builder()
                                 .malwareScanner("malwareScanner")
                                 .scanMode("scanMode")
                                 .build()))
                         .scheduleExpression("scheduleExpression")
                         .scheduleExpressionTimezone("scheduleExpressionTimezone")
                         .startWindowMinutes(123)
                         .targetLogicallyAirGappedBackupVaultArn("targetLogicallyAirGappedBackupVaultArn")
                         .build()))
                 // the properties below are optional
                 .advancedBackupSettings(List.of(AdvancedBackupSettingResourceTypeProperty.builder()
                         .backupOptions(backupOptions)
                         .resourceType("resourceType")
                         .build()))
                 .scanSettings(List.of(ScanSettingResourceTypeProperty.builder()
                         .malwareScanner("malwareScanner")
                         .resourceTypes(List.of("resourceTypes"))
                         .scannerRoleArn("scannerRoleArn")
                         .build()))
                 .build())
         // the properties below are optional
         .backupPlanTags(Map.of(
                 "backupPlanTagsKey", "backupPlanTags"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html

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 Map<String,String>	getBackupPlanTags()	The tags to assign to the backup plan.

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.

Returns union: either IResolvable or CfnBackupPlan.BackupPlanResourceTypeProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html#cfn-backup-backupplan-backupplan

getBackupPlanTags

@Stability(Stable)
@Nullable
default Map<String,String> getBackupPlanTags()

The tags to assign to the backup plan.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupplan.html#cfn-backup-backupplan-backupplantags

builder

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

Returns:

a CfnBackupPlanProps.Builder of CfnBackupPlanProps