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 ros_cdk_graphdatabase
ros_cdk_graphdatabase.DbInstance(
scope: Construct,
id: str,
db_instance_category: typing.Union[str, IResolvable],
db_instance_network_type: typing.Union[str, IResolvable],
db_instance_storage_type: typing.Union[str, IResolvable],
db_node_class: typing.Union[str, IResolvable],
db_node_storage: typing.Union[typing.Union[int, float], IResolvable],
db_version: typing.Union[str, IResolvable],
backup_set_id: typing.Union[str, IResolvable] = None,
create_type: typing.Union[str, IResolvable] = None,
db_instance_description: typing.Union[str, IResolvable] = None,
db_instance_ip_array: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, DBInstanceIPArrayProperty]]] = None,
ecs_security_group_relations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, EcsSecurityGroupRelationsProperty]]] = None,
maintain_time: typing.Union[str, IResolvable] = None,
payment_type: typing.Union[str, IResolvable] = None,
resource_group_id: typing.Union[str, IResolvable] = None,
restore_type: typing.Union[str, IResolvable] = None,
source_db_instance_id: typing.Union[str, IResolvable] = None,
tags: typing.List[TagsProperty] = None,
vpc_id: typing.Union[str, IResolvable] = None,
v_switch_id: typing.Union[str, IResolvable] = None,
zone_id: 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_category |
typing.Union[str, ros_cdk_core.IResolvable] |
Property dbInstanceCategory: The category of the db instance. |
db_instance_network_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property dbInstanceNetworkType: The network type of the db instance. |
db_instance_storage_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property dbInstanceStorageType: Instance storage type, Valid values: - cloud_essd. |
db_node_class |
typing.Union[str, ros_cdk_core.IResolvable] |
Property dbNodeClass: The class of the db node. |
db_node_storage |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property dbNodeStorage: Instance storage space, which is measured in GB. |
db_version |
typing.Union[str, ros_cdk_core.IResolvable] |
Property dbVersion: Kernel version 1.0 is represented as gremlin,1.0-OpenCypher said opencypher. |
backup_set_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property backupSetId: Backup set id. |
create_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property createType: The creation method. |
db_instance_description |
typing.Union[str, ros_cdk_core.IResolvable] |
Property dbInstanceDescription: According to the practical example or notes. |
db_instance_ip_array |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DBInstanceIPArrayProperty]]] |
Property dbInstanceIpArray: IP address whitelist for the instance group list. |
ecs_security_group_relations |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EcsSecurityGroupRelationsProperty]]] |
Property ecsSecurityGroupRelations: Security group information array. |
maintain_time |
typing.Union[str, ros_cdk_core.IResolvable] |
Property maintainTime: Instance maintenance time such as 00:00Z-02:00Z, 0 to 2 points to carry out routine maintenance. |
payment_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property paymentType: The resource attribute field representing the paid type is desirable: - PayAsYouGo: Postpaid. |
resource_group_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property resourceGroupId: Resource group id. |
restore_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property restoreType: Restore type. |
source_db_instance_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property sourceDbInstanceId: Source Instance Id. |
tags |
typing.List[TagsProperty] |
Property tags: Tags of db instance. |
vpc_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property vpcId: The vpc id of the db instance. |
v_switch_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property vSwitchId: The vpc switch id of the resource. |
zone_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property zoneId: ZoneId. |
enable_resource_property_constraint |
bool |
No description. |
scope
Required
- Type: ros_cdk_core.Construct
id
Required
- Type: str
db_instance_category
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property dbInstanceCategory: The category of the db instance.
db_instance_network_type
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property dbInstanceNetworkType: The network type of the db instance.
db_instance_storage_type
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property dbInstanceStorageType: Instance storage type, Valid values: - cloud_essd.
db_node_class
Required
- Type: typing.Union[str, 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
db_node_storage
Required
- Type: typing.Union[typing.Union[int, float], 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.
db_version
Required
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property dbVersion: Kernel version 1.0 is represented as gremlin,1.0-OpenCypher said opencypher.
backup_set_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property backupSetId: Backup set id.
create_type
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property createType: The creation method.
Valid values:
- CreateDBInstance: Create instance
- CloneDBInstance: Clone instance
- CreateReadDBInstance: Create a read-only instance
db_instance_description
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property dbInstanceDescription: According to the practical example or notes.
db_instance_ip_array
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, DBInstanceIPArrayProperty]]]
Property dbInstanceIpArray: IP address whitelist for the instance group list.
ecs_security_group_relations
Optional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, EcsSecurityGroupRelationsProperty]]]
Property ecsSecurityGroupRelations: Security group information array.
maintain_time
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property maintainTime: Instance maintenance time such as 00:00Z-02:00Z, 0 to 2 points to carry out routine maintenance.
payment_type
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property paymentType: The resource attribute field representing the paid type is desirable: - PayAsYouGo: Postpaid.
resource_group_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property resourceGroupId: Resource group id.
restore_type
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property restoreType: Restore type.
source_db_instance_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property sourceDbInstanceId: Source Instance Id.
tags
Optional
- Type: typing.List[TagsProperty]
Property tags: Tags of db instance.
vpc_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property vpcId: The vpc id of the db instance.
v_switch_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property vSwitchId: The vpc switch id of the resource.
zone_id
Optional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property zoneId: ZoneId.
enable_resource_property_constraint
Optional
- 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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
Name | Description |
---|---|
is_construct |
Return whether the given object is a Construct. |
is_construct
import ros_cdk_graphdatabase
ros_cdk_graphdatabase.DbInstance.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- 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 first ID of the resource. |
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 resource 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 resource. |
attr_public_port |
ros_cdk_core.IResolvable |
Attribute PublicPort: The public port ID of the resource. |
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: resource Tag group. |
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 vpc switch id of the resource. |
attr_zone_id |
ros_cdk_core.IResolvable |
Attribute ZoneId: ZoneId. |
node
Required
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
ref
Required
ref: str
- Type: str
stack
Required
stack: Stack
- Type: ros_cdk_core.Stack
The stack in which this resource is defined.
resource
Optional
resource: RosResource
- Type: ros_cdk_core.RosResource
attr_connection_string
Required
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_time
Required
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_version
Required
attr_current_minor_version: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute CurrentMinorVersion: The current kernel image version.
attr_db_instance_category
Required
attr_db_instance_category: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute DbInstanceCategory: The category of the db instance.
attr_db_instance_cpu
Required
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_description
Required
attr_db_instance_description: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute DbInstanceDescription: According to the practical example or notes.
attr_db_instance_id
Required
attr_db_instance_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute DbInstanceId: The first ID of the resource.
attr_db_instance_ip_array
Required
attr_db_instance_ip_array: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute DBInstanceIPArray: IP ADDRESS whitelist for the instance group list.
attr_db_instance_memory
Required
attr_db_instance_memory: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute DbInstanceMemory: Instance memory, which is measured in MB.
attr_db_instance_network_type
Required
attr_db_instance_network_type: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute DbInstanceNetworkType: The network type of the db instance.
attr_db_instance_storage_type
Required
attr_db_instance_storage_type: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute DbInstanceStorageType: Cloud Disk.
attr_db_instance_type
Required
attr_db_instance_type: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute DbInstanceType: The type of the db instance.
attr_db_node_class
Required
attr_db_node_class: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute DbNodeClass: The class of the db node.
attr_db_node_count
Required
attr_db_node_count: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute DbNodeCount: The count of the db node.
attr_db_node_storage
Required
attr_db_node_storage: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute DbNodeStorage: Instance storage space, which is measured in GB.
attr_db_version
Required
attr_db_version: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute DbVersion: Kernel Version 1.0 is represented as gremlin,1.
attr_ecs_security_group_relations
Required
attr_ecs_security_group_relations: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute EcsSecurityGroupRelations: Security group information array.
attr_expired
Required
attr_expired: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute Expired: The expire status of the db instance.
attr_expire_time
Required
attr_expire_time: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute ExpireTime: The instance after it expires time for subscription instance.
attr_latest_minor_version
Required
attr_latest_minor_version: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute LatestMinorVersion: The latest kernel image version.
attr_lock_mode
Required
attr_lock_mode: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute LockMode: Instance lock state.
attr_lock_reason
Required
attr_lock_reason: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute LockReason: An instance is locked the reason.
attr_maintain_time
Required
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_type
Required
attr_payment_type: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute PaymentType: The resource attribute field representing the paid type is desirable:.
attr_port
Required
attr_port: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute Port: Application Port.
attr_public_connection_string
Required
attr_public_connection_string: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute PublicConnectionString: The public connection string ID of the resource.
attr_public_port
Required
attr_public_port: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute PublicPort: The public port ID of the resource.
attr_read_only_db_instance_ids
Required
attr_read_only_db_instance_ids: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute ReadOnlyDbInstanceIds: The array of the readonly db instances.
attr_resource_group_id
Required
attr_resource_group_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute ResourceGroupId: Resource Group ID.
attr_tags
Required
attr_tags: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute Tags: resource Tag group.
attr_vpc_id
Required
attr_vpc_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute VpcId: The vpc id of the db instance.
attr_v_switch_id
Required
attr_v_switch_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute VSwitchId: The vpc switch id of the resource.
attr_zone_id
Required
attr_zone_id: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute ZoneId: ZoneId.