InstanceProps
Properties for defining a Instance.
See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-milvus-instance
Initializer
import { InstanceProps } from '@alicloud/ros-cdk-milvus'
const instanceProps: InstanceProps = { ... }
Properties
| Name | Type | Description |
|---|---|---|
components | @alicloud/ros-cdk-core.IResolvable | ComponentsProperty | @alicloud/ros-cdk-core.IResolvable[] | Property components: The component specifications of the instance. |
dbAdminPassword | string | @alicloud/ros-cdk-core.IResolvable | Property dbAdminPassword: The database administrator password. |
dbVersion | string | @alicloud/ros-cdk-core.IResolvable | Property dbVersion: The database engine version. |
instanceName | string | @alicloud/ros-cdk-core.IResolvable | Property instanceName: The name of the instance. |
paymentType | string | @alicloud/ros-cdk-core.IResolvable | Property paymentType: The billing method of the instance. |
vpcId | string | @alicloud/ros-cdk-core.IResolvable | Property vpcId: The VPC ID. |
vSwitchIds | @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | VSwitchIdsProperty[] | Property vSwitchIds: The vSwitch configurations. |
zoneId | string | @alicloud/ros-cdk-core.IResolvable | Property zoneId: The primary zone ID of the instance. |
aiFunction | boolean | @alicloud/ros-cdk-core.IResolvable | Property aiFunction: Whether the AI function is enabled. |
autoBackup | boolean | @alicloud/ros-cdk-core.IResolvable | Property autoBackup: Whether automatic backup is enabled. |
autoPay | boolean | @alicloud/ros-cdk-core.IResolvable | Property autoPay: Whether the order is automatically paid. |
autoRenew | boolean | @alicloud/ros-cdk-core.IResolvable | Property autoRenew: Whether the subscription is automatically renewed. |
backupRestoreInfo | @alicloud/ros-cdk-core.IResolvable | BackupRestoreInfoProperty | Property backupRestoreInfo: The backup restore information. |
configuration | string | @alicloud/ros-cdk-core.IResolvable | Property configuration: The instance configuration in YAML format. |
encrypted | boolean | @alicloud/ros-cdk-core.IResolvable | Property encrypted: Whether OSS encryption is enabled. |
ha | boolean | @alicloud/ros-cdk-core.IResolvable | Property ha: Whether high availability is enabled. |
isMultiAzStorage | boolean | @alicloud/ros-cdk-core.IResolvable | Property isMultiAzStorage: Whether multi-zone storage is enabled. |
kmsKeyId | string | @alicloud/ros-cdk-core.IResolvable | Property kmsKeyId: The ID of the KMS key used for encryption. |
loadReplicas | number | @alicloud/ros-cdk-core.IResolvable | Property loadReplicas: The number of load replicas. |
multiZoneMode | string | @alicloud/ros-cdk-core.IResolvable | Property multiZoneMode: The multi-zone deployment mode. |
paymentDuration | number | @alicloud/ros-cdk-core.IResolvable | Property paymentDuration: The subscription duration. |
paymentDurationUnit | string | @alicloud/ros-cdk-core.IResolvable | Property paymentDurationUnit: The unit of the subscription duration. |
promotionNo | string | @alicloud/ros-cdk-core.IResolvable | Property promotionNo: The promotion number. |
resourceGroupId | string | @alicloud/ros-cdk-core.IResolvable | Property resourceGroupId: The resource group ID. |
tags | TagsProperty[] | Property tags: Tags to attach to Milvus instance. |
componentsRequired
public readonly components: IResolvable | ComponentsProperty | IResolvable[];
- Type: @alicloud/ros-cdk-core.IResolvable | ComponentsProperty | @alicloud/ros-cdk-core.IResolvable[]
Property components: The component specifications of the instance.
dbAdminPasswordRequired
public readonly dbAdminPassword: string | IResolvable;
- Type: string | @alicloud/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 @#$%^*_+-.
dbVersionRequired
public readonly dbVersion: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property dbVersion: The database engine version.
instanceNameRequired
public readonly instanceName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property instanceName: The name of the instance.
paymentTypeRequired
public readonly paymentType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property paymentType: The billing method of the instance.
vpcIdRequired
public readonly vpcId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property vpcId: The VPC ID.
vSwitchIdsRequired
public readonly vSwitchIds: IResolvable | IResolvable | VSwitchIdsProperty[];
- Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | VSwitchIdsProperty[]
Property vSwitchIds: The vSwitch configurations.
zoneIdRequired
public readonly zoneId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property zoneId: The primary zone ID of the instance.
aiFunctionOptional
public readonly aiFunction: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
Property aiFunction: Whether the AI function is enabled.
autoBackupOptional
public readonly autoBackup: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
Property autoBackup: Whether automatic backup is enabled.
autoPayOptional
public readonly autoPay: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
Property autoPay: Whether the order is automatically paid.
autoRenewOptional
public readonly autoRenew: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
Property autoRenew: Whether the subscription is automatically renewed.
backupRestoreInfoOptional
public readonly backupRestoreInfo: IResolvable | BackupRestoreInfoProperty;
- Type: @alicloud/ros-cdk-core.IResolvable | BackupRestoreInfoProperty
Property backupRestoreInfo: The backup restore information.
configurationOptional
public readonly configuration: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property configuration: The instance configuration in YAML format.
encryptedOptional
public readonly encrypted: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
Property encrypted: Whether OSS encryption is enabled.
haOptional
public readonly ha: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
Property ha: Whether high availability is enabled.
isMultiAzStorageOptional
public readonly isMultiAzStorage: boolean | IResolvable;
- Type: boolean | @alicloud/ros-cdk-core.IResolvable
Property isMultiAzStorage: Whether multi-zone storage is enabled.
kmsKeyIdOptional
public readonly kmsKeyId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property kmsKeyId: The ID of the KMS key used for encryption.
loadReplicasOptional
public readonly loadReplicas: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
Property loadReplicas: The number of load replicas.
multiZoneModeOptional
public readonly multiZoneMode: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property multiZoneMode: The multi-zone deployment mode.
paymentDurationOptional
public readonly paymentDuration: number | IResolvable;
- Type: number | @alicloud/ros-cdk-core.IResolvable
Property paymentDuration: The subscription duration.
paymentDurationUnitOptional
public readonly paymentDurationUnit: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property paymentDurationUnit: The unit of the subscription duration.
promotionNoOptional
public readonly promotionNo: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property promotionNo: The promotion number.
resourceGroupIdOptional
public readonly resourceGroupId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Property resourceGroupId: The resource group ID.
tagsOptional
public readonly tags: TagsProperty[];
- Type: 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.