Interface CfnBackupPlan.IBackupRuleResourceTypeProperty

Specifies an object containing properties used to schedule a task to back up a selection of resources.

Namespace: Amazon.CDK.AWS.Backup
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnBackupPlan.IBackupRuleResourceTypeProperty
Syntax (vb)
Public Interface CfnBackupPlan.IBackupRuleResourceTypeProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.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 backupRuleResourceTypeProperty = new BackupRuleResourceTypeProperty {
                 RuleName = "ruleName",
                 TargetBackupVault = "targetBackupVault",

                 // the properties below are optional
                 CompletionWindowMinutes = 123,
                 CopyActions = new [] { new CopyActionResourceTypeProperty {
                     DestinationBackupVaultArn = "destinationBackupVaultArn",

                     // the properties below are optional
                     Lifecycle = new LifecycleResourceTypeProperty {
                         DeleteAfterDays = 123,
                         MoveToColdStorageAfterDays = 123,
                         OptInToArchiveForSupportedResources = false
                     }
                 } },
                 EnableContinuousBackup = false,
                 IndexActions = new [] { new IndexActionsResourceTypeProperty {
                     ResourceTypes = new [] { "resourceTypes" }
                 } },
                 Lifecycle = new LifecycleResourceTypeProperty {
                     DeleteAfterDays = 123,
                     MoveToColdStorageAfterDays = 123,
                     OptInToArchiveForSupportedResources = false
                 },
                 RecoveryPointTags = new Dictionary<string, string> {
                     { "recoveryPointTagsKey", "recoveryPointTags" }
                 },
                 ScanActions = new [] { new ScanActionResourceTypeProperty {
                     MalwareScanner = "malwareScanner",
                     ScanMode = "scanMode"
                 } },
                 ScheduleExpression = "scheduleExpression",
                 ScheduleExpressionTimezone = "scheduleExpressionTimezone",
                 StartWindowMinutes = 123,
                 TargetLogicallyAirGappedBackupVaultArn = "targetLogicallyAirGappedBackupVaultArn"
             };

Synopsis

Properties

CompletionWindowMinutes

A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup .
CopyActions

An array of CopyAction objects, which contains the details of the copy operation.
EnableContinuousBackup

Enables continuous backup and point-in-time restores (PITR).
IndexActions

There can up to one IndexAction in each BackupRule, as each backup can have 0 or 1 backup index associated with it.
Lifecycle

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
RecoveryPointTags

The tags to assign to the resources.
RuleName

A display name for a backup rule.
ScanActions

Specifies an object containing properties used to schedule a task to back up a selection of resources.
ScheduleExpression

A CRON expression specifying when AWS Backup initiates a backup job.
ScheduleExpressionTimezone

This is the timezone in which the schedule expression is set.
StartWindowMinutes

An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully.
TargetBackupVault

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

The ARN of a logically air-gapped vault.

Properties

CompletionWindowMinutes

A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup .

double? CompletionWindowMinutes { get; }
Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-completionwindowminutes

CopyActions

An array of CopyAction objects, which contains the details of the copy operation.

object? CopyActions { get; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-copyactions

Type union: either IResolvable or (either IResolvable or CfnBackupPlan.ICopyActionResourceTypeProperty)[]

EnableContinuousBackup

Enables continuous backup and point-in-time restores (PITR).

object? EnableContinuousBackup { get; }
Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-enablecontinuousbackup

Type union: either bool or IResolvable

IndexActions

There can up to one IndexAction in each BackupRule, as each backup can have 0 or 1 backup index associated with it.

object? IndexActions { get; }
Property Value

object

Remarks

Within the array is ResourceTypes. Only 1 resource type will be accepted for each BackupRule. Valid values:

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-indexactions

    Type union: either IResolvable or (either IResolvable or CfnBackupPlan.IIndexActionsResourceTypeProperty)[]

    Lifecycle

    The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.

    object? Lifecycle { get; }
    Property Value

    object

    Remarks

    AWS Backup transitions and expires backups automatically according to the lifecycle that you define.

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-lifecycle

    Type union: either IResolvable or CfnBackupPlan.ILifecycleResourceTypeProperty

    RecoveryPointTags

    The tags to assign to the resources.

    object? RecoveryPointTags { get; }
    Property Value

    object

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-recoverypointtags

    Type union: either Dictionary<string, string> or IResolvable

    RuleName

    A display name for a backup rule.

    string RuleName { get; }
    Property Value

    string

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-rulename

    ScanActions

    Specifies an object containing properties used to schedule a task to back up a selection of resources.

    object? ScanActions { get; }
    Property Value

    object

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-scanactions

    Type union: either IResolvable or (either IResolvable or CfnBackupPlan.IScanActionResourceTypeProperty)[]

    ScheduleExpression

    A CRON expression specifying when AWS Backup initiates a backup job.

    string? ScheduleExpression { get; }
    Property Value

    string

    Remarks

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-scheduleexpression

    ScheduleExpressionTimezone

    This is the timezone in which the schedule expression is set.

    string? ScheduleExpressionTimezone { get; }
    Property Value

    string

    Remarks

    By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-scheduleexpressiontimezone

    StartWindowMinutes

    An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully.

    double? StartWindowMinutes { get; }
    Property Value

    double?

    Remarks

    If this value is included, it must be at least 60 minutes to avoid errors.

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-startwindowminutes

    TargetBackupVault

    The name of a logical container where backups are stored.

    string TargetBackupVault { get; }
    Property Value

    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 letters, numbers, and hyphens.

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-targetbackupvault

    TargetLogicallyAirGappedBackupVaultArn

    The ARN of a logically air-gapped vault.

    string? TargetLogicallyAirGappedBackupVaultArn { get; }
    Property Value

    string

    Remarks

    ARN must be in the same account and Region. If provided, supported fully managed resources back up directly to logically air-gapped vault, while other supported resources create a temporary (billable) snapshot in backup vault, then copy it to logically air-gapped vault. Unsupported resources only back up to the specified backup vault.

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupplan-backupruleresourcetype.html#cfn-backup-backupplan-backupruleresourcetype-targetlogicallyairgappedbackupvaultarn