1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. videosurveillance
  5. SystemGroup
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi

alicloud.videosurveillance.SystemGroup

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi

    Provides a Video Surveillance System Group resource.

    For information about Video Surveillance System Group and how to use it, see What is Group.

    NOTE: Available in v1.135.0+.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const _default = new alicloud.videosurveillance.SystemGroup("default", {
        groupName: "your_group_name",
        inProtocol: "rtmp",
        outProtocol: "flv",
        playDomain: "your_plan_domain",
        pushDomain: "your_push_domain",
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    default = alicloud.videosurveillance.SystemGroup("default",
        group_name="your_group_name",
        in_protocol="rtmp",
        out_protocol="flv",
        play_domain="your_plan_domain",
        push_domain="your_push_domain")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/videosurveillance"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := videosurveillance.NewSystemGroup(ctx, "default", &videosurveillance.SystemGroupArgs{
    			GroupName:   pulumi.String("your_group_name"),
    			InProtocol:  pulumi.String("rtmp"),
    			OutProtocol: pulumi.String("flv"),
    			PlayDomain:  pulumi.String("your_plan_domain"),
    			PushDomain:  pulumi.String("your_push_domain"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = new AliCloud.VideoSurveillance.SystemGroup("default", new()
        {
            GroupName = "your_group_name",
            InProtocol = "rtmp",
            OutProtocol = "flv",
            PlayDomain = "your_plan_domain",
            PushDomain = "your_push_domain",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.videosurveillance.SystemGroup;
    import com.pulumi.alicloud.videosurveillance.SystemGroupArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var default_ = new SystemGroup("default", SystemGroupArgs.builder()
                .groupName("your_group_name")
                .inProtocol("rtmp")
                .outProtocol("flv")
                .playDomain("your_plan_domain")
                .pushDomain("your_push_domain")
                .build());
    
        }
    }
    
    resources:
      default:
        type: alicloud:videosurveillance:SystemGroup
        properties:
          groupName: your_group_name
          inProtocol: rtmp
          outProtocol: flv
          playDomain: your_plan_domain
          pushDomain: your_push_domain
    

    Create SystemGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SystemGroup(name: string, args: SystemGroupArgs, opts?: CustomResourceOptions);
    @overload
    def SystemGroup(resource_name: str,
                    args: SystemGroupArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def SystemGroup(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    group_name: Optional[str] = None,
                    in_protocol: Optional[str] = None,
                    out_protocol: Optional[str] = None,
                    play_domain: Optional[str] = None,
                    push_domain: Optional[str] = None,
                    callback: Optional[str] = None,
                    description: Optional[str] = None,
                    enabled: Optional[bool] = None)
    func NewSystemGroup(ctx *Context, name string, args SystemGroupArgs, opts ...ResourceOption) (*SystemGroup, error)
    public SystemGroup(string name, SystemGroupArgs args, CustomResourceOptions? opts = null)
    public SystemGroup(String name, SystemGroupArgs args)
    public SystemGroup(String name, SystemGroupArgs args, CustomResourceOptions options)
    
    type: alicloud:videosurveillance:SystemGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args SystemGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SystemGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SystemGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SystemGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SystemGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var systemGroupResource = new AliCloud.VideoSurveillance.SystemGroup("systemGroupResource", new()
    {
        GroupName = "string",
        InProtocol = "string",
        OutProtocol = "string",
        PlayDomain = "string",
        PushDomain = "string",
        Callback = "string",
        Description = "string",
        Enabled = false,
    });
    
    example, err := videosurveillance.NewSystemGroup(ctx, "systemGroupResource", &videosurveillance.SystemGroupArgs{
    	GroupName:   pulumi.String("string"),
    	InProtocol:  pulumi.String("string"),
    	OutProtocol: pulumi.String("string"),
    	PlayDomain:  pulumi.String("string"),
    	PushDomain:  pulumi.String("string"),
    	Callback:    pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Enabled:     pulumi.Bool(false),
    })
    
    var systemGroupResource = new SystemGroup("systemGroupResource", SystemGroupArgs.builder()
        .groupName("string")
        .inProtocol("string")
        .outProtocol("string")
        .playDomain("string")
        .pushDomain("string")
        .callback("string")
        .description("string")
        .enabled(false)
        .build());
    
    system_group_resource = alicloud.videosurveillance.SystemGroup("systemGroupResource",
        group_name="string",
        in_protocol="string",
        out_protocol="string",
        play_domain="string",
        push_domain="string",
        callback="string",
        description="string",
        enabled=False)
    
    const systemGroupResource = new alicloud.videosurveillance.SystemGroup("systemGroupResource", {
        groupName: "string",
        inProtocol: "string",
        outProtocol: "string",
        playDomain: "string",
        pushDomain: "string",
        callback: "string",
        description: "string",
        enabled: false,
    });
    
    type: alicloud:videosurveillance:SystemGroup
    properties:
        callback: string
        description: string
        enabled: false
        groupName: string
        inProtocol: string
        outProtocol: string
        playDomain: string
        pushDomain: string
    

    SystemGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SystemGroup resource accepts the following input properties:

    GroupName string
    The Group Name.
    InProtocol string
    The use of the access protocol support gb28181, Real Time Messaging Protocol (rtmp). Valid values: gb28181, rtmp.
    OutProtocol string
    The playback protocol used by the space, multiple values are separated by commas (,). Valid values: flv,hls, rtmp.
    PlayDomain string
    The domain name of plan streaming used by the group.
    PushDomain string
    The domain name of push streaming used by the group.
    Callback string
    The space within the device status update of the callback, need to start with http:// or https:// at the beginning.
    Description string
    The description of Group.
    Enabled bool
    Whether to open Group.
    GroupName string
    The Group Name.
    InProtocol string
    The use of the access protocol support gb28181, Real Time Messaging Protocol (rtmp). Valid values: gb28181, rtmp.
    OutProtocol string
    The playback protocol used by the space, multiple values are separated by commas (,). Valid values: flv,hls, rtmp.
    PlayDomain string
    The domain name of plan streaming used by the group.
    PushDomain string
    The domain name of push streaming used by the group.
    Callback string
    The space within the device status update of the callback, need to start with http:// or https:// at the beginning.
    Description string
    The description of Group.
    Enabled bool
    Whether to open Group.
    groupName String
    The Group Name.
    inProtocol String
    The use of the access protocol support gb28181, Real Time Messaging Protocol (rtmp). Valid values: gb28181, rtmp.
    outProtocol String
    The playback protocol used by the space, multiple values are separated by commas (,). Valid values: flv,hls, rtmp.
    playDomain String
    The domain name of plan streaming used by the group.
    pushDomain String
    The domain name of push streaming used by the group.
    callback String
    The space within the device status update of the callback, need to start with http:// or https:// at the beginning.
    description String
    The description of Group.
    enabled Boolean
    Whether to open Group.
    groupName string
    The Group Name.
    inProtocol string
    The use of the access protocol support gb28181, Real Time Messaging Protocol (rtmp). Valid values: gb28181, rtmp.
    outProtocol string
    The playback protocol used by the space, multiple values are separated by commas (,). Valid values: flv,hls, rtmp.
    playDomain string
    The domain name of plan streaming used by the group.
    pushDomain string
    The domain name of push streaming used by the group.
    callback string
    The space within the device status update of the callback, need to start with http:// or https:// at the beginning.
    description string
    The description of Group.
    enabled boolean
    Whether to open Group.
    group_name str
    The Group Name.
    in_protocol str
    The use of the access protocol support gb28181, Real Time Messaging Protocol (rtmp). Valid values: gb28181, rtmp.
    out_protocol str
    The playback protocol used by the space, multiple values are separated by commas (,). Valid values: flv,hls, rtmp.
    play_domain str
    The domain name of plan streaming used by the group.
    push_domain str
    The domain name of push streaming used by the group.
    callback str
    The space within the device status update of the callback, need to start with http:// or https:// at the beginning.
    description str
    The description of Group.
    enabled bool
    Whether to open Group.
    groupName String
    The Group Name.
    inProtocol String
    The use of the access protocol support gb28181, Real Time Messaging Protocol (rtmp). Valid values: gb28181, rtmp.
    outProtocol String
    The playback protocol used by the space, multiple values are separated by commas (,). Valid values: flv,hls, rtmp.
    playDomain String
    The domain name of plan streaming used by the group.
    pushDomain String
    The domain name of push streaming used by the group.
    callback String
    The space within the device status update of the callback, need to start with http:// or https:// at the beginning.
    description String
    The description of Group.
    enabled Boolean
    Whether to open Group.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SystemGroup resource produces the following output properties:

    CaptureImage int
    The capture image.
    CaptureInterval int
    The capture interval.
    CaptureOssBucket string
    The capture oss bucket.
    CaptureOssPath string
    The capture oss path.
    CaptureVideo int
    The capture video.
    Id string
    The provider-assigned unique ID for this managed resource.
    LazyPull bool
    Whether to enable on-demand streaming. Default value:false.
    Status bool
    Whether to open Group. Valid values: on,off.
    CaptureImage int
    The capture image.
    CaptureInterval int
    The capture interval.
    CaptureOssBucket string
    The capture oss bucket.
    CaptureOssPath string
    The capture oss path.
    CaptureVideo int
    The capture video.
    Id string
    The provider-assigned unique ID for this managed resource.
    LazyPull bool
    Whether to enable on-demand streaming. Default value:false.
    Status bool
    Whether to open Group. Valid values: on,off.
    captureImage Integer
    The capture image.
    captureInterval Integer
    The capture interval.
    captureOssBucket String
    The capture oss bucket.
    captureOssPath String
    The capture oss path.
    captureVideo Integer
    The capture video.
    id String
    The provider-assigned unique ID for this managed resource.
    lazyPull Boolean
    Whether to enable on-demand streaming. Default value:false.
    status Boolean
    Whether to open Group. Valid values: on,off.
    captureImage number
    The capture image.
    captureInterval number
    The capture interval.
    captureOssBucket string
    The capture oss bucket.
    captureOssPath string
    The capture oss path.
    captureVideo number
    The capture video.
    id string
    The provider-assigned unique ID for this managed resource.
    lazyPull boolean
    Whether to enable on-demand streaming. Default value:false.
    status boolean
    Whether to open Group. Valid values: on,off.
    capture_image int
    The capture image.
    capture_interval int
    The capture interval.
    capture_oss_bucket str
    The capture oss bucket.
    capture_oss_path str
    The capture oss path.
    capture_video int
    The capture video.
    id str
    The provider-assigned unique ID for this managed resource.
    lazy_pull bool
    Whether to enable on-demand streaming. Default value:false.
    status bool
    Whether to open Group. Valid values: on,off.
    captureImage Number
    The capture image.
    captureInterval Number
    The capture interval.
    captureOssBucket String
    The capture oss bucket.
    captureOssPath String
    The capture oss path.
    captureVideo Number
    The capture video.
    id String
    The provider-assigned unique ID for this managed resource.
    lazyPull Boolean
    Whether to enable on-demand streaming. Default value:false.
    status Boolean
    Whether to open Group. Valid values: on,off.

    Look up Existing SystemGroup Resource

    Get an existing SystemGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SystemGroupState, opts?: CustomResourceOptions): SystemGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            callback: Optional[str] = None,
            capture_image: Optional[int] = None,
            capture_interval: Optional[int] = None,
            capture_oss_bucket: Optional[str] = None,
            capture_oss_path: Optional[str] = None,
            capture_video: Optional[int] = None,
            description: Optional[str] = None,
            enabled: Optional[bool] = None,
            group_name: Optional[str] = None,
            in_protocol: Optional[str] = None,
            lazy_pull: Optional[bool] = None,
            out_protocol: Optional[str] = None,
            play_domain: Optional[str] = None,
            push_domain: Optional[str] = None,
            status: Optional[bool] = None) -> SystemGroup
    func GetSystemGroup(ctx *Context, name string, id IDInput, state *SystemGroupState, opts ...ResourceOption) (*SystemGroup, error)
    public static SystemGroup Get(string name, Input<string> id, SystemGroupState? state, CustomResourceOptions? opts = null)
    public static SystemGroup get(String name, Output<String> id, SystemGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Callback string
    The space within the device status update of the callback, need to start with http:// or https:// at the beginning.
    CaptureImage int
    The capture image.
    CaptureInterval int
    The capture interval.
    CaptureOssBucket string
    The capture oss bucket.
    CaptureOssPath string
    The capture oss path.
    CaptureVideo int
    The capture video.
    Description string
    The description of Group.
    Enabled bool
    Whether to open Group.
    GroupName string
    The Group Name.
    InProtocol string
    The use of the access protocol support gb28181, Real Time Messaging Protocol (rtmp). Valid values: gb28181, rtmp.
    LazyPull bool
    Whether to enable on-demand streaming. Default value:false.
    OutProtocol string
    The playback protocol used by the space, multiple values are separated by commas (,). Valid values: flv,hls, rtmp.
    PlayDomain string
    The domain name of plan streaming used by the group.
    PushDomain string
    The domain name of push streaming used by the group.
    Status bool
    Whether to open Group. Valid values: on,off.
    Callback string
    The space within the device status update of the callback, need to start with http:// or https:// at the beginning.
    CaptureImage int
    The capture image.
    CaptureInterval int
    The capture interval.
    CaptureOssBucket string
    The capture oss bucket.
    CaptureOssPath string
    The capture oss path.
    CaptureVideo int
    The capture video.
    Description string
    The description of Group.
    Enabled bool
    Whether to open Group.
    GroupName string
    The Group Name.
    InProtocol string
    The use of the access protocol support gb28181, Real Time Messaging Protocol (rtmp). Valid values: gb28181, rtmp.
    LazyPull bool
    Whether to enable on-demand streaming. Default value:false.
    OutProtocol string
    The playback protocol used by the space, multiple values are separated by commas (,). Valid values: flv,hls, rtmp.
    PlayDomain string
    The domain name of plan streaming used by the group.
    PushDomain string
    The domain name of push streaming used by the group.
    Status bool
    Whether to open Group. Valid values: on,off.
    callback String
    The space within the device status update of the callback, need to start with http:// or https:// at the beginning.
    captureImage Integer
    The capture image.
    captureInterval Integer
    The capture interval.
    captureOssBucket String
    The capture oss bucket.
    captureOssPath String
    The capture oss path.
    captureVideo Integer
    The capture video.
    description String
    The description of Group.
    enabled Boolean
    Whether to open Group.
    groupName String
    The Group Name.
    inProtocol String
    The use of the access protocol support gb28181, Real Time Messaging Protocol (rtmp). Valid values: gb28181, rtmp.
    lazyPull Boolean
    Whether to enable on-demand streaming. Default value:false.
    outProtocol String
    The playback protocol used by the space, multiple values are separated by commas (,). Valid values: flv,hls, rtmp.
    playDomain String
    The domain name of plan streaming used by the group.
    pushDomain String
    The domain name of push streaming used by the group.
    status Boolean
    Whether to open Group. Valid values: on,off.
    callback string
    The space within the device status update of the callback, need to start with http:// or https:// at the beginning.
    captureImage number
    The capture image.
    captureInterval number
    The capture interval.
    captureOssBucket string
    The capture oss bucket.
    captureOssPath string
    The capture oss path.
    captureVideo number
    The capture video.
    description string
    The description of Group.
    enabled boolean
    Whether to open Group.
    groupName string
    The Group Name.
    inProtocol string
    The use of the access protocol support gb28181, Real Time Messaging Protocol (rtmp). Valid values: gb28181, rtmp.
    lazyPull boolean
    Whether to enable on-demand streaming. Default value:false.
    outProtocol string
    The playback protocol used by the space, multiple values are separated by commas (,). Valid values: flv,hls, rtmp.
    playDomain string
    The domain name of plan streaming used by the group.
    pushDomain string
    The domain name of push streaming used by the group.
    status boolean
    Whether to open Group. Valid values: on,off.
    callback str
    The space within the device status update of the callback, need to start with http:// or https:// at the beginning.
    capture_image int
    The capture image.
    capture_interval int
    The capture interval.
    capture_oss_bucket str
    The capture oss bucket.
    capture_oss_path str
    The capture oss path.
    capture_video int
    The capture video.
    description str
    The description of Group.
    enabled bool
    Whether to open Group.
    group_name str
    The Group Name.
    in_protocol str
    The use of the access protocol support gb28181, Real Time Messaging Protocol (rtmp). Valid values: gb28181, rtmp.
    lazy_pull bool
    Whether to enable on-demand streaming. Default value:false.
    out_protocol str
    The playback protocol used by the space, multiple values are separated by commas (,). Valid values: flv,hls, rtmp.
    play_domain str
    The domain name of plan streaming used by the group.
    push_domain str
    The domain name of push streaming used by the group.
    status bool
    Whether to open Group. Valid values: on,off.
    callback String
    The space within the device status update of the callback, need to start with http:// or https:// at the beginning.
    captureImage Number
    The capture image.
    captureInterval Number
    The capture interval.
    captureOssBucket String
    The capture oss bucket.
    captureOssPath String
    The capture oss path.
    captureVideo Number
    The capture video.
    description String
    The description of Group.
    enabled Boolean
    Whether to open Group.
    groupName String
    The Group Name.
    inProtocol String
    The use of the access protocol support gb28181, Real Time Messaging Protocol (rtmp). Valid values: gb28181, rtmp.
    lazyPull Boolean
    Whether to enable on-demand streaming. Default value:false.
    outProtocol String
    The playback protocol used by the space, multiple values are separated by commas (,). Valid values: flv,hls, rtmp.
    playDomain String
    The domain name of plan streaming used by the group.
    pushDomain String
    The domain name of push streaming used by the group.
    status Boolean
    Whether to open Group. Valid values: on,off.

    Import

    Video Surveillance System Group can be imported using the id, e.g.

    $ pulumi import alicloud:videosurveillance/systemGroup:SystemGroup example <id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi