interface BackupRuleResourceTypeProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Backup.CfnBackupPlan.BackupRuleResourceTypeProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsbackup#CfnBackupPlan_BackupRuleResourceTypeProperty`
Java	`software.amazon.awscdk.services.backup.CfnBackupPlan.BackupRuleResourceTypeProperty`
Python	`aws_cdk.aws_backup.CfnBackupPlan.BackupRuleResourceTypeProperty`
TypeScript	`aws-cdk-lib` » `aws_backup` » `CfnBackupPlan` » `BackupRuleResourceTypeProperty`

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 { aws_backup as backup } from 'aws-cdk-lib';
const backupRuleResourceTypeProperty: backup.CfnBackupPlan.BackupRuleResourceTypeProperty = {
  ruleName: 'ruleName',
  targetBackupVault: 'targetBackupVault',

  // the properties below are optional
  completionWindowMinutes: 123,
  copyActions: [{
    destinationBackupVaultArn: 'destinationBackupVaultArn',

    // the properties below are optional
    lifecycle: {
      deleteAfterDays: 123,
      moveToColdStorageAfterDays: 123,
      optInToArchiveForSupportedResources: false,
    },
  }],
  enableContinuousBackup: false,
  indexActions: [{
    resourceTypes: ['resourceTypes'],
  }],
  lifecycle: {
    deleteAfterDays: 123,
    moveToColdStorageAfterDays: 123,
    optInToArchiveForSupportedResources: false,
  },
  recoveryPointTags: {
    recoveryPointTagsKey: 'recoveryPointTags',
  },
  scheduleExpression: 'scheduleExpression',
  scheduleExpressionTimezone: 'scheduleExpressionTimezone',
  startWindowMinutes: 123,
};

Properties

Name	Type	Description
ruleName	`string`	A display name for a backup rule.
targetBackupVault	`string`	The name of a logical container where backups are stored.
completionWindowMinutes?	`number`	A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup .
copyActions?	`IResolvable` `\|` `IResolvable` `\|` `CopyActionResourceTypeProperty[]`	An array of CopyAction objects, which contains the details of the copy operation.
enableContinuousBackup?	`boolean \|` `IResolvable`	Enables continuous backup and point-in-time restores (PITR).
indexActions?	`IResolvable` `\|` `IResolvable` `\|` `IndexActionsResourceTypeProperty[]`
lifecycle?	`IResolvable` `\|` `LifecycleResourceTypeProperty`	The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
recoveryPointTags?	`{ [string]: string } \|` `IResolvable`	The tags to assign to the resources.
scheduleExpression?	`string`	A CRON expression specifying when AWS Backup initiates a backup job.
scheduleExpressionTimezone?	`string`	This is the timezone in which the schedule expression is set.
startWindowMinutes?	`number`	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.

ruleName

Type: string

A display name for a backup rule.

targetBackupVault

Type: string

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.

completionWindowMinutes?

Type: number (optional)

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

copyActions?

Type: IResolvable | IResolvable | CopyActionResourceTypeProperty[] (optional)

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

enableContinuousBackup?

Type: boolean | IResolvable (optional)

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

indexActions?

Type: IResolvable | IResolvable | IndexActionsResourceTypeProperty[] (optional)

lifecycle?

Type: IResolvable | LifecycleResourceTypeProperty (optional)

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.

recoveryPointTags?

Type: { [string]: string } | IResolvable (optional)

The tags to assign to the resources.

scheduleExpression?

Type: string (optional)

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

scheduleExpressionTimezone?

Type: string (optional)

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.

startWindowMinutes?

Type: number (optional)

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.