Show / Hide Table of Contents

Interface ICfnBackupVaultProps

Properties for defining a CfnBackupVault.

Namespace: Amazon.CDK.AWS.Backup
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnBackupVaultProps
Syntax (vb)
Public Interface ICfnBackupVaultProps
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Backup;

             var accessPolicy;

             var cfnBackupVaultProps = new CfnBackupVaultProps {
                 BackupVaultName = "backupVaultName",

                 // the properties below are optional
                 AccessPolicy = accessPolicy,
                 BackupVaultTags = new Dictionary<string, string> {
                     { "backupVaultTagsKey", "backupVaultTags" }
                 },
                 EncryptionKeyArn = "encryptionKeyArn",
                 LockConfiguration = new LockConfigurationTypeProperty {
                     MinRetentionDays = 123,

                     // the properties below are optional
                     ChangeableForDays = 123,
                     MaxRetentionDays = 123
                 },
                 Notifications = new NotificationObjectTypeProperty {
                     BackupVaultEvents = new [] { "backupVaultEvents" },
                     SnsTopicArn = "snsTopicArn"
                 }
             };

Synopsis

Properties

AccessPolicy

A resource-based policy that is used to manage access permissions on the target backup vault.

BackupVaultName

The name of a logical container where backups are stored.

BackupVaultTags

The tags to assign to the backup vault.

EncryptionKeyArn

A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management;

LockConfiguration

Configuration for AWS Backup Vault Lock .

Notifications

The SNS event notifications for the specified backup vault.

Properties

AccessPolicy

A resource-based policy that is used to manage access permissions on the target backup vault.

object? AccessPolicy { get; }
Property Value

object

Remarks

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

BackupVaultName

The name of a logical container where backups are stored.

string BackupVaultName { get; }
Property Value

string

Remarks

Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.

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

BackupVaultTags

The tags to assign to the backup vault.

IDictionary<string, string>? BackupVaultTags { get; }
Property Value

IDictionary<string, string>

Remarks

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

EncryptionKeyArn

A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management;

object? EncryptionKeyArn { get; }
Property Value

object

Remarks

for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab . If you specify a key, you must specify its ARN, not its alias. If you do not specify a key, AWS Backup creates a KMS key for you by default.

To learn which AWS Backup services support full AWS Backup management and how AWS Backup handles encryption for backups from services that do not yet support full AWS Backup , see Encryption for backups in AWS Backup

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

Type union: either string or IKeyRef

LockConfiguration

Configuration for AWS Backup Vault Lock .

object? LockConfiguration { get; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-lockconfiguration

Type union: either IResolvable or CfnBackupVault.ILockConfigurationTypeProperty

Notifications

The SNS event notifications for the specified backup vault.

object? Notifications { get; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-notifications

Type union: either IResolvable or CfnBackupVault.INotificationObjectTypeProperty

Back to top Generated by DocFX