alicloudroscdkhbr

package module
v1.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 22, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

README

Aliyun ROS HBR Construct Library

This module is part of the AliCloud ROS Cloud Development Kit (ROS CDK) project.

import * as HBR from '@alicloud/ros-cdk-hbr';

Documentation

Overview

Aliyun SDK Copyright (C) Alibaba Cloud Computing All rights reserved. http://www.aliyun.com

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BackupClients_IsConstruct 

func BackupClients_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func DbAgent_IsConstruct 

func DbAgent_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func DbPlan_IsConstruct 

func DbPlan_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func DbVault_IsConstruct 

func DbVault_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func NewBackupClients_Override 

func NewBackupClients_Override(b BackupClients, scope alicloudroscdkcore.Construct, id *string, props *BackupClientsProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewDbAgent_Override 

func NewDbAgent_Override(d DbAgent, scope alicloudroscdkcore.Construct, id *string, props *DbAgentProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewDbPlan_Override 

func NewDbPlan_Override(d DbPlan, scope alicloudroscdkcore.Construct, id *string, props *DbPlanProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewDbVault_Override 

func NewDbVault_Override(d DbVault, scope alicloudroscdkcore.Construct, id *string, props *DbVaultProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewRestoreJob_Override 

func NewRestoreJob_Override(r RestoreJob, scope alicloudroscdkcore.Construct, id *string, props *RestoreJobProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func NewRosBackupClients_Override 

func NewRosBackupClients_Override(r RosBackupClients, scope alicloudroscdkcore.Construct, id *string, props *RosBackupClientsProps, enableResourcePropertyConstraint *bool)

func NewRosDbAgent_Override 

func NewRosDbAgent_Override(r RosDbAgent, scope alicloudroscdkcore.Construct, id *string, props *RosDbAgentProps, enableResourcePropertyConstraint *bool)

func NewRosDbPlan_Override 

func NewRosDbPlan_Override(r RosDbPlan, scope alicloudroscdkcore.Construct, id *string, props *RosDbPlanProps, enableResourcePropertyConstraint *bool)

func NewRosDbVault_Override 

func NewRosDbVault_Override(r RosDbVault, scope alicloudroscdkcore.Construct, id *string, props *RosDbVaultProps, enableResourcePropertyConstraint *bool)

func NewRosRestoreJob_Override 

func NewRosRestoreJob_Override(r RosRestoreJob, scope alicloudroscdkcore.Construct, id *string, props *RosRestoreJobProps, enableResourcePropertyConstraint *bool)

func NewRosVault_Override 

func NewRosVault_Override(r RosVault, scope alicloudroscdkcore.Construct, id *string, props *RosVaultProps, enableResourcePropertyConstraint *bool)

func NewVault_Override 

func NewVault_Override(v Vault, scope alicloudroscdkcore.Construct, id *string, props *VaultProps, enableResourcePropertyConstraint *bool)

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

func RestoreJob_IsConstruct 

func RestoreJob_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosBackupClients_IsConstruct 

func RosBackupClients_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosBackupClients_IsRosElement 

func RosBackupClients_IsRosElement(x interface{}) *bool

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.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosBackupClients_IsRosResource 

func RosBackupClients_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosBackupClients_ROS_RESOURCE_TYPE_NAME 

func RosBackupClients_ROS_RESOURCE_TYPE_NAME() *string

func RosDbAgent_IsConstruct 

func RosDbAgent_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosDbAgent_IsRosElement 

func RosDbAgent_IsRosElement(x interface{}) *bool

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.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosDbAgent_IsRosResource 

func RosDbAgent_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosDbAgent_ROS_RESOURCE_TYPE_NAME 

func RosDbAgent_ROS_RESOURCE_TYPE_NAME() *string

func RosDbPlan_IsConstruct 

func RosDbPlan_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosDbPlan_IsRosElement 

func RosDbPlan_IsRosElement(x interface{}) *bool

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.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosDbPlan_IsRosResource 

func RosDbPlan_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosDbPlan_ROS_RESOURCE_TYPE_NAME 

func RosDbPlan_ROS_RESOURCE_TYPE_NAME() *string

func RosDbVault_IsConstruct 

func RosDbVault_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosDbVault_IsRosElement 

func RosDbVault_IsRosElement(x interface{}) *bool

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.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosDbVault_IsRosResource 

func RosDbVault_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosDbVault_ROS_RESOURCE_TYPE_NAME 

func RosDbVault_ROS_RESOURCE_TYPE_NAME() *string

func RosRestoreJob_IsConstruct 

func RosRestoreJob_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosRestoreJob_IsRosElement 

func RosRestoreJob_IsRosElement(x interface{}) *bool

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.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosRestoreJob_IsRosResource 

func RosRestoreJob_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosRestoreJob_ROS_RESOURCE_TYPE_NAME 

func RosRestoreJob_ROS_RESOURCE_TYPE_NAME() *string

func RosVault_IsConstruct 

func RosVault_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

func RosVault_IsRosElement 

func RosVault_IsRosElement(x interface{}) *bool

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.

Returns: The construct as a stack element or undefined if it is not a stack element.

func RosVault_IsRosResource 

func RosVault_IsRosResource(construct alicloudroscdkcore.IConstruct) *bool

Check whether the given construct is a RosResource.

func RosVault_ROS_RESOURCE_TYPE_NAME 

func RosVault_ROS_RESOURCE_TYPE_NAME() *string

func Vault_IsConstruct 

func Vault_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct.

Types

type BackupClients 

type BackupClients interface {
	alicloudroscdkcore.Resource
	// Attribute ClientIds: ID list of clients installed in instances.
	AttrClientIds() alicloudroscdkcore.IResolvable
	// Attribute InstanceIds: ID list of instances to install backup client.
	AttrInstanceIds() alicloudroscdkcore.IResolvable
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *BackupClientsProps
	SetProps(val *BackupClientsProps)
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::HBR::BackupClients`, which is used to install backup clients on Elastic Compute Service (ECS) instances.

func NewBackupClients 

func NewBackupClients(scope alicloudroscdkcore.Construct, id *string, props *BackupClientsProps, enableResourcePropertyConstraint *bool) BackupClients

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type BackupClientsProps 

type BackupClientsProps struct {
	// Property instanceIds: ID list of instances to install backup client.
	InstanceIds interface{} `field:"required" json:"instanceIds" yaml:"instanceIds"`
	// Property tags: Tags to attach to instance.
	//
	// Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.
	Tags *[]*RosBackupClients_TagsProperty `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `BackupClients`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbr-backupclients

type DbAgent 

type DbAgent interface {
	alicloudroscdkcore.Resource
	// Attribute InstanceIds: Uni backup agent instance ids.
	AttrInstanceIds() alicloudroscdkcore.IResolvable
	// Attribute TaskId: Uni backup agent install task id.
	AttrTaskId() alicloudroscdkcore.IResolvable
	// Attribute UniBackupInstanceDetails: Uni backup agent instance info details.
	AttrUniBackupInstanceDetails() alicloudroscdkcore.IResolvable
	// Attribute UniBackupInstances: Uni backup agent instance info.
	AttrUniBackupInstances() alicloudroscdkcore.IResolvable
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *DbAgentProps
	SetProps(val *DbAgentProps)
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::HBR::DbAgent`, which is used to install a Cloud Backup backup client for a database.

func NewDbAgent 

func NewDbAgent(scope alicloudroscdkcore.Construct, id *string, props *DbAgentProps, enableResourcePropertyConstraint *bool) DbAgent

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type DbAgentProps 

type DbAgentProps struct {
	// Property instanceInfo: Instance infos.
	InstanceInfo interface{} `field:"required" json:"instanceInfo" yaml:"instanceInfo"`
}

Properties for defining a `DbAgent`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbr-dbagent

type DbPlan 

type DbPlan interface {
	alicloudroscdkcore.Resource
	// Attribute ContinuousPlan: Continuous backup plan schedule.
	//
	// Use {   "type": "continuous" }.
	AttrContinuousPlan() alicloudroscdkcore.IResolvable
	// Attribute ContinuousUuid: Uuid of continuous backup plan.
	AttrContinuousUuid() alicloudroscdkcore.IResolvable
	// Attribute CumulativePlan: Cumulative plan schedule, only for mssql.
	//
	// More details see FullPlan.
	AttrCumulativePlan() alicloudroscdkcore.IResolvable
	// Attribute CumulativeUuid: Uuid of cumulative plan.
	AttrCumulativeUuid() alicloudroscdkcore.IResolvable
	// Attribute DbPlanName: Display name of the backup plan.
	AttrDbPlanName() alicloudroscdkcore.IResolvable
	// Attribute FullPlan: Full backup plan schedule.
	//
	// daily: {"type": "daily", "start": "00:00:00", "interval": 3}, weekly {"type":"weekly","start": "03:00:00","days": [1,2,3,4,5],"interval": 1}, days can be 0 - 6, 0 means Sunday, and interval can be 1 - 52.
	AttrFullPlan() alicloudroscdkcore.IResolvable
	// Attribute FullUuid: Uuid of full backup plan.
	AttrFullUuid() alicloudroscdkcore.IResolvable
	// Attribute HostUuid: Uuid of the host of the database instance.
	AttrHostUuid() alicloudroscdkcore.IResolvable
	// Attribute IncPlan: Incremental backup plan schedule.
	//
	// Only for mysql and oracle. More details see FullPlan.
	AttrIncPlan() alicloudroscdkcore.IResolvable
	// Attribute IncUuid: Uuid of the incremental bakcup plan.
	AttrIncUuid() alicloudroscdkcore.IResolvable
	// Attribute InstanceUuid: Uuid of database instance.
	AttrInstanceUuid() alicloudroscdkcore.IResolvable
	// Attribute LogPlan: Log backup plan schedule.More details see FullPlan.
	AttrLogPlan() alicloudroscdkcore.IResolvable
	// Attribute LogUuid: Uuid of the log backup plan.
	AttrLogUuid() alicloudroscdkcore.IResolvable
	// Attribute MaxRateLimit: Max rate limit for backup job,.
	AttrMaxRateLimit() alicloudroscdkcore.IResolvable
	// Attribute MaxRetrySeconds: Max retry seconds on network failure.
	AttrMaxRetrySeconds() alicloudroscdkcore.IResolvable
	// Attribute Options: Backup options in json format, different for each type of database.
	//
	// For Oracle, use {"channels":4,"compression":"lzop","offline_backup":false,"archivelog_reserve_hours":24,"custom_commands":""}, "channels" means numbers of concurrent theads, "archivelog_reserve_hours" means how long before the archive log will be deleted after backup job completed, other paramters should use the default vaule. For Mysql, use {"channels":4,"compression":"lzop","del_binlog":false}, "del_binlog" means whether the binlog will be deleted after backup completed, only take effect for log or continuous backup. For SQL Server, use {\"channels\":4,\"verify\":false,\"compression\":\"lzop\",\"backup_new_databases\":false}.
	AttrOptions() alicloudroscdkcore.IResolvable
	// Attribute PlanId: Id of the backup plan.
	AttrPlanId() alicloudroscdkcore.IResolvable
	// Attribute SourceType: Database type, allowed value: MYSQL, ORACLE, MSSQL.
	AttrSourceType() alicloudroscdkcore.IResolvable
	// Attribute Target: Target vault to backup.
	AttrTarget() alicloudroscdkcore.IResolvable
	// Attribute VaultId: Vault ID to create backup plan, the backup data will be stored to the vault.
	AttrVaultId() alicloudroscdkcore.IResolvable
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *DbPlanProps
	SetProps(val *DbPlanProps)
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::HBR::DbPlan`, which is used to create a backup plan.

func NewDbPlan 

func NewDbPlan(scope alicloudroscdkcore.Construct, id *string, props *DbPlanProps, enableResourcePropertyConstraint *bool) DbPlan

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type DbPlanProps 

type DbPlanProps struct {
	// Property dbPlanName: Display name of the backup plan.
	DbPlanName interface{} `field:"required" json:"dbPlanName" yaml:"dbPlanName"`
	// Property hostUuid: Uuid of the host of the database instance.
	HostUuid interface{} `field:"required" json:"hostUuid" yaml:"hostUuid"`
	// Property sourceType: Database type, allowed value: MYSQL, ORACLE, MSSQL.
	SourceType interface{} `field:"required" json:"sourceType" yaml:"sourceType"`
	// Property vaultId: Vault ID to create backup plan, the backup data will be stored to the vault.
	VaultId interface{} `field:"required" json:"vaultId" yaml:"vaultId"`
	// Property continuousPlan: Continuous backup plan schedule.
	//
	// Use {   "type": "continuous" }.
	ContinuousPlan interface{} `field:"optional" json:"continuousPlan" yaml:"continuousPlan"`
	// Property cumulativePlan: Cumulative plan schedule, only for mssql.
	//
	// More details see FullPlan.
	CumulativePlan interface{} `field:"optional" json:"cumulativePlan" yaml:"cumulativePlan"`
	// Property fullPlan: Full backup plan schedule.
	//
	// daily: {"type": "daily", "start": "00:00:00", "interval": 3}, weekly {"type":"weekly","start": "03:00:00","days": [1,2,3,4,5],"interval": 1}, days can be 0 - 6, 0 means Sunday, and interval can be 1 - 52.
	FullPlan interface{} `field:"optional" json:"fullPlan" yaml:"fullPlan"`
	// Property incPlan: Incremental backup plan schedule.
	//
	// Only for mysql and oracle. More details see FullPlan.
	IncPlan interface{} `field:"optional" json:"incPlan" yaml:"incPlan"`
	// Property instanceUuid: Uuid of database instance.
	InstanceUuid interface{} `field:"optional" json:"instanceUuid" yaml:"instanceUuid"`
	// Property logPlan: Log backup plan schedule.More details see FullPlan.
	LogPlan interface{} `field:"optional" json:"logPlan" yaml:"logPlan"`
	// Property maxRateLimit: Max rate limit for backup job,.
	MaxRateLimit interface{} `field:"optional" json:"maxRateLimit" yaml:"maxRateLimit"`
	// Property maxRetrySeconds: Max retry seconds on network failure.
	MaxRetrySeconds interface{} `field:"optional" json:"maxRetrySeconds" yaml:"maxRetrySeconds"`
	// Property options: Backup options in json format, different for each type of database.
	//
	// For Oracle, use {"channels":4,"compression":"lzop","offline_backup":false,"archivelog_reserve_hours":24,"custom_commands":""}, "channels" means numbers of concurrent theads, "archivelog_reserve_hours" means how long before the archive log will be deleted after backup job completed, other paramters should use the default vaule. For Mysql, use {"channels":4,"compression":"lzop","del_binlog":false}, "del_binlog" means whether the binlog will be deleted after backup completed, only take effect for log or continuous backup. For SQL Server, use {\"channels\":4,\"verify\":false,\"compression\":\"lzop\",\"backup_new_databases\":false}.
	Options interface{} `field:"optional" json:"options" yaml:"options"`
	// Property source: Which database instance or database will be backup.
	Source interface{} `field:"optional" json:"source" yaml:"source"`
}

Properties for defining a `DbPlan`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbr-dbplan

type DbVault 

type DbVault interface {
	alicloudroscdkcore.Resource
	// Attribute Description: Description of the vault.
	AttrDescription() alicloudroscdkcore.IResolvable
	// Attribute RetentionDays: Data retention days of the vault.
	//
	// Data will be deleted when it's older than this time.
	AttrRetentionDays() alicloudroscdkcore.IResolvable
	// Attribute VaultId: Vault ID.
	AttrVaultId() alicloudroscdkcore.IResolvable
	// Attribute VaultName: Display name of the vault.
	AttrVaultName() alicloudroscdkcore.IResolvable
	// Attribute VaultRegionId: The region ID to create the vault.
	AttrVaultRegionId() alicloudroscdkcore.IResolvable
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *DbVaultProps
	SetProps(val *DbVaultProps)
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::HBR::DbVault`, which is used to create a mirror vault.

func NewDbVault 

func NewDbVault(scope alicloudroscdkcore.Construct, id *string, props *DbVaultProps, enableResourcePropertyConstraint *bool) DbVault

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type DbVaultProps 

type DbVaultProps struct {
	// Property retentionDays: Data retention days of the vault.
	//
	// Data will be deleted when it's older than this time.
	RetentionDays interface{} `field:"required" json:"retentionDays" yaml:"retentionDays"`
	// Property vaultName: Display name of the vault.
	VaultName interface{} `field:"required" json:"vaultName" yaml:"vaultName"`
	// Property vaultRegionId: The region ID to create the vault.
	VaultRegionId interface{} `field:"required" json:"vaultRegionId" yaml:"vaultRegionId"`
	// Property description: Description of the vault.
	Description interface{} `field:"optional" json:"description" yaml:"description"`
	// Property tags: Tags to attach to instance.
	//
	// Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.
	Tags *[]*RosDbVault_TagsProperty `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `DbVault`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbr-dbvault

type RestoreJob 

type RestoreJob interface {
	alicloudroscdkcore.Resource
	// Attribute ErrorMessage: Error message of restore job.
	AttrErrorMessage() alicloudroscdkcore.IResolvable
	// Attribute RestoreId: Restore job ID.
	AttrRestoreId() alicloudroscdkcore.IResolvable
	// Attribute RestoreType: Restore type.
	AttrRestoreType() alicloudroscdkcore.IResolvable
	// Attribute SourceType: Source type.
	AttrSourceType() alicloudroscdkcore.IResolvable
	// Attribute Status: Restore job status.
	AttrStatus() alicloudroscdkcore.IResolvable
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *RestoreJobProps
	SetProps(val *RestoreJobProps)
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::HBR::RestoreJob`, which is used to create a restore job.

func NewRestoreJob 

func NewRestoreJob(scope alicloudroscdkcore.Construct, id *string, props *RestoreJobProps, enableResourcePropertyConstraint *bool) RestoreJob

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type RestoreJobProps 

type RestoreJobProps struct {
	// Property restoreType: Restore type.
	RestoreType interface{} `field:"required" json:"restoreType" yaml:"restoreType"`
	// Property snapshotId: Snapshot ID.
	SnapshotId interface{} `field:"required" json:"snapshotId" yaml:"snapshotId"`
	// Property sourceClientId: Source client ID.
	//
	// It should be provided when SourceType=FILE.
	SourceClientId interface{} `field:"required" json:"sourceClientId" yaml:"sourceClientId"`
	// Property sourceInstanceId: Source instance ID.
	//
	// It should be provided when SourceType=ECS_FILE.
	SourceInstanceId interface{} `field:"required" json:"sourceInstanceId" yaml:"sourceInstanceId"`
	// Property sourceType: Source type.
	SourceType interface{} `field:"required" json:"sourceType" yaml:"sourceType"`
	// Property targetClientId: Target client ID.
	//
	// It should be provided when RestoreType=FILE.
	TargetClientId interface{} `field:"required" json:"targetClientId" yaml:"targetClientId"`
	// Property targetInstanceId: Target instance ID.
	//
	// It should be provided when RestoreType=ECS_FILE.
	TargetInstanceId interface{} `field:"required" json:"targetInstanceId" yaml:"targetInstanceId"`
	// Property targetPath: Target path.
	//
	// For instance, "\/".
	TargetPath interface{} `field:"required" json:"targetPath" yaml:"targetPath"`
	// Property vaultId: Vault ID.
	VaultId interface{} `field:"required" json:"vaultId" yaml:"vaultId"`
}

Properties for defining a `RestoreJob`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbr-restorejob

type RosBackupClients 

type RosBackupClients interface {
	alicloudroscdkcore.RosResource
	AttrClientIds() alicloudroscdkcore.IResolvable
	AttrInstanceIds() alicloudroscdkcore.IResolvable
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	InstanceIds() interface{}
	SetInstanceIds(val interface{})
	// 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)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// 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 })`.
	Ref() *string
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	Tags() *[]*RosBackupClients_TagsProperty
	SetTags(val *[]*RosBackupClients_TagsProperty)
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// 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.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// 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,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	// 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.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::HBR::BackupClients`, which is used to install backup clients on Elastic Compute Service (ECS) instances.

func NewRosBackupClients 

func NewRosBackupClients(scope alicloudroscdkcore.Construct, id *string, props *RosBackupClientsProps, enableResourcePropertyConstraint *bool) RosBackupClients

type RosBackupClientsProps 

type RosBackupClientsProps struct {
	InstanceIds interface{}                       `field:"required" json:"instanceIds" yaml:"instanceIds"`
	Tags        *[]*RosBackupClients_TagsProperty `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `RosBackupClients`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbr-backupclients

type RosBackupClients_TagsProperty 

type RosBackupClients_TagsProperty struct {
	Key   interface{} `field:"required" json:"key" yaml:"key"`
	Value interface{} `field:"optional" json:"value" yaml:"value"`
}

type RosDbAgent 

type RosDbAgent interface {
	alicloudroscdkcore.RosResource
	AttrInstanceIds() alicloudroscdkcore.IResolvable
	AttrTaskId() alicloudroscdkcore.IResolvable
	AttrUniBackupInstanceDetails() alicloudroscdkcore.IResolvable
	AttrUniBackupInstances() alicloudroscdkcore.IResolvable
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	InstanceInfo() interface{}
	SetInstanceInfo(val interface{})
	// 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)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// 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 })`.
	Ref() *string
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// 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.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// 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,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	// 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.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::HBR::DbAgent`, which is used to install a Cloud Backup backup client for a database.

func NewRosDbAgent 

func NewRosDbAgent(scope alicloudroscdkcore.Construct, id *string, props *RosDbAgentProps, enableResourcePropertyConstraint *bool) RosDbAgent

type RosDbAgentProps 

type RosDbAgentProps struct {
	InstanceInfo interface{} `field:"required" json:"instanceInfo" yaml:"instanceInfo"`
}

Properties for defining a `RosDbAgent`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbr-dbagent

type RosDbAgent_InstanceInfoProperty 

type RosDbAgent_InstanceInfoProperty struct {
	InstanceId         interface{} `field:"required" json:"instanceId" yaml:"instanceId"`
	SourceType         interface{} `field:"required" json:"sourceType" yaml:"sourceType"`
	AuthenticationType interface{} `field:"optional" json:"authenticationType" yaml:"authenticationType"`
	Password           interface{} `field:"optional" json:"password" yaml:"password"`
	UserName           interface{} `field:"optional" json:"userName" yaml:"userName"`
}

type RosDbPlan 

type RosDbPlan interface {
	alicloudroscdkcore.RosResource
	AttrContinuousPlan() alicloudroscdkcore.IResolvable
	AttrContinuousUuid() alicloudroscdkcore.IResolvable
	AttrCumulativePlan() alicloudroscdkcore.IResolvable
	AttrCumulativeUuid() alicloudroscdkcore.IResolvable
	AttrDbPlanName() alicloudroscdkcore.IResolvable
	AttrFullPlan() alicloudroscdkcore.IResolvable
	AttrFullUuid() alicloudroscdkcore.IResolvable
	AttrHostUuid() alicloudroscdkcore.IResolvable
	AttrIncPlan() alicloudroscdkcore.IResolvable
	AttrIncUuid() alicloudroscdkcore.IResolvable
	AttrInstanceUuid() alicloudroscdkcore.IResolvable
	AttrLogPlan() alicloudroscdkcore.IResolvable
	AttrLogUuid() alicloudroscdkcore.IResolvable
	AttrMaxRateLimit() alicloudroscdkcore.IResolvable
	AttrMaxRetrySeconds() alicloudroscdkcore.IResolvable
	AttrOptions() alicloudroscdkcore.IResolvable
	AttrPlanId() alicloudroscdkcore.IResolvable
	AttrSourceType() alicloudroscdkcore.IResolvable
	AttrTarget() alicloudroscdkcore.IResolvable
	AttrVaultId() alicloudroscdkcore.IResolvable
	ContinuousPlan() interface{}
	SetContinuousPlan(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	CumulativePlan() interface{}
	SetCumulativePlan(val interface{})
	DbPlanName() interface{}
	SetDbPlanName(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	FullPlan() interface{}
	SetFullPlan(val interface{})
	HostUuid() interface{}
	SetHostUuid(val interface{})
	IncPlan() interface{}
	SetIncPlan(val interface{})
	InstanceUuid() interface{}
	SetInstanceUuid(val interface{})
	// 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)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	LogPlan() interface{}
	SetLogPlan(val interface{})
	MaxRateLimit() interface{}
	SetMaxRateLimit(val interface{})
	MaxRetrySeconds() interface{}
	SetMaxRetrySeconds(val interface{})
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	Options() interface{}
	SetOptions(val interface{})
	// 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 })`.
	Ref() *string
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	Source() interface{}
	SetSource(val interface{})
	SourceType() interface{}
	SetSourceType(val interface{})
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	VaultId() interface{}
	SetVaultId(val interface{})
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// 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.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// 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,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	// 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.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

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

func NewRosDbPlan 

func NewRosDbPlan(scope alicloudroscdkcore.Construct, id *string, props *RosDbPlanProps, enableResourcePropertyConstraint *bool) RosDbPlan

type RosDbPlanProps 

type RosDbPlanProps struct {
	DbPlanName      interface{} `field:"required" json:"dbPlanName" yaml:"dbPlanName"`
	HostUuid        interface{} `field:"required" json:"hostUuid" yaml:"hostUuid"`
	SourceType      interface{} `field:"required" json:"sourceType" yaml:"sourceType"`
	VaultId         interface{} `field:"required" json:"vaultId" yaml:"vaultId"`
	ContinuousPlan  interface{} `field:"optional" json:"continuousPlan" yaml:"continuousPlan"`
	CumulativePlan  interface{} `field:"optional" json:"cumulativePlan" yaml:"cumulativePlan"`
	FullPlan        interface{} `field:"optional" json:"fullPlan" yaml:"fullPlan"`
	IncPlan         interface{} `field:"optional" json:"incPlan" yaml:"incPlan"`
	InstanceUuid    interface{} `field:"optional" json:"instanceUuid" yaml:"instanceUuid"`
	LogPlan         interface{} `field:"optional" json:"logPlan" yaml:"logPlan"`
	MaxRateLimit    interface{} `field:"optional" json:"maxRateLimit" yaml:"maxRateLimit"`
	MaxRetrySeconds interface{} `field:"optional" json:"maxRetrySeconds" yaml:"maxRetrySeconds"`
	Options         interface{} `field:"optional" json:"options" yaml:"options"`
	Source          interface{} `field:"optional" json:"source" yaml:"source"`
}

Properties for defining a `RosDbPlan`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbr-dbplan

type RosDbPlan_SourceProperty 

type RosDbPlan_SourceProperty struct {
	Entries interface{} `field:"optional" json:"entries" yaml:"entries"`
}

type RosDbVault 

type RosDbVault interface {
	alicloudroscdkcore.RosResource
	AttrDescription() alicloudroscdkcore.IResolvable
	AttrRetentionDays() alicloudroscdkcore.IResolvable
	AttrVaultId() alicloudroscdkcore.IResolvable
	AttrVaultName() alicloudroscdkcore.IResolvable
	AttrVaultRegionId() alicloudroscdkcore.IResolvable
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	Description() interface{}
	SetDescription(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// 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 })`.
	Ref() *string
	RetentionDays() interface{}
	SetRetentionDays(val interface{})
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	Tags() *[]*RosDbVault_TagsProperty
	SetTags(val *[]*RosDbVault_TagsProperty)
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	VaultName() interface{}
	SetVaultName(val interface{})
	VaultRegionId() interface{}
	SetVaultRegionId(val interface{})
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// 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.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// 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,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	// 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.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::HBR::DbVault`, which is used to create a mirror vault.

func NewRosDbVault 

func NewRosDbVault(scope alicloudroscdkcore.Construct, id *string, props *RosDbVaultProps, enableResourcePropertyConstraint *bool) RosDbVault

type RosDbVaultProps 

type RosDbVaultProps struct {
	RetentionDays interface{}                 `field:"required" json:"retentionDays" yaml:"retentionDays"`
	VaultName     interface{}                 `field:"required" json:"vaultName" yaml:"vaultName"`
	VaultRegionId interface{}                 `field:"required" json:"vaultRegionId" yaml:"vaultRegionId"`
	Description   interface{}                 `field:"optional" json:"description" yaml:"description"`
	Tags          *[]*RosDbVault_TagsProperty `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `RosDbVault`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbr-dbvault

type RosDbVault_TagsProperty 

type RosDbVault_TagsProperty struct {
	Key   interface{} `field:"required" json:"key" yaml:"key"`
	Value interface{} `field:"optional" json:"value" yaml:"value"`
}

type RosRestoreJob 

type RosRestoreJob interface {
	alicloudroscdkcore.RosResource
	AttrErrorMessage() alicloudroscdkcore.IResolvable
	AttrRestoreId() alicloudroscdkcore.IResolvable
	AttrRestoreType() alicloudroscdkcore.IResolvable
	AttrSourceType() alicloudroscdkcore.IResolvable
	AttrStatus() alicloudroscdkcore.IResolvable
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	// 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)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// 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 })`.
	Ref() *string
	RestoreType() interface{}
	SetRestoreType(val interface{})
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	SnapshotId() interface{}
	SetSnapshotId(val interface{})
	SourceClientId() interface{}
	SetSourceClientId(val interface{})
	SourceInstanceId() interface{}
	SetSourceInstanceId(val interface{})
	SourceType() interface{}
	SetSourceType(val interface{})
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	TargetClientId() interface{}
	SetTargetClientId(val interface{})
	TargetInstanceId() interface{}
	SetTargetInstanceId(val interface{})
	TargetPath() interface{}
	SetTargetPath(val interface{})
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	VaultId() interface{}
	SetVaultId(val interface{})
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// 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.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// 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,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	// 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.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

This class is a base encapsulation around the ROS resource type `ALIYUN::HBR::RestoreJob`, which is used to create a restore job.

func NewRosRestoreJob 

func NewRosRestoreJob(scope alicloudroscdkcore.Construct, id *string, props *RosRestoreJobProps, enableResourcePropertyConstraint *bool) RosRestoreJob

type RosRestoreJobProps 

type RosRestoreJobProps struct {
	RestoreType      interface{} `field:"required" json:"restoreType" yaml:"restoreType"`
	SnapshotId       interface{} `field:"required" json:"snapshotId" yaml:"snapshotId"`
	SourceClientId   interface{} `field:"required" json:"sourceClientId" yaml:"sourceClientId"`
	SourceInstanceId interface{} `field:"required" json:"sourceInstanceId" yaml:"sourceInstanceId"`
	SourceType       interface{} `field:"required" json:"sourceType" yaml:"sourceType"`
	TargetClientId   interface{} `field:"required" json:"targetClientId" yaml:"targetClientId"`
	TargetInstanceId interface{} `field:"required" json:"targetInstanceId" yaml:"targetInstanceId"`
	TargetPath       interface{} `field:"required" json:"targetPath" yaml:"targetPath"`
	VaultId          interface{} `field:"required" json:"vaultId" yaml:"vaultId"`
}

Properties for defining a `RosRestoreJob`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbr-restorejob

type RosVault 

type RosVault interface {
	alicloudroscdkcore.RosResource
	AttrBackupPlanStatistics() alicloudroscdkcore.IResolvable
	AttrBytesDone() alicloudroscdkcore.IResolvable
	AttrCreateTime() alicloudroscdkcore.IResolvable
	AttrDedup() alicloudroscdkcore.IResolvable
	AttrDescription() alicloudroscdkcore.IResolvable
	AttrIndexAvailable() alicloudroscdkcore.IResolvable
	AttrIndexLevel() alicloudroscdkcore.IResolvable
	AttrIndexUpdateTime() alicloudroscdkcore.IResolvable
	AttrLatestReplicationTime() alicloudroscdkcore.IResolvable
	AttrPaymentType() alicloudroscdkcore.IResolvable
	AttrRedundancyType() alicloudroscdkcore.IResolvable
	AttrReplication() alicloudroscdkcore.IResolvable
	AttrReplicationProgress() alicloudroscdkcore.IResolvable
	AttrReplicationSourceRegionId() alicloudroscdkcore.IResolvable
	AttrReplicationSourceVaultId() alicloudroscdkcore.IResolvable
	AttrResourceGroupId() alicloudroscdkcore.IResolvable
	AttrRetention() alicloudroscdkcore.IResolvable
	AttrSearchEnabled() alicloudroscdkcore.IResolvable
	AttrSourceTypes() alicloudroscdkcore.IResolvable
	AttrStorageSize() alicloudroscdkcore.IResolvable
	AttrTags() alicloudroscdkcore.IResolvable
	AttrTrialInfo() alicloudroscdkcore.IResolvable
	AttrUpdatedTime() alicloudroscdkcore.IResolvable
	AttrVaultId() alicloudroscdkcore.IResolvable
	AttrVaultName() alicloudroscdkcore.IResolvable
	AttrVaultStatusMessage() alicloudroscdkcore.IResolvable
	AttrVaultStorageClass() alicloudroscdkcore.IResolvable
	AttrVaultType() alicloudroscdkcore.IResolvable
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aliyun:ros:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	Description() interface{}
	SetDescription(val interface{})
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	EncryptType() interface{}
	SetEncryptType(val interface{})
	KmsKeyId() interface{}
	SetKmsKeyId(val interface{})
	// 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)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	RedundancyType() interface{}
	SetRedundancyType(val interface{})
	// 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 })`.
	Ref() *string
	ResourceGroupId() interface{}
	SetResourceGroupId(val interface{})
	// Options for this resource, such as condition, update policy etc.
	RosOptions() alicloudroscdkcore.IRosResourceOptions
	RosProperties() *map[string]interface{}
	// ROS resource type.
	RosResourceType() *string
	// The stack in which this element is defined.
	//
	// RosElements must be defined within a stack scope (directly or indirectly).
	Stack() alicloudroscdkcore.Stack
	Tags() *[]*RosVault_TagsProperty
	SetTags(val *[]*RosVault_TagsProperty)
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	VaultName() interface{}
	SetVaultName(val interface{})
	VaultStorageClass() interface{}
	SetVaultStorageClass(val interface{})
	VaultType() interface{}
	SetVaultType(val interface{})
	AddCondition(con alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// 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.
	AddDependsOn(target alicloudroscdkcore.RosResource)
	AddDesc(desc *string)
	AddMetaData(key *string, value interface{})
	// 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,
	// “`typescript
	// addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
	// addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	AddRosDependency(target *string)
	// Sets the deletion policy of the resource based on the removal policy specified.
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy, options *alicloudroscdkcore.RemovalPolicyOptions)
	// 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.
	GetAtt(attributeName *string) alicloudroscdkcore.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
	ValidateProperties(_properties interface{})
}

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

func NewRosVault 

func NewRosVault(scope alicloudroscdkcore.Construct, id *string, props *RosVaultProps, enableResourcePropertyConstraint *bool) RosVault

type RosVaultProps 

type RosVaultProps struct {
	VaultName         interface{}               `field:"required" json:"vaultName" yaml:"vaultName"`
	VaultType         interface{}               `field:"required" json:"vaultType" yaml:"vaultType"`
	Description       interface{}               `field:"optional" json:"description" yaml:"description"`
	EncryptType       interface{}               `field:"optional" json:"encryptType" yaml:"encryptType"`
	KmsKeyId          interface{}               `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"`
	RedundancyType    interface{}               `field:"optional" json:"redundancyType" yaml:"redundancyType"`
	ResourceGroupId   interface{}               `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
	Tags              *[]*RosVault_TagsProperty `field:"optional" json:"tags" yaml:"tags"`
	VaultStorageClass interface{}               `field:"optional" json:"vaultStorageClass" yaml:"vaultStorageClass"`
}

Properties for defining a `RosVault`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbr-vault

type RosVault_TagsProperty 

type RosVault_TagsProperty struct {
	Key   interface{} `field:"required" json:"key" yaml:"key"`
	Value interface{} `field:"optional" json:"value" yaml:"value"`
}

type Vault 

type Vault interface {
	alicloudroscdkcore.Resource
	// Attribute BackupPlanStatistics: The statistics of backup plans that use the backup vault.
	AttrBackupPlanStatistics() alicloudroscdkcore.IResolvable
	// Attribute BytesDone: The amount of data that is backed up.
	//
	// Unit: bytes.
	AttrBytesDone() alicloudroscdkcore.IResolvable
	// Attribute CreateTime: The time when the backup vault was created.
	//
	// This value is a UNIX timestamp. Unit: seconds.
	AttrCreateTime() alicloudroscdkcore.IResolvable
	// Attribute Dedup: Indicates whether the deduplication feature is enabled.
	AttrDedup() alicloudroscdkcore.IResolvable
	// Attribute Description: The description of the backup vault.
	AttrDescription() alicloudroscdkcore.IResolvable
	// Attribute IndexAvailable: Indicates whether indexes are available.
	//
	// Indexes are available when they are not being updated.
	AttrIndexAvailable() alicloudroscdkcore.IResolvable
	// Attribute IndexLevel: The index level.
	//
	// - **OFF**: No indexes are created.
	// - **META**: Metadata indexes are created.
	// - **ALL**: Full-text indexes are created.
	AttrIndexLevel() alicloudroscdkcore.IResolvable
	// Attribute IndexUpdateTime: The time when the index was updated.
	AttrIndexUpdateTime() alicloudroscdkcore.IResolvable
	// Attribute LatestReplicationTime: The time when the last remote backup was synchronized.
	//
	// This value is a UNIX timestamp. Unit: seconds.
	AttrLatestReplicationTime() alicloudroscdkcore.IResolvable
	// Attribute PaymentType: PaymentType.
	AttrPaymentType() alicloudroscdkcore.IResolvable
	// Attribute RedundancyType: The data redundancy type of the backup vault.
	//
	// Valid values:
	// - **LRS**: Locally redundant storage (LRS) is enabled for the backup vault. HBR stores the copies of each object on multiple devices of different facilities in the same zone. This way, HBR ensures data durability and availability even if hardware failures occur.
	// - **ZRS**: Zone-redundant storage (ZRS) is enabled for the backup vault. HBR uses the multi-zone mechanism to distribute data across three zones within the same region. If a zone fails, the data that is stored in the other two zones is still accessible.
	AttrRedundancyType() alicloudroscdkcore.IResolvable
	// Attribute Replication: Indicates whether the backup vault is a remote backup vault.
	//
	// Valid values:
	// - **true**: The backup vault is a remote backup vault.
	// - **false**: The backup vault is an on-premises backup vault.
	AttrReplication() alicloudroscdkcore.IResolvable
	// Attribute ReplicationProgress: The progress of data synchronization from the backup vault to the mirror vault.
	AttrReplicationProgress() alicloudroscdkcore.IResolvable
	// Attribute ReplicationSourceRegionId: The ID of the region where the remote backup vault resides.
	AttrReplicationSourceRegionId() alicloudroscdkcore.IResolvable
	// Attribute ReplicationSourceVaultId: The ID of the source vault that corresponds to the remote backup vault.
	AttrReplicationSourceVaultId() alicloudroscdkcore.IResolvable
	// Attribute ResourceGroupId: The ID of the resource group.
	AttrResourceGroupId() alicloudroscdkcore.IResolvable
	// Attribute Retention: The retention period of the backup vault.
	//
	// Unit: days.
	AttrRetention() alicloudroscdkcore.IResolvable
	// Attribute SearchEnabled: Indicates whether the backup search feature is enabled.
	AttrSearchEnabled() alicloudroscdkcore.IResolvable
	// Attribute SourceTypes: The information about the data source.
	AttrSourceTypes() alicloudroscdkcore.IResolvable
	// Attribute StorageSize: The usage of the backup vault.
	//
	// Unit: bytes.
	AttrStorageSize() alicloudroscdkcore.IResolvable
	// Attribute Tags: The tags of the backup vault.
	AttrTags() alicloudroscdkcore.IResolvable
	// Attribute TrialInfo: The free trial information.
	AttrTrialInfo() alicloudroscdkcore.IResolvable
	// Attribute UpdatedTime: The time when the backup vault was updated.
	//
	// This value is a UNIX timestamp. Unit: seconds.
	AttrUpdatedTime() alicloudroscdkcore.IResolvable
	// Attribute VaultId: The ID of the backup vault.
	AttrVaultId() alicloudroscdkcore.IResolvable
	// Attribute VaultName: The name of the backup vault.
	AttrVaultName() alicloudroscdkcore.IResolvable
	// Attribute VaultStatusMessage: The status message that is returned when the backup vault is in the ERROR state.
	//
	// This parameter is available only for remote backup vaults. Valid values:
	// - **UNKNOWN_ERROR*: An unknown error occurs.
	// - **SOURCE_VAULT_ALREADY_HAS_REPLICATION**: A mirror vault is configured for the source vault.
	AttrVaultStatusMessage() alicloudroscdkcore.IResolvable
	// Attribute VaultStorageClass: The storage type of the backup vault.
	//
	// Valid value: **STANDARD**, which indicates standard storage.
	AttrVaultStorageClass() alicloudroscdkcore.IResolvable
	// Attribute VaultType: The type of the backup vault.
	//
	// Valid value: **STANDARD**, which indicates a standard backup vault.
	AttrVaultType() alicloudroscdkcore.IResolvable
	EnableResourcePropertyConstraint() *bool
	SetEnableResourcePropertyConstraint(val *bool)
	Id() *string
	SetId(val *string)
	// The construct tree node associated with this construct.
	Node() alicloudroscdkcore.ConstructNode
	// Returns a string-encoded token that resolves to the physical name that should be passed to the ROS resource.
	//
	// This value will resolve to one of the following:
	// - a concrete value (e.g. `"my-awesome-bucket"`)
	// - `undefined`, when a name should be generated by ROS
	// - a concrete name generated automatically during synthesis, in
	//    cross-environment scenarios.
	// Experimental.
	PhysicalName() *string
	Props() *VaultProps
	SetProps(val *VaultProps)
	Ref() *string
	Resource() alicloudroscdkcore.RosResource
	SetResource(val alicloudroscdkcore.RosResource)
	Scope() alicloudroscdkcore.Construct
	SetScope(val alicloudroscdkcore.Construct)
	// The stack in which this resource is defined.
	Stack() alicloudroscdkcore.Stack
	AddCondition(condition alicloudroscdkcore.RosCondition)
	AddCount(count interface{})
	AddDependency(resource alicloudroscdkcore.Resource)
	AddResourceDesc(desc *string)
	ApplyRemovalPolicy(policy alicloudroscdkcore.RemovalPolicy)
	GeneratePhysicalName() *string
	GetAtt(name *string) alicloudroscdkcore.IResolvable
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	OnPrepare()
	// 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.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	Prepare()
	SetMetadata(key *string, value interface{})
	// 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.
	Synthesize(session alicloudroscdkcore.ISynthesisSession)
	// Returns a string representation of this construct.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	Validate() *[]*string
}

This class encapsulates and extends the ROS resource type `ALIYUN::HBR::Vault`, which is used to create a backup vault.

func NewVault 

func NewVault(scope alicloudroscdkcore.Construct, id *string, props *VaultProps, enableResourcePropertyConstraint *bool) Vault

Param scope - scope in which this resource is defined Param id - scoped id of the resource Param props - resource properties.

type VaultProps 

type VaultProps struct {
	// Property vaultName: The name of the backup vault.
	//
	// The name must be 1 to 64 characters in length.
	VaultName interface{} `field:"required" json:"vaultName" yaml:"vaultName"`
	// Property vaultType: The type of the backup vault.
	//
	// Valid values:
	// - **STANDARD**: standard backup vault.
	// - **OTS_BACKUP**: backup vault for Tablestore.
	VaultType interface{} `field:"required" json:"vaultType" yaml:"vaultType"`
	// Property description: The description of the backup vault.
	//
	// The description must be 0 to 255 characters in length.
	Description interface{} `field:"optional" json:"description" yaml:"description"`
	// Property encryptType: The method that is used to encrypt the source data.
	//
	// This parameter is valid only if you set the VaultType parameter to STANDARD or OTS_BACKUP.
	// Valid values:- **HBR_PRIVATE**: The source data is encrypted by using the built-in encryption method of Hybrid Backup Recovery (HBR).
	// - **KMS**: The source data is encrypted by using Key Management Service (KMS).
	EncryptType interface{} `field:"optional" json:"encryptType" yaml:"encryptType"`
	// Property kmsKeyId: The customer master key (CMK) created in KMS or the alias of the key.
	//
	// This parameter is required only if you set the EncryptType parameter to KMS.
	KmsKeyId interface{} `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"`
	// Property redundancyType: The data redundancy type of the backup vault.
	//
	// Valid values:
	// - **LRS**: Locally redundant storage (LRS) is enabled for the backup vault. HBR stores the copies of each object on multiple devices of different facilities in the same zone. This way, HBR ensures data durability and availability even if hardware failures occur.
	// - **ZRS**: Zone-redundant storage (ZRS) is enabled for the backup vault. HBR uses the multi-zone mechanism to distribute data across three zones within the same region. If a zone fails, the data that is stored in the other two zones is still accessible.
	RedundancyType interface{} `field:"optional" json:"redundancyType" yaml:"redundancyType"`
	// Property resourceGroupId: The ID of the resource group.
	ResourceGroupId interface{} `field:"optional" json:"resourceGroupId" yaml:"resourceGroupId"`
	// Property tags: Tags of The resource attribute field representing the resource tag..
	Tags *[]*RosVault_TagsProperty `field:"optional" json:"tags" yaml:"tags"`
	// Property vaultStorageClass: The storage type of the backup vault.
	//
	// The value is only **STANDARD**, which indicates STANDARD storage.
	VaultStorageClass interface{} `field:"optional" json:"vaultStorageClass" yaml:"vaultStorageClass"`
}

Properties for defining a `Vault`.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbr-vault

Source Files

View all Source files

Directories

Path Synopsis
internal
Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.
 Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.