Package 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.97.0 (build 729de35)",
           date="2024-04-18T17:54:13.130Z")
@Stability(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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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 Map<String,String>	getBackupVaultTags()	Metadata that you can assign to help organize your backup vaults.
default String	getEncryptionKeyArn()	A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management;
default Object	getLockConfiguration()	Configuration for AWS Backup Vault Lock .
default Object	getNotifications()	The SNS event notifications for the specified backup vault.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBackupVaultName

@Stability(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.

See Also:

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

getAccessPolicy

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

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

See Also:

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

getBackupVaultTags

@Stability(Stable)
@Nullable
default Map<String,String> getBackupVaultTags()

Metadata that you can assign to help organize your backup vaults.

Each tag is a key-value pair.

See Also:

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

getEncryptionKeyArn

@Stability(Stable)
@Nullable
default 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

See Also:

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

getLockConfiguration

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

Configuration for AWS Backup Vault Lock .

See Also:

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

getNotifications

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

The SNS event notifications for the specified backup vault.

See Also:

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

builder

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

Returns:

a CfnBackupVaultProps.Builder of CfnBackupVaultProps