DbPlan
- Implements: IDbPlan
This class encapsulates and extends the ROS resource type ALIYUN::HBR::DbPlanCreates a database backup plan.
Initializers
import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkhbr"
alicloudroscdkhbr.NewDbPlan(scope Construct, id *string, props DbPlanProps, enableResourcePropertyConstraint *bool) DbPlan
| Name | Type | Description |
|---|---|---|
scope | github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct | No description. |
id | *string | No description. |
props | DbPlanProps | No description. |
enableResourcePropertyConstraint | *bool | No description. |
scopeRequired
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct
idRequired
- Type: *string
propsRequired
- Type: DbPlanProps
enableResourcePropertyConstraintOptional
- Type: *bool
Methods
| Name | Description |
|---|---|
ToString | Returns a string representation of this construct. |
Synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
AddCondition | No description. |
AddCount | No description. |
AddDependency | No description. |
AddResourceDesc | No description. |
ApplyRemovalPolicy | No description. |
FetchCondition | No description. |
FetchDependency | No description. |
FetchResourceDesc | No description. |
GetAtt | No description. |
SetMetadata | No description. |
ToString
func ToString() *string
Returns a string representation of this construct.
Synthesize
func Synthesize(session ISynthesisSession)
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.
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession
The synthesis session.
AddCondition
func AddCondition(condition RosCondition)
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition
AddCount
func AddCount(count interface{})
- Type: interface{}
AddDependency
func AddDependency(resource Resource)
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Resource
AddResourceDesc
func AddResourceDesc(desc *string)
- Type: *string
ApplyRemovalPolicy
func ApplyRemovalPolicy(policy RemovalPolicy)
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy
FetchCondition
func FetchCondition() RosCondition
FetchDependency
func FetchDependency() *[]*string
FetchResourceDesc
func FetchResourceDesc() *string
GetAtt
func GetAtt(name *string) IResolvable
- Type: *string
SetMetadata
func SetMetadata(key *string, value interface{})
- Type: *string
- Type: interface{}
Static Functions
| Name | Description |
|---|---|
IsConstruct | Return whether the given object is a Construct. |
IsConstruct
import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkhbr"
alicloudroscdkhbr.DbPlan_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
- Type: interface{}
Properties
| Name | Type | Description |
|---|---|---|
Node | github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode | The construct tree node associated with this construct. |
Env | github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResourceEnvironment | The environment this resource belongs to. |
Ref | *string | No description. |
Stack | github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack | The stack in which this resource is defined. |
Resource | github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource | No description. |
AttrContinuousPlan | interface{} | Attribute ContinuousPlan: Continuous backup plan schedule. |
AttrContinuousUuid | interface{} | Attribute ContinuousUuid: Uuid of continuous backup plan. |
AttrCumulativePlan | interface{} | Attribute CumulativePlan: Cumulative plan schedule, only for mssql. |
AttrCumulativeUuid | interface{} | Attribute CumulativeUuid: Uuid of cumulative plan. |
AttrDbPlanName | interface{} | Attribute DbPlanName: Display name of the backup plan. |
AttrFullPlan | interface{} | Attribute FullPlan: Full backup plan schedule. |
AttrFullUuid | interface{} | Attribute FullUuid: Uuid of full backup plan. |
AttrHostUuid | interface{} | Attribute HostUuid: Uuid of the host of the database instance. |
AttrIncPlan | interface{} | Attribute IncPlan: Incremental backup plan schedule. |
AttrIncUuid | interface{} | Attribute IncUuid: Uuid of the incremental bakcup plan. |
AttrInstanceUuid | interface{} | Attribute InstanceUuid: Uuid of database instance. |
AttrLogPlan | interface{} | Attribute LogPlan: Log backup plan schedule.More details see FullPlan. |
AttrLogUuid | interface{} | Attribute LogUuid: Uuid of the log backup plan. |
AttrMaxRateLimit | interface{} | Attribute MaxRateLimit: Max rate limit for backup job,. |
AttrMaxRetrySeconds | interface{} | Attribute MaxRetrySeconds: Max retry seconds on network failure. |
AttrOptions | interface{} | Attribute Options: Backup options in json format, different for each type of database. |
AttrPlanId | interface{} | Attribute PlanId: Id of the backup plan. |
AttrSourceType | interface{} | Attribute SourceType: Database type, allowed value: MYSQL, ORACLE, MSSQL. |
AttrTarget | interface{} | Attribute Target: Target vault to backup. |
AttrVaultId | interface{} | Attribute VaultId: Vault ID to create backup plan, the backup data will be stored to the vault. |
Props | DbPlanProps | No description. |
NodeRequired
func Node() ConstructNode
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode
The construct tree node associated with this construct.
EnvRequired
func Env() IResourceEnvironment
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
RefRequired
func Ref() *string
- Type: *string
StackRequired
func Stack() Stack
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack
The stack in which this resource is defined.
ResourceOptional
func Resource() RosResource
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource
AttrContinuousPlanRequired
func AttrContinuousPlan() interface{}
- Type: interface{}
Attribute ContinuousPlan: Continuous backup plan schedule.
Use { "type": "continuous" }.
AttrContinuousUuidRequired
func AttrContinuousUuid() interface{}
- Type: interface{}
Attribute ContinuousUuid: Uuid of continuous backup plan.
AttrCumulativePlanRequired
func AttrCumulativePlan() interface{}
- Type: interface{}
Attribute CumulativePlan: Cumulative plan schedule, only for mssql.
More details see FullPlan.
AttrCumulativeUuidRequired
func AttrCumulativeUuid() interface{}
- Type: interface{}
Attribute CumulativeUuid: Uuid of cumulative plan.
AttrDbPlanNameRequired
func AttrDbPlanName() interface{}
- Type: interface{}
Attribute DbPlanName: Display name of the backup plan.
AttrFullPlanRequired
func AttrFullPlan() interface{}
- Type: interface{}
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.
AttrFullUuidRequired
func AttrFullUuid() interface{}
- Type: interface{}
Attribute FullUuid: Uuid of full backup plan.
AttrHostUuidRequired
func AttrHostUuid() interface{}
- Type: interface{}
Attribute HostUuid: Uuid of the host of the database instance.
AttrIncPlanRequired
func AttrIncPlan() interface{}
- Type: interface{}
Attribute IncPlan: Incremental backup plan schedule.
Only for mysql and oracle. More details see FullPlan.
AttrIncUuidRequired
func AttrIncUuid() interface{}
- Type: interface{}
Attribute IncUuid: Uuid of the incremental bakcup plan.
AttrInstanceUuidRequired
func AttrInstanceUuid() interface{}
- Type: interface{}
Attribute InstanceUuid: Uuid of database instance.
AttrLogPlanRequired
func AttrLogPlan() interface{}
- Type: interface{}
Attribute LogPlan: Log backup plan schedule.More details see FullPlan.
AttrLogUuidRequired
func AttrLogUuid() interface{}
- Type: interface{}
Attribute LogUuid: Uuid of the log backup plan.
AttrMaxRateLimitRequired
func AttrMaxRateLimit() interface{}
- Type: interface{}
Attribute MaxRateLimit: Max rate limit for backup job,.
AttrMaxRetrySecondsRequired
func AttrMaxRetrySeconds() interface{}
- Type: interface{}
Attribute MaxRetrySeconds: Max retry seconds on network failure.
AttrOptionsRequired
func AttrOptions() interface{}
- Type: interface{}
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}.
AttrPlanIdRequired
func AttrPlanId() interface{}
- Type: interface{}
Attribute PlanId: Id of the backup plan.
AttrSourceTypeRequired
func AttrSourceType() interface{}
- Type: interface{}
Attribute SourceType: Database type, allowed value: MYSQL, ORACLE, MSSQL.
AttrTargetRequired
func AttrTarget() interface{}
- Type: interface{}
Attribute Target: Target vault to backup.
AttrVaultIdRequired
func AttrVaultId() interface{}
- Type: interface{}
Attribute VaultId: Vault ID to create backup plan, the backup data will be stored to the vault.
PropsRequired
func Props() DbPlanProps
- Type: DbPlanProps