Skip to content

InstancesProps

Properties for defining a Instances.

See https://www.alibabacloud.com/help/ros/developer-reference/datasource-mongodb-instances

Initializer

from ros_cdk_mongodb import datasource
datasource.InstancesProps(
  charge_type: typing.Union[str, IResolvable] = None,
  connection_domain: typing.Union[str, IResolvable] = None,
  db_instance_class: typing.Union[str, IResolvable] = None,
  db_instance_description: typing.Union[str, IResolvable] = None,
  db_instance_id: typing.Union[str, IResolvable] = None,
  db_instance_status: typing.Union[str, IResolvable] = None,
  db_instance_type: typing.Union[str, IResolvable] = None,
  engine_version: typing.Union[str, IResolvable] = None,
  expired: typing.Union[bool, IResolvable] = None,
  network_type: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  replication_factor: typing.Union[str, IResolvable] = None,
  resource_group_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
)

Properties

Name Type Description
charge_type typing.Union[str, ros_cdk_core.IResolvable] Property chargeType: The billing method of the instance.
connection_domain typing.Union[str, ros_cdk_core.IResolvable] Property connectionDomain: The endpoint of the node.
db_instance_class typing.Union[str, ros_cdk_core.IResolvable] Property dbInstanceClass: The instance type.
db_instance_description typing.Union[str, ros_cdk_core.IResolvable] Property dbInstanceDescription: The description of the instance.
db_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property dbInstanceId: The ID of the instance.
db_instance_status typing.Union[str, ros_cdk_core.IResolvable] Property dbInstanceStatus: The state of the instance.
db_instance_type typing.Union[str, ros_cdk_core.IResolvable] Property dbInstanceType: The category of the instance.
engine_version typing.Union[str, ros_cdk_core.IResolvable] Property engineVersion: The database engine version of the instance.
expired typing.Union[bool, ros_cdk_core.IResolvable] Property expired: Specifies whether the instance expires.
network_type typing.Union[str, ros_cdk_core.IResolvable] Property networkType: The network type of the instance.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
replication_factor typing.Union[str, ros_cdk_core.IResolvable] Property replicationFactor: The number of nodes in a replica set instance.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group.
tags typing.List[ros_cdk_mongodb.datasource.RosInstances.TagsProperty] Property tags: Tags of instance.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The VPC ID of the instance.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: The vSwitch ID of the instance.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The zone ID of the instance.

charge_typeOptional

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

Property chargeType: The billing method of the instance.

Valid values: PostPaid: pay-as-you-go PrePaid: subscription


connection_domainOptional

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

Property connectionDomain: The endpoint of the node.

You can call the DescribeDBInstanceAttribute operation to query the endpoint of the node.


db_instance_classOptional

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

Property dbInstanceClass: The instance type.

For more information about valid values, see Instance types.


db_instance_descriptionOptional

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

Property dbInstanceDescription: The description of the instance.


db_instance_idOptional

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

Property dbInstanceId: The ID of the instance.


db_instance_statusOptional

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

Property dbInstanceStatus: The state of the instance.

For more information about valid values, see Instance states.


db_instance_typeOptional

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

Property dbInstanceType: The category of the instance.

Default value: replicate. Valid values: sharding: sharded cluster instance replicate: replica set or standalone instance Note To query the list of sharded cluster instances, you must set the parameter to sharding. This operation displays the list of replica set and standalone instances when the parameter uses the default value replicate.


engine_versionOptional

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

Property engineVersion: The database engine version of the instance.

Valid values: 5.0 4.4 4.2 4.0 3.4


expiredOptional

expired: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property expired: Specifies whether the instance expires.

Valid values: true: The instance expires. false: The instance does not expire.


network_typeOptional

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

Property networkType: The network type of the instance.

Valid values: Classic Vpc


refresh_optionsOptional

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

replication_factorOptional

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

Property replicationFactor: The number of nodes in a replica set instance.

Valid values: 3, 5, and 7.


resource_group_idOptional

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

Property resourceGroupId: The ID of the resource group.


tagsOptional

tags: typing.List[TagsProperty]
  • Type: typing.List[ros_cdk_mongodb.datasource.RosInstances.TagsProperty]

Property tags: Tags of instance.


vpc_idOptional

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

Property vpcId: The VPC ID of the instance.


v_switch_idOptional

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

Property vSwitchId: The vSwitch ID of the instance.


zone_idOptional

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

Property zoneId: The zone ID of the instance.

You can call the DescribeRegions operation to query the most recent zone list.