Group
- Implements: IGroup
This class encapsulates and extends the ROS resource type ALIYUN::VS::Group.
Initializers
import com.aliyun.ros.cdk.vs.Group;
Group.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.inProtocol(java.lang.String)
.inProtocol(IResolvable)
.name(java.lang.String)
.name(IResolvable)
.outProtocol(java.lang.String)
.outProtocol(IResolvable)
.playDomain(java.lang.String)
.playDomain(IResolvable)
.pushDomain(java.lang.String)
.pushDomain(IResolvable)
.region(java.lang.String)
.region(IResolvable)
// .app(java.lang.String)
// .app(IResolvable)
// .callback(java.lang.String)
// .callback(IResolvable)
// .description(java.lang.String)
// .description(IResolvable)
// .enabled(java.lang.Boolean)
// .enabled(IResolvable)
// .lazyPull(java.lang.Boolean)
// .lazyPull(IResolvable)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
inProtocol | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property inProtocol: Access protocol used by the space. |
name | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property name: Space name. |
outProtocol | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property outProtocol: Play protocol used by the space, multivalued separated by commas. |
playDomain | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property playDomain: Use of the domain name space broadcast stream. |
pushDomain | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property pushDomain: Plug flow domain name space to use. |
region | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property region: Space belongs to the region, as a service center. |
app | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property app: Application name space used, the default live. |
callback | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property callback: Updating the space callback device \/ flow state. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: Space description. |
enabled | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property enabled: Space is enabled. |
lazyPull | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property lazyPull: Whether to enable on-demand pull flow, default false. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
inProtocolRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property inProtocol: Access protocol used by the space.
Value: gb28181, rtmp
nameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property name: Space name.
outProtocolRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property outProtocol: Play protocol used by the space, multivalued separated by commas.
Value: flv, hls, rtmp
playDomainRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property playDomain: Use of the domain name space broadcast stream.
pushDomainRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property pushDomain: Plug flow domain name space to use.
(Only access to the space rtmp)
regionRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property region: Space belongs to the region, as a service center.
appOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property app: Application name space used, the default live.
callbackOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property callback: Updating the space callback device \/ flow state.
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: Space description.
enabledOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property enabled: Space is enabled.
lazyPullOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property lazyPull: Whether to enable on-demand pull flow, default false.
Methods
| Name | Description |
|---|---|
toString | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition | No description. |
addCount | No description. |
addDependency | No description. |
addResourceDesc | No description. |
applyRemovalPolicy | No description. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
toString
public java.lang.String toString()
Returns a string representation of this construct.
synthesize
public void synthesize(ISynthesisSession session)
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: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.vs.Group;
Group.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrGbId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute GbId: GB ID space provided. |
attrGbIp | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute GbIp: GB signaling server address space provided. |
attrGbPort | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute GbPort: GB Port space provided. |
attrId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Id: Space ID. |
props | GroupProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.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
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrGbIdRequired
public java.lang.Object getAttrGbId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute GbId: GB ID space provided.
(Applies only to access the space marked States)
attrGbIpRequired
public java.lang.Object getAttrGbIp();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute GbIp: GB signaling server address space provided.
(Applies only to access the space marked States)
attrGbPortRequired
public java.lang.Object getAttrGbPort();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute GbPort: GB Port space provided.
(Applies only to access the space marked States)
attrIdRequired
public java.lang.Object getAttrId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Id: Space ID.
propsRequired
public GroupProps getProps();
- Type: GroupProps