DbInstance
- Implements: com.aliyun.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 com.aliyun.ros.cdk.graphdatabase.datasource.DbInstance;
DbInstance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.dbInstanceId(java.lang.String)
.dbInstanceId(IResolvable)
// .refreshOptions(java.lang.String)
// .refreshOptions(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. |
dbInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property dbInstanceId: The ID of the GDB Instance. |
refreshOptions | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
dbInstanceIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property dbInstanceId: The ID of the GDB Instance.
refreshOptionsOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
Valid values:
- Never: Never refresh the datasource resource when the stack is updated.
- Always: Always refresh the datasource resource when the stack is updated. Default is Never.
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 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.graphdatabase.datasource.DbInstance;
DbInstance.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ConnectionString: Virtual Private Cloud (vpc connection such as a VPN connection or leased line domain name. |
attrCreateTime | java.lang.String OR 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 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CurrentMinorVersion: The current kernel image version. |
attrDbInstanceCategory | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DbInstanceCategory: The category of the db instance. |
attrDbInstanceCpu | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DbInstanceCpu: For example, instances can be grouped according to Cpu core count. |
attrDbInstanceDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DbInstanceDescription: According to the practical example or notes. |
attrDbInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DbInstanceId: The ID of the GDB Instance. |
attrDbInstanceIpArray | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DBInstanceIPArray: IP ADDRESS whitelist for the instance group list. |
attrDbInstanceMemory | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DbInstanceMemory: Instance memory, which is measured in MB. |
attrDbInstanceNetworkType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DbInstanceNetworkType: The network type of the db instance. |
attrDbInstanceStorageType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DbInstanceStorageType: Cloud Disk. |
attrDbInstanceType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DbInstanceType: The type of the db instance. |
attrDbNodeClass | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DbNodeClass: The class of the db node. |
attrDbNodeCount | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DbNodeCount: The count of the db node. |
attrDbNodeStorage | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DbNodeStorage: Instance storage space, which is measured in GB. |
attrDbVersion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DbVersion: Kernel Version 1.0 is represented as gremlin,1. |
attrEcsSecurityGroupRelations | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute EcsSecurityGroupRelations: Security group information array. |
attrExpired | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Expired: The expire status of the db instance. |
attrExpireTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ExpireTime: The instance after it expires time for subscription instance. |
attrLatestMinorVersion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute LatestMinorVersion: The latest kernel image version. |
attrLockMode | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute LockMode: Instance lock state. |
attrLockReason | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute LockReason: An instance is locked the reason. |
attrMaintainTime | java.lang.String OR 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 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PaymentType: The DB instance attribute field representing the paid type is desirable. |
attrPort | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Port: Application Port. |
attrPublicConnectionString | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PublicConnectionString: The public connection string ID of the DB instance. |
attrPublicPort | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PublicPort: The public port ID of the DB instance. |
attrReadOnlyDbInstanceIds | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ReadOnlyDbInstanceIds: The array of the readonly db instances. |
attrResourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceGroupId: Resource Group ID. |
attrTags | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Tags: The tags of the GDB Instance. |
attrVpcId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VpcId: The vpc id of the db instance. |
attrVSwitchId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VSwitchId: The vswitch id of the DB instance. |
attrZoneId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ZoneId: The zone ID of the instance. |
props | DbInstanceProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.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 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 java.lang.Object getAttrConnectionString();
- Type: java.lang.String OR 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 java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR 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 java.lang.Object getAttrCurrentMinorVersion();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CurrentMinorVersion: The current kernel image version.
attrDbInstanceCategoryRequired
public java.lang.Object getAttrDbInstanceCategory();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DbInstanceCategory: The category of the db instance.
attrDbInstanceCpuRequired
public java.lang.Object getAttrDbInstanceCpu();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DbInstanceCpu: For example, instances can be grouped according to Cpu core count.
attrDbInstanceDescriptionRequired
public java.lang.Object getAttrDbInstanceDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DbInstanceDescription: According to the practical example or notes.
attrDbInstanceIdRequired
public java.lang.Object getAttrDbInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DbInstanceId: The ID of the GDB Instance.
attrDbInstanceIpArrayRequired
public java.lang.Object getAttrDbInstanceIpArray();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DBInstanceIPArray: IP ADDRESS whitelist for the instance group list.
attrDbInstanceMemoryRequired
public java.lang.Object getAttrDbInstanceMemory();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DbInstanceMemory: Instance memory, which is measured in MB.
attrDbInstanceNetworkTypeRequired
public java.lang.Object getAttrDbInstanceNetworkType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DbInstanceNetworkType: The network type of the db instance.
attrDbInstanceStorageTypeRequired
public java.lang.Object getAttrDbInstanceStorageType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DbInstanceStorageType: Cloud Disk.
attrDbInstanceTypeRequired
public java.lang.Object getAttrDbInstanceType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DbInstanceType: The type of the db instance.
attrDbNodeClassRequired
public java.lang.Object getAttrDbNodeClass();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DbNodeClass: The class of the db node.
attrDbNodeCountRequired
public java.lang.Object getAttrDbNodeCount();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DbNodeCount: The count of the db node.
attrDbNodeStorageRequired
public java.lang.Object getAttrDbNodeStorage();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DbNodeStorage: Instance storage space, which is measured in GB.
attrDbVersionRequired
public java.lang.Object getAttrDbVersion();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DbVersion: Kernel Version 1.0 is represented as gremlin,1.
attrEcsSecurityGroupRelationsRequired
public java.lang.Object getAttrEcsSecurityGroupRelations();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute EcsSecurityGroupRelations: Security group information array.
attrExpiredRequired
public java.lang.Object getAttrExpired();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Expired: The expire status of the db instance.
attrExpireTimeRequired
public java.lang.Object getAttrExpireTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ExpireTime: The instance after it expires time for subscription instance.
attrLatestMinorVersionRequired
public java.lang.Object getAttrLatestMinorVersion();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute LatestMinorVersion: The latest kernel image version.
attrLockModeRequired
public java.lang.Object getAttrLockMode();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute LockMode: Instance lock state.
attrLockReasonRequired
public java.lang.Object getAttrLockReason();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute LockReason: An instance is locked the reason.
attrMaintainTimeRequired
public java.lang.Object getAttrMaintainTime();
- Type: java.lang.String OR 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 java.lang.Object getAttrPaymentType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PaymentType: The DB instance attribute field representing the paid type is desirable.
attrPortRequired
public java.lang.Object getAttrPort();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Port: Application Port.
attrPublicConnectionStringRequired
public java.lang.Object getAttrPublicConnectionString();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PublicConnectionString: The public connection string ID of the DB instance.
attrPublicPortRequired
public java.lang.Object getAttrPublicPort();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PublicPort: The public port ID of the DB instance.
attrReadOnlyDbInstanceIdsRequired
public java.lang.Object getAttrReadOnlyDbInstanceIds();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ReadOnlyDbInstanceIds: The array of the readonly db instances.
attrResourceGroupIdRequired
public java.lang.Object getAttrResourceGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceGroupId: Resource Group ID.
attrTagsRequired
public java.lang.Object getAttrTags();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Tags: The tags of the GDB Instance.
attrVpcIdRequired
public java.lang.Object getAttrVpcId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VpcId: The vpc id of the db instance.
attrVSwitchIdRequired
public java.lang.Object getAttrVSwitchId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VSwitchId: The vswitch id of the DB instance.
attrZoneIdRequired
public java.lang.Object getAttrZoneId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ZoneId: The zone ID of the instance.
propsRequired
public DbInstanceProps getProps();
- Type: DbInstanceProps