Alibaba Cloud

Pulumi Official
Package maintained by Pulumi
v3.19.0 published on Friday, Mar 18, 2022 by Pulumi

Domain

You can use DCDN to improve the overall performance of your website and accelerate content delivery to improve user experience. For information about Alicloud DCDN Domain and how to use it, see What is Resource Alicloud DCDN Domain.

NOTE: Available in v1.94.0+.

NOTE: You must activate the Dynamic Route for CDN (DCDN) service before you create an accelerated domain.

NOTE: Make sure that you have obtained an Internet content provider (ICP) filling for the accelerated domain.

NOTE: If the origin content is not saved on Alibaba Cloud, the content must be reviewed by Alibaba Cloud. The review will be completed by the next working day after you submit the application.

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new AliCloud.Dcdn.Domain("example", new AliCloud.Dcdn.DomainArgs
        {
            DomainName = "example.com",
            Scope = "overseas",
            Sources = 
            {
                new AliCloud.Dcdn.Inputs.DomainSourceArgs
                {
                    Content = "1.1.1.1",
                    Port = 80,
                    Priority = "20",
                    Type = "ipaddr",
                },
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/dcdn"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dcdn.NewDomain(ctx, "example", &dcdn.DomainArgs{
			DomainName: pulumi.String("example.com"),
			Scope:      pulumi.String("overseas"),
			Sources: dcdn.DomainSourceArray{
				&dcdn.DomainSourceArgs{
					Content:  pulumi.String("1.1.1.1"),
					Port:     pulumi.Int(80),
					Priority: pulumi.String("20"),
					Type:     pulumi.String("ipaddr"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_alicloud as alicloud

example = alicloud.dcdn.Domain("example",
    domain_name="example.com",
    scope="overseas",
    sources=[alicloud.dcdn.DomainSourceArgs(
        content="1.1.1.1",
        port=80,
        priority="20",
        type="ipaddr",
    )])
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const example = new alicloud.dcdn.Domain("example", {
    domainName: "example.com",
    scope: "overseas",
    sources: [{
        content: "1.1.1.1",
        port: 80,
        priority: "20",
        type: "ipaddr",
    }],
});

Coming soon!

Create a Domain Resource

new Domain(name: string, args: DomainArgs, opts?: CustomResourceOptions);
@overload
def Domain(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           cert_name: Optional[str] = None,
           cert_type: Optional[str] = None,
           check_url: Optional[str] = None,
           domain_name: Optional[str] = None,
           force_set: Optional[str] = None,
           resource_group_id: Optional[str] = None,
           scope: Optional[str] = None,
           security_token: Optional[str] = None,
           sources: Optional[Sequence[DomainSourceArgs]] = None,
           ssl_pri: Optional[str] = None,
           ssl_protocol: Optional[str] = None,
           ssl_pub: Optional[str] = None,
           status: Optional[str] = None,
           top_level_domain: Optional[str] = None)
@overload
def Domain(resource_name: str,
           args: DomainArgs,
           opts: Optional[ResourceOptions] = 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:dcdn:Domain
properties: # The arguments to resource properties.
options: # 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.
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.

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

The Domain resource accepts the following input properties:

DomainName string

The name of the accelerated domain.

Sources List<Pulumi.AliCloud.Dcdn.Inputs.DomainSourceArgs>

The origin information.

CertName string

Indicates the name of the certificate if the HTTPS protocol is enabled.

CertType string

The type of the certificate. Valid values: free: a free certificate. cas: a certificate purchased from Alibaba Cloud SSL Certificates Service. upload: a user uploaded certificate.

CheckUrl string

The URL that is used to test the accessibility of the origin.

ForceSet string

Specifies whether to check the certificate name for duplicates. If you set the value to 1, the system does not perform the check and overwrites the information of the existing certificate with the same name.

ResourceGroupId string

The ID of the resource group.

Scope string

The acceleration region.

SecurityToken string
SslPri string

The private key. Specify this parameter only if you enable the SSL certificate.

SslProtocol string

Indicates whether the SSL certificate is enabled. Valid values: on enabled, off disabled.

SslPub string

Indicates the public key of the certificate if the HTTPS protocol is enabled.

Status string

The status of DCDN Domain. Valid values: online, offline. Default to online.

TopLevelDomain string

The top-level domain name.

DomainName string

The name of the accelerated domain.

Sources []DomainSourceArgs

The origin information.

CertName string

Indicates the name of the certificate if the HTTPS protocol is enabled.

CertType string

The type of the certificate. Valid values: free: a free certificate. cas: a certificate purchased from Alibaba Cloud SSL Certificates Service. upload: a user uploaded certificate.

CheckUrl string

The URL that is used to test the accessibility of the origin.

ForceSet string

Specifies whether to check the certificate name for duplicates. If you set the value to 1, the system does not perform the check and overwrites the information of the existing certificate with the same name.

ResourceGroupId string

The ID of the resource group.

Scope string

The acceleration region.

SecurityToken string
SslPri string

The private key. Specify this parameter only if you enable the SSL certificate.

SslProtocol string

Indicates whether the SSL certificate is enabled. Valid values: on enabled, off disabled.

SslPub string

Indicates the public key of the certificate if the HTTPS protocol is enabled.

Status string

The status of DCDN Domain. Valid values: online, offline. Default to online.

TopLevelDomain string

The top-level domain name.

domainName String

The name of the accelerated domain.

sources ListSourceArgs>

The origin information.

certName String

Indicates the name of the certificate if the HTTPS protocol is enabled.

certType String

The type of the certificate. Valid values: free: a free certificate. cas: a certificate purchased from Alibaba Cloud SSL Certificates Service. upload: a user uploaded certificate.

checkUrl String

The URL that is used to test the accessibility of the origin.

forceSet String

Specifies whether to check the certificate name for duplicates. If you set the value to 1, the system does not perform the check and overwrites the information of the existing certificate with the same name.

resourceGroupId String

The ID of the resource group.

scope String

The acceleration region.

securityToken String
sslPri String

The private key. Specify this parameter only if you enable the SSL certificate.

sslProtocol String

Indicates whether the SSL certificate is enabled. Valid values: on enabled, off disabled.

sslPub String

Indicates the public key of the certificate if the HTTPS protocol is enabled.

status String

The status of DCDN Domain. Valid values: online, offline. Default to online.

topLevelDomain String

The top-level domain name.

domainName string

The name of the accelerated domain.

sources DomainSourceArgs[]

The origin information.

certName string

Indicates the name of the certificate if the HTTPS protocol is enabled.

certType string

The type of the certificate. Valid values: free: a free certificate. cas: a certificate purchased from Alibaba Cloud SSL Certificates Service. upload: a user uploaded certificate.

checkUrl string

The URL that is used to test the accessibility of the origin.

forceSet string

Specifies whether to check the certificate name for duplicates. If you set the value to 1, the system does not perform the check and overwrites the information of the existing certificate with the same name.

resourceGroupId string

The ID of the resource group.

scope string

The acceleration region.

securityToken string
sslPri string

The private key. Specify this parameter only if you enable the SSL certificate.

sslProtocol string

Indicates whether the SSL certificate is enabled. Valid values: on enabled, off disabled.

sslPub string

Indicates the public key of the certificate if the HTTPS protocol is enabled.

status string

The status of DCDN Domain. Valid values: online, offline. Default to online.

topLevelDomain string

The top-level domain name.

domain_name str

The name of the accelerated domain.

sources Sequence[DomainSourceArgs]

The origin information.

cert_name str

Indicates the name of the certificate if the HTTPS protocol is enabled.

cert_type str

The type of the certificate. Valid values: free: a free certificate. cas: a certificate purchased from Alibaba Cloud SSL Certificates Service. upload: a user uploaded certificate.

check_url str

The URL that is used to test the accessibility of the origin.

force_set str

Specifies whether to check the certificate name for duplicates. If you set the value to 1, the system does not perform the check and overwrites the information of the existing certificate with the same name.

resource_group_id str

The ID of the resource group.

scope str

The acceleration region.

security_token str
ssl_pri str

The private key. Specify this parameter only if you enable the SSL certificate.

ssl_protocol str

Indicates whether the SSL certificate is enabled. Valid values: on enabled, off disabled.

ssl_pub str

Indicates the public key of the certificate if the HTTPS protocol is enabled.

status str

The status of DCDN Domain. Valid values: online, offline. Default to online.

top_level_domain str

The top-level domain name.

domainName String

The name of the accelerated domain.

sources List

The origin information.

certName String

Indicates the name of the certificate if the HTTPS protocol is enabled.

certType String

The type of the certificate. Valid values: free: a free certificate. cas: a certificate purchased from Alibaba Cloud SSL Certificates Service. upload: a user uploaded certificate.

checkUrl String

The URL that is used to test the accessibility of the origin.

forceSet String

Specifies whether to check the certificate name for duplicates. If you set the value to 1, the system does not perform the check and overwrites the information of the existing certificate with the same name.

resourceGroupId String

The ID of the resource group.

scope String

The acceleration region.

securityToken String
sslPri String

The private key. Specify this parameter only if you enable the SSL certificate.

sslProtocol String

Indicates whether the SSL certificate is enabled. Valid values: on enabled, off disabled.

sslPub String

Indicates the public key of the certificate if the HTTPS protocol is enabled.

status String

The status of DCDN Domain. Valid values: online, offline. Default to online.

topLevelDomain String

The top-level domain name.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up an 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,
        cert_name: Optional[str] = None,
        cert_type: Optional[str] = None,
        check_url: Optional[str] = None,
        domain_name: Optional[str] = None,
        force_set: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        scope: Optional[str] = None,
        security_token: Optional[str] = None,
        sources: Optional[Sequence[DomainSourceArgs]] = None,
        ssl_pri: Optional[str] = None,
        ssl_protocol: Optional[str] = None,
        ssl_pub: Optional[str] = None,
        status: Optional[str] = None,
        top_level_domain: Optional[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)
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:
CertName string

Indicates the name of the certificate if the HTTPS protocol is enabled.

CertType string

The type of the certificate. Valid values: free: a free certificate. cas: a certificate purchased from Alibaba Cloud SSL Certificates Service. upload: a user uploaded certificate.

CheckUrl string

The URL that is used to test the accessibility of the origin.

DomainName string

The name of the accelerated domain.

ForceSet string

Specifies whether to check the certificate name for duplicates. If you set the value to 1, the system does not perform the check and overwrites the information of the existing certificate with the same name.

ResourceGroupId string

The ID of the resource group.

Scope string

The acceleration region.

SecurityToken string
Sources List<Pulumi.AliCloud.Dcdn.Inputs.DomainSourceArgs>

The origin information.

SslPri string

The private key. Specify this parameter only if you enable the SSL certificate.

SslProtocol string

Indicates whether the SSL certificate is enabled. Valid values: on enabled, off disabled.

SslPub string

Indicates the public key of the certificate if the HTTPS protocol is enabled.

Status string

The status of DCDN Domain. Valid values: online, offline. Default to online.

TopLevelDomain string

The top-level domain name.

CertName string

Indicates the name of the certificate if the HTTPS protocol is enabled.

CertType string

The type of the certificate. Valid values: free: a free certificate. cas: a certificate purchased from Alibaba Cloud SSL Certificates Service. upload: a user uploaded certificate.

CheckUrl string

The URL that is used to test the accessibility of the origin.

DomainName string

The name of the accelerated domain.

ForceSet string

Specifies whether to check the certificate name for duplicates. If you set the value to 1, the system does not perform the check and overwrites the information of the existing certificate with the same name.

ResourceGroupId string

The ID of the resource group.

Scope string

The acceleration region.

SecurityToken string
Sources []DomainSourceArgs

The origin information.

SslPri string

The private key. Specify this parameter only if you enable the SSL certificate.

SslProtocol string

Indicates whether the SSL certificate is enabled. Valid values: on enabled, off disabled.

SslPub string

Indicates the public key of the certificate if the HTTPS protocol is enabled.

Status string

The status of DCDN Domain. Valid values: online, offline. Default to online.

TopLevelDomain string

The top-level domain name.

certName String

Indicates the name of the certificate if the HTTPS protocol is enabled.

certType String

The type of the certificate. Valid values: free: a free certificate. cas: a certificate purchased from Alibaba Cloud SSL Certificates Service. upload: a user uploaded certificate.

checkUrl String

The URL that is used to test the accessibility of the origin.

domainName String

The name of the accelerated domain.

forceSet String

Specifies whether to check the certificate name for duplicates. If you set the value to 1, the system does not perform the check and overwrites the information of the existing certificate with the same name.

resourceGroupId String

The ID of the resource group.

scope String

The acceleration region.

securityToken String
sources ListSourceArgs>

The origin information.

sslPri String

The private key. Specify this parameter only if you enable the SSL certificate.

sslProtocol String

Indicates whether the SSL certificate is enabled. Valid values: on enabled, off disabled.

sslPub String

Indicates the public key of the certificate if the HTTPS protocol is enabled.

status String

The status of DCDN Domain. Valid values: online, offline. Default to online.

topLevelDomain String

The top-level domain name.

certName string

Indicates the name of the certificate if the HTTPS protocol is enabled.

certType string

The type of the certificate. Valid values: free: a free certificate. cas: a certificate purchased from Alibaba Cloud SSL Certificates Service. upload: a user uploaded certificate.

checkUrl string

The URL that is used to test the accessibility of the origin.

domainName string

The name of the accelerated domain.

forceSet string

Specifies whether to check the certificate name for duplicates. If you set the value to 1, the system does not perform the check and overwrites the information of the existing certificate with the same name.

resourceGroupId string

The ID of the resource group.

scope string

The acceleration region.

securityToken string
sources DomainSourceArgs[]

The origin information.

sslPri string

The private key. Specify this parameter only if you enable the SSL certificate.

sslProtocol string

Indicates whether the SSL certificate is enabled. Valid values: on enabled, off disabled.

sslPub string

Indicates the public key of the certificate if the HTTPS protocol is enabled.

status string

The status of DCDN Domain. Valid values: online, offline. Default to online.

topLevelDomain string

The top-level domain name.

cert_name str

Indicates the name of the certificate if the HTTPS protocol is enabled.

cert_type str

The type of the certificate. Valid values: free: a free certificate. cas: a certificate purchased from Alibaba Cloud SSL Certificates Service. upload: a user uploaded certificate.

check_url str

The URL that is used to test the accessibility of the origin.

domain_name str

The name of the accelerated domain.

force_set str

Specifies whether to check the certificate name for duplicates. If you set the value to 1, the system does not perform the check and overwrites the information of the existing certificate with the same name.

resource_group_id str

The ID of the resource group.

scope str

The acceleration region.

security_token str
sources Sequence[DomainSourceArgs]

The origin information.

ssl_pri str

The private key. Specify this parameter only if you enable the SSL certificate.

ssl_protocol str

Indicates whether the SSL certificate is enabled. Valid values: on enabled, off disabled.

ssl_pub str

Indicates the public key of the certificate if the HTTPS protocol is enabled.

status str

The status of DCDN Domain. Valid values: online, offline. Default to online.

top_level_domain str

The top-level domain name.

certName String

Indicates the name of the certificate if the HTTPS protocol is enabled.

certType String

The type of the certificate. Valid values: free: a free certificate. cas: a certificate purchased from Alibaba Cloud SSL Certificates Service. upload: a user uploaded certificate.

checkUrl String

The URL that is used to test the accessibility of the origin.

domainName String

The name of the accelerated domain.

forceSet String

Specifies whether to check the certificate name for duplicates. If you set the value to 1, the system does not perform the check and overwrites the information of the existing certificate with the same name.

resourceGroupId String

The ID of the resource group.

scope String

The acceleration region.

securityToken String
sources List

The origin information.

sslPri String

The private key. Specify this parameter only if you enable the SSL certificate.

sslProtocol String

Indicates whether the SSL certificate is enabled. Valid values: on enabled, off disabled.

sslPub String

Indicates the public key of the certificate if the HTTPS protocol is enabled.

status String

The status of DCDN Domain. Valid values: online, offline. Default to online.

topLevelDomain String

The top-level domain name.

Supporting Types

DomainSource

Content string

The origin address.

Type string

The type of the origin. Valid values: ipaddr: The origin is configured using an IP address. domain: The origin is configured using a domain name. oss: The origin is configured using the Internet domain name of an Alibaba Cloud Object Storage Service (OSS) bucket.

Port int

The port number. Valid values: 443 and 80. Default to 80.

Priority string

The priority of the origin if multiple origins are specified. Default to 20.

Weight string

The weight of the origin if multiple origins are specified. Default to 10.

Content string

The origin address.

Type string

The type of the origin. Valid values: ipaddr: The origin is configured using an IP address. domain: The origin is configured using a domain name. oss: The origin is configured using the Internet domain name of an Alibaba Cloud Object Storage Service (OSS) bucket.

Port int

The port number. Valid values: 443 and 80. Default to 80.

Priority string

The priority of the origin if multiple origins are specified. Default to 20.

Weight string

The weight of the origin if multiple origins are specified. Default to 10.

content String

The origin address.

type String

The type of the origin. Valid values: ipaddr: The origin is configured using an IP address. domain: The origin is configured using a domain name. oss: The origin is configured using the Internet domain name of an Alibaba Cloud Object Storage Service (OSS) bucket.

port Integer

The port number. Valid values: 443 and 80. Default to 80.

priority String

The priority of the origin if multiple origins are specified. Default to 20.

weight String

The weight of the origin if multiple origins are specified. Default to 10.

content string

The origin address.

type string

The type of the origin. Valid values: ipaddr: The origin is configured using an IP address. domain: The origin is configured using a domain name. oss: The origin is configured using the Internet domain name of an Alibaba Cloud Object Storage Service (OSS) bucket.

port number

The port number. Valid values: 443 and 80. Default to 80.

priority string

The priority of the origin if multiple origins are specified. Default to 20.

weight string

The weight of the origin if multiple origins are specified. Default to 10.

content str

The origin address.

type str

The type of the origin. Valid values: ipaddr: The origin is configured using an IP address. domain: The origin is configured using a domain name. oss: The origin is configured using the Internet domain name of an Alibaba Cloud Object Storage Service (OSS) bucket.

port int

The port number. Valid values: 443 and 80. Default to 80.

priority str

The priority of the origin if multiple origins are specified. Default to 20.

weight str

The weight of the origin if multiple origins are specified. Default to 10.

content String

The origin address.

type String

The type of the origin. Valid values: ipaddr: The origin is configured using an IP address. domain: The origin is configured using a domain name. oss: The origin is configured using the Internet domain name of an Alibaba Cloud Object Storage Service (OSS) bucket.

port Number

The port number. Valid values: 443 and 80. Default to 80.

priority String

The priority of the origin if multiple origins are specified. Default to 20.

weight String

The weight of the origin if multiple origins are specified. Default to 10.

Import

DCDN Domain can be imported using the id or DCDN Domain name, e.g.

 $ pulumi import alicloud:dcdn/domain:Domain example example.com

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.