Package software.amazon.awscdk.cfnpropertymixins.services.backup

Class CfnBackupPlanPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.backup.CfnBackupPlanPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.262Z")
@Stability(Stable)
public class CfnBackupPlanPropsMixin
extends Mixin
implements software.constructs.IMixin

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule.

Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources.

For a sample CloudFormation template, see the AWS Backup Developer Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.backup.*;
 import software.amazon.awscdk.*;
 Object backupOptions;
 IMergeStrategy mergeStrategy;
 CfnBackupPlanPropsMixin cfnBackupPlanPropsMixin = CfnBackupPlanPropsMixin.Builder.create(CfnBackupPlanMixinProps.builder()
         .backupPlan(BackupPlanResourceTypeProperty.builder()
                 .advancedBackupSettings(List.of(AdvancedBackupSettingResourceTypeProperty.builder()
                         .backupOptions(backupOptions)
                         .resourceType("resourceType")
                         .build()))
                 .backupPlanName("backupPlanName")
                 .backupPlanRule(List.of(BackupRuleResourceTypeProperty.builder()
                         .completionWindowMinutes(123)
                         .copyActions(List.of(CopyActionResourceTypeProperty.builder()
                                 .destinationBackupVaultArn("destinationBackupVaultArn")
                                 .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"))
                         .ruleName("ruleName")
                         .scanActions(List.of(ScanActionResourceTypeProperty.builder()
                                 .malwareScanner("malwareScanner")
                                 .scanMode("scanMode")
                                 .build()))
                         .scheduleExpression("scheduleExpression")
                         .scheduleExpressionTimezone("scheduleExpressionTimezone")
                         .startWindowMinutes(123)
                         .targetBackupVault("targetBackupVault")
                         .targetLogicallyAirGappedBackupVaultArn("targetLogicallyAirGappedBackupVaultArn")
                         .build()))
                 .scanSettings(List.of(ScanSettingResourceTypeProperty.builder()
                         .malwareScanner("malwareScanner")
                         .resourceTypes(List.of("resourceTypes"))
                         .scannerRoleArn("scannerRoleArn")
                         .build()))
                 .build())
         .backupPlanTags(Map.of(
                 "backupPlanTagsKey", "backupPlanTags"))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnBackupPlanPropsMixin.AdvancedBackupSettingResourceTypeProperty	Specifies an object containing resource type and backup options.
static interface	CfnBackupPlanPropsMixin.BackupPlanResourceTypeProperty	Specifies an object containing properties used to create a backup plan.
static interface	CfnBackupPlanPropsMixin.BackupRuleResourceTypeProperty	Specifies an object containing properties used to schedule a task to back up a selection of resources.
static final class	CfnBackupPlanPropsMixin.Builder	A fluent builder for CfnBackupPlanPropsMixin.
static interface	CfnBackupPlanPropsMixin.CopyActionResourceTypeProperty	Copies backups created by a backup rule to another vault.
static interface	CfnBackupPlanPropsMixin.IndexActionsResourceTypeProperty	Specifies index actions.
static interface	CfnBackupPlanPropsMixin.LifecycleResourceTypeProperty	Specifies an object containing an array of Transition objects that determine how long in days before a recovery point transitions to cold storage or is deleted.
static interface	CfnBackupPlanPropsMixin.ScanActionResourceTypeProperty	Example:
static interface	CfnBackupPlanPropsMixin.ScanSettingResourceTypeProperty	Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnBackupPlanPropsMixin(CfnBackupPlanMixinProps props)	Create a mixin to apply properties to AWS::Backup::BackupPlan.
	CfnBackupPlanPropsMixin(CfnBackupPlanMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Backup::BackupPlan.
protected	CfnBackupPlanPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnBackupPlanPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnBackupPlanMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnBackupPlanPropsMixin

protected CfnBackupPlanPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnBackupPlanPropsMixin

protected CfnBackupPlanPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnBackupPlanPropsMixin

@Stability(Stable)
public CfnBackupPlanPropsMixin(@NotNull
 CfnBackupPlanMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Backup::BackupPlan.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnBackupPlanPropsMixin

@Stability(Stable)
public CfnBackupPlanPropsMixin(@NotNull
 CfnBackupPlanMixinProps props)

Create a mixin to apply properties to AWS::Backup::BackupPlan.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnBackupPlanMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()