@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:51.656Z") public class CfnBackupVault extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnBackupVault(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnBackupVault(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnBackupVault(Construct scope, java.lang.String id, CfnBackupVaultProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrBackupVaultArn()
for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault
.
public java.lang.String getAttrBackupVaultName()
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.
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.Object getAccessPolicy()
public void setAccessPolicy(java.lang.Object value)
public java.lang.String getBackupVaultName()
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.
public void setBackupVaultName(java.lang.String value)
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.
public java.lang.Object getBackupVaultTags()
Each tag is a key-value pair.
public void setBackupVaultTags(IResolvable value)
Each tag is a key-value pair.
public void setBackupVaultTags(java.util.Map<java.lang.String,java.lang.String> value)
Each tag is a key-value pair.
public java.lang.String getEncryptionKeyArn()
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
public void setEncryptionKeyArn(java.lang.String value)
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
public java.lang.Object getLockConfiguration()
public void setLockConfiguration(IResolvable value)
public void setLockConfiguration(CfnBackupVault.LockConfigurationTypeProperty value)
public java.lang.Object getNotifications()
public void setNotifications(IResolvable value)
public void setNotifications(CfnBackupVault.NotificationObjectTypeProperty value)