@huaweicloudos/pulumi
Version:
A Pulumi package for creating and managing Huaweicloud cloud resources.
202 lines (201 loc) • 7.47 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a Live domain within HuaweiCloud.
*
* ## Example Usage
* ### Create an ingest domain name and a streaming domain name
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pulumi from "@huaweicloudos/pulumi";
*
* const config = new pulumi.Config();
* const ingestDomainName = config.requireObject("ingestDomainName");
* const streamingDomainName = config.requireObject("streamingDomainName");
* const ingestDomain = new huaweicloud.live.Domain("ingestDomain", {type: "push"});
* const streamingDomain = new huaweicloud.live.Domain("streamingDomain", {
* type: "pull",
* ingestDomainName: ingestDomain.name,
* });
* ```
*
* ## Import
*
* Domains can be imported using the `name`, e.g. bash
*
* ```sh
* $ pulumi import huaweicloud:Live/domain:Domain test <name>
* ```
*/
export declare class Domain extends pulumi.CustomResource {
/**
* Get an existing Domain resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DomainState, opts?: pulumi.CustomResourceOptions): Domain;
/**
* Returns true if the given object is an instance of Domain. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Domain;
/**
* CNAME record of the domain name.
*/
readonly cname: pulumi.Output<string>;
/**
* Specifies the enterprise project ID.
* Changing this parameter will create a new resource.
*/
readonly enterpriseProjectId: pulumi.Output<string>;
/**
* Specifies the ingest domain name, which associates with the streaming
* domain name to push streams to nearby CDN nodes.
*/
readonly ingestDomainName: pulumi.Output<string | undefined>;
/**
* Specifies whether enable IPv6 switch. Defaults to **false**.
* This field can only be edited when `status` is **on**.
*/
readonly isIpv6: pulumi.Output<boolean>;
/**
* Specifies the domain name. Changing this parameter will create a new resource.
*/
readonly name: pulumi.Output<string>;
/**
* Specifies the region in which to create the Live domain resource. If omitted,
* the provider-level region will be used. Changing this parameter will create a new resource.
*/
readonly region: pulumi.Output<string>;
/**
* Specifies the domain name acceleration service area. Valid values are:
* + **mainland_china**: Chinese mainland.
* + **outside_mainland_china**: Outside the Chinese mainland.
* + **global**: Global acceleration.
*/
readonly serviceArea: pulumi.Output<string>;
/**
* Specifies status of the domain name. The options are as follows:
* + **on**: enable the domain name.
* + **off**: disable the domain name.
*/
readonly status: pulumi.Output<string>;
/**
* Specifies the type of domain name. The options are as follows:
* + **pull**: streaming domain name.
* + **push**: ingest domain name.
*/
readonly type: pulumi.Output<string>;
/**
* Create a Domain resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DomainArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Domain resources.
*/
export interface DomainState {
/**
* CNAME record of the domain name.
*/
cname?: pulumi.Input<string>;
/**
* Specifies the enterprise project ID.
* Changing this parameter will create a new resource.
*/
enterpriseProjectId?: pulumi.Input<string>;
/**
* Specifies the ingest domain name, which associates with the streaming
* domain name to push streams to nearby CDN nodes.
*/
ingestDomainName?: pulumi.Input<string>;
/**
* Specifies whether enable IPv6 switch. Defaults to **false**.
* This field can only be edited when `status` is **on**.
*/
isIpv6?: pulumi.Input<boolean>;
/**
* Specifies the domain name. Changing this parameter will create a new resource.
*/
name?: pulumi.Input<string>;
/**
* Specifies the region in which to create the Live domain resource. If omitted,
* the provider-level region will be used. Changing this parameter will create a new resource.
*/
region?: pulumi.Input<string>;
/**
* Specifies the domain name acceleration service area. Valid values are:
* + **mainland_china**: Chinese mainland.
* + **outside_mainland_china**: Outside the Chinese mainland.
* + **global**: Global acceleration.
*/
serviceArea?: pulumi.Input<string>;
/**
* Specifies status of the domain name. The options are as follows:
* + **on**: enable the domain name.
* + **off**: disable the domain name.
*/
status?: pulumi.Input<string>;
/**
* Specifies the type of domain name. The options are as follows:
* + **pull**: streaming domain name.
* + **push**: ingest domain name.
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Domain resource.
*/
export interface DomainArgs {
/**
* Specifies the enterprise project ID.
* Changing this parameter will create a new resource.
*/
enterpriseProjectId?: pulumi.Input<string>;
/**
* Specifies the ingest domain name, which associates with the streaming
* domain name to push streams to nearby CDN nodes.
*/
ingestDomainName?: pulumi.Input<string>;
/**
* Specifies whether enable IPv6 switch. Defaults to **false**.
* This field can only be edited when `status` is **on**.
*/
isIpv6?: pulumi.Input<boolean>;
/**
* Specifies the domain name. Changing this parameter will create a new resource.
*/
name?: pulumi.Input<string>;
/**
* Specifies the region in which to create the Live domain resource. If omitted,
* the provider-level region will be used. Changing this parameter will create a new resource.
*/
region?: pulumi.Input<string>;
/**
* Specifies the domain name acceleration service area. Valid values are:
* + **mainland_china**: Chinese mainland.
* + **outside_mainland_china**: Outside the Chinese mainland.
* + **global**: Global acceleration.
*/
serviceArea?: pulumi.Input<string>;
/**
* Specifies status of the domain name. The options are as follows:
* + **on**: enable the domain name.
* + **off**: disable the domain name.
*/
status?: pulumi.Input<string>;
/**
* Specifies the type of domain name. The options are as follows:
* + **pull**: streaming domain name.
* + **push**: ingest domain name.
*/
type: pulumi.Input<string>;
}