Skip to content

DbInstance

This class encapsulates and extends the ROS resource type DATASOURCE::GraphDatabase::DbInstance, which is used to query the information about an instance.

Initializers 

from ros_cdk_graphdatabase import datasource
datasource.DbInstance(
  scope: Construct,
  id: str,
  db_instance_id: typing.Union[str, IResolvable],
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
db_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property dbInstanceId: The ID of the GDB Instance.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

db_instance_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dbInstanceId: The ID of the GDB Instance.

refresh_optionsOptional

  • Type: typing.Union[str, 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.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct 

from ros_cdk_graphdatabase import datasource
datasource.DbInstance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_connection_string ros_cdk_core.IResolvable Attribute ConnectionString: Virtual Private Cloud (vpc connection such as a VPN connection or leased line domain name.
attr_create_time 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.
attr_current_minor_version ros_cdk_core.IResolvable Attribute CurrentMinorVersion: The current kernel image version.
attr_db_instance_category ros_cdk_core.IResolvable Attribute DbInstanceCategory: The category of the db instance.
attr_db_instance_cpu ros_cdk_core.IResolvable Attribute DbInstanceCpu: For example, instances can be grouped according to Cpu core count.
attr_db_instance_description ros_cdk_core.IResolvable Attribute DbInstanceDescription: According to the practical example or notes.
attr_db_instance_id ros_cdk_core.IResolvable Attribute DbInstanceId: The ID of the GDB Instance.
attr_db_instance_ip_array ros_cdk_core.IResolvable Attribute DBInstanceIPArray: IP ADDRESS whitelist for the instance group list.
attr_db_instance_memory ros_cdk_core.IResolvable Attribute DbInstanceMemory: Instance memory, which is measured in MB.
attr_db_instance_network_type ros_cdk_core.IResolvable Attribute DbInstanceNetworkType: The network type of the db instance.
attr_db_instance_storage_type ros_cdk_core.IResolvable Attribute DbInstanceStorageType: Cloud Disk.
attr_db_instance_type ros_cdk_core.IResolvable Attribute DbInstanceType: The type of the db instance.
attr_db_node_class ros_cdk_core.IResolvable Attribute DbNodeClass: The class of the db node.
attr_db_node_count ros_cdk_core.IResolvable Attribute DbNodeCount: The count of the db node.
attr_db_node_storage ros_cdk_core.IResolvable Attribute DbNodeStorage: Instance storage space, which is measured in GB.
attr_db_version ros_cdk_core.IResolvable Attribute DbVersion: Kernel Version 1.0 is represented as gremlin,1.
attr_ecs_security_group_relations ros_cdk_core.IResolvable Attribute EcsSecurityGroupRelations: Security group information array.
attr_expired ros_cdk_core.IResolvable Attribute Expired: The expire status of the db instance.
attr_expire_time ros_cdk_core.IResolvable Attribute ExpireTime: The instance after it expires time for subscription instance.
attr_latest_minor_version ros_cdk_core.IResolvable Attribute LatestMinorVersion: The latest kernel image version.
attr_lock_mode ros_cdk_core.IResolvable Attribute LockMode: Instance lock state.
attr_lock_reason ros_cdk_core.IResolvable Attribute LockReason: An instance is locked the reason.
attr_maintain_time ros_cdk_core.IResolvable Attribute MaintainTime: Instance maintenance time such as 00:00Z-02:00Z, 0 to 2 points to carry out routine maintenance.
attr_payment_type ros_cdk_core.IResolvable Attribute PaymentType: The DB instance attribute field representing the paid type is desirable.
attr_port ros_cdk_core.IResolvable Attribute Port: Application Port.
attr_public_connection_string ros_cdk_core.IResolvable Attribute PublicConnectionString: The public connection string ID of the DB instance.
attr_public_port ros_cdk_core.IResolvable Attribute PublicPort: The public port ID of the DB instance.
attr_read_only_db_instance_ids ros_cdk_core.IResolvable Attribute ReadOnlyDbInstanceIds: The array of the readonly db instances.
attr_resource_group_id ros_cdk_core.IResolvable Attribute ResourceGroupId: Resource Group ID.
attr_tags ros_cdk_core.IResolvable Attribute Tags: The tags of the GDB Instance.
attr_vpc_id ros_cdk_core.IResolvable Attribute VpcId: The vpc id of the db instance.
attr_v_switch_id ros_cdk_core.IResolvable Attribute VSwitchId: The vswitch id of the DB instance.
attr_zone_id ros_cdk_core.IResolvable Attribute ZoneId: The zone ID of the instance.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_connection_stringRequired 

attr_connection_string: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: 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.

attr_current_minor_versionRequired 

attr_current_minor_version: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CurrentMinorVersion: The current kernel image version.

attr_db_instance_categoryRequired 

attr_db_instance_category: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DbInstanceCategory: The category of the db instance.

attr_db_instance_cpuRequired 

attr_db_instance_cpu: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_db_instance_descriptionRequired 

attr_db_instance_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DbInstanceDescription: According to the practical example or notes.

attr_db_instance_idRequired 

attr_db_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DbInstanceId: The ID of the GDB Instance.

attr_db_instance_ip_arrayRequired 

attr_db_instance_ip_array: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_db_instance_memoryRequired 

attr_db_instance_memory: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_db_instance_network_typeRequired 

attr_db_instance_network_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DbInstanceNetworkType: The network type of the db instance.

attr_db_instance_storage_typeRequired 

attr_db_instance_storage_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DbInstanceStorageType: Cloud Disk.

attr_db_instance_typeRequired 

attr_db_instance_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DbInstanceType: The type of the db instance.

attr_db_node_classRequired 

attr_db_node_class: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DbNodeClass: The class of the db node.

attr_db_node_countRequired 

attr_db_node_count: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DbNodeCount: The count of the db node.

attr_db_node_storageRequired 

attr_db_node_storage: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_db_versionRequired 

attr_db_version: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_ecs_security_group_relationsRequired 

attr_ecs_security_group_relations: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EcsSecurityGroupRelations: Security group information array.

attr_expiredRequired 

attr_expired: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Expired: The expire status of the db instance.

attr_expire_timeRequired 

attr_expire_time: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_latest_minor_versionRequired 

attr_latest_minor_version: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LatestMinorVersion: The latest kernel image version.

attr_lock_modeRequired 

attr_lock_mode: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LockMode: Instance lock state.

attr_lock_reasonRequired 

attr_lock_reason: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LockReason: An instance is locked the reason.

attr_maintain_timeRequired 

attr_maintain_time: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_payment_typeRequired 

attr_payment_type: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_portRequired 

attr_port: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Port: Application Port.

attr_public_connection_stringRequired 

attr_public_connection_string: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_public_portRequired 

attr_public_port: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_read_only_db_instance_idsRequired 

attr_read_only_db_instance_ids: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ReadOnlyDbInstanceIds: The array of the readonly db instances.

attr_resource_group_idRequired 

attr_resource_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: Resource Group ID.

attr_tagsRequired 

attr_tags: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Tags: The tags of the GDB Instance.

attr_vpc_idRequired 

attr_vpc_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcId: The vpc id of the db instance.

attr_v_switch_idRequired 

attr_v_switch_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VSwitchId: The vswitch id of the DB instance.

attr_zone_idRequired 

attr_zone_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ZoneId: The zone ID of the instance.