interface CfnLogicallyAirGappedBackupVaultProps

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

Properties for defining a CfnLogicallyAirGappedBackupVault.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html

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 accessPolicy: any;
const cfnLogicallyAirGappedBackupVaultProps: backup.CfnLogicallyAirGappedBackupVaultProps = {
  backupVaultName: 'backupVaultName',
  maxRetentionDays: 123,
  minRetentionDays: 123,

  // the properties below are optional
  accessPolicy: accessPolicy,
  backupVaultTags: {
    backupVaultTagsKey: 'backupVaultTags',
  },
  encryptionKeyArn: 'encryptionKeyArn',
  mpaApprovalTeamArn: 'mpaApprovalTeamArn',
  notifications: {
    backupVaultEvents: ['backupVaultEvents'],
    snsTopicArn: 'snsTopicArn',
  },
};

Properties

Name	Type	Description
backupVaultName	`string`	The name of a logical container where backups are stored.
maxRetentionDays	`number`	The maximum retention period that the vault retains its recovery points.
minRetentionDays	`number`	This setting specifies the minimum retention period that the vault retains its recovery points.
accessPolicy?	`any`	The backup vault access policy document in JSON format.
backupVaultTags?	`{ [string]: string }`	The tags to assign to the vault.
encryptionKeyArn?	`string`	The server-side encryption key that is used to protect your backups; for example, `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` .
mpaApprovalTeamArn?	`string`	The Amazon Resource Name (ARN) of the MPA approval team to associate with the backup vault.
notifications?	`IResolvable` `\|` `NotificationObjectTypeProperty`	Returns event notifications for the specified backup vault.

backupVaultName

Type: string

The name of a logical container where backups are stored.

Logically air-gapped backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-backupvaultname

maxRetentionDays

Type: number

The maximum retention period that the vault retains its recovery points.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-maxretentiondays

minRetentionDays

Type: number

This setting specifies the minimum retention period that the vault retains its recovery points.

The minimum value accepted is 7 days.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-minretentiondays

accessPolicy?

Type: any (optional)

The backup vault access policy document in JSON format.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-accesspolicy

backupVaultTags?

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

The tags to assign to the vault.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-backupvaulttags

encryptionKeyArn?

Type: string (optional)

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .

If this field is left blank, AWS Backup will create an AWS owned key to be used to encrypt the content of the logically air-gapped vault. The ARN of this created key will be available as Fn::GetAtt output.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-encryptionkeyarn