ResourceGroup

• Implements: IResourceGroup

This class encapsulates and extends the ROS resource type ALIYUN::ADBLake::ResourceGroup.

Initializers

import ros_cdk_adblake
ros_cdk_adblake.ResourceGroup(
  scope: Construct,
  id: str,
  db_cluster_id: typing.Union[str, IResolvable],
  engine: typing.Union[str, IResolvable],
  group_name: typing.Union[str, IResolvable],
  group_type: typing.Union[str, IResolvable],
  auto_stop_interval: typing.Union[str, IResolvable] = None,
  cluster_mode: typing.Union[str, IResolvable] = None,
  cluster_size_resource: typing.Union[str, IResolvable] = None,
  enable_spot: typing.Union[bool, IResolvable] = None,
  engine_params: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  max_cluster_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  max_compute_resource: typing.Union[str, IResolvable] = None,
  min_cluster_count: typing.Union[typing.Union[int, float], IResolvable] = None,
  min_compute_resource: typing.Union[str, IResolvable] = None,
  rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, RulesProperty]]] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

db_cluster_id^Required

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

Property dbClusterId: The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.

engine^Required

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

Property engine: The database engine.

Valid values:

• AnalyticDB (default): the AnalyticDB for MySQL engine.
• SparkWarehouse: the SparkWarehouse engine.

group_name^Required

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

Property groupName: The name of the resource group.

The name can be up to 255 characters in length. The name must start with a letter or digit. The name can contain letters, digits, hyphens (-), and underscores (_).

group_type^Required

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

Property groupType: The type of the resource group.

Valid values: Interactive Job Note For more information about resource groups, see Resource group overview.

auto_stop_interval^Optional

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

Property autoStopInterval: Automatically stop time, the unit is minutes (m).

cluster_mode^Optional

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

Property clusterMode: This parameter is reserved.

cluster_size_resource^Optional

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

Property clusterSizeResource: A reserved parameter.

enable_spot^Optional

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

Property enableSpot: Specifies whether to enable the spot instance feature for the resource group.

After you enable the spot instance feature, you are charged for resources at a lower unit price but the resources are probably released. You can enable the spot instance feature only for job resource groups. Valid values: True False

engine_params^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property engineParams: Engine configuration.

max_cluster_count^Optional

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

Property maxClusterCount: A reserved parameter.

max_compute_resource^Optional

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

Property maxComputeResource: The maximum reserved computing resources.

If GroupType is set to Interactive, the maximum amount of reserved computing resources refers to the amount of resources that are not allocated in the cluster. Set this parameter to a value in increments of 16ACU. If GroupType is set to Job, the maximum amount of reserved computing resources refers to the amount of resources that are not allocated in the cluster. Set this parameter to a value in increments of 8ACU.

min_cluster_count^Optional

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

Property minClusterCount: A reserved parameter.

min_compute_resource^Optional

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

Property minComputeResource: The minimum reserved computing resources.

When GroupType is set to Interactive, set this parameter to 16ACU. When GroupType is set to Job, set this parameter to 0ACU.

rules^Optional

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

Property rules: The job resubmission rules.

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_adblake
ros_cdk_adblake.ResourceGroup.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_group_name^Required

attr_group_name: typing.Union[str, IResolvable]

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

Attribute GroupName: The name of the resource group.

attr_group_type^Required

attr_group_type: typing.Union[str, IResolvable]

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

Attribute GroupType: The type of the resource group.

attr_group_users^Required

attr_group_users: typing.Union[str, IResolvable]

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

Attribute GroupUsers: The list of users in the resource group.

props^Required

props: ResourceGroupProps

• Type: ResourceGroupProps