StarRocksInstance

• Implements: IStarRocksInstance

This class encapsulates and extends the ROS resource type ALIYUN::EMR::StarRocksInstance.

Initializers

import ros_cdk_emr
ros_cdk_emr.StarRocksInstance(
  scope: Construct,
  id: str,
  admin_password: typing.Union[str, IResolvable],
  cluster_zone_id: typing.Union[str, IResolvable],
  instance_name: typing.Union[str, IResolvable],
  package_type: typing.Union[str, IResolvable],
  pay_type: typing.Union[str, IResolvable],
  run_mode: typing.Union[str, IResolvable],
  version: typing.Union[str, IResolvable],
  vpc_id: typing.Union[str, IResolvable],
  auto_renew: typing.Union[bool, IResolvable] = None,
  backend_node_groups: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, BackendNodeGroupsProperty]]] = None,
  duration: typing.Union[typing.Union[int, float], IResolvable] = None,
  encrypted: typing.Union[bool, IResolvable] = None,
  frontend_node_groups: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, FrontendNodeGroupsProperty]]] = None,
  kms_key_id: typing.Union[str, IResolvable] = None,
  observer_node_groups: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ObserverNodeGroupsProperty]]] = None,
  order_id: typing.Union[typing.Union[int, float], IResolvable] = None,
  oss_accessing_role_name: typing.Union[str, IResolvable] = None,
  pricing_cycle: typing.Union[str, IResolvable] = None,
  promotion_option_no: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  resource_type: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  vswitches: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, VswitchesProperty]]] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

admin_password^Required

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

Property adminPassword: Password of admin user.

cluster_zone_id^Required

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

Property clusterZoneId: Primary ZoneId of StarRocks instance.

instance_name^Required

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

Property instanceName: The name of the StarRocks instance.

package_type^Required

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

Property packageType: The package type of the instance: - trial: Starter Edition - official: Standard.

pay_type^Required

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

Property payType: The pay type of the StarRocks instance: - prePaid - postPaid.

run_mode^Required

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

Property runMode: The run mode of the instance: - **shared_nothing: Storage and calculation.

• **shared_data: Storage and calculation separation.
• **lakehouse: Data lake analysis.

version^Required

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

Property version: The version of the StarRocks instance.

vpc_id^Required

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

Property vpcId: The VPC ID of the StarRocks instance.

auto_renew^Optional

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

Property autoRenew: Whether to enable automatic renewal.

This is only meaningful when payType is set to PrePaid. Disabled by default.

backend_node_groups^Optional

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

Property backendNodeGroups: List of BE or CN compute group information.

duration^Optional

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

Property duration: Duration of purchase.

It is only meaningful when PayType is set to PrePaid.

encrypted^Optional

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

Property encrypted: Whether encrypted.

frontend_node_groups^Optional

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

Property frontendNodeGroups: List of FE Node Group Information.

kms_key_id^Optional

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

Property kmsKeyId: The ID of the Key Management Service (KMS) key.

observer_node_groups^Optional

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

Property observerNodeGroups: list of Observer calculates group information.

order_id^Optional

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

Property orderId: Order ID.

oss_accessing_role_name^Optional

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

Property ossAccessingRoleName: Role name used for password-free access to OSS.

pricing_cycle^Optional

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

Property pricingCycle: The duration unit for purchasing: - Month - Year This is only meaningful when PayType is set to PrePaid.

promotion_option_no^Optional

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

Property promotionOptionNo: Promotion ID.

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group to which the StarRocks instance belongs.

resource_type^Optional

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

Property resourceType: Resource type.

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: Tags of StarRocks.

vswitches^Optional

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

Property vswitches: The VSwitches info of the StarRocks instance.

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_emr
ros_cdk_emr.StarRocksInstance.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_acl_id^Required

attr_acl_id: typing.Union[str, IResolvable]

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

Attribute AclId: Access control ID.

attr_architecture^Required

attr_architecture: typing.Union[str, IResolvable]

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

Attribute Architecture: Architecture of StarRocks instance.

attr_create_time^Required

attr_create_time: typing.Union[str, IResolvable]

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

Attribute CreateTime: The creation time of the StarRocks instance.

attr_enable_auto_minor_version_upgrade^Required

attr_enable_auto_minor_version_upgrade: typing.Union[str, IResolvable]

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

Attribute EnableAutoMinorVersionUpgrade: Whether minor version automatic upgrades are supported.

attr_enabled_audit_loader^Required

attr_enabled_audit_loader: typing.Union[str, IResolvable]

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

Attribute EnabledAuditLoader: Whether enable audit loader.

attr_enable_ssl^Required

attr_enable_ssl: typing.Union[str, IResolvable]

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

Attribute EnableSsl: Enable SSL.

attr_encrypted^Required

attr_encrypted: typing.Union[str, IResolvable]

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

Attribute Encrypted: Whether encrypted.

attr_expire_time^Required

attr_expire_time: typing.Union[str, IResolvable]

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

Attribute ExpireTime: StarRocks Instance expire time.

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 StarRocks instance.

attr_instance_name^Required

attr_instance_name: typing.Union[str, IResolvable]

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

Attribute InstanceName: The name of the StarRocks instance.

attr_isolate_leader^Required

attr_isolate_leader: typing.Union[str, IResolvable]

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

Attribute IsolateLeader: Whether leader FE is isolated.

attr_kms_key_id^Required

attr_kms_key_id: typing.Union[str, IResolvable]

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

Attribute KmsKeyId: The ID of the Key Management Service (KMS) key.

attr_maintainable_period^Required

attr_maintainable_period: typing.Union[str, IResolvable]

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

Attribute MaintainablePeriod: StarRocks Instance maintainable period.

attr_minor_version^Required

attr_minor_version: typing.Union[str, IResolvable]

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

Attribute MinorVersion: StarRocks Instance minor version.

attr_monitor_type^Required

attr_monitor_type: typing.Union[str, IResolvable]

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

Attribute MonitorType: Monitor Type.

attr_oss_location^Required

attr_oss_location: typing.Union[str, IResolvable]

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

Attribute OssLocation: OSS Location.

attr_package_type^Required

attr_package_type: typing.Union[str, IResolvable]

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

Attribute PackageType: The package type of the StarRocks instance.

attr_pay_type^Required

attr_pay_type: typing.Union[str, IResolvable]

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

Attribute PayType: The pay type of the StarRocks instance.

attr_resource_group_id^Required

attr_resource_group_id: typing.Union[str, IResolvable]

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

Attribute ResourceGroupId: The ID of the resource group to which the StarRocks instance belongs..

attr_run_mode^Required

attr_run_mode: typing.Union[str, IResolvable]

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

Attribute RunMode: The run mode of the StarRocks instance.

attr_running_time^Required

attr_running_time: typing.Union[str, IResolvable]

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

Attribute RunningTime: StarRocks Instance running time.

attr_security_group_managed^Required

attr_security_group_managed: typing.Union[str, IResolvable]

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

Attribute SecurityGroupManaged: Whether security group is managed.

attr_sg_id^Required

attr_sg_id: typing.Union[str, IResolvable]

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

Attribute SgId: Security Group ID of StarRocks instance.

attr_tags^Required

attr_tags: typing.Union[str, IResolvable]

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

Attribute Tags: Tag list of the StarRocks instance.

attr_version^Required

attr_version: typing.Union[str, IResolvable]

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

Attribute Version: The version of the StarRocks instance.

attr_vpc_id^Required

attr_vpc_id: typing.Union[str, IResolvable]

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

Attribute VpcId: The VPC ID of the StarRocks instance.

attr_vswitches^Required

attr_vswitches: typing.Union[str, IResolvable]

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

Attribute Vswitches: The VSwitches info of the StarRocks instance.

props^Required

props: StarRocksInstanceProps

• Type: StarRocksInstanceProps

Structs