Instance

• Implements: ros_cdk_mongodb.datasource.IInstance

This class encapsulates and extends the ROS resource type DATASOURCE::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
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

instance_id^Required

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

Property instanceId: The ID of the mongos.

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.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

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

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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_account_description^Required

attr_account_description: typing.Union[str, IResolvable]

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

Attribute AccountDescription: The description of the account.

attr_account_name^Required

attr_account_name: typing.Union[str, IResolvable]

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

Attribute AccountName: The name of the account.

Value: *root * .

attr_auto_renew^Required

attr_auto_renew: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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_duration^Required

attr_auto_renew_duration: typing.Union[str, IResolvable]

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

Attribute AutoRenewDuration: Auto Renew Duration.

attr_backup_interval^Required

attr_backup_interval: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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_period^Required

attr_backup_retention_period: typing.Union[str, IResolvable]

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

Attribute BackupRetentionPeriod: The retention period of the backup data.

Unit: day.

attr_create_time^Required

attr_create_time: typing.Union[str, IResolvable]

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

Attribute CreateTime: The Database create time.

attr_db_instance_class^Required

attr_db_instance_class: typing.Union[str, IResolvable]

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

Attribute DBInstanceClass: The instance type of the instance.

attr_db_instance_description^Required

attr_db_instance_description: typing.Union[str, IResolvable]

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

Attribute DBInstanceDescription: The name of the instance.

attr_db_instance_release_protection^Required

attr_db_instance_release_protection: typing.Union[str, IResolvable]

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

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

Valid values: true false

attr_db_instance_storage^Required

attr_db_instance_storage: typing.Union[str, IResolvable]

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

Attribute DbInstanceStorage: The storage capacity of the instance.

attr_db_instance_type^Required

attr_db_instance_type: typing.Union[str, IResolvable]

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

Attribute DBInstanceType: The architecture of the instance.

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

attr_enable_backup_log^Required

attr_enable_backup_log: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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_engine^Required

attr_engine: typing.Union[str, IResolvable]

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

Attribute Engine: The database engine of the instance.

Default value: mongodb.

attr_engine_version^Required

attr_engine_version: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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_time^Required

attr_expire_time: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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_id^Required

attr_hidden_zone_id: typing.Union[str, IResolvable]

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

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

attr_instance_id^Required

attr_instance_id: typing.Union[str, IResolvable]

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

Attribute InstanceId: The ID of the mongos.

attr_kind_code^Required

attr_kind_code: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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_time^Required

attr_last_downgrade_time: typing.Union[str, IResolvable]

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

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

attr_lock_mode^Required

attr_lock_mode: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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_period^Required

attr_log_backup_retention_period: typing.Union[str, IResolvable]

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

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

Valid values: 7 to 730.

attr_maintain_end_time^Required

attr_maintain_end_time: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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_time^Required

attr_maintain_start_time: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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_list^Required

attr_mongos_list: typing.Union[str, IResolvable]

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

Attribute MongosList: The information of the mongos nodes.

attr_network_addresses^Required

attr_network_addresses: typing.Union[str, IResolvable]

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

Attribute NetworkAddresses: The endpoints of ApsaraDB for MongoDB instances.

attr_network_type^Required

attr_network_type: typing.Union[str, IResolvable]

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

Attribute NetworkType: The network type of the instance.

Valid values: Classic: classic network VPC: VPC

attr_parameters^Required

attr_parameters: typing.Union[str, IResolvable]

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

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

attr_payment_type^Required

attr_payment_type: typing.Union[str, IResolvable]

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

Attribute PaymentType: The billing method of the Database.

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

attr_preferred_backup_period^Required

attr_preferred_backup_period: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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_time^Required

attr_preferred_backup_time: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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_type^Required

attr_protocol_type: typing.Union[str, IResolvable]

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

Attribute ProtocolType: The access protocol type of the instance.

Valid values: mongodb dynamodb

attr_readonly_replicas^Required

attr_readonly_replicas: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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_connections^Required

attr_replica_sets_connections: typing.Union[str, IResolvable]

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

Attribute ReplicaSetsConnections: ReplicaSets Connections.

attr_replication_factor^Required

attr_replication_factor: typing.Union[str, IResolvable]

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

Attribute ReplicationFactor: The number of nodes in the instance.

attr_resource_group_id^Required

attr_resource_group_id: typing.Union[str, IResolvable]

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

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

attr_secondary_zone_id^Required

attr_secondary_zone_id: typing.Union[str, IResolvable]

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

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

attr_security_group_id^Required

attr_security_group_id: typing.Union[str, IResolvable]

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

Attribute SecurityGroupId: The ID of the ECS security group.

attr_security_ip_list^Required

attr_security_ip_list: typing.Union[str, IResolvable]

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

Attribute SecurityIpList: The name of the IP whitelist.

attr_security_ips^Required

attr_security_ips: typing.Union[str, IResolvable]

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

Attribute SecurityIps: The IP addresses in the default whitelist.

attr_shard_list^Required

attr_shard_list: typing.Union[str, IResolvable]

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

Attribute ShardList: The information of the shard nodes.

attr_snapshot_backup_type^Required

attr_snapshot_backup_type: typing.Union[str, IResolvable]

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

Attribute SnapshotBackupType: The snapshot backup type.

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

attr_ssl_expired_time^Required

attr_ssl_expired_time: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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_status^Required

attr_ssl_status: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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_engine^Required

attr_storage_engine: typing.Union[str, IResolvable]

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

Attribute StorageEngine: The Storage Engine Of The Instance Type.

attr_tags^Required

attr_tags: typing.Union[str, IResolvable]

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

Attribute Tags: The details of the instance tags.

attr_tde_status^Required

attr_tde_status: typing.Union[str, IResolvable]

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

Attribute TdeStatus: The TDE status.

Valid values: enabled disabled

attr_vpc_auth_mode^Required

attr_vpc_auth_mode: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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_id^Required

attr_vpc_id: typing.Union[str, IResolvable]

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

Attribute VpcId: The VPC ID of the instance.

attr_v_switch_id^Required

attr_v_switch_id: typing.Union[str, IResolvable]

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

Attribute VSwitchId: The vSwitch ID of the instance.

attr_zone_id^Required

attr_zone_id: typing.Union[str, IResolvable]

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

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

props^Required

props: InstanceProps

• Type: InstanceProps