RosDBInstanceClone
This class is a base encapsulation around the ROS resource type ALIYUN::RDS::DBInstanceClone
, which is used to restore historical data of an instance to a new instance.
The new instance is the clone of the instance.
Initializers
import { RosDBInstanceClone } from '@alicloud/ros-cdk-rds'
new RosDBInstanceClone(scope: Construct, id: string, props: RosDBInstanceCloneProps, enableResourcePropertyConstraint: boolean)
Name | Type | Description |
---|---|---|
scope |
@alicloud/ros-cdk-core.Construct |
- scope in which this resource is defined. |
id |
string |
- scoped id of the resource. |
props |
RosDBInstanceCloneProps |
- resource properties. |
enableResourcePropertyConstraint |
boolean |
No description. |
scope
Required
- Type: @alicloud/ros-cdk-core.Construct
scope in which this resource is defined.
id
Required
- Type: string
scoped id of the resource.
props
Required
- Type: RosDBInstanceCloneProps
resource properties.
enableResourcePropertyConstraint
Required
- Type: boolean
Methods
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
synthesize |
Allows this construct to emit artifacts into the cloud assembly during synthesis. |
overrideLogicalId |
Overrides the auto-generated logical ID with a specific ID. |
addCondition |
No description. |
addCount |
No description. |
addDeletionOverride |
Syntactic sugar for addOverride(path, undefined) . |
addDependsOn |
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
addDesc |
No description. |
addMetaData |
No description. |
addOverride |
Adds an override to the synthesized ROS resource. |
addPropertyDeletionOverride |
Adds an override that deletes the value of a property from the resource definition. |
addPropertyOverride |
Adds an override to a resource property. |
addRosDependency |
No description. |
applyRemovalPolicy |
Sets the deletion policy of the resource based on the removal policy specified. |
getAtt |
Returns a token for an runtime attribute of this resource. |
toString
public toString(): string
Returns a string representation of this construct.
synthesize
public synthesize(session: ISynthesisSession): void
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: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
addCondition
public addCondition(con: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDeletionOverride
public addDeletionOverride(path: string): void
Syntactic sugar for addOverride(path, undefined)
.
- Type: string
The path of the value to delete.
addDependsOn
public addDependsOn(target: RosResource): void
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.
- Type: @alicloud/ros-cdk-core.RosResource
addDesc
public addDesc(desc: string): void
- Type: string
addMetaData
public addMetaData(key: string, value: any): void
- Type: string
- Type: any
addOverride
public addOverride(path: string, value: any): void
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,
addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
- Type: string
The path of the property, you can use dot notation to override values in complex types.
Any intermdediate keys will be created as needed.
- Type: any
The value.
Could be primitive or complex.
addPropertyDeletionOverride
public addPropertyDeletionOverride(propertyPath: string): void
Adds an override that deletes the value of a property from the resource definition.
- Type: string
The path to the property.
addPropertyOverride
public addPropertyOverride(propertyPath: string, value: any): void
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
- Type: string
The path of the property.
- Type: any
The value.
addRosDependency
public addRosDependency(target: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Sets the deletion policy of the resource based on the removal policy specified.
- Type: @alicloud/ros-cdk-core.RemovalPolicy
- Type: @alicloud/ros-cdk-core.RemovalPolicyOptions
getAtt
public getAtt(attributeName: string): Reference
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.
- Type: string
The name of the attribute.
Static Functions
Name | Description |
---|---|
isConstruct |
Return whether the given object is a Construct. |
isRosElement |
Returns true if a construct is a stack element (i.e. part of the synthesized template). |
isRosResource |
Check whether the given construct is a RosResource. |
isConstruct
import { RosDBInstanceClone } from '@alicloud/ros-cdk-rds'
RosDBInstanceClone.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
isRosElement
import { RosDBInstanceClone } from '@alicloud/ros-cdk-rds'
RosDBInstanceClone.isRosElement(x: any)
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.
- Type: any
isRosResource
import { RosDBInstanceClone } from '@alicloud/ros-cdk-rds'
RosDBInstanceClone.isRosResource(construct: IConstruct)
Check whether the given construct is a RosResource.
- Type: @alicloud/ros-cdk-core.IConstruct
Properties
Name | Type | Description |
---|---|---|
node |
@alicloud/ros-cdk-core.ConstructNode |
The construct tree node associated with this construct. |
creationStack |
string[] |
No description. |
logicalId |
string |
The logical ID for this stack element. |
stack |
@alicloud/ros-cdk-core.Stack |
The stack in which this element is defined. |
ref |
string |
Return a string that will be resolved to a RosTemplate { Ref } for this element. |
rosOptions |
@alicloud/ros-cdk-core.IRosResourceOptions |
Options for this resource, such as condition, update policy etc. |
rosResourceType |
string |
ROS resource type. |
attrDbInstanceId |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrInnerConnectionString |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrInnerIpAddress |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrInnerPort |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrPublicConnectionString |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrPublicIpAddress |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrPublicPort |
@alicloud/ros-cdk-core.IResolvable |
No description. |
dbInstanceId |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
enableResourcePropertyConstraint |
boolean |
No description. |
payType |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
allocatePublicConnection |
boolean | @alicloud/ros-cdk-core.IResolvable |
No description. |
backupId |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
backupRetentionPeriod |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
backupType |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
category |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
connectionStringPrefix |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
connectionStringType |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
dbInstanceClass |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
dbInstanceDescription |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
dbInstanceStorage |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
dbInstanceStorageType |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
dbMappings |
@alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | DBMappingsProperty[] |
No description. |
dbNames |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
dedicatedHostGroupId |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
instanceNetworkType |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
maintainTime |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
masterUsername |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
masterUserPassword |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
masterUserType |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
period |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
periodType |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
port |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
preferredBackupPeriod |
@alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] |
No description. |
preferredBackupTime |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
privateIpAddress |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
restoreTable |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
restoreTime |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
securityGroupId |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
securityIpList |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
slaveZoneIds |
@alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] |
No description. |
sqlCollectorStatus |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
sslSetting |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
tableMeta |
@alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | TableMetaProperty[] |
No description. |
tags |
{[ key: string ]: any} |
No description. |
timeoutInMinutes |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
vpcId |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
vSwitchId |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
zoneId |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
node
Required
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
creationStack
Required
public readonly creationStack: string[];
- Type: string[]
logicalId
Required
public readonly logicalId: string;
- Type: string
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)
.
stack
Required
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this element is defined.
RosElements must be defined within a stack scope (directly or indirectly).
ref
Required
public readonly ref: string;
- Type: string
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 })
.
rosOptions
Required
public readonly rosOptions: IRosResourceOptions;
- Type: @alicloud/ros-cdk-core.IRosResourceOptions
Options for this resource, such as condition, update policy etc.
rosResourceType
Required
public readonly rosResourceType: string;
- Type: string
ROS resource type.
attrDbInstanceId
Required
public readonly attrDbInstanceId: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrInnerConnectionString
Required
public readonly attrInnerConnectionString: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrInnerIpAddress
Required
public readonly attrInnerIpAddress: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrInnerPort
Required
public readonly attrInnerPort: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrPublicConnectionString
Required
public readonly attrPublicConnectionString: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrPublicIpAddress
Required
public readonly attrPublicIpAddress: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrPublicPort
Required
public readonly attrPublicPort: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
dbInstanceId
Required
public readonly dbInstanceId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
enableResourcePropertyConstraint
Required
public readonly enableResourcePropertyConstraint: boolean;
- Type: boolean
payType
Required
public readonly payType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
allocatePublicConnection
Optional
public readonly allocatePublicConnection: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
backupId
Optional
public readonly backupId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
backupRetentionPeriod
Optional
public readonly backupRetentionPeriod: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
backupType
Optional
public readonly backupType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
category
Optional
public readonly category: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
connectionStringPrefix
Optional
public readonly connectionStringPrefix: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
connectionStringType
Optional
public readonly connectionStringType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
dbInstanceClass
Optional
public readonly dbInstanceClass: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
dbInstanceDescription
Optional
public readonly dbInstanceDescription: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
dbInstanceStorage
Optional
public readonly dbInstanceStorage: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
dbInstanceStorageType
Optional
public readonly dbInstanceStorageType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
dbMappings
Optional
public readonly dbMappings: IResolvable | IResolvable | DBMappingsProperty[];
- Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | DBMappingsProperty[]
dbNames
Optional
public readonly dbNames: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
dedicatedHostGroupId
Optional
public readonly dedicatedHostGroupId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
instanceNetworkType
Optional
public readonly instanceNetworkType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
maintainTime
Optional
public readonly maintainTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
masterUsername
Optional
public readonly masterUsername: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
masterUserPassword
Optional
public readonly masterUserPassword: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
masterUserType
Optional
public readonly masterUserType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
period
Optional
public readonly period: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
periodType
Optional
public readonly periodType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
port
Optional
public readonly port: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
preferredBackupPeriod
Optional
public readonly preferredBackupPeriod: IResolvable | string | IResolvable[];
- Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]
preferredBackupTime
Optional
public readonly preferredBackupTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
privateIpAddress
Optional
public readonly privateIpAddress: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
restoreTable
Optional
public readonly restoreTable: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
restoreTime
Optional
public readonly restoreTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
securityGroupId
Optional
public readonly securityGroupId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
securityIpList
Optional
public readonly securityIpList: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
slaveZoneIds
Optional
public readonly slaveZoneIds: IResolvable | string | IResolvable[];
- Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]
sqlCollectorStatus
Optional
public readonly sqlCollectorStatus: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
sslSetting
Optional
public readonly sslSetting: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
tableMeta
Optional
public readonly tableMeta: IResolvable | IResolvable | TableMetaProperty[];
- Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | TableMetaProperty[]
tags
Optional
public readonly tags: {[ key: string ]: any};
- Type: {[ key: string ]: any}
timeoutInMinutes
Optional
public readonly timeoutInMinutes: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
vpcId
Optional
public readonly vpcId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
vSwitchId
Optional
public readonly vSwitchId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
zoneId
Optional
public readonly zoneId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Constants
Name | Type | Description |
---|---|---|
ROS_RESOURCE_TYPE_NAME |
string |
The resource type name for this resource class. |
ROS_RESOURCE_TYPE_NAME
Required
public readonly ROS_RESOURCE_TYPE_NAME: string;
- Type: string
The resource type name for this resource class.