Skip to content

Download

This class encapsulates and extends the ROS resource type ALIYUN::DBS::Download, which is used to create an advanced download task.

Initializers 

import ros_cdk_dbs
ros_cdk_dbs.Download(
  scope: Construct,
  id: str,
  format_type: typing.Union[str, IResolvable],
  instance_name: typing.Union[str, IResolvable],
  bak_set_id: typing.Union[str, IResolvable] = None,
  bak_set_size: typing.Union[str, IResolvable] = None,
  bak_set_type: typing.Union[str, IResolvable] = None,
  delete_backup_set_in_oss: typing.Union[bool, IResolvable] = None,
  download_address_duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  download_point_in_time: typing.Union[str, IResolvable] = None,
  target_bucket: typing.Union[str, IResolvable] = None,
  target_oss_region: typing.Union[str, IResolvable] = None,
  target_path: typing.Union[str, IResolvable] = None,
  target_type: 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.
format_type typing.Union[str, ros_cdk_core.IResolvable] Property formatType: The format to which the downloaded backup set is converted.
instance_name typing.Union[str, ros_cdk_core.IResolvable] Property instanceName: The ID of the instance.
bak_set_id typing.Union[str, ros_cdk_core.IResolvable] Property bakSetId: The ID of the backup set.
bak_set_size typing.Union[str, ros_cdk_core.IResolvable] Property bakSetSize: The size of the full backup set.
bak_set_type typing.Union[str, ros_cdk_core.IResolvable] Property bakSetType: The type of the download task.
delete_backup_set_in_oss typing.Union[bool, ros_cdk_core.IResolvable] Property deleteBackupSetInOss: Whether to delete the backup set in OSS when deleting the stack.
download_address_duration typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property downloadAddressDuration: When the download target is a URL, set the link validity period.
download_point_in_time typing.Union[str, ros_cdk_core.IResolvable] Property downloadPointInTime: The point in time at which the backup set is downloaded.
target_bucket typing.Union[str, ros_cdk_core.IResolvable] Property targetBucket: The name of the OSS bucket that is used to store the backup set.
target_oss_region typing.Union[str, ros_cdk_core.IResolvable] Property targetOssRegion: The region in which the OSS bucket resides.
target_path typing.Union[str, ros_cdk_core.IResolvable] Property targetPath: The destination path to which the backup set is downloaded.
target_type typing.Union[str, ros_cdk_core.IResolvable] Property targetType: The type of the destination to which the backup set is downloaded.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

format_typeRequired

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

Property formatType: The format to which the downloaded backup set is converted.

Valid values: CSV|SQL|Parquet

instance_nameRequired

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

Property instanceName: The ID of the instance.

bak_set_idOptional

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

Property bakSetId: The ID of the backup set.

You can call the DescribeBackups operation to query the ID of the backup set. This parameter is required if the BakSetType parameter is set to full.

bak_set_sizeOptional

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

Property bakSetSize: The size of the full backup set.

Unit: bytes. You can call the DescribeBackups operation to query the size of the full backup set.

bak_set_typeOptional

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

Property bakSetType: The type of the download task.

Valid values: full: downloads a full backup set pitr: downloads a backup set at a specific point in time.

delete_backup_set_in_ossOptional

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

Property deleteBackupSetInOss: Whether to delete the backup set in OSS when deleting the stack.

Valid values: true|false, default is true.

download_address_durationOptional

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

Property downloadAddressDuration: When the download target is a URL, set the link validity period.

The default URL validity period is 7200 seconds. The effective duration range can be set from 300 seconds to 86400 seconds

download_point_in_timeOptional

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

Property downloadPointInTime: The point in time at which the backup set is downloaded.

Specify a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. This parameter is required if the BakSetType parameter is set to pitr.

target_bucketOptional

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

Property targetBucket: The name of the OSS bucket that is used to store the backup set.

This parameter is required if the TargetType parameter is set to OSS. Make sure that your account is granted the AliyunDBSDefaultRole permission. For more information, see Use RAM for resource authorization. You can also grant permissions based on the operation instructions in the Resource Access Management (RAM) console.

target_oss_regionOptional

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

Property targetOssRegion: The region in which the OSS bucket resides.

This parameter is required if the TargetType parameter is set to OSS.

target_pathOptional

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

Property targetPath: The destination path to which the backup set is downloaded.

This parameter is required if the TargetType parameter is set to OSS.

target_typeOptional

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

Property targetType: The type of the destination to which the backup set is downloaded.

Valid values: OSS|URL

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 

import ros_cdk_dbs
ros_cdk_dbs.Download.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_bak_set_id ros_cdk_core.IResolvable Attribute BakSetId: The ID of the backup set.
attr_download_address_info ros_cdk_core.IResolvable Attribute DownloadAddressInfo: The download address information.
attr_instance_name ros_cdk_core.IResolvable Attribute InstanceName: The ID of the instance.
attr_task_id ros_cdk_core.IResolvable Attribute TaskId: The ID of the download task.

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_bak_set_idRequired 

attr_bak_set_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BakSetId: The ID of the backup set.

attr_download_address_infoRequired 

attr_download_address_info: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DownloadAddressInfo: The download address information.

attr_instance_nameRequired 

attr_instance_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceName: The ID of the instance.

attr_task_idRequired 

attr_task_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute TaskId: The ID of the download task.