1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. live
  5. Domain
Viewing docs for Alibaba Cloud v3.97.0
published on Saturday, Mar 14, 2026 by Pulumi
alicloud logo
Viewing docs for Alibaba Cloud v3.97.0
published on Saturday, Mar 14, 2026 by Pulumi

    Provides a Live Domain resource.

    Live domain name.

    For information about Live Domain and how to use it, see What is Domain.

    NOTE: Available since v1.272.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const config = new pulumi.Config();
    const domainName = config.get("domainName") || "demo.alicloud.com";
    const _default = new alicloud.live.Domain("default", {
        domainType: "liveVideo",
        scope: "overseas",
        domainName: domainName,
        region: "cn-shanghai",
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    config = pulumi.Config()
    domain_name = config.get("domainName")
    if domain_name is None:
        domain_name = "demo.alicloud.com"
    default = alicloud.live.Domain("default",
        domain_type="liveVideo",
        scope="overseas",
        domain_name=domain_name,
        region="cn-shanghai")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/live"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		domainName := "demo.alicloud.com"
    		if param := cfg.Get("domainName"); param != "" {
    			domainName = param
    		}
    		_, err := live.NewDomain(ctx, "default", &live.DomainArgs{
    			DomainType: pulumi.String("liveVideo"),
    			Scope:      pulumi.String("overseas"),
    			DomainName: pulumi.String(domainName),
    			Region:     pulumi.String("cn-shanghai"),
    		})
    		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 config = new Config();
        var domainName = config.Get("domainName") ?? "demo.alicloud.com";
        var @default = new AliCloud.Live.Domain("default", new()
        {
            DomainType = "liveVideo",
            Scope = "overseas",
            DomainName = domainName,
            Region = "cn-shanghai",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.live.Domain;
    import com.pulumi.alicloud.live.DomainArgs;
    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) {
            final var config = ctx.config();
            final var domainName = config.get("domainName").orElse("demo.alicloud.com");
            var default_ = new Domain("default", DomainArgs.builder()
                .domainType("liveVideo")
                .scope("overseas")
                .domainName(domainName)
                .region("cn-shanghai")
                .build());
    
        }
    }
    
    configuration:
      domainName:
        type: string
        default: demo.alicloud.com
    resources:
      default:
        type: alicloud:live:Domain
        properties:
          domainType: liveVideo
          scope: overseas
          domainName: ${domainName}
          region: cn-shanghai
    

    📚 Need more examples? VIEW MORE EXAMPLES

    Create Domain Resource

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

    Constructor syntax

    new Domain(name: string, args: DomainArgs, opts?: CustomResourceOptions);
    @overload
    def Domain(resource_name: str,
               args: DomainArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Domain(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               domain_name: Optional[str] = None,
               domain_type: Optional[str] = None,
               region: Optional[str] = None,
               check_url: Optional[str] = None,
               resource_group_id: Optional[str] = None,
               scope: Optional[str] = None,
               status: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None)
    func NewDomain(ctx *Context, name string, args DomainArgs, opts ...ResourceOption) (*Domain, error)
    public Domain(string name, DomainArgs args, CustomResourceOptions? opts = null)
    public Domain(String name, DomainArgs args)
    public Domain(String name, DomainArgs args, CustomResourceOptions options)
    
    type: alicloud:live:Domain
    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 DomainArgs
    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 DomainArgs
    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 DomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DomainArgs
    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 exampledomainResourceResourceFromLivedomain = new AliCloud.Live.Domain("exampledomainResourceResourceFromLivedomain", new()
    {
        DomainName = "string",
        DomainType = "string",
        Region = "string",
        CheckUrl = "string",
        ResourceGroupId = "string",
        Scope = "string",
        Status = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := live.NewDomain(ctx, "exampledomainResourceResourceFromLivedomain", &live.DomainArgs{
    	DomainName:      pulumi.String("string"),
    	DomainType:      pulumi.String("string"),
    	Region:          pulumi.String("string"),
    	CheckUrl:        pulumi.String("string"),
    	ResourceGroupId: pulumi.String("string"),
    	Scope:           pulumi.String("string"),
    	Status:          pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var exampledomainResourceResourceFromLivedomain = new com.pulumi.alicloud.live.Domain("exampledomainResourceResourceFromLivedomain", com.pulumi.alicloud.live.DomainArgs.builder()
        .domainName("string")
        .domainType("string")
        .region("string")
        .checkUrl("string")
        .resourceGroupId("string")
        .scope("string")
        .status("string")
        .tags(Map.of("string", "string"))
        .build());
    
    exampledomain_resource_resource_from_livedomain = alicloud.live.Domain("exampledomainResourceResourceFromLivedomain",
        domain_name="string",
        domain_type="string",
        region="string",
        check_url="string",
        resource_group_id="string",
        scope="string",
        status="string",
        tags={
            "string": "string",
        })
    
    const exampledomainResourceResourceFromLivedomain = new alicloud.live.Domain("exampledomainResourceResourceFromLivedomain", {
        domainName: "string",
        domainType: "string",
        region: "string",
        checkUrl: "string",
        resourceGroupId: "string",
        scope: "string",
        status: "string",
        tags: {
            string: "string",
        },
    });
    
    type: alicloud:live:Domain
    properties:
        checkUrl: string
        domainName: string
        domainType: string
        region: string
        resourceGroupId: string
        scope: string
        status: string
        tags:
            string: string
    

    Domain 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 Domain resource accepts the following input properties:

    DomainName string

    Fuzzy match filter for domain names.

    NOTE: - If domain_type (live streaming domain business type) is set to liveVideo, and this parameter is not specified, the system queries information about the user's playback domains by default.

    NOTE: - If domain_type is set to liveEdge, and this parameter is not specified, the system queries information about the user's ingest domains by default.

    DomainType string
    Domain business type. Valid values:

    • liveVideo: Playback domain.
    • liveEdge: Edge ingest domain.
    Region string
    Region to which the domain belongs.
    CheckUrl string

    Health check URL.

    NOTE: The parameter is immutable after resource creation. It only applies during resource creation and has no effect when modified post-creation.

    ResourceGroupId string
    Resource group ID. For more information about resource groups, see What is a resource group?.
    Scope string
    Acceleration region. This parameter takes effect only for international users and China site users with L3 or higher privileges. Valid values:
    Status string
    Domain status. Valid values:
    Tags Dictionary<string, string>
    List of tags.
    DomainName string

    Fuzzy match filter for domain names.

    NOTE: - If domain_type (live streaming domain business type) is set to liveVideo, and this parameter is not specified, the system queries information about the user's playback domains by default.

    NOTE: - If domain_type is set to liveEdge, and this parameter is not specified, the system queries information about the user's ingest domains by default.

    DomainType string
    Domain business type. Valid values:

    • liveVideo: Playback domain.
    • liveEdge: Edge ingest domain.
    Region string
    Region to which the domain belongs.
    CheckUrl string

    Health check URL.

    NOTE: The parameter is immutable after resource creation. It only applies during resource creation and has no effect when modified post-creation.

    ResourceGroupId string
    Resource group ID. For more information about resource groups, see What is a resource group?.
    Scope string
    Acceleration region. This parameter takes effect only for international users and China site users with L3 or higher privileges. Valid values:
    Status string
    Domain status. Valid values:
    Tags map[string]string
    List of tags.
    domainName String

    Fuzzy match filter for domain names.

    NOTE: - If domain_type (live streaming domain business type) is set to liveVideo, and this parameter is not specified, the system queries information about the user's playback domains by default.

    NOTE: - If domain_type is set to liveEdge, and this parameter is not specified, the system queries information about the user's ingest domains by default.

    domainType String
    Domain business type. Valid values:

    • liveVideo: Playback domain.
    • liveEdge: Edge ingest domain.
    region String
    Region to which the domain belongs.
    checkUrl String

    Health check URL.

    NOTE: The parameter is immutable after resource creation. It only applies during resource creation and has no effect when modified post-creation.

    resourceGroupId String
    Resource group ID. For more information about resource groups, see What is a resource group?.
    scope String
    Acceleration region. This parameter takes effect only for international users and China site users with L3 or higher privileges. Valid values:
    status String
    Domain status. Valid values:
    tags Map<String,String>
    List of tags.
    domainName string

    Fuzzy match filter for domain names.

    NOTE: - If domain_type (live streaming domain business type) is set to liveVideo, and this parameter is not specified, the system queries information about the user's playback domains by default.

    NOTE: - If domain_type is set to liveEdge, and this parameter is not specified, the system queries information about the user's ingest domains by default.

    domainType string
    Domain business type. Valid values:

    • liveVideo: Playback domain.
    • liveEdge: Edge ingest domain.
    region string
    Region to which the domain belongs.
    checkUrl string

    Health check URL.

    NOTE: The parameter is immutable after resource creation. It only applies during resource creation and has no effect when modified post-creation.

    resourceGroupId string
    Resource group ID. For more information about resource groups, see What is a resource group?.
    scope string
    Acceleration region. This parameter takes effect only for international users and China site users with L3 or higher privileges. Valid values:
    status string
    Domain status. Valid values:
    tags {[key: string]: string}
    List of tags.
    domain_name str

    Fuzzy match filter for domain names.

    NOTE: - If domain_type (live streaming domain business type) is set to liveVideo, and this parameter is not specified, the system queries information about the user's playback domains by default.

    NOTE: - If domain_type is set to liveEdge, and this parameter is not specified, the system queries information about the user's ingest domains by default.

    domain_type str
    Domain business type. Valid values:

    • liveVideo: Playback domain.
    • liveEdge: Edge ingest domain.
    region str
    Region to which the domain belongs.
    check_url str

    Health check URL.

    NOTE: The parameter is immutable after resource creation. It only applies during resource creation and has no effect when modified post-creation.

    resource_group_id str
    Resource group ID. For more information about resource groups, see What is a resource group?.
    scope str
    Acceleration region. This parameter takes effect only for international users and China site users with L3 or higher privileges. Valid values:
    status str
    Domain status. Valid values:
    tags Mapping[str, str]
    List of tags.
    domainName String

    Fuzzy match filter for domain names.

    NOTE: - If domain_type (live streaming domain business type) is set to liveVideo, and this parameter is not specified, the system queries information about the user's playback domains by default.

    NOTE: - If domain_type is set to liveEdge, and this parameter is not specified, the system queries information about the user's ingest domains by default.

    domainType String
    Domain business type. Valid values:

    • liveVideo: Playback domain.
    • liveEdge: Edge ingest domain.
    region String
    Region to which the domain belongs.
    checkUrl String

    Health check URL.

    NOTE: The parameter is immutable after resource creation. It only applies during resource creation and has no effect when modified post-creation.

    resourceGroupId String
    Resource group ID. For more information about resource groups, see What is a resource group?.
    scope String
    Acceleration region. This parameter takes effect only for international users and China site users with L3 or higher privileges. Valid values:
    status String
    Domain status. Valid values:
    tags Map<String>
    List of tags.

    Outputs

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

    CreateTime string
    Creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreateTime string
    Creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    createTime String
    Creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    createTime string
    Creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    create_time str
    Creation time.
    id str
    The provider-assigned unique ID for this managed resource.
    createTime String
    Creation time.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Domain Resource

    Get an existing Domain 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?: DomainState, opts?: CustomResourceOptions): Domain
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            check_url: Optional[str] = None,
            create_time: Optional[str] = None,
            domain_name: Optional[str] = None,
            domain_type: Optional[str] = None,
            region: Optional[str] = None,
            resource_group_id: Optional[str] = None,
            scope: Optional[str] = None,
            status: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None) -> Domain
    func GetDomain(ctx *Context, name string, id IDInput, state *DomainState, opts ...ResourceOption) (*Domain, error)
    public static Domain Get(string name, Input<string> id, DomainState? state, CustomResourceOptions? opts = null)
    public static Domain get(String name, Output<String> id, DomainState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:live:Domain    get:      id: ${id}
    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:
    CheckUrl string

    Health check URL.

    NOTE: The parameter is immutable after resource creation. It only applies during resource creation and has no effect when modified post-creation.

    CreateTime string
    Creation time.
    DomainName string

    Fuzzy match filter for domain names.

    NOTE: - If domain_type (live streaming domain business type) is set to liveVideo, and this parameter is not specified, the system queries information about the user's playback domains by default.

    NOTE: - If domain_type is set to liveEdge, and this parameter is not specified, the system queries information about the user's ingest domains by default.

    DomainType string
    Domain business type. Valid values:

    • liveVideo: Playback domain.
    • liveEdge: Edge ingest domain.
    Region string
    Region to which the domain belongs.
    ResourceGroupId string
    Resource group ID. For more information about resource groups, see What is a resource group?.
    Scope string
    Acceleration region. This parameter takes effect only for international users and China site users with L3 or higher privileges. Valid values:
    Status string
    Domain status. Valid values:
    Tags Dictionary<string, string>
    List of tags.
    CheckUrl string

    Health check URL.

    NOTE: The parameter is immutable after resource creation. It only applies during resource creation and has no effect when modified post-creation.

    CreateTime string
    Creation time.
    DomainName string

    Fuzzy match filter for domain names.

    NOTE: - If domain_type (live streaming domain business type) is set to liveVideo, and this parameter is not specified, the system queries information about the user's playback domains by default.

    NOTE: - If domain_type is set to liveEdge, and this parameter is not specified, the system queries information about the user's ingest domains by default.

    DomainType string
    Domain business type. Valid values:

    • liveVideo: Playback domain.
    • liveEdge: Edge ingest domain.
    Region string
    Region to which the domain belongs.
    ResourceGroupId string
    Resource group ID. For more information about resource groups, see What is a resource group?.
    Scope string
    Acceleration region. This parameter takes effect only for international users and China site users with L3 or higher privileges. Valid values:
    Status string
    Domain status. Valid values:
    Tags map[string]string
    List of tags.
    checkUrl String

    Health check URL.

    NOTE: The parameter is immutable after resource creation. It only applies during resource creation and has no effect when modified post-creation.

    createTime String
    Creation time.
    domainName String

    Fuzzy match filter for domain names.

    NOTE: - If domain_type (live streaming domain business type) is set to liveVideo, and this parameter is not specified, the system queries information about the user's playback domains by default.

    NOTE: - If domain_type is set to liveEdge, and this parameter is not specified, the system queries information about the user's ingest domains by default.

    domainType String
    Domain business type. Valid values:

    • liveVideo: Playback domain.
    • liveEdge: Edge ingest domain.
    region String
    Region to which the domain belongs.
    resourceGroupId String
    Resource group ID. For more information about resource groups, see What is a resource group?.
    scope String
    Acceleration region. This parameter takes effect only for international users and China site users with L3 or higher privileges. Valid values:
    status String
    Domain status. Valid values:
    tags Map<String,String>
    List of tags.
    checkUrl string

    Health check URL.

    NOTE: The parameter is immutable after resource creation. It only applies during resource creation and has no effect when modified post-creation.

    createTime string
    Creation time.
    domainName string

    Fuzzy match filter for domain names.

    NOTE: - If domain_type (live streaming domain business type) is set to liveVideo, and this parameter is not specified, the system queries information about the user's playback domains by default.

    NOTE: - If domain_type is set to liveEdge, and this parameter is not specified, the system queries information about the user's ingest domains by default.

    domainType string
    Domain business type. Valid values:

    • liveVideo: Playback domain.
    • liveEdge: Edge ingest domain.
    region string
    Region to which the domain belongs.
    resourceGroupId string
    Resource group ID. For more information about resource groups, see What is a resource group?.
    scope string
    Acceleration region. This parameter takes effect only for international users and China site users with L3 or higher privileges. Valid values:
    status string
    Domain status. Valid values:
    tags {[key: string]: string}
    List of tags.
    check_url str

    Health check URL.

    NOTE: The parameter is immutable after resource creation. It only applies during resource creation and has no effect when modified post-creation.

    create_time str
    Creation time.
    domain_name str

    Fuzzy match filter for domain names.

    NOTE: - If domain_type (live streaming domain business type) is set to liveVideo, and this parameter is not specified, the system queries information about the user's playback domains by default.

    NOTE: - If domain_type is set to liveEdge, and this parameter is not specified, the system queries information about the user's ingest domains by default.

    domain_type str
    Domain business type. Valid values:

    • liveVideo: Playback domain.
    • liveEdge: Edge ingest domain.
    region str
    Region to which the domain belongs.
    resource_group_id str
    Resource group ID. For more information about resource groups, see What is a resource group?.
    scope str
    Acceleration region. This parameter takes effect only for international users and China site users with L3 or higher privileges. Valid values:
    status str
    Domain status. Valid values:
    tags Mapping[str, str]
    List of tags.
    checkUrl String

    Health check URL.

    NOTE: The parameter is immutable after resource creation. It only applies during resource creation and has no effect when modified post-creation.

    createTime String
    Creation time.
    domainName String

    Fuzzy match filter for domain names.

    NOTE: - If domain_type (live streaming domain business type) is set to liveVideo, and this parameter is not specified, the system queries information about the user's playback domains by default.

    NOTE: - If domain_type is set to liveEdge, and this parameter is not specified, the system queries information about the user's ingest domains by default.

    domainType String
    Domain business type. Valid values:

    • liveVideo: Playback domain.
    • liveEdge: Edge ingest domain.
    region String
    Region to which the domain belongs.
    resourceGroupId String
    Resource group ID. For more information about resource groups, see What is a resource group?.
    scope String
    Acceleration region. This parameter takes effect only for international users and China site users with L3 or higher privileges. Valid values:
    status String
    Domain status. Valid values:
    tags Map<String>
    List of tags.

    Import

    Live Domain can be imported using the id, e.g.

    $ pulumi import alicloud:live/domain:Domain example <domain_name>
    

    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
    Viewing docs for Alibaba Cloud v3.97.0
    published on Saturday, Mar 14, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.