Class CfnLogicallyAirGappedBackupVault

Creates a logical container to where backups may be copied.

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

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

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

CloudformationResource: AWS::Backup::LogicallyAirGappedBackupVault

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 cfnLogicallyAirGappedBackupVault = new CfnLogicallyAirGappedBackupVault(this, "MyCfnLogicallyAirGappedBackupVault", new CfnLogicallyAirGappedBackupVaultProps {
                 BackupVaultName = "backupVaultName",
                 MaxRetentionDays = 123,
                 MinRetentionDays = 123,

                 // the properties below are optional
                 AccessPolicy = accessPolicy,
                 BackupVaultTags = new Dictionary<string, string> {
                     { "backupVaultTagsKey", "backupVaultTags" }
                 },
                 EncryptionKeyArn = "encryptionKeyArn",
                 MpaApprovalTeamArn = "mpaApprovalTeamArn",
                 Notifications = new NotificationObjectTypeProperty {
                     BackupVaultEvents = new [] { "backupVaultEvents" },
                     SnsTopicArn = "snsTopicArn"
                 }
             });

Synopsis

Constructors

CfnLogicallyAirGappedBackupVault(Construct, string, ICfnLogicallyAirGappedBackupVaultProps)

Create a new AWS::Backup::LogicallyAirGappedBackupVault.

Properties

AccessPolicy

The backup vault access policy document in JSON format.
AttrBackupVaultArn

The ARN of the backup vault.
AttrVaultState

The vault state.
AttrVaultType

The vault type.
BackupVaultName

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

The tags to assign to the 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 to where backups may be copied.
CfnPropertyNames

Creates a logical container to where backups may be copied.
EncryptionKeyArn

The server-side encryption key that is used to protect your backups;
LogicallyAirGappedBackupVaultRef

A reference to a LogicallyAirGappedBackupVault resource.
MaxRetentionDays

The maximum retention period that the vault retains its recovery points.
MinRetentionDays

This setting specifies the minimum retention period that the vault retains its recovery points.
MpaApprovalTeamArn

The Amazon Resource Name (ARN) of the MPA approval team to associate with the backup vault.
Notifications

Returns event notifications for the specified backup vault.

Methods

ArnForLogicallyAirGappedBackupVault(ILogicallyAirGappedBackupVaultRef)

Creates a logical container to where backups may be copied.
FromBackupVaultName(Construct, string, string)

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

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

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

Creates a logical container to where backups may be copied.

Constructors

CfnLogicallyAirGappedBackupVault(Construct, string, ICfnLogicallyAirGappedBackupVaultProps)

Create a new AWS::Backup::LogicallyAirGappedBackupVault.

public CfnLogicallyAirGappedBackupVault(Construct scope, string id, ICfnLogicallyAirGappedBackupVaultProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

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

props ICfnLogicallyAirGappedBackupVaultProps

Resource properties.

Remarks

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

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

CloudformationResource: AWS::Backup::LogicallyAirGappedBackupVault

ExampleMetadata: fixture=_generated

Properties

AccessPolicy

The backup vault access policy document in JSON format.

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

object

Remarks

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

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

CloudformationResource: AWS::Backup::LogicallyAirGappedBackupVault

ExampleMetadata: fixture=_generated

AttrBackupVaultArn

The ARN of the backup vault.

public virtual string AttrBackupVaultArn { get; }
Property Value

string

Remarks

CloudformationAttribute: BackupVaultArn

AttrVaultState

The vault state.

public virtual string AttrVaultState { get; }
Property Value

string

Remarks

The possible values are CREATING , AVAILABLE , and FAILED .

CloudformationAttribute: VaultState

AttrVaultType

The vault type.

public virtual string AttrVaultType { get; }
Property Value

string

Remarks

The possible values are BACKUP_VAULT and LOGICALLY_AIR_GAPPED_BACKUP_VAULT .

CloudformationAttribute: VaultType

BackupVaultName

The name of a logical container where backups are stored.

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

string

Remarks

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

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

CloudformationResource: AWS::Backup::LogicallyAirGappedBackupVault

ExampleMetadata: fixture=_generated

BackupVaultTags

The tags to assign to the vault.

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

IDictionary<string, string>

Remarks

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

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

CloudformationResource: AWS::Backup::LogicallyAirGappedBackupVault

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

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

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

CloudformationResource: AWS::Backup::LogicallyAirGappedBackupVault

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

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

CloudformationResource: AWS::Backup::LogicallyAirGappedBackupVault

ExampleMetadata: fixture=_generated

CfnProperties

Creates a logical container to where backups may be copied.

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

IDictionary<string, object>

Overrides
Remarks

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

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

CloudformationResource: AWS::Backup::LogicallyAirGappedBackupVault

ExampleMetadata: fixture=_generated

CfnPropertyNames

Creates a logical container to where backups may be copied.

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

IDictionary<string, string>

Overrides
Remarks

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

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

CloudformationResource: AWS::Backup::LogicallyAirGappedBackupVault

ExampleMetadata: fixture=_generated

EncryptionKeyArn

The server-side encryption key that is used to protect your backups;

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

string

Remarks

for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .

LogicallyAirGappedBackupVaultRef

A reference to a LogicallyAirGappedBackupVault resource.

public virtual ILogicallyAirGappedBackupVaultReference LogicallyAirGappedBackupVaultRef { get; }
Property Value

ILogicallyAirGappedBackupVaultReference

Remarks

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

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

CloudformationResource: AWS::Backup::LogicallyAirGappedBackupVault

ExampleMetadata: fixture=_generated

MaxRetentionDays

The maximum retention period that the vault retains its recovery points.

public virtual double MaxRetentionDays { get; set; }
Property Value

double

Remarks

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

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

CloudformationResource: AWS::Backup::LogicallyAirGappedBackupVault

ExampleMetadata: fixture=_generated

MinRetentionDays

This setting specifies the minimum retention period that the vault retains its recovery points.

public virtual double MinRetentionDays { get; set; }
Property Value

double

Remarks

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

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

CloudformationResource: AWS::Backup::LogicallyAirGappedBackupVault

ExampleMetadata: fixture=_generated

MpaApprovalTeamArn

The Amazon Resource Name (ARN) of the MPA approval team to associate with the backup vault.

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

string

Remarks

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

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

CloudformationResource: AWS::Backup::LogicallyAirGappedBackupVault

ExampleMetadata: fixture=_generated

Notifications

Returns event notifications for the specified backup vault.

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

object

Remarks

Type union: either IResolvable or CfnLogicallyAirGappedBackupVault.INotificationObjectTypeProperty

Methods

ArnForLogicallyAirGappedBackupVault(ILogicallyAirGappedBackupVaultRef)

Creates a logical container to where backups may be copied.

public static string ArnForLogicallyAirGappedBackupVault(ILogicallyAirGappedBackupVaultRef resource)
Parameters
resource ILogicallyAirGappedBackupVaultRef
Returns

string

Remarks

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

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

CloudformationResource: AWS::Backup::LogicallyAirGappedBackupVault

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 cfnLogicallyAirGappedBackupVault = new CfnLogicallyAirGappedBackupVault(this, "MyCfnLogicallyAirGappedBackupVault", new CfnLogicallyAirGappedBackupVaultProps {
                 BackupVaultName = "backupVaultName",
                 MaxRetentionDays = 123,
                 MinRetentionDays = 123,

                 // the properties below are optional
                 AccessPolicy = accessPolicy,
                 BackupVaultTags = new Dictionary<string, string> {
                     { "backupVaultTagsKey", "backupVaultTags" }
                 },
                 EncryptionKeyArn = "encryptionKeyArn",
                 MpaApprovalTeamArn = "mpaApprovalTeamArn",
                 Notifications = new NotificationObjectTypeProperty {
                     BackupVaultEvents = new [] { "backupVaultEvents" },
                     SnsTopicArn = "snsTopicArn"
                 }
             });

FromBackupVaultName(Construct, string, string)

Creates a new ILogicallyAirGappedBackupVaultRef from a backupVaultName.

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

ILogicallyAirGappedBackupVaultRef

Remarks

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

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

CloudformationResource: AWS::Backup::LogicallyAirGappedBackupVault

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

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

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

CloudformationResource: AWS::Backup::LogicallyAirGappedBackupVault

ExampleMetadata: fixture=_generated

IsCfnLogicallyAirGappedBackupVault(object)

Checks whether the given object is a CfnLogicallyAirGappedBackupVault.

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

bool

Remarks

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

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

CloudformationResource: AWS::Backup::LogicallyAirGappedBackupVault

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a logical container to where backups may be copied.

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

IDictionary<string, object>

Overrides
Remarks

This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.

Do not include sensitive data, such as passport numbers, in the name of a backup vault.

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

CloudformationResource: AWS::Backup::LogicallyAirGappedBackupVault

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable