Instance

• Implements: IInstance

This class encapsulates and extends the ROS resource type ALIYUN::Milvus::Instance.

Initializers

import ros_cdk_milvus
ros_cdk_milvus.Instance(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

components^Required

• 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_password^Required

• 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_version^Required

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

Property dbVersion: The database engine version.

instance_name^Required

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

Property instanceName: The name of the instance.

payment_type^Required

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

Property paymentType: The billing method of the instance.

vpc_id^Required

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

Property vpcId: The VPC ID.

v_switch_ids^Required

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

Property vSwitchIds: The vSwitch configurations.

zone_id^Required

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

Property zoneId: The primary zone ID of the instance.

ai_function^Optional

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

Property aiFunction: Whether the AI function is enabled.

auto_backup^Optional

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

Property autoBackup: Whether automatic backup is enabled.

auto_pay^Optional

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

Property autoPay: Whether the order is automatically paid.

auto_renew^Optional

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

Property autoRenew: Whether the subscription is automatically renewed.

backup_restore_info^Optional

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

Property backupRestoreInfo: The backup restore information.

configuration^Optional

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

Property configuration: The instance configuration in YAML format.

encrypted^Optional

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

Property encrypted: Whether OSS encryption is enabled.

ha^Optional

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

Property ha: Whether high availability is enabled.

is_multi_az_storage^Optional

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

Property isMultiAzStorage: Whether multi-zone storage is enabled.

kms_key_id^Optional

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

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

load_replicas^Optional

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

Property loadReplicas: The number of load replicas.

multi_zone_mode^Optional

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

Property multiZoneMode: The multi-zone deployment mode.

payment_duration^Optional

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

Property paymentDuration: The subscription duration.

payment_duration_unit^Optional

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

Property paymentDurationUnit: The unit of the subscription duration.

promotion_no^Optional

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

Property promotionNo: The promotion number.

resource_group_id^Optional

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

Property resourceGroupId: The resource group ID.

tags^Optional

• Type: 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.

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

import ros_cdk_milvus
ros_cdk_milvus.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_instance_id^Required

attr_instance_id: typing.Union[str, IResolvable]

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

Attribute InstanceId: The ID of the instance.

props^Required

props: InstanceProps

• Type: InstanceProps