software.amazon.awscdk.services.backup

Class CfnBackupVault

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.backup.CfnBackupVault

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:51.656Z")
public class CfnBackupVault
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Backup::BackupVault`.

Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

For a sample AWS CloudFormation template, see the AWS Backup Developer Guide .

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;
 CfnBackupVault cfnBackupVault = CfnBackupVault.Builder.create(this, "MyCfnBackupVault")
         .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	Class and Description
static class	CfnBackupVault.Builder A fluent builder for CfnBackupVault.
static interface	CfnBackupVault.LockConfigurationTypeProperty The `LockConfigurationType` property type specifies configuration for [AWS Backup Vault Lock](https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html) .
static interface	CfnBackupVault.NotificationObjectTypeProperty Specifies an object containing SNS event notification properties for the target backup vault.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnBackupVault(Construct scope, java.lang.String id, CfnBackupVaultProps props) Create a new `AWS::Backup::BackupVault`.
protected	CfnBackupVault(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnBackupVault(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAccessPolicy() A resource-based policy that is used to manage access permissions on the target backup vault.
java.lang.String	getAttrBackupVaultArn() An Amazon Resource Name (ARN) that uniquely identifies a backup vault;
java.lang.String	getAttrBackupVaultName() The name of a logical container where backups are stored.
java.lang.String	getBackupVaultName() The name of a logical container where backups are stored.
java.lang.Object	getBackupVaultTags() Metadata that you can assign to help organize the resources that you create.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getEncryptionKeyArn() A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management;
java.lang.Object	getLockConfiguration() Configuration for [AWS Backup Vault Lock](https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html) .
java.lang.Object	getNotifications() The SNS event notifications for the specified backup vault.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAccessPolicy(java.lang.Object value) A resource-based policy that is used to manage access permissions on the target backup vault.
void	setBackupVaultName(java.lang.String value) The name of a logical container where backups are stored.
void	setBackupVaultTags(IResolvable value) Metadata that you can assign to help organize the resources that you create.
void	setBackupVaultTags(java.util.Map<java.lang.String,java.lang.String> value) Metadata that you can assign to help organize the resources that you create.
void	setEncryptionKeyArn(java.lang.String value) A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management;
void	setLockConfiguration(CfnBackupVault.LockConfigurationTypeProperty value) Configuration for [AWS Backup Vault Lock](https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html) .
void	setLockConfiguration(IResolvable value) Configuration for [AWS Backup Vault Lock](https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html) .
void	setNotifications(CfnBackupVault.NotificationObjectTypeProperty value) The SNS event notifications for the specified backup vault.
void	setNotifications(IResolvable value) The SNS event notifications for the specified backup vault.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnBackupVault

protected CfnBackupVault(software.amazon.jsii.JsiiObjectRef objRef)

CfnBackupVault

protected CfnBackupVault(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnBackupVault

public CfnBackupVault(Construct scope,
                      java.lang.String id,
                      CfnBackupVaultProps props)

Create a new `AWS::Backup::BackupVault`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrBackupVaultArn

public java.lang.String getAttrBackupVaultArn()

An Amazon Resource Name (ARN) that uniquely identifies a backup vault;

for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault .

getAttrBackupVaultName

public java.lang.String getAttrBackupVaultName()

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 Region where they are created. They consist of lowercase and uppercase letters, numbers, and hyphens.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAccessPolicy

public java.lang.Object getAccessPolicy()

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

setAccessPolicy

public void setAccessPolicy(java.lang.Object value)

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

getBackupVaultName

public 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.

setBackupVaultName

public void setBackupVaultName(java.lang.String value)

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.

getBackupVaultTags

public java.lang.Object getBackupVaultTags()

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

Each tag is a key-value pair.

setBackupVaultTags

public void setBackupVaultTags(IResolvable value)

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

Each tag is a key-value pair.

setBackupVaultTags

public void setBackupVaultTags(java.util.Map<java.lang.String,java.lang.String> value)

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

Each tag is a key-value pair.

getEncryptionKeyArn

public 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

setEncryptionKeyArn

public void setEncryptionKeyArn(java.lang.String value)

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

public java.lang.Object getLockConfiguration()

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

setLockConfiguration

public void setLockConfiguration(IResolvable value)

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

setLockConfiguration

public void setLockConfiguration(CfnBackupVault.LockConfigurationTypeProperty value)

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

getNotifications

public java.lang.Object getNotifications()

The SNS event notifications for the specified backup vault.

setNotifications

public void setNotifications(IResolvable value)

The SNS event notifications for the specified backup vault.

setNotifications

public void setNotifications(CfnBackupVault.NotificationObjectTypeProperty value)

The SNS event notifications for the specified backup vault.