software.amazon.awscdk.services.backup

Interface CfnBackupVaultProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBackupVaultProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:03.495Z")
 @Stability(value=Stable)
public interface CfnBackupVaultProps
extends software.amazon.jsii.JsiiSerializable

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 Object	getAccessPolicy() A resource-based policy that is used to manage access permissions on the target backup vault.
String	getBackupVaultName() The name of a logical container where backups are stored.
default Object	getBackupVaultTags() Metadata that you can assign to help organize the resources that you create.
default String	getEncryptionKeyArn() The server-side encryption key that is used to protect your backups;
default Object	getLockConfiguration() Configuration for [AWS Backup Vault Lock](https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html) .
default Object	getNotifications() The SNS event notifications for the specified backup vault.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBackupVaultName

@Stability(value=Stable)
 @NotNull
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

@Stability(value=Stable)
 @Nullable
default Object getAccessPolicy()

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

getBackupVaultTags

@Stability(value=Stable)
 @Nullable
default Object getBackupVaultTags()

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

Each tag is a key-value pair.

getEncryptionKeyArn

@Stability(value=Stable)
 @Nullable
default String getEncryptionKeyArn()

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 .

getLockConfiguration

@Stability(value=Stable)
 @Nullable
default Object getLockConfiguration()

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

getNotifications

@Stability(value=Stable)
 @Nullable
default Object getNotifications()

The SNS event notifications for the specified backup vault.

builder

@Stability(value=Stable)
static CfnBackupVaultProps.Builder builder()

Returns:

a CfnBackupVaultProps.Builder of CfnBackupVaultProps