software.amazon.awscdk.services.backup

Class BackupVault.Builder

java.lang.Object

software.amazon.awscdk.services.backup.BackupVault.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BackupVault>

Enclosing class:

BackupVault

@Stability(value=Experimental)
public static final class BackupVault.Builder
extends Object
implements software.amazon.jsii.Builder<BackupVault>

(experimental) A fluent builder for BackupVault.

Method Summary

Modifier and Type	Method and Description
BackupVault.Builder	accessPolicy(PolicyDocument accessPolicy) (experimental) A resource-based policy that is used to manage access permissions on the backup vault.
BackupVault.Builder	backupVaultName(String backupVaultName) (experimental) The name of a logical container where backups are stored.
BackupVault	build()
static BackupVault.Builder	create(software.constructs.Construct scope, String id)
BackupVault.Builder	encryptionKey(IKey encryptionKey) (experimental) The server-side encryption key to use to protect your backups.
BackupVault.Builder	notificationEvents(List<? extends BackupVaultEvents> notificationEvents) (experimental) The vault events to send.
BackupVault.Builder	notificationTopic(ITopic notificationTopic) (experimental) A SNS topic to send vault events to.
BackupVault.Builder	removalPolicy(RemovalPolicy removalPolicy) (experimental) The removal policy to apply to the vault.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static BackupVault.Builder create(software.constructs.Construct scope,
                                                                        String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of BackupVault.Builder.

accessPolicy

@Stability(value=Experimental)
public BackupVault.Builder accessPolicy(PolicyDocument accessPolicy)

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

Default: - access is not restricted

Parameters:

accessPolicy - A resource-based policy that is used to manage access permissions on the backup vault. This parameter is required.

Returns:

this

backupVaultName

@Stability(value=Experimental)
public BackupVault.Builder backupVaultName(String backupVaultName)

(experimental) 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.

Default: - A CDK generated name

Parameters:

backupVaultName - The name of a logical container where backups are stored. This parameter is required.

Returns:

this

encryptionKey

@Stability(value=Experimental)
public BackupVault.Builder encryptionKey(IKey encryptionKey)

(experimental) The server-side encryption key to use to protect your backups.

Default: - an Amazon managed KMS key

Parameters:

encryptionKey - The server-side encryption key to use to protect your backups. This parameter is required.

Returns:

this

notificationEvents

@Stability(value=Experimental)
public BackupVault.Builder notificationEvents(List<? extends BackupVaultEvents> notificationEvents)

(experimental) The vault events to send.

Default: - all vault events if `notificationTopic` is defined

Parameters:

notificationEvents - The vault events to send. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html

notificationTopic

@Stability(value=Experimental)
public BackupVault.Builder notificationTopic(ITopic notificationTopic)

(experimental) A SNS topic to send vault events to.

Default: - no notifications

Parameters:

notificationTopic - A SNS topic to send vault events to. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html

removalPolicy

@Stability(value=Experimental)
public BackupVault.Builder removalPolicy(RemovalPolicy removalPolicy)

(experimental) The removal policy to apply to the vault.

Note that removing a vault that contains recovery points will fail.

Default: RemovalPolicy.RETAIN

Parameters:

removalPolicy - The removal policy to apply to the vault. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public BackupVault build()

Specified by:

build in interface software.amazon.jsii.Builder<BackupVault>