Queue
- Implements: IQueue
This class encapsulates and extends the ROS resource type ALIYUN::EHPC::Queue.
Initializers
import ros_cdk_ehpc
ros_cdk_ehpc.Queue(
scope: Construct,
id: str,
cluster_id: typing.Union[str, IResolvable] = None,
compute_nodes: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ComputeNodesProperty]]] = None,
enable_scale_in: typing.Union[bool, IResolvable] = None,
enable_scale_out: typing.Union[bool, IResolvable] = None,
hostname_prefix: typing.Union[str, IResolvable] = None,
hostname_suffix: typing.Union[str, IResolvable] = None,
initial_count: typing.Union[typing.Union[int, float], IResolvable] = None,
inter_connect: typing.Union[str, IResolvable] = None,
max_count: typing.Union[typing.Union[int, float], IResolvable] = None,
min_count: typing.Union[typing.Union[int, float], IResolvable] = None,
queue_name: typing.Union[str, IResolvable] = None,
v_switch_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
enable_resource_property_constraint: bool = None
)
| Name | Type | Description |
|---|---|---|
scope | ros_cdk_core.Construct | No description. |
id | str | No description. |
cluster_id | typing.Union[str, ros_cdk_core.IResolvable] | Property clusterId: The cluster ID. |
compute_nodes | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ComputeNodesProperty]]] | Property computeNodes: The hardware configurations of the compute nodes in the queue. |
enable_scale_in | typing.Union[bool, ros_cdk_core.IResolvable] | Property enableScaleIn: Specifies whether to enable auto scale-in for the queue. |
enable_scale_out | typing.Union[bool, ros_cdk_core.IResolvable] | Property enableScaleOut: Specifies whether to enable auto scale-out for the queue. |
hostname_prefix | typing.Union[str, ros_cdk_core.IResolvable] | Property hostnamePrefix: The hostname prefix of the added compute nodes. |
hostname_suffix | typing.Union[str, ros_cdk_core.IResolvable] | Property hostnameSuffix: The hostname suffix of the compute nodes in the queue. |
initial_count | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property initialCount: The initial number of compute nodes in the queue. |
inter_connect | typing.Union[str, ros_cdk_core.IResolvable] | Property interConnect: The type of the network for interconnecting compute nodes in the queue. |
max_count | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property maxCount: The maximum number of compute nodes that the queue can contain. |
min_count | typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] | Property minCount: The minimum number of compute nodes that the queue must contain. |
queue_name | typing.Union[str, ros_cdk_core.IResolvable] | Property queueName: The queue name. |
v_switch_ids | typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]] | Property vSwitchIds: The VSwitches available for use by compute nodes in the queue. |
enable_resource_property_constraint | bool | No description. |
scopeRequired
- Type: ros_cdk_core.Construct
idRequired
- Type: str
cluster_idOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property clusterId: The cluster ID.
compute_nodesOptional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, ComputeNodesProperty]]]
Property computeNodes: The hardware configurations of the compute nodes in the queue.
Valid values of N: 1 to 10.
enable_scale_inOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property enableScaleIn: Specifies whether to enable auto scale-in for the queue.
Valid values:
- true
- false.
enable_scale_outOptional
- Type: typing.Union[bool, ros_cdk_core.IResolvable]
Property enableScaleOut: Specifies whether to enable auto scale-out for the queue.
Valid values:
- true
- false.
hostname_prefixOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property hostnamePrefix: The hostname prefix of the added compute nodes.
hostname_suffixOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property hostnameSuffix: The hostname suffix of the compute nodes in the queue.
initial_countOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property initialCount: The initial number of compute nodes in the queue.
inter_connectOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property interConnect: The type of the network for interconnecting compute nodes in the queue.
max_countOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property maxCount: The maximum number of compute nodes that the queue can contain.
min_countOptional
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
Property minCount: The minimum number of compute nodes that the queue must contain.
queue_nameOptional
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Property queueName: The queue name.
v_switch_idsOptional
- Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]
Property vSwitchIds: The VSwitches available for use by compute nodes in the queue.
enable_resource_property_constraintOptional
- Type: bool
Methods
| Name | Description |
|---|---|
to_string | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
add_condition | No description. |
add_count | No description. |
add_dependency | No description. |
add_resource_desc | No description. |
apply_removal_policy | No description. |
fetch_condition | No description. |
fetch_dependency | No description. |
fetch_resource_desc | No description. |
get_att | No description. |
set_metadata | No description. |
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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- 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
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
| Name | Description |
|---|---|
is_construct | Return whether the given object is a Construct. |
is_construct
import ros_cdk_ehpc
ros_cdk_ehpc.Queue.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
| Name | Type | Description |
|---|---|---|
node | ros_cdk_core.ConstructNode | The construct tree node associated with this construct. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
ref | str | No description. |
stack | ros_cdk_core.Stack | The stack in which this resource is defined. |
resource | ros_cdk_core.RosResource | No description. |
attr_compute_nodes | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ComputeNodes: The hardware configurations of the compute nodes in the queue. |
attr_create_time | typing.Union[str, ros_cdk_core.IResolvable] | Attribute CreateTime: Queue creation time. |
attr_enable_scale_in | typing.Union[str, ros_cdk_core.IResolvable] | Attribute EnableScaleIn: Specifies whether to enable auto scale-in for the queue. |
attr_enable_scale_out | typing.Union[str, ros_cdk_core.IResolvable] | Attribute EnableScaleOut: Specifies whether to enable auto scale-out for the queue. |
attr_hostname_prefix | typing.Union[str, ros_cdk_core.IResolvable] | Attribute HostnamePrefix: The hostname prefix of the added compute nodes. |
attr_hostname_suffix | typing.Union[str, ros_cdk_core.IResolvable] | Attribute HostnameSuffix: The hostname suffix of the compute nodes in the queue. |
attr_initial_count | typing.Union[str, ros_cdk_core.IResolvable] | Attribute InitialCount: The initial number of compute nodes in the queue. |
attr_inter_connect | typing.Union[str, ros_cdk_core.IResolvable] | Attribute InterConnect: The type of the network for interconnecting compute nodes in the queue. |
attr_max_count | typing.Union[str, ros_cdk_core.IResolvable] | Attribute MaxCount: The maximum number of compute nodes that the queue can contain. |
attr_min_count | typing.Union[str, ros_cdk_core.IResolvable] | Attribute MinCount: The minimum number of compute nodes that the queue must contain. |
attr_queue_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute QueueName: The queue name. |
attr_update_time | typing.Union[str, ros_cdk_core.IResolvable] | Attribute UpdateTime: Queue update time. |
attr_v_switch_ids | typing.Union[str, ros_cdk_core.IResolvable] | Attribute VSwitchIds: The VSwitches available for use by compute nodes in the queue. |
props | QueueProps | No description. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
refRequired
ref: str
- Type: str
stackRequired
stack: Stack
- Type: ros_cdk_core.Stack
The stack in which this resource is defined.
resourceOptional
resource: RosResource
- Type: ros_cdk_core.RosResource
attr_compute_nodesRequired
attr_compute_nodes: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ComputeNodes: The hardware configurations of the compute nodes in the queue.
attr_create_timeRequired
attr_create_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute CreateTime: Queue creation time.
attr_enable_scale_inRequired
attr_enable_scale_in: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute EnableScaleIn: Specifies whether to enable auto scale-in for the queue.
attr_enable_scale_outRequired
attr_enable_scale_out: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute EnableScaleOut: Specifies whether to enable auto scale-out for the queue.
attr_hostname_prefixRequired
attr_hostname_prefix: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute HostnamePrefix: The hostname prefix of the added compute nodes.
attr_hostname_suffixRequired
attr_hostname_suffix: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute HostnameSuffix: The hostname suffix of the compute nodes in the queue.
attr_initial_countRequired
attr_initial_count: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute InitialCount: The initial number of compute nodes in the queue.
attr_inter_connectRequired
attr_inter_connect: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute InterConnect: The type of the network for interconnecting compute nodes in the queue.
attr_max_countRequired
attr_max_count: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute MaxCount: The maximum number of compute nodes that the queue can contain.
attr_min_countRequired
attr_min_count: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute MinCount: The minimum number of compute nodes that the queue must contain.
attr_queue_nameRequired
attr_queue_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute QueueName: The queue name.
attr_update_timeRequired
attr_update_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute UpdateTime: Queue update time.
attr_v_switch_idsRequired
attr_v_switch_ids: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute VSwitchIds: The VSwitches available for use by compute nodes in the queue.
propsRequired
props: QueueProps
- Type: QueueProps