Package software.amazon.awscdk.services.backup

Class CfnBackupVault

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.backup.CfnBackupVault
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.648Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnBackupVault

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

    • CfnBackupVault

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

    • CfnBackupVault

      @Stability(Stable) public CfnBackupVault(@NotNull 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 Details

    • inspect

      @Stability(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(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(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAccessPolicy

      @Stability(Stable) @NotNull public Object getAccessPolicy()
      A resource-based policy that is used to manage access permissions on the target backup vault.

    • setAccessPolicy

      @Stability(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(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(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(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(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(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(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(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(Stable) @Nullable public Object getLockConfiguration()
      Configuration for AWS Backup Vault Lock .

    • setLockConfiguration

      @Stability(Stable) public void setLockConfiguration(@Nullable IResolvable value)
      Configuration for AWS Backup Vault Lock .

    • setLockConfiguration

      @Stability(Stable) public void setLockConfiguration(@Nullable CfnBackupVault.LockConfigurationTypeProperty value)
      Configuration for AWS Backup Vault Lock .

    • getNotifications

      @Stability(Stable) @Nullable public Object getNotifications()
      The SNS event notifications for the specified backup vault.

    • setNotifications

      @Stability(Stable) public void setNotifications(@Nullable IResolvable value)
      The SNS event notifications for the specified backup vault.

    • setNotifications

      @Stability(Stable) public void setNotifications(@Nullable CfnBackupVault.NotificationObjectTypeProperty value)
      The SNS event notifications for the specified backup vault.