RosStarRocksInstance

This class is a base encapsulation around the ROS resource type ALIYUN::EMR::StarRocksInstance.

Initializers

import ros_cdk_emr
ros_cdk_emr.RosStarRocksInstance(
  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
)

scope^Required

• Type: ros_cdk_core.Construct

scope in which this resource is defined.

id^Required

• Type: str

scoped id of the resource.

admin_password^Required

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

cluster_zone_id^Required

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

instance_name^Required

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

package_type^Required

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

pay_type^Required

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

run_mode^Required

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

version^Required

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

vpc_id^Required

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

auto_renew^Optional

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

backend_node_groups^Optional

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

duration^Optional

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

encrypted^Optional

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

frontend_node_groups^Optional

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

kms_key_id^Optional

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

observer_node_groups^Optional

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

order_id^Optional

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

oss_accessing_role_name^Optional

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

pricing_cycle^Optional

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

promotion_option_no^Optional

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

resource_group_id^Optional

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

resource_type^Optional

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

tags^Optional

• Type: typing.List[TagsProperty]

vswitches^Optional

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

enable_resource_property_constraint^Required

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

override_logical_id

def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_id^Required

• Type: str

The new logical ID to use for this stack element.

add_condition

def add_condition(
  con: RosCondition
) -> None

con^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_deletion_override

def add_deletion_override(
  path: str
) -> None

Syntactic sugar for addOverride(path, undefined).

path^Required

• Type: str

The path of the value to delete.

add_depends_on

def add_depends_on(
  target: RosResource
) -> None

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

target^Required

• Type: ros_cdk_core.RosResource

add_desc

def add_desc(
  desc: str
) -> None

desc^Required

• Type: str

add_meta_data

def add_meta_data(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

add_override

def add_override(
  path: str,
  value: typing.Any
) -> None

Adds an override to the synthesized ROS resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

For example,

addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute'])
addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE')

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

path^Required

• Type: str

The path of the property, you can use dot notation to override values in complex types.

Any intermdediate keys will be created as needed.

value^Required

• Type: typing.Any

The value.

Could be primitive or complex.

add_property_deletion_override

def add_property_deletion_override(
  property_path: str
) -> None

Adds an override that deletes the value of a property from the resource definition.

property_path^Required

• Type: str

The path to the property.

add_property_override

def add_property_override(
  property_path: str,
  value: typing.Any
) -> None

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

property_path^Required

• Type: str

The path of the property.

value^Required

• Type: typing.Any

The value.

add_ros_dependency

def add_ros_dependency(
  target: str
) -> None

target^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy = None,
  apply_to_update_replace_policy: bool = None,
  default_policy: RemovalPolicy = None
) -> None

Sets the deletion policy of the resource based on the removal policy specified.

policy^Optional

• Type: ros_cdk_core.RemovalPolicy

apply_to_update_replace_policy^Optional

• Type: bool

default_policy^Optional

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_desc

def fetch_desc() -> str

fetch_ros_dependency

def fetch_ros_dependency() -> typing.List[str]

get_att

def get_att(
  attribute_name: str
) -> Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

attribute_name^Required

• Type: str

The name of the attribute.

Static Functions

is_construct

import ros_cdk_emr
ros_cdk_emr.RosStarRocksInstance.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

is_ros_element

import ros_cdk_emr
ros_cdk_emr.RosStarRocksInstance.is_ros_element(
  x: typing.Any
)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

x^Required

• Type: typing.Any

is_ros_resource

import ros_cdk_emr
ros_cdk_emr.RosStarRocksInstance.is_ros_resource(
  construct: IConstruct
)

Check whether the given construct is a RosResource.

construct^Required

• Type: ros_cdk_core.IConstruct

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

creation_stack^Required

creation_stack: typing.List[str]

• Type: typing.List[str]

logical_id^Required

logical_id: str

• Type: str

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

ref^Required

ref: str

• Type: str

Return a string that will be resolved to a RosTemplate { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

ros_options^Required

ros_options: IRosResourceOptions

• Type: ros_cdk_core.IRosResourceOptions

Options for this resource, such as condition, update policy etc.

ros_resource_type^Required

ros_resource_type: str

• Type: str

ROS resource type.

attr_acl_id^Required

attr_acl_id: IResolvable

• Type: ros_cdk_core.IResolvable

attr_architecture^Required

attr_architecture: IResolvable

• Type: ros_cdk_core.IResolvable

attr_create_time^Required

attr_create_time: IResolvable

• Type: ros_cdk_core.IResolvable

attr_enable_auto_minor_version_upgrade^Required

attr_enable_auto_minor_version_upgrade: IResolvable

• Type: ros_cdk_core.IResolvable

attr_enabled_audit_loader^Required

attr_enabled_audit_loader: IResolvable

• Type: ros_cdk_core.IResolvable

attr_enable_ssl^Required

attr_enable_ssl: IResolvable

• Type: ros_cdk_core.IResolvable

attr_encrypted^Required

attr_encrypted: IResolvable

• Type: ros_cdk_core.IResolvable

attr_expire_time^Required

attr_expire_time: IResolvable

• Type: ros_cdk_core.IResolvable

attr_instance_id^Required

attr_instance_id: IResolvable

• Type: ros_cdk_core.IResolvable

attr_instance_name^Required

attr_instance_name: IResolvable

• Type: ros_cdk_core.IResolvable

attr_isolate_leader^Required

attr_isolate_leader: IResolvable

• Type: ros_cdk_core.IResolvable

attr_kms_key_id^Required

attr_kms_key_id: IResolvable

• Type: ros_cdk_core.IResolvable

attr_maintainable_period^Required

attr_maintainable_period: IResolvable

• Type: ros_cdk_core.IResolvable

attr_minor_version^Required

attr_minor_version: IResolvable

• Type: ros_cdk_core.IResolvable

attr_monitor_type^Required

attr_monitor_type: IResolvable

• Type: ros_cdk_core.IResolvable

attr_oss_location^Required

attr_oss_location: IResolvable

• Type: ros_cdk_core.IResolvable

attr_package_type^Required

attr_package_type: IResolvable

• Type: ros_cdk_core.IResolvable

attr_pay_type^Required

attr_pay_type: IResolvable

• Type: ros_cdk_core.IResolvable

attr_resource_group_id^Required

attr_resource_group_id: IResolvable

• Type: ros_cdk_core.IResolvable

attr_run_mode^Required

attr_run_mode: IResolvable

• Type: ros_cdk_core.IResolvable

attr_running_time^Required

attr_running_time: IResolvable

• Type: ros_cdk_core.IResolvable

attr_security_group_managed^Required

attr_security_group_managed: IResolvable

• Type: ros_cdk_core.IResolvable

attr_sg_id^Required

attr_sg_id: IResolvable

• Type: ros_cdk_core.IResolvable

attr_tags^Required

attr_tags: IResolvable

• Type: ros_cdk_core.IResolvable

attr_version^Required

attr_version: IResolvable

• Type: ros_cdk_core.IResolvable

attr_vpc_id^Required

attr_vpc_id: IResolvable

• Type: ros_cdk_core.IResolvable

attr_vswitches^Required

attr_vswitches: IResolvable

• Type: ros_cdk_core.IResolvable

admin_password^Required

admin_password: typing.Union[str, IResolvable]

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

cluster_zone_id^Required

cluster_zone_id: typing.Union[str, IResolvable]

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

enable_resource_property_constraint^Required

enable_resource_property_constraint: bool

• Type: bool

instance_name^Required

instance_name: typing.Union[str, IResolvable]

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

package_type^Required

package_type: typing.Union[str, IResolvable]

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

pay_type^Required

pay_type: typing.Union[str, IResolvable]

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

run_mode^Required

run_mode: typing.Union[str, IResolvable]

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

version^Required

version: typing.Union[str, IResolvable]

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

vpc_id^Required

vpc_id: typing.Union[str, IResolvable]

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

auto_renew^Optional

auto_renew: typing.Union[bool, IResolvable]

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

backend_node_groups^Optional

backend_node_groups: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, BackendNodeGroupsProperty]]]

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

duration^Optional

duration: typing.Union[typing.Union[int, float], IResolvable]

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

encrypted^Optional

encrypted: typing.Union[bool, IResolvable]

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

frontend_node_groups^Optional

frontend_node_groups: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, FrontendNodeGroupsProperty]]]

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

kms_key_id^Optional

kms_key_id: typing.Union[str, IResolvable]

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

observer_node_groups^Optional

observer_node_groups: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ObserverNodeGroupsProperty]]]

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

order_id^Optional

order_id: typing.Union[typing.Union[int, float], IResolvable]

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

oss_accessing_role_name^Optional

oss_accessing_role_name: typing.Union[str, IResolvable]

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

pricing_cycle^Optional

pricing_cycle: typing.Union[str, IResolvable]

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

promotion_option_no^Optional

promotion_option_no: typing.Union[str, IResolvable]

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

resource_group_id^Optional

resource_group_id: typing.Union[str, IResolvable]

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

resource_type^Optional

resource_type: typing.Union[str, IResolvable]

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

tags^Optional

tags: typing.List[TagsProperty]

• Type: typing.List[TagsProperty]

vswitches^Optional

vswitches: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, VswitchesProperty]]]

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

Constants

ROS_RESOURCE_TYPE_NAME^Required

ROS_RESOURCE_TYPE_NAME: str

• Type: str

The resource type name for this resource class.