Skip to content

DbInstance

This class encapsulates and extends the ROS resource type ALIYUN::GraphDatabase::DbInstance, which is used to create a Graph Database (GDB) instance.

Initializers 

import com.aliyun.ros.cdk.graphdatabase.DbInstance;
DbInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dbInstanceCategory(java.lang.String)
    .dbInstanceCategory(IResolvable)
    .dbInstanceNetworkType(java.lang.String)
    .dbInstanceNetworkType(IResolvable)
    .dbInstanceStorageType(java.lang.String)
    .dbInstanceStorageType(IResolvable)
    .dbNodeClass(java.lang.String)
    .dbNodeClass(IResolvable)
    .dbNodeStorage(java.lang.Number)
    .dbNodeStorage(IResolvable)
    .dbVersion(java.lang.String)
    .dbVersion(IResolvable)
//  .backupSetId(java.lang.String)
//  .backupSetId(IResolvable)
//  .createType(java.lang.String)
//  .createType(IResolvable)
//  .dbInstanceDescription(java.lang.String)
//  .dbInstanceDescription(IResolvable)
//  .dbInstanceIpArray(IResolvable)
//  .dbInstanceIpArray(java.util.List<IResolvable)
//  .dbInstanceIpArray(DBInstanceIPArrayProperty>)
//  .ecsSecurityGroupRelations(IResolvable)
//  .ecsSecurityGroupRelations(java.util.List<IResolvable)
//  .ecsSecurityGroupRelations(EcsSecurityGroupRelationsProperty>)
//  .maintainTime(java.lang.String)
//  .maintainTime(IResolvable)
//  .paymentType(java.lang.String)
//  .paymentType(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .restoreType(java.lang.String)
//  .restoreType(IResolvable)
//  .sourceDbInstanceId(java.lang.String)
//  .sourceDbInstanceId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .vpcId(java.lang.String)
//  .vpcId(IResolvable)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
//  .zoneId(java.lang.String)
//  .zoneId(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
dbInstanceCategory java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceCategory: The category of the db instance.
dbInstanceNetworkType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceNetworkType: The network type of the db instance.
dbInstanceStorageType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceStorageType: Instance storage type, Valid values: - cloud_essd.
dbNodeClass java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbNodeClass: The class of the db node.
dbNodeStorage java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property dbNodeStorage: Instance storage space, which is measured in GB.
dbVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbVersion: Kernel version 1.0 is represented as gremlin,1.0-OpenCypher said opencypher.
backupSetId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property backupSetId: Backup set id.
createType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property createType: The creation method.
dbInstanceDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbInstanceDescription: According to the practical example or notes.
dbInstanceIpArray com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDBInstanceIPArrayProperty> Property dbInstanceIpArray: IP address whitelist for the instance group list.
ecsSecurityGroupRelations com.aliyun.ros.cdk.core.IResolvable OR java.util.ListEcsSecurityGroupRelationsProperty> Property ecsSecurityGroupRelations: Security group information array.
maintainTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property maintainTime: Instance maintenance time such as 00:00Z-02:00Z, 0 to 2 points to carry out routine maintenance.
paymentType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property paymentType: The resource attribute field representing the paid type is desirable: - PayAsYouGo: Postpaid.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: Resource group id.
restoreType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property restoreType: Restore type.
sourceDbInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sourceDbInstanceId: Source Instance Id.
tags java.util.List<TagsProperty> Property tags: Tags of db instance.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The vpc id of the db instance.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: The vpc switch id of the resource.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: ZoneId.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

dbInstanceCategoryRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbInstanceCategory: The category of the db instance.

dbInstanceNetworkTypeRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbInstanceNetworkType: The network type of the db instance.

dbInstanceStorageTypeRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbInstanceStorageType: Instance storage type, Valid values: - cloud_essd.

dbNodeClassRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbNodeClass: The class of the db node.

Valid values: gdb.r.xlarge, gdb.r.2xlarge, gdb.r.4xlarge, gdb.r.8xlarge,gdb.r.16xlarge, gdb.re.13xlarge, gdb.re.26xlarge, gdb.re.52xlarge

dbNodeStorageRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property dbNodeStorage: Instance storage space, which is measured in GB.

The minimum storage space is 20 GB and the step size is 10GB.

dbVersionRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbVersion: Kernel version 1.0 is represented as gremlin,1.0-OpenCypher said opencypher.

backupSetIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property backupSetId: Backup set id.

createTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property createType: The creation method.

Valid values:

  • CreateDBInstance: Create instance
  • CloneDBInstance: Clone instance
  • CreateReadDBInstance: Create a read-only instance

dbInstanceDescriptionOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbInstanceDescription: According to the practical example or notes.

dbInstanceIpArrayOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListDBInstanceIPArrayProperty>

Property dbInstanceIpArray: IP address whitelist for the instance group list.

ecsSecurityGroupRelationsOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListEcsSecurityGroupRelationsProperty>

Property ecsSecurityGroupRelations: Security group information array.

maintainTimeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property maintainTime: Instance maintenance time such as 00:00Z-02:00Z, 0 to 2 points to carry out routine maintenance.

paymentTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property paymentType: The resource attribute field representing the paid type is desirable: - PayAsYouGo: Postpaid.

resourceGroupIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: Resource group id.

restoreTypeOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property restoreType: Restore type.

sourceDbInstanceIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property sourceDbInstanceId: Source Instance Id.

tagsOptional

Property tags: Tags of db instance.

vpcIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vpcId: The vpc id of the db instance.

vSwitchIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: The vpc switch id of the resource.

zoneIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property zoneId: ZoneId.

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 java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import com.aliyun.ros.cdk.graphdatabase.DbInstance;
DbInstance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

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

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrConnectionStringRequired 

public IResolvable getAttrConnectionString();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ConnectionString: Virtual Private Cloud (vpc connection such as a VPN connection or leased line domain name.

attrCreateTimeRequired 

public IResolvable getAttrCreateTime();
  • Type: com.aliyun.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 IResolvable getAttrCurrentMinorVersion();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CurrentMinorVersion: The current kernel image version.

attrDbInstanceCategoryRequired 

public IResolvable getAttrDbInstanceCategory();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DbInstanceCategory: The category of the db instance.

attrDbInstanceCpuRequired 

public IResolvable getAttrDbInstanceCpu();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrDbInstanceDescriptionRequired 

public IResolvable getAttrDbInstanceDescription();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DbInstanceDescription: According to the practical example or notes.

attrDbInstanceIdRequired 

public IResolvable getAttrDbInstanceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DbInstanceId: The first ID of the resource.

attrDbInstanceIpArrayRequired 

public IResolvable getAttrDbInstanceIpArray();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrDbInstanceMemoryRequired 

public IResolvable getAttrDbInstanceMemory();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrDbInstanceNetworkTypeRequired 

public IResolvable getAttrDbInstanceNetworkType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DbInstanceNetworkType: The network type of the db instance.

attrDbInstanceStorageTypeRequired 

public IResolvable getAttrDbInstanceStorageType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DbInstanceStorageType: Cloud Disk.

attrDbInstanceTypeRequired 

public IResolvable getAttrDbInstanceType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DbInstanceType: The type of the db instance.

attrDbNodeClassRequired 

public IResolvable getAttrDbNodeClass();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DbNodeClass: The class of the db node.

attrDbNodeCountRequired 

public IResolvable getAttrDbNodeCount();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DbNodeCount: The count of the db node.

attrDbNodeStorageRequired 

public IResolvable getAttrDbNodeStorage();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrDbVersionRequired 

public IResolvable getAttrDbVersion();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrEcsSecurityGroupRelationsRequired 

public IResolvable getAttrEcsSecurityGroupRelations();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EcsSecurityGroupRelations: Security group information array.

attrExpiredRequired 

public IResolvable getAttrExpired();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Expired: The expire status of the db instance.

attrExpireTimeRequired 

public IResolvable getAttrExpireTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrLatestMinorVersionRequired 

public IResolvable getAttrLatestMinorVersion();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute LatestMinorVersion: The latest kernel image version.

attrLockModeRequired 

public IResolvable getAttrLockMode();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute LockMode: Instance lock state.

attrLockReasonRequired 

public IResolvable getAttrLockReason();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute LockReason: An instance is locked the reason.

attrMaintainTimeRequired 

public IResolvable getAttrMaintainTime();
  • Type: com.aliyun.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 IResolvable getAttrPaymentType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrPortRequired 

public IResolvable getAttrPort();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Port: Application Port.

attrPublicConnectionStringRequired 

public IResolvable getAttrPublicConnectionString();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PublicConnectionString: The public connection string ID of the resource.

attrPublicPortRequired 

public IResolvable getAttrPublicPort();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PublicPort: The public port ID of the resource.

attrReadOnlyDbInstanceIdsRequired 

public IResolvable getAttrReadOnlyDbInstanceIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ReadOnlyDbInstanceIds: The array of the readonly db instances.

attrResourceGroupIdRequired 

public IResolvable getAttrResourceGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: Resource Group ID.

attrTagsRequired 

public IResolvable getAttrTags();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Tags: resource Tag group.

attrVpcIdRequired 

public IResolvable getAttrVpcId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VpcId: The vpc id of the db instance.

attrVSwitchIdRequired 

public IResolvable getAttrVSwitchId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VSwitchId: The vpc switch id of the resource.

attrZoneIdRequired 

public IResolvable getAttrZoneId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ZoneId: ZoneId.