Skip to content

DbInstance

This class encapsulates and extends the ROS resource type DATASOURCE::GraphDatabase::DbInstance.

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

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.
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.

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount 

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency 

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • 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.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
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 @alicloud/ros-cdk-core.IResolvable Attribute ConnectionString: Virtual Private Cloud (vpc connection such as a VPN connection or leased line domain name.
attrCreateTime @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 @alicloud/ros-cdk-core.IResolvable Attribute CurrentMinorVersion: The current kernel image version.
attrDbInstanceCategory @alicloud/ros-cdk-core.IResolvable Attribute DbInstanceCategory: The category of the db instance.
attrDbInstanceCpu @alicloud/ros-cdk-core.IResolvable Attribute DbInstanceCpu: For example, instances can be grouped according to Cpu core count.
attrDbInstanceDescription @alicloud/ros-cdk-core.IResolvable Attribute DbInstanceDescription: According to the practical example or notes.
attrDbInstanceId @alicloud/ros-cdk-core.IResolvable Attribute DbInstanceId: The ID of the GDB Instance.
attrDbInstanceIpArray @alicloud/ros-cdk-core.IResolvable Attribute DBInstanceIPArray: IP ADDRESS whitelist for the instance group list.
attrDbInstanceMemory @alicloud/ros-cdk-core.IResolvable Attribute DbInstanceMemory: Instance memory, which is measured in MB.
attrDbInstanceNetworkType @alicloud/ros-cdk-core.IResolvable Attribute DbInstanceNetworkType: The network type of the db instance.
attrDbInstanceStorageType @alicloud/ros-cdk-core.IResolvable Attribute DbInstanceStorageType: Cloud Disk.
attrDbInstanceType @alicloud/ros-cdk-core.IResolvable Attribute DbInstanceType: The type of the db instance.
attrDbNodeClass @alicloud/ros-cdk-core.IResolvable Attribute DbNodeClass: The class of the db node.
attrDbNodeCount @alicloud/ros-cdk-core.IResolvable Attribute DbNodeCount: The count of the db node.
attrDbNodeStorage @alicloud/ros-cdk-core.IResolvable Attribute DbNodeStorage: Instance storage space, which is measured in GB.
attrDbVersion @alicloud/ros-cdk-core.IResolvable Attribute DbVersion: Kernel Version 1.0 is represented as gremlin,1.
attrEcsSecurityGroupRelations @alicloud/ros-cdk-core.IResolvable Attribute EcsSecurityGroupRelations: Security group information array.
attrExpired @alicloud/ros-cdk-core.IResolvable Attribute Expired: The expire status of the db instance.
attrExpireTime @alicloud/ros-cdk-core.IResolvable Attribute ExpireTime: The instance after it expires time for subscription instance.
attrLatestMinorVersion @alicloud/ros-cdk-core.IResolvable Attribute LatestMinorVersion: The latest kernel image version.
attrLockMode @alicloud/ros-cdk-core.IResolvable Attribute LockMode: Instance lock state.
attrLockReason @alicloud/ros-cdk-core.IResolvable Attribute LockReason: An instance is locked the reason.
attrMaintainTime @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 @alicloud/ros-cdk-core.IResolvable Attribute PaymentType: The DB instance attribute field representing the paid type is desirable.
attrPort @alicloud/ros-cdk-core.IResolvable Attribute Port: Application Port.
attrPublicConnectionString @alicloud/ros-cdk-core.IResolvable Attribute PublicConnectionString: The public connection string ID of the DB instance.
attrPublicPort @alicloud/ros-cdk-core.IResolvable Attribute PublicPort: The public port ID of the DB instance.
attrReadOnlyDbInstanceIds @alicloud/ros-cdk-core.IResolvable Attribute ReadOnlyDbInstanceIds: The array of the readonly db instances.
attrResourceGroupId @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: Resource Group ID.
attrTags @alicloud/ros-cdk-core.IResolvable Attribute Tags: The tags of the GDB Instance.
attrVpcId @alicloud/ros-cdk-core.IResolvable Attribute VpcId: The vpc id of the db instance.
attrVSwitchId @alicloud/ros-cdk-core.IResolvable Attribute VSwitchId: The vswitch id of the DB instance.
attrZoneId @alicloud/ros-cdk-core.IResolvable Attribute ZoneId: The zone ID of the instance.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

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: IResolvable;
  • Type: @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: IResolvable;
  • Type: @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: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CurrentMinorVersion: The current kernel image version.

attrDbInstanceCategoryRequired 

public readonly attrDbInstanceCategory: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DbInstanceCategory: The category of the db instance.

attrDbInstanceCpuRequired 

public readonly attrDbInstanceCpu: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DbInstanceCpu: For example, instances can be grouped according to Cpu core count.

attrDbInstanceDescriptionRequired 

public readonly attrDbInstanceDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DbInstanceDescription: According to the practical example or notes.

attrDbInstanceIdRequired 

public readonly attrDbInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DbInstanceId: The ID of the GDB Instance.

attrDbInstanceIpArrayRequired 

public readonly attrDbInstanceIpArray: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DBInstanceIPArray: IP ADDRESS whitelist for the instance group list.

attrDbInstanceMemoryRequired 

public readonly attrDbInstanceMemory: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DbInstanceMemory: Instance memory, which is measured in MB.

attrDbInstanceNetworkTypeRequired 

public readonly attrDbInstanceNetworkType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DbInstanceNetworkType: The network type of the db instance.

attrDbInstanceStorageTypeRequired 

public readonly attrDbInstanceStorageType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DbInstanceStorageType: Cloud Disk.

attrDbInstanceTypeRequired 

public readonly attrDbInstanceType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DbInstanceType: The type of the db instance.

attrDbNodeClassRequired 

public readonly attrDbNodeClass: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DbNodeClass: The class of the db node.

attrDbNodeCountRequired 

public readonly attrDbNodeCount: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DbNodeCount: The count of the db node.

attrDbNodeStorageRequired 

public readonly attrDbNodeStorage: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DbNodeStorage: Instance storage space, which is measured in GB.

attrDbVersionRequired 

public readonly attrDbVersion: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DbVersion: Kernel Version 1.0 is represented as gremlin,1.

attrEcsSecurityGroupRelationsRequired 

public readonly attrEcsSecurityGroupRelations: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute EcsSecurityGroupRelations: Security group information array.

attrExpiredRequired 

public readonly attrExpired: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Expired: The expire status of the db instance.

attrExpireTimeRequired 

public readonly attrExpireTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ExpireTime: The instance after it expires time for subscription instance.

attrLatestMinorVersionRequired 

public readonly attrLatestMinorVersion: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute LatestMinorVersion: The latest kernel image version.

attrLockModeRequired 

public readonly attrLockMode: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute LockMode: Instance lock state.

attrLockReasonRequired 

public readonly attrLockReason: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute LockReason: An instance is locked the reason.

attrMaintainTimeRequired 

public readonly attrMaintainTime: IResolvable;
  • Type: @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: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PaymentType: The DB instance attribute field representing the paid type is desirable.

attrPortRequired 

public readonly attrPort: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Port: Application Port.

attrPublicConnectionStringRequired 

public readonly attrPublicConnectionString: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PublicConnectionString: The public connection string ID of the DB instance.

attrPublicPortRequired 

public readonly attrPublicPort: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PublicPort: The public port ID of the DB instance.

attrReadOnlyDbInstanceIdsRequired 

public readonly attrReadOnlyDbInstanceIds: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ReadOnlyDbInstanceIds: The array of the readonly db instances.

attrResourceGroupIdRequired 

public readonly attrResourceGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: Resource Group ID.

attrTagsRequired 

public readonly attrTags: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Tags: The tags of the GDB Instance.

attrVpcIdRequired 

public readonly attrVpcId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VpcId: The vpc id of the db instance.

attrVSwitchIdRequired 

public readonly attrVSwitchId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VSwitchId: The vswitch id of the DB instance.

attrZoneIdRequired 

public readonly attrZoneId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ZoneId: The zone ID of the instance.