Class CfnBackupVault

Creates a logical container where backups are stored.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnBackupVault
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Backup
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnBackupVault : CfnResource, IInspectable, IBackupVaultRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Syntax (vb)
Public Class CfnBackupVault Inherits CfnResource Implements IInspectable, IBackupVaultRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Remarks

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 CloudFormation template, see the AWS Backup Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html

CloudformationResource: AWS::Backup::BackupVault

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Backup;

             var accessPolicy;

             var cfnBackupVault = new CfnBackupVault(this, "MyCfnBackupVault", new CfnBackupVaultProps {
                 BackupVaultName = "backupVaultName",

                 // the properties below are optional
                 AccessPolicy = accessPolicy,
                 BackupVaultTags = new Dictionary<string, string> {
                     { "backupVaultTagsKey", "backupVaultTags" }
                 },
                 EncryptionKeyArn = "encryptionKeyArn",
                 LockConfiguration = new LockConfigurationTypeProperty {
                     MinRetentionDays = 123,

                     // the properties below are optional
                     ChangeableForDays = 123,
                     MaxRetentionDays = 123
                 },
                 Notifications = new NotificationObjectTypeProperty {
                     BackupVaultEvents = new [] { "backupVaultEvents" },
                     SnsTopicArn = "snsTopicArn"
                 }
             });

Synopsis

Constructors

CfnBackupVault(Construct, string, ICfnBackupVaultProps)

Create a new AWS::Backup::BackupVault.

Properties

AccessPolicy

A resource-based policy that is used to manage access permissions on the target backup vault.
AttrBackupVaultArn

An Amazon Resource Name (ARN) that uniquely identifies a backup vault;
AttrBackupVaultName

The name of a logical container where backups are stored.
BackupVaultName

The name of a logical container where backups are stored.
BackupVaultRef

A reference to a BackupVault resource.
BackupVaultTags

The tags to assign to the backup vault.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CdkTagManager

Tag Manager which manages the tags for this resource.
CfnProperties

Creates a logical container where backups are stored.
CfnPropertyNames

Creates a logical container where backups are stored.
EncryptionKeyArn

A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management;
LockConfiguration

Configuration for AWS Backup Vault Lock .
Notifications

The SNS event notifications for the specified backup vault.

Methods

ArnForBackupVault(IBackupVaultRef)

Creates a logical container where backups are stored.
FromBackupVaultArn(Construct, string, string)

Creates a new IBackupVaultRef from an ARN.
FromBackupVaultName(Construct, string, string)

Creates a new IBackupVaultRef from a backupVaultName.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnBackupVault(object)

Checks whether the given object is a CfnBackupVault.
RenderProperties(IDictionary<string, object>)

Creates a logical container where backups are stored.

Constructors

CfnBackupVault(Construct, string, ICfnBackupVaultProps)

Create a new AWS::Backup::BackupVault.

public CfnBackupVault(Construct scope, string id, ICfnBackupVaultProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnBackupVaultProps

Resource properties.

Remarks

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 CloudFormation template, see the AWS Backup Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html

CloudformationResource: AWS::Backup::BackupVault

ExampleMetadata: fixture=_generated

Properties

AccessPolicy

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

public virtual object AccessPolicy { get; set; }
Property Value

object

Remarks

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 CloudFormation template, see the AWS Backup Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html

CloudformationResource: AWS::Backup::BackupVault

ExampleMetadata: fixture=_generated

AttrBackupVaultArn

An Amazon Resource Name (ARN) that uniquely identifies a backup vault;

public virtual string AttrBackupVaultArn { get; }
Property Value

string

Remarks

for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault .

CloudformationAttribute: BackupVaultArn

AttrBackupVaultName

The name of a logical container where backups are stored.

public virtual string AttrBackupVaultName { get; }
Property Value

string

Remarks

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.

CloudformationAttribute: BackupVaultName

BackupVaultName

The name of a logical container where backups are stored.

public virtual string BackupVaultName { get; set; }
Property Value

string

Remarks

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 CloudFormation template, see the AWS Backup Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html

CloudformationResource: AWS::Backup::BackupVault

ExampleMetadata: fixture=_generated

BackupVaultRef

A reference to a BackupVault resource.

public virtual IBackupVaultReference BackupVaultRef { get; }
Property Value

IBackupVaultReference

Remarks

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 CloudFormation template, see the AWS Backup Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html

CloudformationResource: AWS::Backup::BackupVault

ExampleMetadata: fixture=_generated

BackupVaultTags

The tags to assign to the backup vault.

public virtual IDictionary<string, string>? BackupVaultTags { get; set; }
Property Value

IDictionary<string, string>

Remarks

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 CloudFormation template, see the AWS Backup Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html

CloudformationResource: AWS::Backup::BackupVault

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

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 CloudFormation template, see the AWS Backup Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html

CloudformationResource: AWS::Backup::BackupVault

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

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 CloudFormation template, see the AWS Backup Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html

CloudformationResource: AWS::Backup::BackupVault

ExampleMetadata: fixture=_generated

CfnProperties

Creates a logical container where backups are stored.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

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 CloudFormation template, see the AWS Backup Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html

CloudformationResource: AWS::Backup::BackupVault

ExampleMetadata: fixture=_generated

CfnPropertyNames

Creates a logical container where backups are stored.

protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value

IDictionary<string, string>

Overrides
Remarks

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 CloudFormation template, see the AWS Backup Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html

CloudformationResource: AWS::Backup::BackupVault

ExampleMetadata: fixture=_generated

EncryptionKeyArn

A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management;

public virtual string? EncryptionKeyArn { get; set; }
Property Value

string

Remarks

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 CloudFormation template, see the AWS Backup Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html

CloudformationResource: AWS::Backup::BackupVault

ExampleMetadata: fixture=_generated

LockConfiguration

Configuration for AWS Backup Vault Lock .

public virtual object? LockConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnBackupVault.ILockConfigurationTypeProperty

Notifications

The SNS event notifications for the specified backup vault.

public virtual object? Notifications { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnBackupVault.INotificationObjectTypeProperty

Methods

ArnForBackupVault(IBackupVaultRef)

Creates a logical container where backups are stored.

public static string ArnForBackupVault(IBackupVaultRef resource)
Parameters
resource IBackupVaultRef
Returns

string

Remarks

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 CloudFormation template, see the AWS Backup Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html

CloudformationResource: AWS::Backup::BackupVault

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Backup;

             var accessPolicy;

             var cfnBackupVault = new CfnBackupVault(this, "MyCfnBackupVault", new CfnBackupVaultProps {
                 BackupVaultName = "backupVaultName",

                 // the properties below are optional
                 AccessPolicy = accessPolicy,
                 BackupVaultTags = new Dictionary<string, string> {
                     { "backupVaultTagsKey", "backupVaultTags" }
                 },
                 EncryptionKeyArn = "encryptionKeyArn",
                 LockConfiguration = new LockConfigurationTypeProperty {
                     MinRetentionDays = 123,

                     // the properties below are optional
                     ChangeableForDays = 123,
                     MaxRetentionDays = 123
                 },
                 Notifications = new NotificationObjectTypeProperty {
                     BackupVaultEvents = new [] { "backupVaultEvents" },
                     SnsTopicArn = "snsTopicArn"
                 }
             });

FromBackupVaultArn(Construct, string, string)

Creates a new IBackupVaultRef from an ARN.

public static IBackupVaultRef FromBackupVaultArn(Construct scope, string id, string arn)
Parameters
scope Construct
id string
arn string
Returns

IBackupVaultRef

Remarks

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 CloudFormation template, see the AWS Backup Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html

CloudformationResource: AWS::Backup::BackupVault

ExampleMetadata: fixture=_generated

FromBackupVaultName(Construct, string, string)

Creates a new IBackupVaultRef from a backupVaultName.

public static IBackupVaultRef FromBackupVaultName(Construct scope, string id, string backupVaultName)
Parameters
scope Construct
id string
backupVaultName string
Returns

IBackupVaultRef

Remarks

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 CloudFormation template, see the AWS Backup Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html

CloudformationResource: AWS::Backup::BackupVault

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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 CloudFormation template, see the AWS Backup Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html

CloudformationResource: AWS::Backup::BackupVault

ExampleMetadata: fixture=_generated

IsCfnBackupVault(object)

Checks whether the given object is a CfnBackupVault.

public static bool IsCfnBackupVault(object x)
Parameters
x object
Returns

bool

Remarks

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 CloudFormation template, see the AWS Backup Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html

CloudformationResource: AWS::Backup::BackupVault

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a logical container where backups are stored.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

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 CloudFormation template, see the AWS Backup Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html

CloudformationResource: AWS::Backup::BackupVault

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable