RosWaitingRoomEvent

This class is a base encapsulation around the ROS resource type ALIYUN::ESA::WaitingRoomEvent.

Initializers

import ros_cdk_esa
ros_cdk_esa.RosWaitingRoomEvent(
  scope: Construct,
  id: str,
  end_time: typing.Union[str, IResolvable],
  new_users_per_minute: typing.Union[typing.Union[int, float], IResolvable],
  queuing_method: typing.Union[str, IResolvable],
  queuing_status_code: typing.Union[str, IResolvable],
  session_duration: typing.Union[typing.Union[int, float], IResolvable],
  site_id: typing.Union[typing.Union[int, float], IResolvable],
  start_time: typing.Union[str, IResolvable],
  total_active_users: typing.Union[typing.Union[int, float], IResolvable],
  waiting_room_event_name: typing.Union[str, IResolvable],
  waiting_room_type: typing.Union[str, IResolvable],
  custom_page_html: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  disable_session_renewal_enable: typing.Union[str, IResolvable] = None,
  json_response_enable: typing.Union[str, IResolvable] = None,
  language: typing.Union[str, IResolvable] = None,
  pre_queue_enable: typing.Union[str, IResolvable] = None,
  pre_queue_start_time: typing.Union[str, IResolvable] = None,
  random_pre_queue_enable: typing.Union[str, IResolvable] = None,
  waiting_room_id: typing.Union[str, IResolvable] = 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.

end_time^Required

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

new_users_per_minute^Required

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

queuing_method^Required

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

queuing_status_code^Required

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

session_duration^Required

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

site_id^Required

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

start_time^Required

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

total_active_users^Required

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

waiting_room_event_name^Required

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

waiting_room_type^Required

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

custom_page_html^Optional

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

description^Optional

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

disable_session_renewal_enable^Optional

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

json_response_enable^Optional

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

language^Optional

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

pre_queue_enable^Optional

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

pre_queue_start_time^Optional

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

random_pre_queue_enable^Optional

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

waiting_room_id^Optional

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

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_esa
ros_cdk_esa.RosWaitingRoomEvent.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

is_ros_element

import ros_cdk_esa
ros_cdk_esa.RosWaitingRoomEvent.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_esa
ros_cdk_esa.RosWaitingRoomEvent.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_custom_page_html^Required

attr_custom_page_html: IResolvable

• Type: ros_cdk_core.IResolvable

attr_description^Required

attr_description: IResolvable

• Type: ros_cdk_core.IResolvable

attr_disable_session_renewal_enable^Required

attr_disable_session_renewal_enable: IResolvable

• Type: ros_cdk_core.IResolvable

attr_end_time^Required

attr_end_time: IResolvable

• Type: ros_cdk_core.IResolvable

attr_json_response_enable^Required

attr_json_response_enable: IResolvable

• Type: ros_cdk_core.IResolvable

attr_language^Required

attr_language: IResolvable

• Type: ros_cdk_core.IResolvable

attr_new_users_per_minute^Required

attr_new_users_per_minute: IResolvable

• Type: ros_cdk_core.IResolvable

attr_pre_queue_enable^Required

attr_pre_queue_enable: IResolvable

• Type: ros_cdk_core.IResolvable

attr_pre_queue_start_time^Required

attr_pre_queue_start_time: IResolvable

• Type: ros_cdk_core.IResolvable

attr_queuing_method^Required

attr_queuing_method: IResolvable

• Type: ros_cdk_core.IResolvable

attr_queuing_status_code^Required

attr_queuing_status_code: IResolvable

• Type: ros_cdk_core.IResolvable

attr_random_pre_queue_enable^Required

attr_random_pre_queue_enable: IResolvable

• Type: ros_cdk_core.IResolvable

attr_session_duration^Required

attr_session_duration: IResolvable

• Type: ros_cdk_core.IResolvable

attr_start_time^Required

attr_start_time: IResolvable

• Type: ros_cdk_core.IResolvable

attr_total_active_users^Required

attr_total_active_users: IResolvable

• Type: ros_cdk_core.IResolvable

attr_waiting_room_event_id^Required

attr_waiting_room_event_id: IResolvable

• Type: ros_cdk_core.IResolvable

attr_waiting_room_event_name^Required

attr_waiting_room_event_name: IResolvable

• Type: ros_cdk_core.IResolvable

attr_waiting_room_id^Required

attr_waiting_room_id: IResolvable

• Type: ros_cdk_core.IResolvable

attr_waiting_room_type^Required

attr_waiting_room_type: IResolvable

• Type: ros_cdk_core.IResolvable

enable_resource_property_constraint^Required

enable_resource_property_constraint: bool

• Type: bool

end_time^Required

end_time: typing.Union[str, IResolvable]

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

new_users_per_minute^Required

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

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

queuing_method^Required

queuing_method: typing.Union[str, IResolvable]

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

queuing_status_code^Required

queuing_status_code: typing.Union[str, IResolvable]

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

session_duration^Required

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

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

site_id^Required

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

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

start_time^Required

start_time: typing.Union[str, IResolvable]

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

total_active_users^Required

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

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

waiting_room_event_name^Required

waiting_room_event_name: typing.Union[str, IResolvable]

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

waiting_room_type^Required

waiting_room_type: typing.Union[str, IResolvable]

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

custom_page_html^Optional

custom_page_html: typing.Union[str, IResolvable]

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

description^Optional

description: typing.Union[str, IResolvable]

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

disable_session_renewal_enable^Optional

disable_session_renewal_enable: typing.Union[str, IResolvable]

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

json_response_enable^Optional

json_response_enable: typing.Union[str, IResolvable]

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

language^Optional

language: typing.Union[str, IResolvable]

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

pre_queue_enable^Optional

pre_queue_enable: typing.Union[str, IResolvable]

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

pre_queue_start_time^Optional

pre_queue_start_time: typing.Union[str, IResolvable]

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

random_pre_queue_enable^Optional

random_pre_queue_enable: typing.Union[str, IResolvable]

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

waiting_room_id^Optional

waiting_room_id: typing.Union[str, IResolvable]

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

Constants

ROS_RESOURCE_TYPE_NAME^Required

ROS_RESOURCE_TYPE_NAME: str

• Type: str

The resource type name for this resource class.