Skip to content

InstancesProps

Properties for defining a Instances.

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

Initializer 

import { datasource } from '@alicloud/ros-cdk-mongodb'
const instancesProps: datasource.InstancesProps = { ... }

Properties

Name Type Description
chargeType string | @alicloud/ros-cdk-core.IResolvable Property chargeType: The billing method of the instance.
connectionDomain string | @alicloud/ros-cdk-core.IResolvable Property connectionDomain: The endpoint of the node.
dbInstanceClass string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceClass: The instance type.
dbInstanceDescription string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceDescription: The description of the instance.
dbInstanceId string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceId: The ID of the instance.
dbInstanceStatus string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceStatus: The state of the instance.
dbInstanceType string | @alicloud/ros-cdk-core.IResolvable Property dbInstanceType: The category of the instance.
engineVersion string | @alicloud/ros-cdk-core.IResolvable Property engineVersion: The database engine version of the instance.
expired boolean | @alicloud/ros-cdk-core.IResolvable Property expired: Specifies whether the instance expires.
networkType string | @alicloud/ros-cdk-core.IResolvable Property networkType: The network type of the instance.
refreshOptions string | @alicloud/ros-cdk-core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
replicationFactor string | @alicloud/ros-cdk-core.IResolvable Property replicationFactor: The number of nodes in a replica set instance.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group.
tags @alicloud/ros-cdk-mongodb.datasource.RosInstances.TagsProperty[] Property tags: Tags of instance.
vpcId string | @alicloud/ros-cdk-core.IResolvable Property vpcId: The VPC ID of the instance.
vSwitchId string | @alicloud/ros-cdk-core.IResolvable Property vSwitchId: The vSwitch ID of the instance.
zoneId string | @alicloud/ros-cdk-core.IResolvable Property zoneId: The zone ID of the instance.

chargeTypeOptional 

public readonly chargeType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property chargeType: The billing method of the instance.

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

connectionDomainOptional 

public readonly connectionDomain: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property connectionDomain: The endpoint of the node.

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

dbInstanceClassOptional 

public readonly dbInstanceClass: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceClass: The instance type.

For more information about valid values, see Instance types.

dbInstanceDescriptionOptional 

public readonly dbInstanceDescription: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceDescription: The description of the instance.

dbInstanceIdOptional 

public readonly dbInstanceId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceId: The ID of the instance.

dbInstanceStatusOptional 

public readonly dbInstanceStatus: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property dbInstanceStatus: The state of the instance.

For more information about valid values, see Instance states.

dbInstanceTypeOptional 

public readonly dbInstanceType: string | IResolvable;
  • Type: string | @alicloud/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.

engineVersionOptional 

public readonly engineVersion: string | IResolvable;
  • Type: string | @alicloud/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 

public readonly expired: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property expired: Specifies whether the instance expires.

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

networkTypeOptional 

public readonly networkType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property networkType: The network type of the instance.

Valid values: Classic Vpc

refreshOptionsOptional 

public readonly refreshOptions: string | IResolvable;
  • Type: string | @alicloud/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.

replicationFactorOptional 

public readonly replicationFactor: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

Valid values: 3, 5, and 7.

resourceGroupIdOptional 

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of the resource group.

tagsOptional 

public readonly tags: TagsProperty[];
  • Type: @alicloud/ros-cdk-mongodb.datasource.RosInstances.TagsProperty[]

Property tags: Tags of instance.

vpcIdOptional 

public readonly vpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vpcId: The VPC ID of the instance.

vSwitchIdOptional 

public readonly vSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vSwitchId: The vSwitch ID of the instance.

zoneIdOptional 

public readonly zoneId: string | IResolvable;
  • Type: string | @alicloud/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.