OtsBackupPlan

• Implements: IOtsBackupPlan

This class encapsulates and extends the ROS resource type ALIYUN::HBR::OtsBackupPlan.

Initializers

import ros_cdk_hbr
ros_cdk_hbr.OtsBackupPlan(
  scope: Construct,
  id: str,
  backup_type: typing.Union[str, IResolvable],
  plan_name: typing.Union[str, IResolvable],
  retention: typing.Union[typing.Union[int, float], IResolvable],
  schedule: typing.Union[str, IResolvable],
  vault_id: typing.Union[str, IResolvable],
  cross_account_role_name: typing.Union[str, IResolvable] = None,
  cross_account_type: typing.Union[str, IResolvable] = None,
  cross_account_user_id: typing.Union[str, IResolvable] = None,
  disabled: typing.Union[bool, IResolvable] = None,
  instance_name: typing.Union[str, IResolvable] = None,
  ots_detail: typing.Union[IResolvable, OtsDetailProperty] = None,
  rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, RulesProperty]]] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

backup_type^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property backupType: Backup type.

Valid values: COMPLETE.

plan_name^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property planName: The name of the backup plan.

1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.

retention^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property retention: Backup retention days, the minimum is 1.

schedule^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property schedule: The backup policy.

The format is I|{startTime}|{interval}. This specifies that a backup job runs at an interval of {interval}, starting from {startTime}. Overdue backup jobs are not retried. If the previous backup job is not complete, the next backup job is not triggered. For example, I|1631685600|P1D indicates that a backup job runs daily starting from 14:00:00 on September 15, 2021.

• startTime: The start time for the backup, specified as a UNIX timestamp in seconds.
• interval: The backup interval, specified in the ISO 8601 duration format. For example, PT1H represents one hour and P1D represents one day.

vault_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vaultId: The ID of backup vault.

cross_account_role_name^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property crossAccountRoleName: The role name created in the original account RAM backup by the cross account managed by the current account.

cross_account_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property crossAccountType: The type of the cross account backup.

Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.

cross_account_user_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property crossAccountUserId: The original account ID of the cross account backup managed by the current account.

disabled^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property disabled: Whether to disable the backup task.

Valid values: true, false.

instance_name^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceName: The name of the Table store instance.

ots_detail^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, OtsDetailProperty]

Property otsDetail: The details about the Table store instance.

rules^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, RulesProperty]]]

Property rules: The backup plan rule.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_hbr
ros_cdk_hbr.OtsBackupPlan.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_plan_id^Required

attr_plan_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute PlanId: The ID of the backup plan.

props^Required

props: OtsBackupPlanProps

• Type: OtsBackupPlanProps