software.amazon.awscdk.services.backup

Class CfnBackupPlan

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.backup.CfnBackupPlan

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.854Z")
 @Stability(value=Stable)
public class CfnBackupPlan
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Backup::BackupPlan`.

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 AWS 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.services.backup.*;
 Object backupOptions;
 CfnBackupPlan cfnBackupPlan = CfnBackupPlan.Builder.create(this, "MyCfnBackupPlan")
         .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	Class and Description
static interface	CfnBackupPlan.AdvancedBackupSettingResourceTypeProperty Specifies an object containing resource type and backup options.
static interface	CfnBackupPlan.BackupPlanResourceTypeProperty Specifies an object containing properties used to create a backup plan.
static interface	CfnBackupPlan.BackupRuleResourceTypeProperty Specifies an object containing properties used to schedule a task to back up a selection of resources.
static class	CfnBackupPlan.Builder A fluent builder for CfnBackupPlan.
static interface	CfnBackupPlan.CopyActionResourceTypeProperty Copies backups created by a backup rule to another vault.
static interface	CfnBackupPlan.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.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnBackupPlan(software.constructs.Construct scope, String id, CfnBackupPlanProps props) Create a new `AWS::Backup::BackupPlan`.
protected	CfnBackupPlan(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnBackupPlan(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrBackupPlanArn() An Amazon Resource Name (ARN) that uniquely identifies a backup plan;
String	getAttrBackupPlanId() Uniquely identifies a backup plan.
String	getAttrVersionId() Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long.
Object	getBackupPlan() Uniquely identifies the backup plan to be associated with the selection of resources.
Object	getBackupPlanTags() To help organize your resources, you can assign your own metadata to the resources that you create.
protected Map<String,Object>	getCfnProperties()
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBackupPlan(CfnBackupPlan.BackupPlanResourceTypeProperty value) Uniquely identifies the backup plan to be associated with the selection of resources.
void	setBackupPlan(IResolvable value) Uniquely identifies the backup plan to be associated with the selection of resources.
void	setBackupPlanTags(IResolvable value) To help organize your resources, you can assign your own metadata to the resources that you create.
void	setBackupPlanTags(Map<String,String> value) To help organize your resources, you can assign your own metadata to the resources that you create.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnBackupPlan

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

CfnBackupPlan

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

CfnBackupPlan

@Stability(value=Stable)
public CfnBackupPlan(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              CfnBackupPlanProps props)

Create a new `AWS::Backup::BackupPlan`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrBackupPlanArn

@Stability(value=Stable)
 @NotNull
public String getAttrBackupPlanArn()

An Amazon Resource Name (ARN) that uniquely identifies a backup plan;

for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50 .

getAttrBackupPlanId

@Stability(value=Stable)
 @NotNull
public String getAttrBackupPlanId()

Uniquely identifies a backup plan.

getAttrVersionId

@Stability(value=Stable)
 @NotNull
public String getAttrVersionId()

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long.

Version Ids cannot be edited.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getBackupPlan

@Stability(value=Stable)
 @NotNull
public Object getBackupPlan()

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

setBackupPlan

@Stability(value=Stable)
public void setBackupPlan(@NotNull
                                                   CfnBackupPlan.BackupPlanResourceTypeProperty value)

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

setBackupPlan

@Stability(value=Stable)
public void setBackupPlan(@NotNull
                                                   IResolvable value)

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

getBackupPlanTags

@Stability(value=Stable)
 @Nullable
public 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.

setBackupPlanTags

@Stability(value=Stable)
public void setBackupPlanTags(@Nullable
                                                       IResolvable value)

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.

setBackupPlanTags

@Stability(value=Stable)
public void setBackupPlanTags(@Nullable
                                                       Map<String,String> value)

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.