Class CfnBackupVault
Creates a logical container where backups are stored.
Inherited Members
Namespace: Amazon.CDK.AWS.Backup
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnBackupVault : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnBackupVault
Inherits CfnResource
Implements IInspectable, 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 AWS 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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnBackupVault(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnBackupVault(Construct, String, ICfnBackupVaultProps) |
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. |
BackupVaultTags | Metadata that you can assign to help organize your backup vaults. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnBackupVault(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnBackupVault(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnBackupVault(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnBackupVault(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnBackupVault(Construct, String, ICfnBackupVaultProps)
public CfnBackupVault(Construct scope, string id, ICfnBackupVaultProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnBackupVaultProps
Resource properties.
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
System.Object
AttrBackupVaultArn
An Amazon Resource Name (ARN) that uniquely identifies a backup vault;
public virtual string AttrBackupVaultArn { get; }
Property Value
System.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
System.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
System.String
BackupVaultTags
Metadata that you can assign to help organize your backup vaults.
public virtual IDictionary<string, string> BackupVaultTags { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
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
System.String
LockConfiguration
Configuration for AWS Backup Vault Lock .
public virtual object LockConfiguration { get; set; }
Property Value
System.Object
Notifications
The SNS event notifications for the specified backup vault.
public virtual object Notifications { get; set; }
Property Value
System.Object
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>