Skip to content

Cluster

This class encapsulates and extends the ROS resource type ALIYUN::FOAS::Cluster, which is used to create a cluster for an order in exclusive mode.

Initializers 

import ros_cdk_foas
ros_cdk_foas.Cluster(
  scope: Construct,
  id: str,
  cluster_name: typing.Union[str, IResolvable],
  description: typing.Union[str, IResolvable],
  oss_bucket: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  order: typing.Union[IResolvable, OrderProperty] = None,
  order_id: 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_name typing.Union[str, ros_cdk_core.IResolvable] Property clusterName: Cluster name.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: Cluster description.
oss_bucket typing.Union[str, ros_cdk_core.IResolvable] Property ossBucket: Bucket name in your OSS.
v_switch_id typing.Union[str, ros_cdk_core.IResolvable] Property vSwitchId: VSwitch ID.
order typing.Union[ros_cdk_core.IResolvable, OrderProperty] Property order: Order detail.
order_id typing.Union[str, ros_cdk_core.IResolvable] Property orderId: Order Id.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

cluster_nameRequired

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

Property clusterName: Cluster name.

It begins with a letter, and contains only lowercase English letters, numbers, underscores (_), and is limited to 3-64 characters.

descriptionRequired

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

Property description: Cluster description.

oss_bucketRequired

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

Property ossBucket: Bucket name in your OSS.

v_switch_idRequired

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

Property vSwitchId: VSwitch ID.

orderOptional

Property order: Order detail.

Only one of property Order or OrderId can be specified. Order is not suggested. Policy AliyunBSSFullAccess must be granted to StreamDefaultRole in RAM console. The order can not be cancelled.

order_idOptional

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

Property orderId: Order Id.

Only one of property Order or OrderId can be specified. OrderId is suggested.

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

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_foas
ros_cdk_foas.Cluster.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
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_cluster_id ros_cdk_core.IResolvable Attribute ClusterId: Cluster ID.
attr_engine_versions ros_cdk_core.IResolvable Attribute EngineVersions: Engine Versions.
attr_master_instance_infos ros_cdk_core.IResolvable Attribute MasterInstanceInfos: Master instance infos.
attr_order_id ros_cdk_core.IResolvable Attribute OrderId: Order ID.
attr_security_group_id ros_cdk_core.IResolvable Attribute SecurityGroupId: Security group Id.
attr_slave_instance_infos ros_cdk_core.IResolvable Attribute SlaveInstanceInfos: Slave instance infos.
attr_state ros_cdk_core.IResolvable Attribute State: Cluster status.
attr_v_switch_ids ros_cdk_core.IResolvable Attribute VSwitchIds: VSwitch Ids.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

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_cluster_idRequired 

attr_cluster_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ClusterId: Cluster ID.

attr_engine_versionsRequired 

attr_engine_versions: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EngineVersions: Engine Versions.

attr_master_instance_infosRequired 

attr_master_instance_infos: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute MasterInstanceInfos: Master instance infos.

attr_order_idRequired 

attr_order_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute OrderId: Order ID.

attr_security_group_idRequired 

attr_security_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SecurityGroupId: Security group Id.

attr_slave_instance_infosRequired 

attr_slave_instance_infos: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SlaveInstanceInfos: Slave instance infos.

attr_stateRequired 

attr_state: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute State: Cluster status.

attr_v_switch_idsRequired 

attr_v_switch_ids: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VSwitchIds: VSwitch Ids.