Skip to content

Instance

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

Initializers 

from ros_cdk_mongodb import datasource
datasource.Instance(
  scope: Construct,
  id: str,
  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.
instance_id typing.Union[str, ros_cdk_core.IResolvable] Property instanceId: The ID of the mongos.
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

instance_idRequired

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

Property instanceId: The ID of the mongos.

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_mongodb import datasource
datasource.Instance.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_account_description ros_cdk_core.IResolvable Attribute AccountDescription: The description of the account.
attr_account_name ros_cdk_core.IResolvable Attribute AccountName: The name of the account.
attr_auto_renew ros_cdk_core.IResolvable Attribute AutoRenew: Indicates whether auto-renewal is enabled for the instance.
attr_auto_renew_duration ros_cdk_core.IResolvable Attribute AutoRenewDuration: Auto Renew Duration.
attr_backup_interval ros_cdk_core.IResolvable Attribute BackupInterval: The frequency at which high-frequency backup is created.
attr_backup_retention_period ros_cdk_core.IResolvable Attribute BackupRetentionPeriod: The retention period of the backup data.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: The Database create time.
attr_db_instance_class ros_cdk_core.IResolvable Attribute DBInstanceClass: The instance type of the instance.
attr_db_instance_description ros_cdk_core.IResolvable Attribute DBInstanceDescription: The name of the instance.
attr_db_instance_release_protection ros_cdk_core.IResolvable Attribute DBInstanceReleaseProtection: Indicates whether release protection is enabled for the instance.
attr_db_instance_storage ros_cdk_core.IResolvable Attribute DbInstanceStorage: The storage capacity of the instance.
attr_db_instance_type ros_cdk_core.IResolvable Attribute DBInstanceType: The architecture of the instance.
attr_enable_backup_log ros_cdk_core.IResolvable Attribute EnableBackupLog: Indicates whether the log backup feature is enabled.
attr_engine ros_cdk_core.IResolvable Attribute Engine: The database engine of the instance.
attr_engine_version ros_cdk_core.IResolvable Attribute EngineVersion: The database engine version of the instance.
attr_expire_time ros_cdk_core.IResolvable Attribute ExpireTime: The time when the subscription instance expires.
attr_hidden_zone_id ros_cdk_core.IResolvable Attribute HiddenZoneId: The zone where the hidden node resides for multi-zone deployment.
attr_instance_id ros_cdk_core.IResolvable Attribute InstanceId: The ID of the mongos.
attr_kind_code ros_cdk_core.IResolvable Attribute KindCode: The kind code of the instance.
attr_last_downgrade_time ros_cdk_core.IResolvable Attribute LastDowngradeTime: The date when the last downgrade operation was performed on the instance.
attr_lock_mode ros_cdk_core.IResolvable Attribute LockMode: The lock status of the instance.
attr_log_backup_retention_period ros_cdk_core.IResolvable Attribute LogBackupRetentionPeriod: The number of days for which log backups are retained.
attr_maintain_end_time ros_cdk_core.IResolvable Attribute MaintainEndTime: The end time of the maintenance window.
attr_maintain_start_time ros_cdk_core.IResolvable Attribute MaintainStartTime: The start time of the maintenance window.
attr_mongos_list ros_cdk_core.IResolvable Attribute MongosList: The information of the mongos nodes.
attr_network_addresses ros_cdk_core.IResolvable Attribute NetworkAddresses: The endpoints of ApsaraDB for MongoDB instances.
attr_network_type ros_cdk_core.IResolvable Attribute NetworkType: The network type of the instance.
attr_parameters ros_cdk_core.IResolvable Attribute Parameters: The settings of the parameters that have taken effect.
attr_payment_type ros_cdk_core.IResolvable Attribute PaymentType: The billing method of the Database.
attr_preferred_backup_period ros_cdk_core.IResolvable Attribute PreferredBackupPeriod: The day of a week on which to back up data.
attr_preferred_backup_time ros_cdk_core.IResolvable Attribute PreferredBackupTime: The time range during which the backup was created.
attr_protocol_type ros_cdk_core.IResolvable Attribute ProtocolType: The access protocol type of the instance.
attr_readonly_replicas ros_cdk_core.IResolvable Attribute ReadonlyReplicas: The number of read-only nodes in the shard node.
attr_replica_sets_connections ros_cdk_core.IResolvable Attribute ReplicaSetsConnections: ReplicaSets Connections.
attr_replication_factor ros_cdk_core.IResolvable Attribute ReplicationFactor: The number of nodes in the instance.
attr_resource_group_id ros_cdk_core.IResolvable Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.
attr_secondary_zone_id ros_cdk_core.IResolvable Attribute SecondaryZoneId: The zone where the secondary node resides for multi-zone deployment.
attr_security_group_id ros_cdk_core.IResolvable Attribute SecurityGroupId: The ID of the ECS security group.
attr_security_ip_list ros_cdk_core.IResolvable Attribute SecurityIpList: The name of the IP whitelist.
attr_security_ips ros_cdk_core.IResolvable Attribute SecurityIps: The IP addresses in the default whitelist.
attr_shard_list ros_cdk_core.IResolvable Attribute ShardList: The information of the shard nodes.
attr_snapshot_backup_type ros_cdk_core.IResolvable Attribute SnapshotBackupType: The snapshot backup type.
attr_ssl_expired_time ros_cdk_core.IResolvable Attribute SslExpiredTime: The time when the SSL certificate expires.
attr_ssl_status ros_cdk_core.IResolvable Attribute SslStatus: The status of the SSL feature.
attr_storage_engine ros_cdk_core.IResolvable Attribute StorageEngine: The Storage Engine Of The Instance Type.
attr_tags ros_cdk_core.IResolvable Attribute Tags: The details of the instance tags.
attr_tde_status ros_cdk_core.IResolvable Attribute TdeStatus: The TDE status.
attr_vpc_auth_mode ros_cdk_core.IResolvable Attribute VpcAuthMode: Indicates whether password-free access within the VPC is enabled.
attr_vpc_id ros_cdk_core.IResolvable Attribute VpcId: The VPC ID of the instance.
attr_v_switch_id ros_cdk_core.IResolvable Attribute VSwitchId: The vSwitch ID of the instance.
attr_zone_id ros_cdk_core.IResolvable Attribute ZoneId: The ID of the zone in which the instance resides.

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_account_descriptionRequired 

attr_account_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AccountDescription: The description of the account.

attr_account_nameRequired 

attr_account_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AccountName: The name of the account.

Value: *root * .

attr_auto_renewRequired 

attr_auto_renew: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AutoRenew: Indicates whether auto-renewal is enabled for the instance.

Valid values: true: Auto-renewal is enabled for the instance. false: Auto-renewal is disabled for the instance.

attr_auto_renew_durationRequired 

attr_auto_renew_duration: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AutoRenewDuration: Auto Renew Duration.

attr_backup_intervalRequired 

attr_backup_interval: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BackupInterval: The frequency at which high-frequency backup is created.

Valid values: -1: High-frequency backup is disabled. 15: every 15 minutes. 30: every 30 minutes. 60: every hour. 120: every 2 hours. 180: every 3 hours. 240: every 4 hours. 360: every 6 hours. 480: every 8 hours. 720: every 12 hours.

attr_backup_retention_periodRequired 

attr_backup_retention_period: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BackupRetentionPeriod: The retention period of the backup data.

Unit: day.

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: The Database create time.

attr_db_instance_classRequired 

attr_db_instance_class: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DBInstanceClass: The instance type of the instance.

attr_db_instance_descriptionRequired 

attr_db_instance_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DBInstanceDescription: The name of the instance.

attr_db_instance_release_protectionRequired 

attr_db_instance_release_protection: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DBInstanceReleaseProtection: Indicates whether release protection is enabled for the instance.

Valid values: true false

attr_db_instance_storageRequired 

attr_db_instance_storage: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DbInstanceStorage: The storage capacity of the instance.

attr_db_instance_typeRequired 

attr_db_instance_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute DBInstanceType: The architecture of the instance.

Valid values: replicate: replica set instance sharding: sharded cluster instance

attr_enable_backup_logRequired 

attr_enable_backup_log: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EnableBackupLog: Indicates whether the log backup feature is enabled.

Valid values: 0 (default): The log backup feature is disabled. 1: The log backup feature is enabled.

attr_engineRequired 

attr_engine: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Engine: The database engine of the instance.

Default value: mongodb.

attr_engine_versionRequired 

attr_engine_version: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EngineVersion: The database engine version of the instance.

6.0 5.0 4.4 4.2 4.0

attr_expire_timeRequired 

attr_expire_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ExpireTime: The time when the subscription instance expires.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time is displayed in UTC.

attr_hidden_zone_idRequired 

attr_hidden_zone_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute HiddenZoneId: The zone where the hidden node resides for multi-zone deployment.

attr_instance_idRequired 

attr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute InstanceId: The ID of the mongos.

attr_kind_codeRequired 

attr_kind_code: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute KindCode: The kind code of the instance.

Valid values: 0: physical machine 1: Elastic Compute Service (ECS) instance 2: Docker cluster 18: Kubernetes cluster

attr_last_downgrade_timeRequired 

attr_last_downgrade_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LastDowngradeTime: The date when the last downgrade operation was performed on the instance.

attr_lock_modeRequired 

attr_lock_mode: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LockMode: The lock status of the instance.

Valid values: Unlock: The instance is not locked. ManualLock: The instance is manually locked. LockByExpiration: The instance is automatically locked due to instance expiration. LockByRestoration: The instance is automatically locked before the instance is rolled back. LockByDiskQuota: The instance is automatically locked after the storage space is exhausted. Released: The instance is released.

attr_log_backup_retention_periodRequired 

attr_log_backup_retention_period: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute LogBackupRetentionPeriod: The number of days for which log backups are retained.

Valid values: 7 to 730.

attr_maintain_end_timeRequired 

attr_maintain_end_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MaintainEndTime: The end time of the maintenance window.

The time follows the ISO 8601 standard in the HH:mmZ format. The time is displayed in UTC.

attr_maintain_start_timeRequired 

attr_maintain_start_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MaintainStartTime: The start time of the maintenance window.

The time follows the ISO 8601 standard in the HH:mmZ format. The time is displayed in UTC.

attr_mongos_listRequired 

attr_mongos_list: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MongosList: The information of the mongos nodes.

attr_network_addressesRequired 

attr_network_addresses: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NetworkAddresses: The endpoints of ApsaraDB for MongoDB instances.

attr_network_typeRequired 

attr_network_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute NetworkType: The network type of the instance.

Valid values: Classic: classic network VPC: VPC

attr_parametersRequired 

attr_parameters: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Parameters: The settings of the parameters that have taken effect.

attr_payment_typeRequired 

attr_payment_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PaymentType: The billing method of the Database.

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

attr_preferred_backup_periodRequired 

attr_preferred_backup_period: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PreferredBackupPeriod: The day of a week on which to back up data.

Valid values: Monday Tuesday Wednesday Thursday Friday Saturday Sunday

attr_preferred_backup_timeRequired 

attr_preferred_backup_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PreferredBackupTime: The time range during which the backup was created.

The time follows the ISO 8601 standard in the HH:mmZ-HH:mmZ format. The time is displayed in UTC.

attr_protocol_typeRequired 

attr_protocol_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ProtocolType: The access protocol type of the instance.

Valid values: mongodb dynamodb

attr_readonly_replicasRequired 

attr_readonly_replicas: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ReadonlyReplicas: The number of read-only nodes in the shard node.

Valid values: 0 to 5. The value must be an integer.

attr_replica_sets_connectionsRequired 

attr_replica_sets_connections: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ReplicaSetsConnections: ReplicaSets Connections.

attr_replication_factorRequired 

attr_replication_factor: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ReplicationFactor: The number of nodes in the instance.

attr_resource_group_idRequired 

attr_resource_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: The ID of the resource group to which the instance belongs.

attr_secondary_zone_idRequired 

attr_secondary_zone_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SecondaryZoneId: The zone where the secondary node resides for multi-zone deployment.

attr_security_group_idRequired 

attr_security_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SecurityGroupId: The ID of the ECS security group.

attr_security_ip_listRequired 

attr_security_ip_list: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SecurityIpList: The name of the IP whitelist.

attr_security_ipsRequired 

attr_security_ips: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SecurityIps: The IP addresses in the default whitelist.

attr_shard_listRequired 

attr_shard_list: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ShardList: The information of the shard nodes.

attr_snapshot_backup_typeRequired 

attr_snapshot_backup_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SnapshotBackupType: The snapshot backup type.

Valid values: Flash: single-digit second backup Standard (default): standard backup

attr_ssl_expired_timeRequired 

attr_ssl_expired_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SslExpiredTime: The time when the SSL certificate expires.

The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in Coordinated Universal Time (UTC).

attr_ssl_statusRequired 

attr_ssl_status: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SslStatus: The status of the SSL feature.

Valid values: Open: The SSL feature is enabled. Closed: The SSL feature is disabled.

attr_storage_engineRequired 

attr_storage_engine: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute StorageEngine: The Storage Engine Of The Instance Type.

attr_tagsRequired 

attr_tags: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Tags: The details of the instance tags.

attr_tde_statusRequired 

attr_tde_status: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute TdeStatus: The TDE status.

Valid values: enabled disabled

attr_vpc_auth_modeRequired 

attr_vpc_auth_mode: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcAuthMode: Indicates whether password-free access within the VPC is enabled.

Valid values: Open: Password-free access within the VPC is enabled. Close: Password-free access within the VPC is disabled, and you must use a password for access. NotSupport: Password-free access within the VPC is not supported.

attr_vpc_idRequired 

attr_vpc_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VpcId: The VPC ID of the instance.

attr_v_switch_idRequired 

attr_v_switch_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VSwitchId: The vSwitch ID of the instance.

attr_zone_idRequired 

attr_zone_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ZoneId: The ID of the zone in which the instance resides.