Package software.amazon.awscdk.services.backup

Interface CfnBackupPlan.BackupRuleResourceTypeProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBackupPlan.BackupRuleResourceTypeProperty.Jsii$Proxy

Enclosing class:

CfnBackupPlan

@Stability(Stable)
public static interface CfnBackupPlan.BackupRuleResourceTypeProperty
extends software.amazon.jsii.JsiiSerializable

Specifies an object containing properties used to schedule a task to back up a selection of resources.

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.*;
 BackupRuleResourceTypeProperty backupRuleResourceTypeProperty = 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"))
         .scheduleExpression("scheduleExpression")
         .scheduleExpressionTimezone("scheduleExpressionTimezone")
         .startWindowMinutes(123)
         .targetLogicallyAirGappedBackupVaultArn("targetLogicallyAirGappedBackupVaultArn")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnBackupPlan.BackupRuleResourceTypeProperty.Builder	builder()
default Number	getCompletionWindowMinutes()	A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup .
default Object	getCopyActions()	An array of CopyAction objects, which contains the details of the copy operation.
default Object	getEnableContinuousBackup()	Enables continuous backup and point-in-time restores (PITR).
default Object	getIndexActions()	There can up to one IndexAction in each BackupRule, as each backup can have 0 or 1 backup index associated with it.
default Object	getLifecycle()	The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
default Object	getRecoveryPointTags()	The tags to assign to the resources.
String	getRuleName()	A display name for a backup rule.
default String	getScheduleExpression()	A CRON expression specifying when AWS Backup initiates a backup job.
default String	getScheduleExpressionTimezone()	This is the timezone in which the schedule expression is set.
default Number	getStartWindowMinutes()	An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully.
String	getTargetBackupVault()	The name of a logical container where backups are stored.
default String	getTargetLogicallyAirGappedBackupVaultArn()	The ARN of a logically air-gapped vault.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRuleName

@Stability(Stable)
@NotNull
String getRuleName()

A display name for a backup rule.

See Also:

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

getTargetBackupVault

@Stability(Stable)
@NotNull
String getTargetBackupVault()

The name of a logical container where backups are stored.

Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of letters, numbers, and hyphens.

See Also:

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

getCompletionWindowMinutes

@Stability(Stable)
@Nullable
default Number getCompletionWindowMinutes()

A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup .

See Also:

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

getCopyActions

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

An array of CopyAction objects, which contains the details of the copy operation.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnBackupPlan.CopyActionResourceTypeProperty>

See Also:

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

getEnableContinuousBackup

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

Enables continuous backup and point-in-time restores (PITR).

Returns union: either Boolean or IResolvable

See Also:

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

getIndexActions

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

There can up to one IndexAction in each BackupRule, as each backup can have 0 or 1 backup index associated with it.

Within the array is ResourceTypes. Only 1 resource type will be accepted for each BackupRule. Valid values:

• EBS for Amazon Elastic Block Store
• S3 for Amazon Simple Storage Service (Amazon S3)

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnBackupPlan.IndexActionsResourceTypeProperty>

See Also:

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

getLifecycle

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

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.

AWS Backup transitions and expires backups automatically according to the lifecycle that you define.

Returns union: either IResolvable or CfnBackupPlan.LifecycleResourceTypeProperty

See Also:

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

getRecoveryPointTags

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

The tags to assign to the resources.

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

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

getScheduleExpression

@Stability(Stable)
@Nullable
default String getScheduleExpression()

A CRON expression specifying when AWS Backup initiates a backup job.

See Also:

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

getScheduleExpressionTimezone

@Stability(Stable)
@Nullable
default String getScheduleExpressionTimezone()

This is the timezone in which the schedule expression is set.

By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

See Also:

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

getStartWindowMinutes

@Stability(Stable)
@Nullable
default Number getStartWindowMinutes()

An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully.

If this value is included, it must be at least 60 minutes to avoid errors.

See Also:

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

getTargetLogicallyAirGappedBackupVaultArn

@Stability(Stable)
@Nullable
default String getTargetLogicallyAirGappedBackupVaultArn()

The ARN of a logically air-gapped vault.

ARN must be in the same account and Region. If provided, supported fully managed resources back up directly to logically air-gapped vault, while other supported resources create a temporary (billable) snapshot in backup vault, then copy it to logically air-gapped vault. Unsupported resources only back up to the specified backup vault.

See Also:

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

builder

@Stability(Stable)
static CfnBackupPlan.BackupRuleResourceTypeProperty.Builder builder()

Returns:

a CfnBackupPlan.BackupRuleResourceTypeProperty.Builder of CfnBackupPlan.BackupRuleResourceTypeProperty