Skip to content

InstanceProps

Properties for defining a Instance.

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

Initializer

import com.aliyun.ros.cdk.milvus.InstanceProps;
InstanceProps.builder()
    .components(IResolvable)
    .components(java.util.List<ComponentsProperty)
    .components(IResolvable>)
    .dbAdminPassword(java.lang.String)
    .dbAdminPassword(IResolvable)
    .dbVersion(java.lang.String)
    .dbVersion(IResolvable)
    .instanceName(java.lang.String)
    .instanceName(IResolvable)
    .paymentType(java.lang.String)
    .paymentType(IResolvable)
    .vpcId(java.lang.String)
    .vpcId(IResolvable)
    .vSwitchIds(IResolvable)
    .vSwitchIds(java.util.List<IResolvable)
    .vSwitchIds(VSwitchIdsProperty>)
    .zoneId(java.lang.String)
    .zoneId(IResolvable)
//  .aiFunction(java.lang.Boolean)
//  .aiFunction(IResolvable)
//  .autoBackup(java.lang.Boolean)
//  .autoBackup(IResolvable)
//  .autoPay(java.lang.Boolean)
//  .autoPay(IResolvable)
//  .autoRenew(java.lang.Boolean)
//  .autoRenew(IResolvable)
//  .backupRestoreInfo(IResolvable)
//  .backupRestoreInfo(BackupRestoreInfoProperty)
//  .configuration(java.lang.String)
//  .configuration(IResolvable)
//  .encrypted(java.lang.Boolean)
//  .encrypted(IResolvable)
//  .ha(java.lang.Boolean)
//  .ha(IResolvable)
//  .isMultiAzStorage(java.lang.Boolean)
//  .isMultiAzStorage(IResolvable)
//  .kmsKeyId(java.lang.String)
//  .kmsKeyId(IResolvable)
//  .loadReplicas(java.lang.Number)
//  .loadReplicas(IResolvable)
//  .multiZoneMode(java.lang.String)
//  .multiZoneMode(IResolvable)
//  .paymentDuration(java.lang.Number)
//  .paymentDuration(IResolvable)
//  .paymentDurationUnit(java.lang.String)
//  .paymentDurationUnit(IResolvable)
//  .promotionNo(java.lang.String)
//  .promotionNo(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
    .build();

Properties

Name Type Description
components com.aliyun.ros.cdk.core.IResolvable OR java.util.List<ComponentsProperty OR com.aliyun.ros.cdk.core.IResolvable> Property components: The component specifications of the instance.
dbAdminPassword java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbAdminPassword: The database administrator password.
dbVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dbVersion: The database engine version.
instanceName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceName: The name of the instance.
paymentType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property paymentType: The billing method of the instance.
vpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vpcId: The VPC ID.
vSwitchIds com.aliyun.ros.cdk.core.IResolvable OR java.util.ListVSwitchIdsProperty> Property vSwitchIds: The vSwitch configurations.
zoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property zoneId: The primary zone ID of the instance.
aiFunction java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property aiFunction: Whether the AI function is enabled.
autoBackup java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoBackup: Whether automatic backup is enabled.
autoPay java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoPay: Whether the order is automatically paid.
autoRenew java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property autoRenew: Whether the subscription is automatically renewed.
backupRestoreInfo com.aliyun.ros.cdk.core.IResolvable OR BackupRestoreInfoProperty Property backupRestoreInfo: The backup restore information.
configuration java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property configuration: The instance configuration in YAML format.
encrypted java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property encrypted: Whether OSS encryption is enabled.
ha java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property ha: Whether high availability is enabled.
isMultiAzStorage java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property isMultiAzStorage: Whether multi-zone storage is enabled.
kmsKeyId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property kmsKeyId: The ID of the KMS key used for encryption.
loadReplicas java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property loadReplicas: The number of load replicas.
multiZoneMode java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property multiZoneMode: The multi-zone deployment mode.
paymentDuration java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property paymentDuration: The subscription duration.
paymentDurationUnit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property paymentDurationUnit: The unit of the subscription duration.
promotionNo java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property promotionNo: The promotion number.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: The resource group ID.
tags java.util.List<TagsProperty> Property tags: Tags to attach to Milvus instance.

componentsRequired

public java.lang.Object getComponents();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List<ComponentsProperty OR com.aliyun.ros.cdk.core.IResolvable>

Property components: The component specifications of the instance.


dbAdminPasswordRequired

public java.lang.Object getDbAdminPassword();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getDbVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbVersion: The database engine version.


instanceNameRequired

public java.lang.Object getInstanceName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceName: The name of the instance.


paymentTypeRequired

public java.lang.Object getPaymentType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property paymentType: The billing method of the instance.


vpcIdRequired

public java.lang.Object getVpcId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vpcId: The VPC ID.


vSwitchIdsRequired

public java.lang.Object getVSwitchIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListVSwitchIdsProperty>

Property vSwitchIds: The vSwitch configurations.


zoneIdRequired

public java.lang.Object getZoneId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property zoneId: The primary zone ID of the instance.


aiFunctionOptional

public java.lang.Object getAiFunction();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property aiFunction: Whether the AI function is enabled.


autoBackupOptional

public java.lang.Object getAutoBackup();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property autoBackup: Whether automatic backup is enabled.


autoPayOptional

public java.lang.Object getAutoPay();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property autoPay: Whether the order is automatically paid.


autoRenewOptional

public java.lang.Object getAutoRenew();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property autoRenew: Whether the subscription is automatically renewed.


backupRestoreInfoOptional

public java.lang.Object getBackupRestoreInfo();

Property backupRestoreInfo: The backup restore information.


configurationOptional

public java.lang.Object getConfiguration();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property configuration: The instance configuration in YAML format.


encryptedOptional

public java.lang.Object getEncrypted();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property encrypted: Whether OSS encryption is enabled.


haOptional

public java.lang.Object getHa();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property ha: Whether high availability is enabled.


isMultiAzStorageOptional

public java.lang.Object getIsMultiAzStorage();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property isMultiAzStorage: Whether multi-zone storage is enabled.


kmsKeyIdOptional

public java.lang.Object getKmsKeyId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


loadReplicasOptional

public java.lang.Object getLoadReplicas();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property loadReplicas: The number of load replicas.


multiZoneModeOptional

public java.lang.Object getMultiZoneMode();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property multiZoneMode: The multi-zone deployment mode.


paymentDurationOptional

public java.lang.Object getPaymentDuration();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property paymentDuration: The subscription duration.


paymentDurationUnitOptional

public java.lang.Object getPaymentDurationUnit();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property paymentDurationUnit: The unit of the subscription duration.


promotionNoOptional

public java.lang.Object getPromotionNo();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property promotionNo: The promotion number.


resourceGroupIdOptional

public java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The resource group ID.


tagsOptional

public java.util.List<TagsProperty> getTags();

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.