1. Docs
  2. Reference
  3. API
  4. @pulumi/alicloud
  5. cdn

Module cdn

This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

Resources

Others

Resources

Resource Domain

class Domain extends CustomResource

constructor

new Domain(name: string, args: DomainArgs, opts?: pulumi.CustomResourceOptions)

Create a Domain resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DomainState, opts?: pulumi.CustomResourceOptions): Domain

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is 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.

property authConfig

public authConfig: pulumi.Output<DomainAuthConfig | undefined>;

The auth config of the accelerated domain.

property blockIps

public blockIps: pulumi.Output<string[] | undefined>;

property cacheConfigs

public cacheConfigs: pulumi.Output<DomainCacheConfig[] | undefined>;

The cache configs of the accelerated domain.

property cdnType

public cdnType: pulumi.Output<string>;

Cdn type of the accelerated domain. Valid values are web, download, video, liveStream.

property certificateConfig

public certificateConfig: pulumi.Output<DomainCertificateConfig | undefined>;

property domainName

public domainName: pulumi.Output<string>;

Name of the accelerated domain. This name without suffix can have a string of 1 to 63 characters, must contain only alphanumeric characters or “-”, and must not begin or end with “-”, and “-” must not in the 3th and 4th character positions at the same time. Suffix .sh and .tel are not supported.

property httpHeaderConfigs

public httpHeaderConfigs: pulumi.Output<DomainHttpHeaderConfig[] | undefined>;

The http header configs of the accelerated domain.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property optimizeEnable

public optimizeEnable: pulumi.Output<string | undefined>;

Page Optimize config of the accelerated domain. Valid values are on and off. Default value is off. It can effectively remove the page redundant content, reduce the file size and improve the speed of distribution when this parameter value is on.

property page404Config

public page404Config: pulumi.Output<DomainPage404Config | undefined>;

The error page config of the accelerated domain.

property pageCompressEnable

public pageCompressEnable: pulumi.Output<string | undefined>;

Page Compress config of the accelerated domain. Valid values are on and off. Default value is off.

property parameterFilterConfig

public parameterFilterConfig: pulumi.Output<DomainParameterFilterConfig | undefined>;

The parameter filter config of the accelerated domain.

property rangeEnable

public rangeEnable: pulumi.Output<string | undefined>;

Range Source config of the accelerated domain. Valid values are on and off. Default value is off.

property referConfig

public referConfig: pulumi.Output<DomainReferConfig | undefined>;

The refer config of the accelerated domain.

property scope

public scope: pulumi.Output<string>;

Scope of the accelerated domain. Valid values are domestic, overseas, global. Default value is domestic. This parameter’s setting is valid Only for the international users and domestic L3 and above users .

property sourcePort

public sourcePort: pulumi.Output<number | undefined>;

Source port of the accelerated domain. Valid values are 80 and 443. Default value is 80. You must use 80 when the sourceType is oss.

property sourceType

public sourceType: pulumi.Output<string | undefined>;

Source type of the accelerated domain. Valid values are ipaddr, domain, oss. You must set this parameter when cdnType value is not liveStream.

property sources

public sources: pulumi.Output<string[] | undefined>;

Sources of the accelerated domain. It’s a list of domain names or IP address and consists of at most 20 items. You must set this parameter when cdnType value is not liveStream.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property videoSeekEnable

public videoSeekEnable: pulumi.Output<string | undefined>;

Video Seek config of the accelerated domain. Valid values are on and off. Default value is off.

Resource DomainConfig

class DomainConfig extends CustomResource

Provides a CDN Accelerated Domain resource.

For information about domain config and how to use it, see Batch set config

NOTE: Available in v1.34.0+.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

// Create a new Domain config.
const domain = new alicloud.cdn.DomainNew("domain", {
    cdnType: "web",
    domainName: "tf-testacc%d.xiaozhu.com",
    scope: "overseas",
    sources: {
        content: "1.1.1.1",
        port: 80,
        priority: 20,
        type: "ipaddr",
        weight: 15,
    },
});
const config = new alicloud.cdn.DomainConfig("config", {
    domainName: domain.domainName,
    functionArgs: [{
        argName: "ipList",
        argValue: "110.110.110.110",
    }],
    functionName: "ipAllowListSet",
});

constructor

new DomainConfig(name: string, args: DomainConfigArgs, opts?: pulumi.CustomResourceOptions)

Create a DomainConfig resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DomainConfigState, opts?: pulumi.CustomResourceOptions): DomainConfig

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DomainConfig

Returns true if the given object is an instance of DomainConfig. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property domainName

public domainName: pulumi.Output<string>;

Name of the accelerated domain. This name without suffix can have a string of 1 to 63 characters, must contain only alphanumeric characters or “-”, and must not begin or end with “-”, and “-” must not in the 3th and 4th character positions at the same time. Suffix .sh and .tel are not supported.

property functionArgs

public functionArgs: pulumi.Output<DomainConfigFunctionArg[]>;

The args of the domain config.

property functionName

public functionName: pulumi.Output<string>;

The name of the domain config.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource DomainNew

class DomainNew extends CustomResource

constructor

new DomainNew(name: string, args: DomainNewArgs, opts?: pulumi.CustomResourceOptions)

Create a DomainNew resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DomainNewState, opts?: pulumi.CustomResourceOptions): DomainNew

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DomainNew

Returns true if the given object is an instance of DomainNew. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property cdnType

public cdnType: pulumi.Output<string>;

Cdn type of the accelerated domain. Valid values are web, download, video.

property certificateConfig

public certificateConfig: pulumi.Output<DomainNewCertificateConfig>;

Certificate config of the accelerated domain. It’s a list and consist of at most 1 item.

property domainName

public domainName: pulumi.Output<string>;

Name of the accelerated domain. This name without suffix can have a string of 1 to 63 characters, must contain only alphanumeric characters or “-”, and must not begin or end with “-”, and “-” must not in the 3th and 4th character positions at the same time. Suffix .sh and .tel are not supported.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property resourceGroupId

public resourceGroupId: pulumi.Output<string>;

Resource group ID.

property scope

public scope: pulumi.Output<string>;

Scope of the accelerated domain. Valid values are domestic, overseas, global. Default value is domestic. This parameter’s setting is valid Only for the international users and domestic L3 and above users .

property sources

public sources: pulumi.Output<DomainNewSources>;

The source address list of the accelerated domain. Defaults to null. See Block Sources.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface DomainArgs

interface DomainArgs

The set of arguments for constructing a Domain resource.

property authConfig

DEPRECATED Use alicloud_cdn_domain_config configuration function_name and function_args arguments instead.
authConfig?: pulumi.Input<DomainAuthConfig>;

The auth config of the accelerated domain.

property blockIps

blockIps?: pulumi.Input<pulumi.Input<string>[]>;

property cacheConfigs

DEPRECATED Use `alicloud_cdn_domain_config` configuration `function_name` and `function_args` arguments instead.
cacheConfigs?: pulumi.Input<pulumi.Input<DomainCacheConfig>[]>;

The cache configs of the accelerated domain.

property cdnType

cdnType: pulumi.Input<string>;

Cdn type of the accelerated domain. Valid values are web, download, video, liveStream.

property certificateConfig

certificateConfig?: pulumi.Input<DomainCertificateConfig>;

property domainName

domainName: pulumi.Input<string>;

Name of the accelerated domain. This name without suffix can have a string of 1 to 63 characters, must contain only alphanumeric characters or “-”, and must not begin or end with “-”, and “-” must not in the 3th and 4th character positions at the same time. Suffix .sh and .tel are not supported.

property httpHeaderConfigs

DEPRECATED Use alicloud_cdn_domain_config configuration function_name and function_args arguments instead.
httpHeaderConfigs?: pulumi.Input<pulumi.Input<DomainHttpHeaderConfig>[]>;

The http header configs of the accelerated domain.

property optimizeEnable

DEPRECATED Use alicloud_cdn_domain_config configuration function_name and function_args arguments instead.
optimizeEnable?: pulumi.Input<string>;

Page Optimize config of the accelerated domain. Valid values are on and off. Default value is off. It can effectively remove the page redundant content, reduce the file size and improve the speed of distribution when this parameter value is on.

property page404Config

DEPRECATED Use alicloud_cdn_domain_config configuration function_name and function_args arguments instead.
page404Config?: pulumi.Input<DomainPage404Config>;

The error page config of the accelerated domain.

property pageCompressEnable

DEPRECATED Use alicloud_cdn_domain_config configuration function_name and function_args arguments instead.
pageCompressEnable?: pulumi.Input<string>;

Page Compress config of the accelerated domain. Valid values are on and off. Default value is off.

property parameterFilterConfig

DEPRECATED Use alicloud_cdn_domain_config configuration function_name and function_args arguments instead.
parameterFilterConfig?: pulumi.Input<DomainParameterFilterConfig>;

The parameter filter config of the accelerated domain.

property rangeEnable

DEPRECATED Use alicloud_cdn_domain_config configuration function_name and function_args arguments instead.
rangeEnable?: pulumi.Input<string>;

Range Source config of the accelerated domain. Valid values are on and off. Default value is off.

property referConfig

DEPRECATED Use alicloud_cdn_domain_config configuration function_name and function_args arguments instead.
referConfig?: pulumi.Input<DomainReferConfig>;

The refer config of the accelerated domain.

property scope

scope?: pulumi.Input<string>;

Scope of the accelerated domain. Valid values are domestic, overseas, global. Default value is domestic. This parameter’s setting is valid Only for the international users and domestic L3 and above users .

property sourcePort

DEPRECATED Use alicloud_cdn_domain_new configuration sources block port argument instead.
sourcePort?: pulumi.Input<number>;

Source port of the accelerated domain. Valid values are 80 and 443. Default value is 80. You must use 80 when the sourceType is oss.

property sourceType

DEPRECATED Use alicloud_cdn_domain_new configuration sources block type argument instead.
sourceType?: pulumi.Input<string>;

Source type of the accelerated domain. Valid values are ipaddr, domain, oss. You must set this parameter when cdnType value is not liveStream.

property sources

DEPRECATED Use alicloud_cdn_domain_new configuration sources argument instead.
sources?: pulumi.Input<pulumi.Input<string>[]>;

Sources of the accelerated domain. It’s a list of domain names or IP address and consists of at most 20 items. You must set this parameter when cdnType value is not liveStream.

property videoSeekEnable

DEPRECATED Use alicloud_cdn_domain_config configuration function_name and function_args arguments instead.
videoSeekEnable?: pulumi.Input<string>;

Video Seek config of the accelerated domain. Valid values are on and off. Default value is off.

interface DomainConfigArgs

interface DomainConfigArgs

The set of arguments for constructing a DomainConfig resource.

property domainName

domainName: pulumi.Input<string>;

Name of the accelerated domain. This name without suffix can have a string of 1 to 63 characters, must contain only alphanumeric characters or “-”, and must not begin or end with “-”, and “-” must not in the 3th and 4th character positions at the same time. Suffix .sh and .tel are not supported.

property functionArgs

functionArgs: pulumi.Input<pulumi.Input<DomainConfigFunctionArg>[]>;

The args of the domain config.

property functionName

functionName: pulumi.Input<string>;

The name of the domain config.

interface DomainConfigState

interface DomainConfigState

Input properties used for looking up and filtering DomainConfig resources.

property domainName

domainName?: pulumi.Input<string>;

Name of the accelerated domain. This name without suffix can have a string of 1 to 63 characters, must contain only alphanumeric characters or “-”, and must not begin or end with “-”, and “-” must not in the 3th and 4th character positions at the same time. Suffix .sh and .tel are not supported.

property functionArgs

functionArgs?: pulumi.Input<pulumi.Input<DomainConfigFunctionArg>[]>;

The args of the domain config.

property functionName

functionName?: pulumi.Input<string>;

The name of the domain config.

interface DomainNewArgs

interface DomainNewArgs

The set of arguments for constructing a DomainNew resource.

property cdnType

cdnType: pulumi.Input<string>;

Cdn type of the accelerated domain. Valid values are web, download, video.

property certificateConfig

certificateConfig?: pulumi.Input<DomainNewCertificateConfig>;

Certificate config of the accelerated domain. It’s a list and consist of at most 1 item.

property domainName

domainName: pulumi.Input<string>;

Name of the accelerated domain. This name without suffix can have a string of 1 to 63 characters, must contain only alphanumeric characters or “-”, and must not begin or end with “-”, and “-” must not in the 3th and 4th character positions at the same time. Suffix .sh and .tel are not supported.

property resourceGroupId

resourceGroupId?: pulumi.Input<string>;

Resource group ID.

property scope

scope?: pulumi.Input<string>;

Scope of the accelerated domain. Valid values are domestic, overseas, global. Default value is domestic. This parameter’s setting is valid Only for the international users and domestic L3 and above users .

property sources

sources: pulumi.Input<DomainNewSources>;

The source address list of the accelerated domain. Defaults to null. See Block Sources.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

interface DomainNewState

interface DomainNewState

Input properties used for looking up and filtering DomainNew resources.

property cdnType

cdnType?: pulumi.Input<string>;

Cdn type of the accelerated domain. Valid values are web, download, video.

property certificateConfig

certificateConfig?: pulumi.Input<DomainNewCertificateConfig>;

Certificate config of the accelerated domain. It’s a list and consist of at most 1 item.

property domainName

domainName?: pulumi.Input<string>;

Name of the accelerated domain. This name without suffix can have a string of 1 to 63 characters, must contain only alphanumeric characters or “-”, and must not begin or end with “-”, and “-” must not in the 3th and 4th character positions at the same time. Suffix .sh and .tel are not supported.

property resourceGroupId

resourceGroupId?: pulumi.Input<string>;

Resource group ID.

property scope

scope?: pulumi.Input<string>;

Scope of the accelerated domain. Valid values are domestic, overseas, global. Default value is domestic. This parameter’s setting is valid Only for the international users and domestic L3 and above users .

property sources

sources?: pulumi.Input<DomainNewSources>;

The source address list of the accelerated domain. Defaults to null. See Block Sources.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

interface DomainState

interface DomainState

Input properties used for looking up and filtering Domain resources.

property authConfig

DEPRECATED Use alicloud_cdn_domain_config configuration function_name and function_args arguments instead.
authConfig?: pulumi.Input<DomainAuthConfig>;

The auth config of the accelerated domain.

property blockIps

blockIps?: pulumi.Input<pulumi.Input<string>[]>;

property cacheConfigs

DEPRECATED Use `alicloud_cdn_domain_config` configuration `function_name` and `function_args` arguments instead.
cacheConfigs?: pulumi.Input<pulumi.Input<DomainCacheConfig>[]>;

The cache configs of the accelerated domain.

property cdnType

cdnType?: pulumi.Input<string>;

Cdn type of the accelerated domain. Valid values are web, download, video, liveStream.

property certificateConfig

certificateConfig?: pulumi.Input<DomainCertificateConfig>;

property domainName

domainName?: pulumi.Input<string>;

Name of the accelerated domain. This name without suffix can have a string of 1 to 63 characters, must contain only alphanumeric characters or “-”, and must not begin or end with “-”, and “-” must not in the 3th and 4th character positions at the same time. Suffix .sh and .tel are not supported.

property httpHeaderConfigs

DEPRECATED Use alicloud_cdn_domain_config configuration function_name and function_args arguments instead.
httpHeaderConfigs?: pulumi.Input<pulumi.Input<DomainHttpHeaderConfig>[]>;

The http header configs of the accelerated domain.

property optimizeEnable

DEPRECATED Use alicloud_cdn_domain_config configuration function_name and function_args arguments instead.
optimizeEnable?: pulumi.Input<string>;

Page Optimize config of the accelerated domain. Valid values are on and off. Default value is off. It can effectively remove the page redundant content, reduce the file size and improve the speed of distribution when this parameter value is on.

property page404Config

DEPRECATED Use alicloud_cdn_domain_config configuration function_name and function_args arguments instead.
page404Config?: pulumi.Input<DomainPage404Config>;

The error page config of the accelerated domain.

property pageCompressEnable

DEPRECATED Use alicloud_cdn_domain_config configuration function_name and function_args arguments instead.
pageCompressEnable?: pulumi.Input<string>;

Page Compress config of the accelerated domain. Valid values are on and off. Default value is off.

property parameterFilterConfig

DEPRECATED Use alicloud_cdn_domain_config configuration function_name and function_args arguments instead.
parameterFilterConfig?: pulumi.Input<DomainParameterFilterConfig>;

The parameter filter config of the accelerated domain.

property rangeEnable

DEPRECATED Use alicloud_cdn_domain_config configuration function_name and function_args arguments instead.
rangeEnable?: pulumi.Input<string>;

Range Source config of the accelerated domain. Valid values are on and off. Default value is off.

property referConfig

DEPRECATED Use alicloud_cdn_domain_config configuration function_name and function_args arguments instead.
referConfig?: pulumi.Input<DomainReferConfig>;

The refer config of the accelerated domain.

property scope

scope?: pulumi.Input<string>;

Scope of the accelerated domain. Valid values are domestic, overseas, global. Default value is domestic. This parameter’s setting is valid Only for the international users and domestic L3 and above users .

property sourcePort

DEPRECATED Use alicloud_cdn_domain_new configuration sources block port argument instead.
sourcePort?: pulumi.Input<number>;

Source port of the accelerated domain. Valid values are 80 and 443. Default value is 80. You must use 80 when the sourceType is oss.

property sourceType

DEPRECATED Use alicloud_cdn_domain_new configuration sources block type argument instead.
sourceType?: pulumi.Input<string>;

Source type of the accelerated domain. Valid values are ipaddr, domain, oss. You must set this parameter when cdnType value is not liveStream.

property sources

DEPRECATED Use alicloud_cdn_domain_new configuration sources argument instead.
sources?: pulumi.Input<pulumi.Input<string>[]>;

Sources of the accelerated domain. It’s a list of domain names or IP address and consists of at most 20 items. You must set this parameter when cdnType value is not liveStream.

property videoSeekEnable

DEPRECATED Use alicloud_cdn_domain_config configuration function_name and function_args arguments instead.
videoSeekEnable?: pulumi.Input<string>;

Video Seek config of the accelerated domain. Valid values are on and off. Default value is off.