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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:16.162Z")
 @Stability(value=Stable)
public class CfnBackupVault
extends CfnResource
implements IInspectable

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

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 Example:
static interface	CfnBackupVault.NotificationObjectTypeProperty Example:

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() `AWS::Backup::BackupVault.AccessPolicy`.
String	getAttrBackupVaultArn()
String	getAttrBackupVaultName()
String	getBackupVaultName() `AWS::Backup::BackupVault.BackupVaultName`.
Object	getBackupVaultTags() `AWS::Backup::BackupVault.BackupVaultTags`.
protected Map<String,Object>	getCfnProperties()
String	getEncryptionKeyArn() `AWS::Backup::BackupVault.EncryptionKeyArn`.
Object	getLockConfiguration() `AWS::Backup::BackupVault.LockConfiguration`.
Object	getNotifications() `AWS::Backup::BackupVault.Notifications`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessPolicy(Object value) `AWS::Backup::BackupVault.AccessPolicy`.
void	setBackupVaultName(String value) `AWS::Backup::BackupVault.BackupVaultName`.
void	setBackupVaultTags(IResolvable value) `AWS::Backup::BackupVault.BackupVaultTags`.
void	setBackupVaultTags(Map<String,String> value) `AWS::Backup::BackupVault.BackupVaultTags`.
void	setEncryptionKeyArn(String value) `AWS::Backup::BackupVault.EncryptionKeyArn`.
void	setLockConfiguration(CfnBackupVault.LockConfigurationTypeProperty value) `AWS::Backup::BackupVault.LockConfiguration`.
void	setLockConfiguration(IResolvable value) `AWS::Backup::BackupVault.LockConfiguration`.
void	setNotifications(CfnBackupVault.NotificationObjectTypeProperty value) `AWS::Backup::BackupVault.Notifications`.
void	setNotifications(IResolvable value) `AWS::Backup::BackupVault.Notifications`.

Methods inherited from class software.amazon.awscdk.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.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.

getAccessPolicy

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

`AWS::Backup::BackupVault.AccessPolicy`.

setAccessPolicy

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

`AWS::Backup::BackupVault.AccessPolicy`.

getAttrBackupVaultArn

@Stability(value=Stable)
 @NotNull
public String getAttrBackupVaultArn()

getAttrBackupVaultName

@Stability(value=Stable)
 @NotNull
public String getAttrBackupVaultName()

getBackupVaultName

@Stability(value=Stable)
 @NotNull
public String getBackupVaultName()

`AWS::Backup::BackupVault.BackupVaultName`.

setBackupVaultName

@Stability(value=Stable)
public void setBackupVaultName(@NotNull
                                                        String value)

`AWS::Backup::BackupVault.BackupVaultName`.

getBackupVaultTags

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

`AWS::Backup::BackupVault.BackupVaultTags`.

setBackupVaultTags

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

`AWS::Backup::BackupVault.BackupVaultTags`.

setBackupVaultTags

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

`AWS::Backup::BackupVault.BackupVaultTags`.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getEncryptionKeyArn

@Stability(value=Stable)
 @Nullable
public String getEncryptionKeyArn()

`AWS::Backup::BackupVault.EncryptionKeyArn`.

setEncryptionKeyArn

@Stability(value=Stable)
public void setEncryptionKeyArn(@Nullable
                                                         String value)

`AWS::Backup::BackupVault.EncryptionKeyArn`.

getLockConfiguration

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

`AWS::Backup::BackupVault.LockConfiguration`.

setLockConfiguration

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

`AWS::Backup::BackupVault.LockConfiguration`.

setLockConfiguration

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

`AWS::Backup::BackupVault.LockConfiguration`.

getNotifications

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

`AWS::Backup::BackupVault.Notifications`.

setNotifications

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

`AWS::Backup::BackupVault.Notifications`.

setNotifications

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

`AWS::Backup::BackupVault.Notifications`.