Instance

• Implements: IInstance

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

Initializers

import com.aliyun.ros.cdk.milvus.Instance;
Instance.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .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();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

components^Required

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

dbAdminPassword^Required

• 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 @#$%^*_+-.

dbVersion^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbVersion: The database engine version.

instanceName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceName: The name of the instance.

paymentType^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property paymentType: The billing method of the instance.

vpcId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vpcId: The VPC ID.

vSwitchIds^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListVSwitchIdsProperty>

Property vSwitchIds: The vSwitch configurations.

zoneId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property zoneId: The primary zone ID of the instance.

aiFunction^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property aiFunction: Whether the AI function is enabled.

autoBackup^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property autoBackup: Whether automatic backup is enabled.

autoPay^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property autoPay: Whether the order is automatically paid.

autoRenew^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property autoRenew: Whether the subscription is automatically renewed.

backupRestoreInfo^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR BackupRestoreInfoProperty

Property backupRestoreInfo: The backup restore information.

configuration^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property configuration: The instance configuration in YAML format.

encrypted^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property encrypted: Whether OSS encryption is enabled.

ha^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property ha: Whether high availability is enabled.

isMultiAzStorage^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property isMultiAzStorage: Whether multi-zone storage is enabled.

kmsKeyId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

loadReplicas^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property loadReplicas: The number of load replicas.

multiZoneMode^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property multiZoneMode: The multi-zone deployment mode.

paymentDuration^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property paymentDuration: The subscription duration.

paymentDurationUnit^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property paymentDurationUnit: The unit of the subscription duration.

promotionNo^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property promotionNo: The promotion number.

resourceGroupId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The resource group ID.

tags^Optional

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

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.milvus.Instance;
Instance.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrInstanceId^Required

public java.lang.Object getAttrInstanceId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceId: The ID of the instance.

props^Required

public InstanceProps getProps();

• Type: InstanceProps