DbInstance
- Implements: @alicloud/ros-cdk-graphdatabase.datasource.IDbInstance
This class encapsulates and extends the ROS resource type DATASOURCE::GraphDatabase::DbInstance, which is used to query the information about an instance.
Initializers
import { datasource } from '@alicloud/ros-cdk-graphdatabase'
new datasource.DbInstance(scope: Construct, id: string, props: DbInstanceProps, enableResourcePropertyConstraint?: boolean)
| Name | Type | Description |
|---|---|---|
scope | @alicloud/ros-cdk-core.Construct | No description. |
id | string | No description. |
props | DbInstanceProps | No description. |
enableResourcePropertyConstraint | boolean | No description. |
scopeRequired
- Type: @alicloud/ros-cdk-core.Construct
idRequired
- Type: string
propsRequired
- Type: DbInstanceProps
enableResourcePropertyConstraintOptional
- 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. |
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
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.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- Type: any
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import { datasource } from '@alicloud/ros-cdk-graphdatabase'
datasource.DbInstance.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
ref | string | No description. |
stack | @alicloud/ros-cdk-core.Stack | The stack in which this resource is defined. |
resource | @alicloud/ros-cdk-core.RosResource | No description. |
attrConnectionString | string | @alicloud/ros-cdk-core.IResolvable | Attribute ConnectionString: Virtual Private Cloud (vpc connection such as a VPN connection or leased line domain name. |
attrCreateTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreateTime: Creation time, which follows the format of YYYY-MM-DD 'T'hh:mm:ssZ, such as 2011-05-30 T12:11:4Z. |
attrCurrentMinorVersion | string | @alicloud/ros-cdk-core.IResolvable | Attribute CurrentMinorVersion: The current kernel image version. |
attrDbInstanceCategory | string | @alicloud/ros-cdk-core.IResolvable | Attribute DbInstanceCategory: The category of the db instance. |
attrDbInstanceCpu | string | @alicloud/ros-cdk-core.IResolvable | Attribute DbInstanceCpu: For example, instances can be grouped according to Cpu core count. |
attrDbInstanceDescription | string | @alicloud/ros-cdk-core.IResolvable | Attribute DbInstanceDescription: According to the practical example or notes. |
attrDbInstanceId | string | @alicloud/ros-cdk-core.IResolvable | Attribute DbInstanceId: The ID of the GDB Instance. |
attrDbInstanceIpArray | string | @alicloud/ros-cdk-core.IResolvable | Attribute DBInstanceIPArray: IP ADDRESS whitelist for the instance group list. |
attrDbInstanceMemory | string | @alicloud/ros-cdk-core.IResolvable | Attribute DbInstanceMemory: Instance memory, which is measured in MB. |
attrDbInstanceNetworkType | string | @alicloud/ros-cdk-core.IResolvable | Attribute DbInstanceNetworkType: The network type of the db instance. |
attrDbInstanceStorageType | string | @alicloud/ros-cdk-core.IResolvable | Attribute DbInstanceStorageType: Cloud Disk. |
attrDbInstanceType | string | @alicloud/ros-cdk-core.IResolvable | Attribute DbInstanceType: The type of the db instance. |
attrDbNodeClass | string | @alicloud/ros-cdk-core.IResolvable | Attribute DbNodeClass: The class of the db node. |
attrDbNodeCount | string | @alicloud/ros-cdk-core.IResolvable | Attribute DbNodeCount: The count of the db node. |
attrDbNodeStorage | string | @alicloud/ros-cdk-core.IResolvable | Attribute DbNodeStorage: Instance storage space, which is measured in GB. |
attrDbVersion | string | @alicloud/ros-cdk-core.IResolvable | Attribute DbVersion: Kernel Version 1.0 is represented as gremlin,1. |
attrEcsSecurityGroupRelations | string | @alicloud/ros-cdk-core.IResolvable | Attribute EcsSecurityGroupRelations: Security group information array. |
attrExpired | string | @alicloud/ros-cdk-core.IResolvable | Attribute Expired: The expire status of the db instance. |
attrExpireTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute ExpireTime: The instance after it expires time for subscription instance. |
attrLatestMinorVersion | string | @alicloud/ros-cdk-core.IResolvable | Attribute LatestMinorVersion: The latest kernel image version. |
attrLockMode | string | @alicloud/ros-cdk-core.IResolvable | Attribute LockMode: Instance lock state. |
attrLockReason | string | @alicloud/ros-cdk-core.IResolvable | Attribute LockReason: An instance is locked the reason. |
attrMaintainTime | string | @alicloud/ros-cdk-core.IResolvable | Attribute MaintainTime: Instance maintenance time such as 00:00Z-02:00Z, 0 to 2 points to carry out routine maintenance. |
attrPaymentType | string | @alicloud/ros-cdk-core.IResolvable | Attribute PaymentType: The DB instance attribute field representing the paid type is desirable. |
attrPort | string | @alicloud/ros-cdk-core.IResolvable | Attribute Port: Application Port. |
attrPublicConnectionString | string | @alicloud/ros-cdk-core.IResolvable | Attribute PublicConnectionString: The public connection string ID of the DB instance. |
attrPublicPort | string | @alicloud/ros-cdk-core.IResolvable | Attribute PublicPort: The public port ID of the DB instance. |
attrReadOnlyDbInstanceIds | string | @alicloud/ros-cdk-core.IResolvable | Attribute ReadOnlyDbInstanceIds: The array of the readonly db instances. |
attrResourceGroupId | string | @alicloud/ros-cdk-core.IResolvable | Attribute ResourceGroupId: Resource Group ID. |
attrTags | string | @alicloud/ros-cdk-core.IResolvable | Attribute Tags: The tags of the GDB Instance. |
attrVpcId | string | @alicloud/ros-cdk-core.IResolvable | Attribute VpcId: The vpc id of the db instance. |
attrVSwitchId | string | @alicloud/ros-cdk-core.IResolvable | Attribute VSwitchId: The vswitch id of the DB instance. |
attrZoneId | string | @alicloud/ros-cdk-core.IResolvable | Attribute ZoneId: The zone ID of the instance. |
props | DbInstanceProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/ros-cdk-core.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
public readonly ref: string;
- Type: string
stackRequired
public readonly stack: Stack;
- Type: @alicloud/ros-cdk-core.Stack
The stack in which this resource is defined.
resourceOptional
public readonly resource: RosResource;
- Type: @alicloud/ros-cdk-core.RosResource
attrConnectionStringRequired
public readonly attrConnectionString: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ConnectionString: Virtual Private Cloud (vpc connection such as a VPN connection or leased line domain name.
attrCreateTimeRequired
public readonly attrCreateTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreateTime: Creation time, which follows the format of YYYY-MM-DD 'T'hh:mm:ssZ, such as 2011-05-30 T12:11:4Z.
attrCurrentMinorVersionRequired
public readonly attrCurrentMinorVersion: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CurrentMinorVersion: The current kernel image version.
attrDbInstanceCategoryRequired
public readonly attrDbInstanceCategory: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DbInstanceCategory: The category of the db instance.
attrDbInstanceCpuRequired
public readonly attrDbInstanceCpu: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DbInstanceCpu: For example, instances can be grouped according to Cpu core count.
attrDbInstanceDescriptionRequired
public readonly attrDbInstanceDescription: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DbInstanceDescription: According to the practical example or notes.
attrDbInstanceIdRequired
public readonly attrDbInstanceId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DbInstanceId: The ID of the GDB Instance.
attrDbInstanceIpArrayRequired
public readonly attrDbInstanceIpArray: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DBInstanceIPArray: IP ADDRESS whitelist for the instance group list.
attrDbInstanceMemoryRequired
public readonly attrDbInstanceMemory: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DbInstanceMemory: Instance memory, which is measured in MB.
attrDbInstanceNetworkTypeRequired
public readonly attrDbInstanceNetworkType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DbInstanceNetworkType: The network type of the db instance.
attrDbInstanceStorageTypeRequired
public readonly attrDbInstanceStorageType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DbInstanceStorageType: Cloud Disk.
attrDbInstanceTypeRequired
public readonly attrDbInstanceType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DbInstanceType: The type of the db instance.
attrDbNodeClassRequired
public readonly attrDbNodeClass: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DbNodeClass: The class of the db node.
attrDbNodeCountRequired
public readonly attrDbNodeCount: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DbNodeCount: The count of the db node.
attrDbNodeStorageRequired
public readonly attrDbNodeStorage: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DbNodeStorage: Instance storage space, which is measured in GB.
attrDbVersionRequired
public readonly attrDbVersion: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute DbVersion: Kernel Version 1.0 is represented as gremlin,1.
attrEcsSecurityGroupRelationsRequired
public readonly attrEcsSecurityGroupRelations: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute EcsSecurityGroupRelations: Security group information array.
attrExpiredRequired
public readonly attrExpired: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Expired: The expire status of the db instance.
attrExpireTimeRequired
public readonly attrExpireTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ExpireTime: The instance after it expires time for subscription instance.
attrLatestMinorVersionRequired
public readonly attrLatestMinorVersion: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute LatestMinorVersion: The latest kernel image version.
attrLockModeRequired
public readonly attrLockMode: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute LockMode: Instance lock state.
attrLockReasonRequired
public readonly attrLockReason: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute LockReason: An instance is locked the reason.
attrMaintainTimeRequired
public readonly attrMaintainTime: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute MaintainTime: Instance maintenance time such as 00:00Z-02:00Z, 0 to 2 points to carry out routine maintenance.
attrPaymentTypeRequired
public readonly attrPaymentType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute PaymentType: The DB instance attribute field representing the paid type is desirable.
attrPortRequired
public readonly attrPort: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Port: Application Port.
attrPublicConnectionStringRequired
public readonly attrPublicConnectionString: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute PublicConnectionString: The public connection string ID of the DB instance.
attrPublicPortRequired
public readonly attrPublicPort: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute PublicPort: The public port ID of the DB instance.
attrReadOnlyDbInstanceIdsRequired
public readonly attrReadOnlyDbInstanceIds: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ReadOnlyDbInstanceIds: The array of the readonly db instances.
attrResourceGroupIdRequired
public readonly attrResourceGroupId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ResourceGroupId: Resource Group ID.
attrTagsRequired
public readonly attrTags: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Tags: The tags of the GDB Instance.
attrVpcIdRequired
public readonly attrVpcId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute VpcId: The vpc id of the db instance.
attrVSwitchIdRequired
public readonly attrVSwitchId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute VSwitchId: The vswitch id of the DB instance.
attrZoneIdRequired
public readonly attrZoneId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ZoneId: The zone ID of the instance.
propsRequired
public readonly props: DbInstanceProps;
- Type: DbInstanceProps