Class CfnBackupVault
A CloudFormation AWS::Backup::BackupVault
.
Inherited Members
Namespace: Amazon.CDK.AWS.Backup
Assembly: Amazon.CDK.AWS.Backup.dll
Syntax (csharp)
public class CfnBackupVault : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnBackupVault
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::Backup::BackupVault
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html
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 |
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 |
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 the resources that you create. |
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(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 System.String
- scoped id of the resource.
- props ICfnBackupVaultProps
- resource properties.
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
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
Remarks
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
Remarks
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.
BackupVaultTags
Metadata that you can assign to help organize the resources that you create.
public virtual object BackupVaultTags { get; set; }
Property Value
System.Object
Remarks
Each tag is a key-value pair.
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
Remarks
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
LockConfiguration
Configuration for AWS Backup Vault Lock .
public virtual object LockConfiguration { get; set; }
Property Value
System.Object
Remarks
Notifications
The SNS event notifications for the specified backup vault.
public virtual object Notifications { get; set; }
Property Value
System.Object
Remarks
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>