RosDBCluster
This class is a base encapsulation around the ROS resource type ALIYUN::POLARDB::DBCluster, which is used to create a PolarDB cluster.
Initializers
import { RosDBCluster } from '@alicloud/ros-cdk-polardb'
new RosDBCluster(scope: Construct, id: string, props: RosDBClusterProps, 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 |
RosDBClusterProps |
- resource properties. |
enableResourcePropertyConstraint |
boolean |
No description. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
scope in which this resource is defined.
idRequired
- Type: string
scoped id of the resource.
propsRequired
- Type: RosDBClusterProps
resource properties.
enableResourcePropertyConstraintRequired
- 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 { RosDBCluster } from '@alicloud/ros-cdk-polardb'
RosDBCluster.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
isRosElement
import { RosDBCluster } from '@alicloud/ros-cdk-polardb'
RosDBCluster.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 { RosDBCluster } from '@alicloud/ros-cdk-polardb'
RosDBCluster.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. |
attrClusterConnectionString |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrClusterEndpointId |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrColdStorageInstanceId |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrCustomConnectionStrings |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrCustomEndpointIds |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrDbClusterDescription |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrDbClusterId |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrDbNodeIds |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrOrderId |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrPrimaryConnectionString |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrPrimaryConnectionStrings |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrPrimaryEndpointId |
@alicloud/ros-cdk-core.IResolvable |
No description. |
attrPrimaryEndpointIds |
@alicloud/ros-cdk-core.IResolvable |
No description. |
dbNodeClass |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
dbType |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
dbVersion |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
enableResourcePropertyConstraint |
boolean |
No description. |
payType |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
allowShutDown |
boolean | @alicloud/ros-cdk-core.IResolvable |
No description. |
architecture |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
autoRenewPeriod |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
backupRetentionPolicyOnClusterDeletion |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
cloneDataPoint |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
clusterNetworkType |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
coldStorageOption |
@alicloud/ros-cdk-core.IResolvable | ColdStorageOptionProperty |
No description. |
creationCategory |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
creationOption |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
dbClusterDescription |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
dbClusterParameters |
@alicloud/ros-cdk-core.IResolvable | DBClusterParametersProperty |
No description. |
dbMinorVersion |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
dbNodeNum |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
defaultTimeZone |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
deletionProtection |
boolean | @alicloud/ros-cdk-core.IResolvable |
No description. |
gdnId |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
hotStandbyCluster |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
loosePolarLogBin |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
looseXEngine |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
looseXEngineUseMemoryPct |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
lowerCaseTableNames |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
maintainTime |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
parameterGroupId |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
period |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
periodUnit |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
provisionedIops |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
proxyClass |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
proxyType |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
renewalStatus |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
resourceGroupId |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
restartMasterNode |
boolean | @alicloud/ros-cdk-core.IResolvable |
No description. |
scaleMax |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
scaleMin |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
scaleRoNumMax |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
scaleRoNumMin |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
securityGroupIds |
@alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] |
No description. |
securityIpList |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
serverlessType |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
sourceResourceId |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
standbyAz |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
storageAutoScale |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
storagePayType |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
storageSpace |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
storageType |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
storageUpperBound |
number | @alicloud/ros-cdk-core.IResolvable |
No description. |
strictConsistency |
string | @alicloud/ros-cdk-core.IResolvable |
No description. |
tags |
TagsProperty[] |
No description. |
tdeStatus |
boolean | @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. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
creationStackRequired
public readonly creationStack: string[];
- Type: string[]
logicalIdRequired
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).
stackRequired
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).
refRequired
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 }).
rosOptionsRequired
public readonly rosOptions: IRosResourceOptions;
- Type: @alicloud/ros-cdk-core.IRosResourceOptions
Options for this resource, such as condition, update policy etc.
rosResourceTypeRequired
public readonly rosResourceType: string;
- Type: string
ROS resource type.
attrClusterConnectionStringRequired
public readonly attrClusterConnectionString: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrClusterEndpointIdRequired
public readonly attrClusterEndpointId: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrColdStorageInstanceIdRequired
public readonly attrColdStorageInstanceId: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrCustomConnectionStringsRequired
public readonly attrCustomConnectionStrings: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrCustomEndpointIdsRequired
public readonly attrCustomEndpointIds: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrDbClusterDescriptionRequired
public readonly attrDbClusterDescription: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrDbClusterIdRequired
public readonly attrDbClusterId: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrDbNodeIdsRequired
public readonly attrDbNodeIds: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrOrderIdRequired
public readonly attrOrderId: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrPrimaryConnectionStringRequired
public readonly attrPrimaryConnectionString: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrPrimaryConnectionStringsRequired
public readonly attrPrimaryConnectionStrings: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrPrimaryEndpointIdRequired
public readonly attrPrimaryEndpointId: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
attrPrimaryEndpointIdsRequired
public readonly attrPrimaryEndpointIds: IResolvable;
- Type: @alicloud/ros-cdk-core.IResolvable
dbNodeClassRequired
public readonly dbNodeClass: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
dbTypeRequired
public readonly dbType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
dbVersionRequired
public readonly dbVersion: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
enableResourcePropertyConstraintRequired
public readonly enableResourcePropertyConstraint: boolean;
- Type: boolean
payTypeRequired
public readonly payType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
allowShutDownOptional
public readonly allowShutDown: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
architectureOptional
public readonly architecture: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
autoRenewPeriodOptional
public readonly autoRenewPeriod: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
backupRetentionPolicyOnClusterDeletionOptional
public readonly backupRetentionPolicyOnClusterDeletion: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
cloneDataPointOptional
public readonly cloneDataPoint: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
clusterNetworkTypeOptional
public readonly clusterNetworkType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
coldStorageOptionOptional
public readonly coldStorageOption: IResolvable | ColdStorageOptionProperty;
- Type: @alicloud/ros-cdk-core.IResolvable | ColdStorageOptionProperty
creationCategoryOptional
public readonly creationCategory: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
creationOptionOptional
public readonly creationOption: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
dbClusterDescriptionOptional
public readonly dbClusterDescription: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
dbClusterParametersOptional
public readonly dbClusterParameters: IResolvable | DBClusterParametersProperty;
- Type: @alicloud/ros-cdk-core.IResolvable | DBClusterParametersProperty
dbMinorVersionOptional
public readonly dbMinorVersion: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
dbNodeNumOptional
public readonly dbNodeNum: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
defaultTimeZoneOptional
public readonly defaultTimeZone: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
deletionProtectionOptional
public readonly deletionProtection: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
gdnIdOptional
public readonly gdnId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
hotStandbyClusterOptional
public readonly hotStandbyCluster: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
loosePolarLogBinOptional
public readonly loosePolarLogBin: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
looseXEngineOptional
public readonly looseXEngine: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
looseXEngineUseMemoryPctOptional
public readonly looseXEngineUseMemoryPct: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
lowerCaseTableNamesOptional
public readonly lowerCaseTableNames: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
maintainTimeOptional
public readonly maintainTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
parameterGroupIdOptional
public readonly parameterGroupId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
periodOptional
public readonly period: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
periodUnitOptional
public readonly periodUnit: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
provisionedIopsOptional
public readonly provisionedIops: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
proxyClassOptional
public readonly proxyClass: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
proxyTypeOptional
public readonly proxyType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
renewalStatusOptional
public readonly renewalStatus: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
resourceGroupIdOptional
public readonly resourceGroupId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
restartMasterNodeOptional
public readonly restartMasterNode: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
scaleMaxOptional
public readonly scaleMax: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
scaleMinOptional
public readonly scaleMin: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
scaleRoNumMaxOptional
public readonly scaleRoNumMax: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
scaleRoNumMinOptional
public readonly scaleRoNumMin: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
securityGroupIdsOptional
public readonly securityGroupIds: IResolvable | string | IResolvable[];
- Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]
securityIpListOptional
public readonly securityIpList: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
serverlessTypeOptional
public readonly serverlessType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
sourceResourceIdOptional
public readonly sourceResourceId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
standbyAzOptional
public readonly standbyAz: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
storageAutoScaleOptional
public readonly storageAutoScale: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
storagePayTypeOptional
public readonly storagePayType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
storageSpaceOptional
public readonly storageSpace: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
storageTypeOptional
public readonly storageType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
storageUpperBoundOptional
public readonly storageUpperBound: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
strictConsistencyOptional
public readonly strictConsistency: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
tagsOptional
public readonly tags: TagsProperty[];
- Type: TagsProperty[]
tdeStatusOptional
public readonly tdeStatus: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
vpcIdOptional
public readonly vpcId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
vSwitchIdOptional
public readonly vSwitchId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
zoneIdOptional
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_NAMERequired
public readonly ROS_RESOURCE_TYPE_NAME: string;
- Type: string
The resource type name for this resource class.