software.amazon.awscdk.services.backup

Interface CfnBackupVaultProps

All Known Implementing Classes:

CfnBackupVaultProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-07-01T09:58:43.973Z")
public interface CfnBackupVaultProps

Properties for defining a `CfnBackupVault`.

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.*;
 Object accessPolicy;
 CfnBackupVaultProps cfnBackupVaultProps = CfnBackupVaultProps.builder()
         .backupVaultName("backupVaultName")
         // the properties below are optional
         .accessPolicy(accessPolicy)
         .backupVaultTags(Map.of(
                 "backupVaultTagsKey", "backupVaultTags"))
         .encryptionKeyArn("encryptionKeyArn")
         .lockConfiguration(LockConfigurationTypeProperty.builder()
                 .minRetentionDays(123)
                 // the properties below are optional
                 .changeableForDays(123)
                 .maxRetentionDays(123)
                 .build())
         .notifications(NotificationObjectTypeProperty.builder()
                 .backupVaultEvents(List.of("backupVaultEvents"))
                 .snsTopicArn("snsTopicArn")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnBackupVaultProps.Builder	builder()
default java.lang.Object	getAccessPolicy() A resource-based policy that is used to manage access permissions on the target backup vault.
java.lang.String	getBackupVaultName() The name of a logical container where backups are stored.
default java.lang.Object	getBackupVaultTags() Metadata that you can assign to help organize the resources that you create.
default java.lang.String	getEncryptionKeyArn() A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management;
default java.lang.Object	getLockConfiguration() Configuration for [AWS Backup Vault Lock](https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html) .
default java.lang.Object	getNotifications() The SNS event notifications for the specified backup vault.

Method Detail

getBackupVaultName

java.lang.String getBackupVaultName()

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 lowercase letters, numbers, and hyphens.

getAccessPolicy

default java.lang.Object getAccessPolicy()

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

getBackupVaultTags

default java.lang.Object getBackupVaultTags()

Metadata that you can assign to help organize the resources that you create.

Each tag is a key-value pair.

getEncryptionKeyArn

default java.lang.String getEncryptionKeyArn()

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

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

getLockConfiguration

default java.lang.Object getLockConfiguration()

Configuration for [AWS Backup Vault Lock](https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html) .

getNotifications

default java.lang.Object getNotifications()

The SNS event notifications for the specified backup vault.

builder

static CfnBackupVaultProps.Builder builder()

Returns:

a CfnBackupVaultProps.Builder of CfnBackupVaultProps