software.amazon.awscdk.services.backup

Class CfnBackupVault

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.backup.CfnBackupVault

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.859Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnBackupVault(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               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

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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrBackupVaultArn

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

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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAccessPolicy

@Stability(value=Stable)
 @NotNull
public Object getAccessPolicy()

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

setAccessPolicy

@Stability(value=Stable)
public void setAccessPolicy(@NotNull
                                                     Object value)

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

getBackupVaultName

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

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

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

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

Each tag is a key-value pair.

setBackupVaultTags

@Stability(value=Stable)
public void setBackupVaultTags(@Nullable
                                                        IResolvable value)

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

Each tag is a key-value pair.

setBackupVaultTags

@Stability(value=Stable)
public void setBackupVaultTags(@Nullable
                                                        Map<String,String> value)

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

@Stability(value=Stable)
public void setEncryptionKeyArn(@Nullable
                                                         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

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

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

setLockConfiguration

@Stability(value=Stable)
public void setLockConfiguration(@Nullable
                                                          CfnBackupVault.LockConfigurationTypeProperty value)

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

setLockConfiguration

@Stability(value=Stable)
public void setLockConfiguration(@Nullable
                                                          IResolvable value)

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

getNotifications

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

The SNS event notifications for the specified backup vault.

setNotifications

@Stability(value=Stable)
public void setNotifications(@Nullable
                                                      CfnBackupVault.NotificationObjectTypeProperty value)

The SNS event notifications for the specified backup vault.

setNotifications

@Stability(value=Stable)
public void setNotifications(@Nullable
                                                      IResolvable value)

The SNS event notifications for the specified backup vault.