Skip to content

BackupPlan

This class encapsulates and extends the ROS resource type DATASOURCE::DBS::BackupPlan.

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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
backup_plan_id typing.Union[str, ros_cdk_core.IResolvable] Property backupPlanId: The ID of the backup plan.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

backup_plan_idRequired

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

Property backupPlanId: The ID of the backup plan.

refresh_optionsOptional

  • 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_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

from ros_cdk_dbs import datasource
datasource.BackupPlan.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_backup_gateway_id ros_cdk_core.IResolvable Attribute BackupGatewayId: The ID of the backup gateway.
attr_backup_method ros_cdk_core.IResolvable Attribute BackupMethod: Backup method.
attr_backup_objects ros_cdk_core.IResolvable Attribute BackupObjects: The backup object.
attr_backup_period ros_cdk_core.IResolvable Attribute BackupPeriod: Full backup cycle.
attr_backup_plan_id ros_cdk_core.IResolvable Attribute BackupPlanId: The ID of the backup plan.
attr_backup_plan_name ros_cdk_core.IResolvable Attribute BackupPlanName: The name of the backup plan.
attr_backup_retention_period ros_cdk_core.IResolvable Attribute BackupRetentionPeriod: The retention time of backup data.
attr_backup_start_time ros_cdk_core.IResolvable Attribute BackupStartTime: The start time of full Backup.
attr_backup_storage_type ros_cdk_core.IResolvable Attribute BackupStorageType: Built-in storage type:.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: The creation time of the backup plans.
attr_cross_aliyun_id ros_cdk_core.IResolvable Attribute CrossAliyunId: The UID that is backed up across Alibaba cloud accounts.
attr_cross_role_name ros_cdk_core.IResolvable Attribute CrossRoleName: The name of the RAM role that is backed up across Alibaba cloud accounts.
attr_database_type ros_cdk_core.IResolvable Attribute DatabaseType: Database type.
attr_duplication_archive_period 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 ros_cdk_core.IResolvable Attribute DuplicationInfrequentAccessPeriod: The storage time is converted to low-frequency access.
attr_enable_backup_log ros_cdk_core.IResolvable Attribute EnableBackupLog: Whether to enable incremental log Backup.
attr_instance_class ros_cdk_core.IResolvable Attribute InstanceClass: Instance class.
attr_oss_bucket_name ros_cdk_core.IResolvable Attribute OssBucketName: OSS Bucket name.
attr_payment_type ros_cdk_core.IResolvable Attribute PaymentType: The payment type of the resource.
attr_resource_group_id ros_cdk_core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attr_source_endpoint_database_name ros_cdk_core.IResolvable Attribute SourceEndpointDatabaseName: The name of the database.
attr_source_endpoint_instance_id ros_cdk_core.IResolvable Attribute SourceEndpointInstanceId: The ID of the database instance.
attr_source_endpoint_instance_type ros_cdk_core.IResolvable Attribute SourceEndpointInstanceType: The location of the database.
attr_source_endpoint_region ros_cdk_core.IResolvable Attribute SourceEndpointRegion: The region of the database.
attr_source_endpoint_sid ros_cdk_core.IResolvable Attribute SourceEndpointSid: Oracle SID name.
attr_source_endpoint_user_name ros_cdk_core.IResolvable Attribute SourceEndpointUserName: Database account.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_backup_gateway_idRequired 

attr_backup_gateway_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BackupGatewayId: The ID of the backup gateway.

attr_backup_methodRequired 

attr_backup_method: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BackupMethod: Backup method.

attr_backup_objectsRequired 

attr_backup_objects: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BackupObjects: The backup object.

attr_backup_periodRequired 

attr_backup_period: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BackupPeriod: Full backup cycle.

attr_backup_plan_idRequired 

attr_backup_plan_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BackupPlanId: The ID of the backup plan.

attr_backup_plan_nameRequired 

attr_backup_plan_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BackupPlanName: The name of the backup plan.

attr_backup_retention_periodRequired 

attr_backup_retention_period: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BackupRetentionPeriod: The retention time of backup data.

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

attr_backup_start_timeRequired 

attr_backup_start_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BackupStartTime: The start time of full Backup.

attr_backup_storage_typeRequired 

attr_backup_storage_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BackupStorageType: Built-in storage type:.

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: The creation time of the backup plans.

attr_cross_aliyun_idRequired 

attr_cross_aliyun_id: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_cross_role_nameRequired 

attr_cross_role_name: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_database_typeRequired 

attr_database_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DatabaseType: Database type.

attr_duplication_archive_periodRequired 

attr_duplication_archive_period: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_duplication_infrequent_access_periodRequired 

attr_duplication_infrequent_access_period: IResolvable
  • Type: ros_cdk_core.IResolvable

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

The default time is 180 days.

attr_enable_backup_logRequired 

attr_enable_backup_log: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EnableBackupLog: Whether to enable incremental log Backup.

attr_instance_classRequired 

attr_instance_class: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceClass: Instance class.

attr_oss_bucket_nameRequired 

attr_oss_bucket_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute OssBucketName: OSS Bucket name.

attr_payment_typeRequired 

attr_payment_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PaymentType: The payment type of the resource.

attr_resource_group_idRequired 

attr_resource_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attr_source_endpoint_database_nameRequired 

attr_source_endpoint_database_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SourceEndpointDatabaseName: The name of the database.

attr_source_endpoint_instance_idRequired 

attr_source_endpoint_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SourceEndpointInstanceId: The ID of the database instance.

attr_source_endpoint_instance_typeRequired 

attr_source_endpoint_instance_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SourceEndpointInstanceType: The location of the database.

attr_source_endpoint_regionRequired 

attr_source_endpoint_region: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SourceEndpointRegion: The region of the database.

attr_source_endpoint_sidRequired 

attr_source_endpoint_sid: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SourceEndpointSid: Oracle SID name.

attr_source_endpoint_user_nameRequired 

attr_source_endpoint_user_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SourceEndpointUserName: Database account.