BackupPlan

• Implements: ros_cdk_dbs.datasource.IBackupPlan

This class encapsulates and extends the ROS resource type DATASOURCE::DBS::BackupPlan, which is used to query the information about a backup schedule.

Initializers

from ros_cdk_dbs import datasource
datasource.BackupPlan(
  scope: Construct,
  id: str,
  backup_plan_id: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

backup_plan_id^Required

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

Property backupPlanId: The ID of the backup plan.

refresh_options^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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

from ros_cdk_dbs import datasource
datasource.BackupPlan.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_backup_gateway_id^Required

attr_backup_gateway_id: typing.Union[str, IResolvable]

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

Attribute BackupGatewayId: The ID of the backup gateway.

attr_backup_method^Required

attr_backup_method: typing.Union[str, IResolvable]

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

Attribute BackupMethod: Backup method.

attr_backup_objects^Required

attr_backup_objects: typing.Union[str, IResolvable]

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

Attribute BackupObjects: The backup object.

attr_backup_period^Required

attr_backup_period: typing.Union[str, IResolvable]

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

Attribute BackupPeriod: Full backup cycle.

attr_backup_plan_id^Required

attr_backup_plan_id: typing.Union[str, IResolvable]

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

Attribute BackupPlanId: The ID of the backup plan.

attr_backup_plan_name^Required

attr_backup_plan_name: typing.Union[str, IResolvable]

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

Attribute BackupPlanName: The name of the backup plan.

attr_backup_retention_period^Required

attr_backup_retention_period: typing.Union[str, IResolvable]

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

Attribute BackupRetentionPeriod: The retention time of backup data.

Valid values: 0 to 1825. Default value: 730 days.

attr_backup_start_time^Required

attr_backup_start_time: typing.Union[str, IResolvable]

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

Attribute BackupStartTime: The start time of full Backup.

attr_backup_storage_type^Required

attr_backup_storage_type: typing.Union[str, IResolvable]

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

Attribute BackupStorageType: Built-in storage type:.

attr_create_time^Required

attr_create_time: typing.Union[str, IResolvable]

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

Attribute CreateTime: The creation time of the backup plans.

attr_cross_aliyun_id^Required

attr_cross_aliyun_id: typing.Union[str, IResolvable]

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

Attribute CrossAliyunId: The UID that is backed up across Alibaba cloud accounts.

attr_cross_role_name^Required

attr_cross_role_name: typing.Union[str, IResolvable]

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

Attribute CrossRoleName: The name of the RAM role that is backed up across Alibaba cloud accounts.

attr_database_type^Required

attr_database_type: typing.Union[str, IResolvable]

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

Attribute DatabaseType: Database type.

attr_duplication_archive_period^Required

attr_duplication_archive_period: typing.Union[str, IResolvable]

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

Attribute DuplicationArchivePeriod: The storage time for conversion to archive cold standby is 365 days by default.

attr_duplication_infrequent_access_period^Required

attr_duplication_infrequent_access_period: typing.Union[str, IResolvable]

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

Attribute DuplicationInfrequentAccessPeriod: The storage time is converted to low-frequency access.

The default time is 180 days.

attr_enable_backup_log^Required

attr_enable_backup_log: typing.Union[str, IResolvable]

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

Attribute EnableBackupLog: Whether to enable incremental log Backup.

attr_instance_class^Required

attr_instance_class: typing.Union[str, IResolvable]

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

Attribute InstanceClass: Instance class.

attr_oss_bucket_name^Required

attr_oss_bucket_name: typing.Union[str, IResolvable]

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

Attribute OssBucketName: OSS Bucket name.

attr_payment_type^Required

attr_payment_type: typing.Union[str, IResolvable]

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

Attribute PaymentType: The payment type of the resource.

attr_resource_group_id^Required

attr_resource_group_id: typing.Union[str, IResolvable]

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

Attribute ResourceGroupId: The ID of the resource group.

attr_source_endpoint_database_name^Required

attr_source_endpoint_database_name: typing.Union[str, IResolvable]

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

Attribute SourceEndpointDatabaseName: The name of the database.

attr_source_endpoint_instance_id^Required

attr_source_endpoint_instance_id: typing.Union[str, IResolvable]

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

Attribute SourceEndpointInstanceId: The ID of the database instance.

attr_source_endpoint_instance_type^Required

attr_source_endpoint_instance_type: typing.Union[str, IResolvable]

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

Attribute SourceEndpointInstanceType: The location of the database.

attr_source_endpoint_region^Required

attr_source_endpoint_region: typing.Union[str, IResolvable]

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

Attribute SourceEndpointRegion: The region of the database.

attr_source_endpoint_sid^Required

attr_source_endpoint_sid: typing.Union[str, IResolvable]

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

Attribute SourceEndpointSid: Oracle SID name.

attr_source_endpoint_user_name^Required

attr_source_endpoint_user_name: typing.Union[str, IResolvable]

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

Attribute SourceEndpointUserName: Database account.

props^Required

props: BackupPlanProps

• Type: BackupPlanProps