software.amazon.awscdk.services.backup

Class BackupVault

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.backup.BackupVault

All Implemented Interfaces:

IConstruct, IDependable, IResource, IBackupVault

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:30.886Z")
public class BackupVault
extends Resource
implements IBackupVault

A backup vault.

Example:

 IBackupVault importedVault = BackupVault.fromBackupVaultName(this, "Vault", "myVaultName");
 Role role = Role.Builder.create(this, "Access Role").assumedBy(new ServicePrincipal("lambda.amazonaws.com")).build();
 importedVault.grant(role, "backup:StartBackupJob");
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BackupVault.Builder A fluent builder for BackupVault.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.backup.IBackupVault

IBackupVault.Jsii$Default, IBackupVault.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BackupVault(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	BackupVault(software.amazon.jsii.JsiiObjectRef objRef)
	BackupVault(software.constructs.Construct scope, java.lang.String id)
	BackupVault(software.constructs.Construct scope, java.lang.String id, BackupVaultProps props)

Method Summary

Modifier and Type	Method and Description
void	addToAccessPolicy(PolicyStatement statement) Adds a statement to the vault access policy.
void	blockRecoveryPointDeletion() Adds a statement to the vault access policy that prevents anyone from deleting a recovery point.
static IBackupVault	fromBackupVaultArn(software.constructs.Construct scope, java.lang.String id, java.lang.String backupVaultArn) Import an existing backup vault by arn.
static IBackupVault	fromBackupVaultName(software.constructs.Construct scope, java.lang.String id, java.lang.String backupVaultName) Import an existing backup vault by name.
java.lang.String	getBackupVaultArn() The ARN of the backup vault.
java.lang.String	getBackupVaultName() The name of a logical container where backups are stored.
Grant	grant(IGrantable grantee, java.lang.String... actions) Grant the actions defined in actions to the given grantee on this Backup Vault resource.

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

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

BackupVault

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

BackupVault

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

BackupVault

public BackupVault(software.constructs.Construct scope,
                   java.lang.String id,
                   BackupVaultProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

BackupVault

public BackupVault(software.constructs.Construct scope,
                   java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromBackupVaultArn

public static IBackupVault fromBackupVaultArn(software.constructs.Construct scope,
                                              java.lang.String id,
                                              java.lang.String backupVaultArn)

Import an existing backup vault by arn.

Parameters:

scope - This parameter is required.

id - This parameter is required.

backupVaultArn - This parameter is required.

fromBackupVaultName

public static IBackupVault fromBackupVaultName(software.constructs.Construct scope,
                                               java.lang.String id,
                                               java.lang.String backupVaultName)

Import an existing backup vault by name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

backupVaultName - This parameter is required.

addToAccessPolicy

public void addToAccessPolicy(PolicyStatement statement)

Adds a statement to the vault access policy.

Parameters:

statement - This parameter is required.

blockRecoveryPointDeletion

public void blockRecoveryPointDeletion()

Adds a statement to the vault access policy that prevents anyone from deleting a recovery point.

grant

public Grant grant(IGrantable grantee,
                   java.lang.String... actions)

Grant the actions defined in actions to the given grantee on this Backup Vault resource.

Specified by:

grant in interface IBackupVault

Parameters:

grantee - Principal to grant right to. This parameter is required.

actions - The actions to grant. This parameter is required.

getBackupVaultArn

public java.lang.String getBackupVaultArn()

The ARN of the backup vault.

Specified by:

getBackupVaultArn in interface IBackupVault

getBackupVaultName

public java.lang.String getBackupVaultName()

The name of a logical container where backups are stored.

Specified by:

getBackupVaultName in interface IBackupVault