Show / Hide Table of Contents

Class CfnRestoreTestingPlan

Creates a restore testing plan.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnRestoreTestingPlan
Implements
IInspectable
IRestoreTestingPlanRef
IConstruct
IDependable
IEnvironmentAware
ITaggableV2
Inherited Members
CfnResource.IsCfnResource(object)
CfnResource.AddDeletionOverride(string)
CfnResource.AddDependency(CfnResource)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(string, object)
CfnResource.AddOverride(string, object)
CfnResource.AddPropertyDeletionOverride(string)
CfnResource.AddPropertyOverride(string, object)
CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)
CfnResource.CfnPropertyName(string)
CfnResource.GetAtt(string, ResolutionTypeHint?)
CfnResource.GetMetadata(string)
CfnResource.ObtainDependencies()
CfnResource.ObtainResourceDependencies()
CfnResource.RemoveDependency(CfnResource)
CfnResource.ReplaceDependency(CfnResource, CfnResource)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.Env
CfnResource.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(object)
CfnElement.OverrideLogicalId(string)
CfnElement.With(params IMixin[])
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Namespace: Amazon.CDK.AWS.Backup
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnRestoreTestingPlan : CfnResource, IInspectable, IRestoreTestingPlanRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Syntax (vb)
Public Class CfnRestoreTestingPlan Inherits CfnResource Implements IInspectable, IRestoreTestingPlanRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Remarks

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

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

CloudformationResource: AWS::Backup::RestoreTestingPlan

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 cfnRestoreTestingPlan = new CfnRestoreTestingPlan(this, "MyCfnRestoreTestingPlan", new CfnRestoreTestingPlanProps {
                 RecoveryPointSelection = new RestoreTestingRecoveryPointSelectionProperty {
                     Algorithm = "algorithm",
                     IncludeVaults = new [] { "includeVaults" },
                     RecoveryPointTypes = new [] { "recoveryPointTypes" },

                     // the properties below are optional
                     ExcludeVaults = new [] { "excludeVaults" },
                     SelectionWindowDays = 123
                 },
                 RestoreTestingPlanName = "restoreTestingPlanName",
                 ScheduleExpression = "scheduleExpression",

                 // the properties below are optional
                 ScheduleExpressionTimezone = "scheduleExpressionTimezone",
                 StartWindowHours = 123,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnRestoreTestingPlan(Construct, string, ICfnRestoreTestingPlanProps)

Create a new AWS::Backup::RestoreTestingPlan.

Properties

AttrRestoreTestingPlanArn

An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.

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 restore testing plan.

CfnPropertyNames

Creates a restore testing plan.

RecoveryPointSelection

The specified criteria to assign a set of resources, such as recovery point types or backup vaults.

RestoreTestingPlanName

The RestoreTestingPlanName is a unique string that is the name of the restore testing plan.

RestoreTestingPlanRef

A reference to a RestoreTestingPlan resource.

ScheduleExpression

A CRON expression in specified timezone when a restore testing plan is executed.

ScheduleExpressionTimezone

Optional.

StartWindowHours

Defaults to 24 hours.

Tags

Optional tags to include.

Methods

ArnForRestoreTestingPlan(IRestoreTestingPlanRef)

Creates a restore testing plan.

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

IsCfnRestoreTestingPlan(object)

Checks whether the given object is a CfnRestoreTestingPlan.

RenderProperties(IDictionary<string, object>)

Creates a restore testing plan.

Constructors

CfnRestoreTestingPlan(Construct, string, ICfnRestoreTestingPlanProps)

Create a new AWS::Backup::RestoreTestingPlan.

public CfnRestoreTestingPlan(Construct scope, string id, ICfnRestoreTestingPlanProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

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

props ICfnRestoreTestingPlanProps

Resource properties.

Remarks

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

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

CloudformationResource: AWS::Backup::RestoreTestingPlan

ExampleMetadata: fixture=_generated

Properties

AttrRestoreTestingPlanArn

An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.

public virtual string AttrRestoreTestingPlanArn { get; }
Property Value

string

Remarks

CloudformationAttribute: RestoreTestingPlanArn

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

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

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

CloudformationResource: AWS::Backup::RestoreTestingPlan

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

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

CloudformationResource: AWS::Backup::RestoreTestingPlan

ExampleMetadata: fixture=_generated

CfnProperties

Creates a restore testing plan.

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

IDictionary<string, object>

Overrides
CfnResource.CfnProperties
Remarks

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

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

CloudformationResource: AWS::Backup::RestoreTestingPlan

ExampleMetadata: fixture=_generated

CfnPropertyNames

Creates a restore testing plan.

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

IDictionary<string, string>

Overrides
CfnResource.CfnPropertyNames
Remarks

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

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

CloudformationResource: AWS::Backup::RestoreTestingPlan

ExampleMetadata: fixture=_generated

RecoveryPointSelection

The specified criteria to assign a set of resources, such as recovery point types or backup vaults.

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

object

Remarks

Type union: either IResolvable or CfnRestoreTestingPlan.IRestoreTestingRecoveryPointSelectionProperty

RestoreTestingPlanName

The RestoreTestingPlanName is a unique string that is the name of the restore testing plan.

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

string

Remarks

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

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

CloudformationResource: AWS::Backup::RestoreTestingPlan

ExampleMetadata: fixture=_generated

RestoreTestingPlanRef

A reference to a RestoreTestingPlan resource.

public virtual IRestoreTestingPlanReference RestoreTestingPlanRef { get; }
Property Value

IRestoreTestingPlanReference

Remarks

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

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

CloudformationResource: AWS::Backup::RestoreTestingPlan

ExampleMetadata: fixture=_generated

ScheduleExpression

A CRON expression in specified timezone when a restore testing plan is executed.

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

string

Remarks

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

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

CloudformationResource: AWS::Backup::RestoreTestingPlan

ExampleMetadata: fixture=_generated

ScheduleExpressionTimezone

Optional.

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

string

Remarks

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

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

CloudformationResource: AWS::Backup::RestoreTestingPlan

ExampleMetadata: fixture=_generated

StartWindowHours

Defaults to 24 hours.

public virtual double? StartWindowHours { get; set; }
Property Value

double?

Remarks

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

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

CloudformationResource: AWS::Backup::RestoreTestingPlan

ExampleMetadata: fixture=_generated

Tags

Optional tags to include.

public virtual ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

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

CloudformationResource: AWS::Backup::RestoreTestingPlan

ExampleMetadata: fixture=_generated

Methods

ArnForRestoreTestingPlan(IRestoreTestingPlanRef)

Creates a restore testing plan.

public static string ArnForRestoreTestingPlan(IRestoreTestingPlanRef resource)
Parameters
resource IRestoreTestingPlanRef
Returns

string

Remarks

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

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

CloudformationResource: AWS::Backup::RestoreTestingPlan

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 cfnRestoreTestingPlan = new CfnRestoreTestingPlan(this, "MyCfnRestoreTestingPlan", new CfnRestoreTestingPlanProps {
                 RecoveryPointSelection = new RestoreTestingRecoveryPointSelectionProperty {
                     Algorithm = "algorithm",
                     IncludeVaults = new [] { "includeVaults" },
                     RecoveryPointTypes = new [] { "recoveryPointTypes" },

                     // the properties below are optional
                     ExcludeVaults = new [] { "excludeVaults" },
                     SelectionWindowDays = 123
                 },
                 RestoreTestingPlanName = "restoreTestingPlanName",
                 ScheduleExpression = "scheduleExpression",

                 // the properties below are optional
                 ScheduleExpressionTimezone = "scheduleExpressionTimezone",
                 StartWindowHours = 123,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

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

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

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

CloudformationResource: AWS::Backup::RestoreTestingPlan

ExampleMetadata: fixture=_generated

IsCfnRestoreTestingPlan(object)

Checks whether the given object is a CfnRestoreTestingPlan.

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

bool

Remarks

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

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

CloudformationResource: AWS::Backup::RestoreTestingPlan

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a restore testing plan.

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

IDictionary<string, object>

Overrides
CfnResource.RenderProperties(IDictionary<string, object>)
Remarks

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

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

CloudformationResource: AWS::Backup::RestoreTestingPlan

ExampleMetadata: fixture=_generated

Implements

IInspectable
IRestoreTestingPlanRef
Constructs.IConstruct
Constructs.IDependable
IEnvironmentAware
ITaggableV2
Back to top Generated by DocFX