Instances

This class encapsulates and extends the ROS resource type DATASOURCE::MONGODB::Instances, which is used to query the information about ApsaraDB for MongoDB instances.

Initializers

from ros_cdk_mongodb import datasource
datasource.Instances(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
`scope`	`ros_cdk_core.Construct`	No description.
`id`	`str`	No 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.
`enable_resource_property_constraint`	`bool`	No description.

`scope`^Required

Type: ros_cdk_core.Construct

`id`^Required

Type: str

`charge_type`^Optional

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_domain`^Optional

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_class`^Optional

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

Property dbInstanceClass: The instance type.

For more information about valid values, see Instance types.

`db_instance_description`^Optional

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

Property dbInstanceDescription: The description of the instance.

`db_instance_id`^Optional

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

Property dbInstanceId: The ID of the instance.

`db_instance_status`^Optional

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_type`^Optional

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_version`^Optional

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

`expired`^Optional

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_type`^Optional

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

Property networkType: The network type of the instance.

Valid values: Classic Vpc

`refresh_options`^Optional

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_factor`^Optional

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_id`^Optional

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

Property resourceGroupId: The ID of the resource group.

`tags`^Optional

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

Property tags: Tags of instance.

`vpc_id`^Optional

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

Property vpcId: The VPC ID of the instance.

`v_switch_id`^Optional

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

Property vSwitchId: The vSwitch ID of the instance.

`zone_id`^Optional

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.

`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.

session^Required

Type: ros_cdk_core.ISynthesisSession

The synthesis session.

`add_condition`

def add_condition(
  condition: RosCondition
) -> None

condition^Required

Type: ros_cdk_core.RosCondition

`add_count`

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

count^Required

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

`add_dependency`

def add_dependency(
  resource: Resource
) -> None

resource^Required

Type: ros_cdk_core.Resource

`add_resource_desc`

def add_resource_desc(
  desc: str
) -> None

desc^Required

Type: str

`apply_removal_policy`

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

Type: ros_cdk_core.RemovalPolicy

`get_att`

def get_att(
  name: str
) -> IResolvable

name^Required

Type: str

`set_metadata`

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

key^Required

Type: str

value^Required

Type: typing.Any

Static Functions

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

`is_construct`

from ros_cdk_mongodb import datasource
datasource.Instances.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

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_instance_ids`	`ros_cdk_core.IResolvable`	Attribute InstanceIds: The list of The instance Ids.
`attr_instances`	`ros_cdk_core.IResolvable`	Attribute Instances: The list of The instances.

`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_instance_ids`^Required

attr_instance_ids: IResolvable

Type: ros_cdk_core.IResolvable

Attribute InstanceIds: The list of The instance Ids.

`attr_instances`^Required

attr_instances: IResolvable

Type: ros_cdk_core.IResolvable

Attribute Instances: The list of The instances.

Instances

Initializers

scopeRequired

idRequired

charge_typeOptional

connection_domainOptional

db_instance_classOptional

db_instance_descriptionOptional

db_instance_idOptional

db_instance_statusOptional

db_instance_typeOptional

engine_versionOptional

expiredOptional

network_typeOptional

refresh_optionsOptional

replication_factorOptional

resource_group_idOptional

tagsOptional

vpc_idOptional

v_switch_idOptional

zone_idOptional

enable_resource_property_constraintOptional