ALIYUN::VS::Group is used to create a workspace.

Syntax

{
  "Type": "ALIYUN::VS::Group",
  "Properties": {
    "OutProtocol": String,
    "Name": String,
    "App": String,
    "Enabled": Boolean,
    "Callback": String,
    "InProtocol": String,
    "Region": String,
    "PlayDomain": String,
    "LazyPull": Boolean,
    "PushDomain": String,
    "Description": String
  }
}

Properties

Parameter Type Required Editable Description Constraint
OutProtocol String Yes Yes The playback protocol used by the space. Valid values:
  • FLV
  • hls
  • rtmp
You can set multiple values. Separate multiple values with commas (,).
Name String Yes Yes Space Name The name must be 4 to 64 characters in length, and can contain uppercase letters, lowercase letters, digits, and hyphen (-).
App String No Released The name of the application used by the space. Default value: live. The name can contain digits, uppercase letters, lowercase letters, underscores (_), and hyphen (-).
Enabled Boolean Not supported Supported Specifies whether to enable a space. None
callback String Not supported Supported Callback when the state of the device or the state of the stream is updated None
InProtocol String Yes Yes The access protocol used by the space. Valid values:
  • gb28181
  • rtmp
Region String Yes Yes The service center of the region to which the space belongs. None
PlayDomain String Yes Yes The streaming domain name used in the space. None
LazyPull Boolean Not supported Supported Specifies whether to enable on-demand stream pulling. Valid values:
  • true
  • false (default)
PushDomain String Yes Yes The ingest domain name used by the space. Only applicable to space accessed by rtmp. That is, this parameter is valid only when the InProtocol parameter is set to rtmp.
Description String Not supported Supported Space Description None

Return value

Fn::GetAtt

  • GbIp: The IP address of the server that is provided by the space. ( (Only applicable to the space of standard access)
  • GbId: Indicates the national standard ID provided by the space. ( (Only applicable to the space of standard access)
  • GbPort: The port of the national standard signaling server provided by the space. ( (Only applicable to the space of standard access)
  • Id: The Space ID.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Resources": {
    "Group": {
      "Type": "ALIYUN::VS::Group",
      "Properties": {
        "LazyPull": {
          "Ref": "LazyPull"
        },
        "Name": {
          "Ref": "Name"
        },
        "App": {
          "Ref": "App"
        },
        "Enabled": {
          "Ref": "Enabled"
        },
        "PushDomain": {
          "Ref": "PushDomain"
        },
        "Callback": {
          "Ref": "Callback"
        },
        "InProtocol": {
          "Ref": "InProtocol"
        },
        "PlayDomain": {
          "Ref": "PlayDomain"
        },
        "OutProtocol": {
          "Ref": "OutProtocol"
        },
        "Region": {
          "Ref": "Region"
        },
        "Description": {
          "Ref": "Description"
        }
      }
    }
  },
  "Parameters": {
    "LazyPull": {
      "Type": "Boolean",
      "Description": "Whether to enable on-demand pull flow, default false",
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    },
    "Name": {
      "Type": "String",
      "Description": "Space name."
    },
    "App": {
      "Type": "String",
      "Description": "Application name space used, the default live."
    },
    "Enabled": {
      "Type": "Boolean",
      "Description": "Space is enabled.",
      "AllowedValues": [
        "True",
        "true",
        "False",
        "false"
      ]
    },
    "PushDomain": {
      "Type": "String",
      "Description": "Plug flow domain name space to use. (Only access to the space rtmp)"
    },
    "Callback": {
      "Type": "String",
      "Description": "Updating the space callback device / flow state"
    },
    "InProtocol": {
      "Type": "String",
      "Description": "Access protocol used by the space.\nValue: gb28181, rtmp"
    },
    "PlayDomain": {
      "Type": "String",
      "Description": "Use of the domain name space broadcast stream."
    },
    "OutProtocol": {
      "Type": "String",
      "Description": "Play protocol used by the space, multivalued separated by commas.\nValue: flv, hls, rtmp"
    },
    "Region": {
      "Type": "String",
      "Description": "Space belongs to the region, as a service center."
    },
    "Description": {
      "Type": "String",
      "Description": "Space description."
    }
  },
  "Outputs": {
    "GbIp": {
      "Description": "GB signaling server address space provided. (Applies only to access the space marked States)",
      "Value": {
        "Fn::GetAtt": [
          "Group",
          "GbIp"
        ]
      }
    },
    "GbPort": {
      "Description": "GB Port space provided. (Applies only to access the space marked States)",
      "Value": {
        "Fn::GetAtt": [
          "Group",
          "GbPort"
        ]
      }
    },
    "GbId": {
      "Description": "GB ID space provided. (Applies only to access the space marked States)",
      "Value": {
        "Fn::GetAtt": [
          "Group",
          "GbId"
        ]
      }
    },
    "Id": {
      "Description": "Space ID.",
      "Value": {
        "Fn::GetAtt": [
          "Group",
          "Id"
        ]
      }
    }
  }
}

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Resources:
  Group:
    Type: 'ALIYUN::VS::Group'
    Properties:
      LazyPull:
        Ref: LazyPull
      Name:
        Ref: Name
      App:
        Ref: App
      Enabled:
        Ref: Enabled
      PushDomain:
        Ref: PushDomain
      Callback:
        Ref: Callback
      InProtocol:
        Ref: InProtocol
      PlayDomain:
        Ref: PlayDomain
      OutProtocol:
        Ref: OutProtocol
      Region:
        Ref: Region
      Description:
        Ref: Description
Parameters:
  LazyPull:
    Type: Boolean
    Description: 'Whether to enable on-demand pull flow, default false'
    AllowedValues:
      - 'True'
      - 'true'
      - 'False'
      - 'false'
  Name:
    Type: String
    Description: Space name.
  App:
    Type: String
    Description: 'Application name space used, the default live.'
  Enabled:
    Type: Boolean
    Description: Space is enabled.
    AllowedValues:
      - 'True'
      - 'true'
      - 'False'
      - 'false'
  PushDomain:
    Type: String
    Description: Plug flow domain name space to use. (Only access to the space rtmp)
  Callback:
    Type: String
    Description: Updating the space callback device / flow state
  InProtocol:
    Type: String
    Description: |-
      Access protocol used by the space.
      Value: gb28181, rtmp
  PlayDomain:
    Type: String
    Description: Use of the domain name space broadcast stream.
  OutProtocol:
    Type: String
    Description: |-
      Play protocol used by the space, multivalued separated by commas.
      Value: flv, hls, rtmp
  Region:
    Type: String
    Description: 'Space belongs to the region, as a service center.'
  Description:
    Type: String
    Description: Space description.
Outputs:
  GbIp:
    Description: >-
      GB signaling server address space provided. (Applies only to access the
      space marked States)
    Value:
      'Fn::GetAtt':
        -Group
        -GbIp
  GbPort:
    Description: GB Port space provided. (Applies only to access the space marked States)
    Value:
      'Fn::GetAtt':
        -Group
        -GbPort
  GbId:
    Description: GB ID space provided. (Applies only to access the space marked States)
    Value:
      'Fn::GetAtt':
        -Group
        -GbId
  Id:
    Description: Space ID.
    Value:
      'Fn::GetAtt':
        -Group
        -Id