RosDbPlan

This class is a base encapsulation around the ROS resource type ALIYUN::HBR::DbPlan, which is used to create a backup plan.

Initializers

using AlibabaCloud.SDK.ROS.CDK.Hbr;
new RosDbPlan(Construct Scope, string Id, RosDbPlanProps Props, bool EnableResourcePropertyConstraint);

Name	Type	Description
Scope	AlibabaCloud.SDK.ROS.CDK.Core.Construct	- scope in which this resource is defined.
Id	string	- scoped id of the resource.
Props	RosDbPlanProps	- resource properties.
EnableResourcePropertyConstraint	bool	No description.

---

Scope^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

scope in which this resource is defined.

---

Id^Required

• Type: string

scoped id of the resource.

---

Props^Required

• Type: RosDbPlanProps

resource properties.

---

EnableResourcePropertyConstraint^Required

• Type: bool

---

Methods

Name	Description
ToString	Returns a string representation of this construct.
Synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
OverrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
AddCondition	No description.
AddCount	No description.
AddDeletionOverride	Syntactic sugar for addOverride(path, undefined).
AddDependsOn	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
AddDesc	No description.
AddMetaData	No description.
AddOverride	Adds an override to the synthesized ROS resource.
AddPropertyDeletionOverride	Adds an override that deletes the value of a property from the resource definition.
AddPropertyOverride	Adds an override to a resource property.
AddRosDependency	No description.
ApplyRemovalPolicy	Sets the deletion policy of the resource based on the removal policy specified.
GetAtt	Returns a token for an runtime attribute of this resource.

---

ToString

private string ToString()

Returns a string representation of this construct.

Synthesize

private void Synthesize(ISynthesisSession Session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

Session^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

Overrides the auto-generated logical ID with a specific ID.

NewLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

AddCondition

private void AddCondition(RosCondition Con)

Con^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

---

AddCount

private void AddCount(object Count)

Count^Required

• Type: object

---

AddDeletionOverride

private void AddDeletionOverride(string Path)

Syntactic sugar for addOverride(path, undefined).

Path^Required

• Type: string

The path of the value to delete.

---

AddDependsOn

private void AddDependsOn(RosResource Target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Target^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

---

AddDesc

private void AddDesc(string Desc)

Desc^Required

• Type: string

---

AddMetaData

private void AddMetaData(string Key, object Value)

Key^Required

• Type: string

---

Value^Required

• Type: object

---

AddOverride

private void AddOverride(string Path, object Value)

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

Path^Required

• Type: string

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.

---

Value^Required

• Type: object

The value.

Could be primitive or complex.

---

AddPropertyDeletionOverride

private void AddPropertyDeletionOverride(string PropertyPath)

Adds an override that deletes the value of a property from the resource definition.

PropertyPath^Required

• Type: string

The path to the property.

---

AddPropertyOverride

private void AddPropertyOverride(string PropertyPath, object Value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

PropertyPath^Required

• Type: string

The path of the property.

---

Value^Required

• Type: object

The value.

---

AddRosDependency

private void AddRosDependency(string Target)

Target^Required

• Type: string

---

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy = null, RemovalPolicyOptions Options = null)

Sets the deletion policy of the resource based on the removal policy specified.

Policy^Optional

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

---

Options^Optional

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicyOptions

---

GetAtt

private Reference GetAtt(string AttributeName)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

AttributeName^Required

• Type: string

The name of the attribute.

---

Static Functions

Name	Description
IsConstruct	Return whether the given object is a Construct.
IsRosElement	Returns true if a construct is a stack element (i.e. part of the synthesized template).
IsRosResource	Check whether the given construct is a RosResource.

---

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Hbr;
RosDbPlan.IsConstruct(object X);

Return whether the given object is a Construct.

X^Required

• Type: object

---

IsRosElement

using AlibabaCloud.SDK.ROS.CDK.Hbr;
RosDbPlan.IsRosElement(object X);

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

X^Required

• Type: object

---

IsRosResource

using AlibabaCloud.SDK.ROS.CDK.Hbr;
RosDbPlan.IsRosResource(IConstruct Construct);

Check whether the given construct is a RosResource.

Construct^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IConstruct

---

Properties

Name	Type	Description
Node	AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode	The construct tree node associated with this construct.
CreationStack	string[]	No description.
LogicalId	string	The logical ID for this stack element.
Stack	AlibabaCloud.SDK.ROS.CDK.Core.Stack	The stack in which this element is defined.
Ref	string	Return a string that will be resolved to a RosTemplate { Ref } for this element.
RosOptions	AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions	Options for this resource, such as condition, update policy etc.
RosResourceType	string	ROS resource type.
AttrContinuousPlan	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrContinuousUuid	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrCumulativePlan	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrCumulativeUuid	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrDbPlanName	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrFullPlan	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrFullUuid	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrHostUuid	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrIncPlan	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrIncUuid	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrInstanceUuid	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrLogPlan	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrLogUuid	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrMaxRateLimit	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrMaxRetrySeconds	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrOptions	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrPlanId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrSourceType	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrTarget	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
AttrVaultId	AlibabaCloud.SDK.ROS.CDK.Core.IResolvable	No description.
DbPlanName	object	No description.
EnableResourcePropertyConstraint	bool	No description.
HostUuid	object	No description.
SourceType	object	No description.
VaultId	object	No description.
ContinuousPlan	object	No description.
CumulativePlan	object	No description.
FullPlan	object	No description.
IncPlan	object	No description.
InstanceUuid	object	No description.
LogPlan	object	No description.
MaxRateLimit	object	No description.
MaxRetrySeconds	object	No description.
Options	object	No description.
Source	object	No description.

---

Node^Required

public ConstructNode Node { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.

---

CreationStack^Required

public string[] CreationStack { get; }

• Type: string[]

---

LogicalId^Required

public string LogicalId { get; }

• Type: string

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

Stack^Required

public Stack Stack { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

---

Ref^Required

public string Ref { get; }

• Type: string

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

RosOptions^Required

public IRosResourceOptions RosOptions { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IRosResourceOptions

Options for this resource, such as condition, update policy etc.

---

RosResourceType^Required

public string RosResourceType { get; }

• Type: string

ROS resource type.

---

AttrContinuousPlan^Required

public IResolvable AttrContinuousPlan { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrContinuousUuid^Required

public IResolvable AttrContinuousUuid { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrCumulativePlan^Required

public IResolvable AttrCumulativePlan { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrCumulativeUuid^Required

public IResolvable AttrCumulativeUuid { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrDbPlanName^Required

public IResolvable AttrDbPlanName { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrFullPlan^Required

public IResolvable AttrFullPlan { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrFullUuid^Required

public IResolvable AttrFullUuid { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrHostUuid^Required

public IResolvable AttrHostUuid { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrIncPlan^Required

public IResolvable AttrIncPlan { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrIncUuid^Required

public IResolvable AttrIncUuid { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrInstanceUuid^Required

public IResolvable AttrInstanceUuid { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrLogPlan^Required

public IResolvable AttrLogPlan { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrLogUuid^Required

public IResolvable AttrLogUuid { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrMaxRateLimit^Required

public IResolvable AttrMaxRateLimit { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrMaxRetrySeconds^Required

public IResolvable AttrMaxRetrySeconds { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrOptions^Required

public IResolvable AttrOptions { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrPlanId^Required

public IResolvable AttrPlanId { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrSourceType^Required

public IResolvable AttrSourceType { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrTarget^Required

public IResolvable AttrTarget { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

AttrVaultId^Required

public IResolvable AttrVaultId { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

---

DbPlanName^Required

public object DbPlanName { get; }

• Type: object

---

EnableResourcePropertyConstraint^Required

public bool EnableResourcePropertyConstraint { get; }

• Type: bool

---

HostUuid^Required

public object HostUuid { get; }

• Type: object

---

SourceType^Required

public object SourceType { get; }

• Type: object

---

VaultId^Required

public object VaultId { get; }

• Type: object

---

ContinuousPlan^Optional

public object ContinuousPlan { get; }

• Type: object

---

CumulativePlan^Optional

public object CumulativePlan { get; }

• Type: object

---

FullPlan^Optional

public object FullPlan { get; }

• Type: object

---

IncPlan^Optional

public object IncPlan { get; }

• Type: object

---

InstanceUuid^Optional

public object InstanceUuid { get; }

• Type: object

---

LogPlan^Optional

public object LogPlan { get; }

• Type: object

---

MaxRateLimit^Optional

public object MaxRateLimit { get; }

• Type: object

---

MaxRetrySeconds^Optional

public object MaxRetrySeconds { get; }

• Type: object

---

Options^Optional

public object Options { get; }

• Type: object

---

Source^Optional

public object Source { get; }

• Type: object

---

Constants

Name	Type	Description
RosResourceTypeName	string	The resource type name for this resource class.

---

RosResourceTypeName^Required

public string RosResourceTypeName { get; }

• Type: string

The resource type name for this resource class.

---