Skip to content

InstanceProps

Properties for defining a Instance.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-milvus-instance

Initializer

import ros_cdk_milvus
ros_cdk_milvus.InstanceProps(
  components: typing.Union[IResolvable, typing.List[typing.Union[ComponentsProperty, IResolvable]]],
  db_admin_password: typing.Union[str, IResolvable],
  db_version: typing.Union[str, IResolvable],
  instance_name: typing.Union[str, IResolvable],
  payment_type: typing.Union[str, IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  v_switch_ids: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, VSwitchIdsProperty]]],
  zone_id: typing.Union[str, IResolvable],
  ai_function: typing.Union[bool, IResolvable] = None,
  auto_backup: typing.Union[bool, IResolvable] = None,
  auto_pay: typing.Union[bool, IResolvable] = None,
  auto_renew: typing.Union[bool, IResolvable] = None,
  backup_restore_info: typing.Union[IResolvable, BackupRestoreInfoProperty] = None,
  configuration: typing.Union[str, IResolvable] = None,
  encrypted: typing.Union[bool, IResolvable] = None,
  ha: typing.Union[bool, IResolvable] = None,
  is_multi_az_storage: typing.Union[bool, IResolvable] = None,
  kms_key_id: typing.Union[str, IResolvable] = None,
  load_replicas: typing.Union[typing.Union[int, float], IResolvable] = None,
  multi_zone_mode: typing.Union[str, IResolvable] = None,
  payment_duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  payment_duration_unit: typing.Union[str, IResolvable] = None,
  promotion_no: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None
)

Properties

Name Type Description
components typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ComponentsProperty, ros_cdk_core.IResolvable]]] Property components: The component specifications of the instance.
db_admin_password typing.Union[str, ros_cdk_core.IResolvable] Property dbAdminPassword: The database administrator password.
db_version typing.Union[str, ros_cdk_core.IResolvable] Property dbVersion: The database engine version.
instance_name typing.Union[str, ros_cdk_core.IResolvable] Property instanceName: The name of the instance.
payment_type typing.Union[str, ros_cdk_core.IResolvable] Property paymentType: The billing method of the instance.
vpc_id typing.Union[str, ros_cdk_core.IResolvable] Property vpcId: The VPC ID.
v_switch_ids typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, VSwitchIdsProperty]]] Property vSwitchIds: The vSwitch configurations.
zone_id typing.Union[str, ros_cdk_core.IResolvable] Property zoneId: The primary zone ID of the instance.
ai_function typing.Union[bool, ros_cdk_core.IResolvable] Property aiFunction: Whether the AI function is enabled.
auto_backup typing.Union[bool, ros_cdk_core.IResolvable] Property autoBackup: Whether automatic backup is enabled.
auto_pay typing.Union[bool, ros_cdk_core.IResolvable] Property autoPay: Whether the order is automatically paid.
auto_renew typing.Union[bool, ros_cdk_core.IResolvable] Property autoRenew: Whether the subscription is automatically renewed.
backup_restore_info typing.Union[ros_cdk_core.IResolvable, BackupRestoreInfoProperty] Property backupRestoreInfo: The backup restore information.
configuration typing.Union[str, ros_cdk_core.IResolvable] Property configuration: The instance configuration in YAML format.
encrypted typing.Union[bool, ros_cdk_core.IResolvable] Property encrypted: Whether OSS encryption is enabled.
ha typing.Union[bool, ros_cdk_core.IResolvable] Property ha: Whether high availability is enabled.
is_multi_az_storage typing.Union[bool, ros_cdk_core.IResolvable] Property isMultiAzStorage: Whether multi-zone storage is enabled.
kms_key_id typing.Union[str, ros_cdk_core.IResolvable] Property kmsKeyId: The ID of the KMS key used for encryption.
load_replicas typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property loadReplicas: The number of load replicas.
multi_zone_mode typing.Union[str, ros_cdk_core.IResolvable] Property multiZoneMode: The multi-zone deployment mode.
payment_duration typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property paymentDuration: The subscription duration.
payment_duration_unit typing.Union[str, ros_cdk_core.IResolvable] Property paymentDurationUnit: The unit of the subscription duration.
promotion_no typing.Union[str, ros_cdk_core.IResolvable] Property promotionNo: The promotion number.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The resource group ID.
tags typing.List[TagsProperty] Property tags: Tags to attach to Milvus instance.

componentsRequired

components: typing.Union[IResolvable, typing.List[typing.Union[ComponentsProperty, IResolvable]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ComponentsProperty, ros_cdk_core.IResolvable]]]

Property components: The component specifications of the instance.


db_admin_passwordRequired

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

Property dbAdminPassword: The database administrator password.

The password must be 8 to 30 characters in length and contain at least one uppercase letter, lowercase letter, digit, and special character from @#$%^*_+-.


db_versionRequired

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

Property dbVersion: The database engine version.


instance_nameRequired

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

Property instanceName: The name of the instance.


payment_typeRequired

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

Property paymentType: The billing method of the instance.


vpc_idRequired

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

Property vpcId: The VPC ID.


v_switch_idsRequired

v_switch_ids: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, VSwitchIdsProperty]]]
  • Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, VSwitchIdsProperty]]]

Property vSwitchIds: The vSwitch configurations.


zone_idRequired

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

Property zoneId: The primary zone ID of the instance.


ai_functionOptional

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

Property aiFunction: Whether the AI function is enabled.


auto_backupOptional

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

Property autoBackup: Whether automatic backup is enabled.


auto_payOptional

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

Property autoPay: Whether the order is automatically paid.


auto_renewOptional

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

Property autoRenew: Whether the subscription is automatically renewed.


backup_restore_infoOptional

backup_restore_info: typing.Union[IResolvable, BackupRestoreInfoProperty]

Property backupRestoreInfo: The backup restore information.


configurationOptional

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

Property configuration: The instance configuration in YAML format.


encryptedOptional

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

Property encrypted: Whether OSS encryption is enabled.


haOptional

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

Property ha: Whether high availability is enabled.


is_multi_az_storageOptional

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

Property isMultiAzStorage: Whether multi-zone storage is enabled.


kms_key_idOptional

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

Property kmsKeyId: The ID of the KMS key used for encryption.


load_replicasOptional

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

Property loadReplicas: The number of load replicas.


multi_zone_modeOptional

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

Property multiZoneMode: The multi-zone deployment mode.


payment_durationOptional

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

Property paymentDuration: The subscription duration.


payment_duration_unitOptional

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

Property paymentDurationUnit: The unit of the subscription duration.


promotion_noOptional

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

Property promotionNo: The promotion number.


resource_group_idOptional

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

Property resourceGroupId: The resource group ID.


tagsOptional

tags: typing.List[TagsProperty]

Property tags: Tags to attach to Milvus instance.

Max support 20 tags to add during create Milvus instance. Each tag with two properties Key and Value, and Key is required.