Group

• Implements: IGroup

This class encapsulates and extends the ROS resource type ALIYUN::VS::Group.

Initializers

import ros_cdk_vs
ros_cdk_vs.Group(
  scope: Construct,
  id: str,
  in_protocol: typing.Union[str, IResolvable],
  name: typing.Union[str, IResolvable],
  out_protocol: typing.Union[str, IResolvable],
  play_domain: typing.Union[str, IResolvable],
  push_domain: typing.Union[str, IResolvable],
  region: typing.Union[str, IResolvable],
  app: typing.Union[str, IResolvable] = None,
  callback: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  enabled: typing.Union[bool, IResolvable] = None,
  lazy_pull: typing.Union[bool, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

in_protocol^Required

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

Property inProtocol: Access protocol used by the space.

Value: gb28181, rtmp

name^Required

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

Property name: Space name.

out_protocol^Required

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

Property outProtocol: Play protocol used by the space, multivalued separated by commas.

Value: flv, hls, rtmp

play_domain^Required

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

Property playDomain: Use of the domain name space broadcast stream.

push_domain^Required

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

Property pushDomain: Plug flow domain name space to use.

(Only access to the space rtmp)

region^Required

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

Property region: Space belongs to the region, as a service center.

app^Optional

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

Property app: Application name space used, the default live.

callback^Optional

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

Property callback: Updating the space callback device \/ flow state.

description^Optional

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

Property description: Space description.

enabled^Optional

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

Property enabled: Space is enabled.

lazy_pull^Optional

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

Property lazyPull: Whether to enable on-demand pull flow, default false.

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_vs
ros_cdk_vs.Group.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_gb_id^Required

attr_gb_id: typing.Union[str, IResolvable]

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

Attribute GbId: GB ID space provided.

(Applies only to access the space marked States)

attr_gb_ip^Required

attr_gb_ip: typing.Union[str, IResolvable]

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

Attribute GbIp: GB signaling server address space provided.

(Applies only to access the space marked States)

attr_gb_port^Required

attr_gb_port: typing.Union[str, IResolvable]

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

Attribute GbPort: GB Port space provided.

(Applies only to access the space marked States)

attr_id^Required

attr_id: typing.Union[str, IResolvable]

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

Attribute Id: Space ID.

props^Required

props: GroupProps

• Type: GroupProps