aws-cdk-lib.aws_backup.CfnBackupPlanProps

interface CfnBackupPlanProps

LanguageType name
.NETAmazon.CDK.AWS.Backup.CfnBackupPlanProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsbackup#CfnBackupPlanProps
Javasoftware.amazon.awscdk.services.backup.CfnBackupPlanProps
Pythonaws_cdk.aws_backup.CfnBackupPlanProps
TypeScript aws-cdk-lib » aws_backup » CfnBackupPlanProps

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 { aws_backup as backup } from 'aws-cdk-lib';

declare const backupOptions: any;
const cfnBackupPlanProps: backup.CfnBackupPlanProps = {
  backupPlan: {
    backupPlanName: 'backupPlanName',
    backupPlanRule: [{
      ruleName: 'ruleName',
      targetBackupVault: 'targetBackupVault',

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

        // the properties below are optional
        lifecycle: {
          deleteAfterDays: 123,
          moveToColdStorageAfterDays: 123,
        },
      }],
      enableContinuousBackup: false,
      lifecycle: {
        deleteAfterDays: 123,
        moveToColdStorageAfterDays: 123,
      },
      recoveryPointTags: {
        recoveryPointTagsKey: 'recoveryPointTags',
      },
      scheduleExpression: 'scheduleExpression',
      startWindowMinutes: 123,
    }],

    // the properties below are optional
    advancedBackupSettings: [{
      backupOptions: backupOptions,
      resourceType: 'resourceType',
    }],
  },

  // the properties below are optional
  backupPlanTags: {
    backupPlanTagsKey: 'backupPlanTags',
  },
};

Properties

NameTypeDescription
backupPlanIResolvable | BackupPlanResourceTypePropertyUniquely identifies the backup plan to be associated with the selection of resources.
backupPlanTags?IResolvable | { [string]: string }To help organize your resources, you can assign your own metadata to the resources that you create.

backupPlan

Type: IResolvable | BackupPlanResourceTypeProperty

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


backupPlanTags?

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

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.