published on Monday, Aug 24, 2026 by Pulumi
published on Monday, Aug 24, 2026 by Pulumi
Provides a APIG Domain resource.
For information about APIG Domain and how to use it, see What is Domain.
NOTE: Available since v1.286.0.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const _default = new alicloud.apig.Domain("default", {
domainName: "example-domain-cspec-v6.example.com",
gatewayType: "API",
protocol: "HTTP",
});
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "terraform-example"
default = alicloud.apig.Domain("default",
domain_name="example-domain-cspec-v6.example.com",
gateway_type="API",
protocol="HTTP")
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/apig"
"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, "")
name := "terraform-example"
if param := cfg.Get("name"); param != "" {
name = param
}
_, err := apig.NewDomain(ctx, "default", &apig.DomainArgs{
DomainName: pulumi.String("example-domain-cspec-v6.example.com"),
GatewayType: pulumi.String("API"),
Protocol: pulumi.String("HTTP"),
})
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 name = config.Get("name") ?? "terraform-example";
var @default = new AliCloud.Apig.Domain("default", new()
{
DomainName = "example-domain-cspec-v6.example.com",
GatewayType = "API",
Protocol = "HTTP",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.apig.Domain;
import com.pulumi.alicloud.apig.DomainArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 name = config.get("name").orElse("terraform-example");
var default_ = new Domain("default", DomainArgs.builder()
.domainName("example-domain-cspec-v6.example.com")
.gatewayType("API")
.protocol("HTTP")
.build());
}
}
configuration:
name:
type: string
default: terraform-example
resources:
default:
type: alicloud:apig:Domain
properties:
domainName: example-domain-cspec-v6.example.com
gatewayType: API
protocol: HTTP
pulumi {
required_providers {
alicloud = {
source = "pulumi/alicloud"
}
}
}
resource "alicloud_apig_domain" "default" {
domain_name = "example-domain-cspec-v6.example.com"
gateway_type = "API"
protocol = "HTTP"
}
variable "name" {
type = string
default = "terraform-example"
}
📚 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,
gateway_type: Optional[str] = None,
client_ca_cert: Optional[str] = None,
cert_identifier: Optional[str] = None,
domain_scope: Optional[str] = None,
force_https: Optional[bool] = None,
ca_cert_identifier: Optional[str] = None,
http2_option: Optional[str] = None,
m_tls_enabled: Optional[bool] = None,
protocol: Optional[str] = None,
resource_group_id: Optional[str] = None,
tls_cipher_suites_config: Optional[DomainTlsCipherSuitesConfigArgs] = None,
tls_max: Optional[str] = None,
tls_min: Optional[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:apig:Domain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "alicloud_apig_domain" "name" {
# resource properties
}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 domainResource = new AliCloud.Apig.Domain("domainResource", new()
{
DomainName = "string",
GatewayType = "string",
ClientCaCert = "string",
CertIdentifier = "string",
DomainScope = "string",
ForceHttps = false,
CaCertIdentifier = "string",
Http2Option = "string",
MTlsEnabled = false,
Protocol = "string",
ResourceGroupId = "string",
TlsCipherSuitesConfig = new AliCloud.Apig.Inputs.DomainTlsCipherSuitesConfigArgs
{
ConfigType = "string",
TlsCipherSuites = new[]
{
new AliCloud.Apig.Inputs.DomainTlsCipherSuitesConfigTlsCipherSuiteArgs
{
Name = "string",
SupportVersions = new[]
{
"string",
},
},
},
},
TlsMax = "string",
TlsMin = "string",
});
example, err := apig.NewDomain(ctx, "domainResource", &apig.DomainArgs{
DomainName: pulumi.String("string"),
GatewayType: pulumi.String("string"),
ClientCaCert: pulumi.String("string"),
CertIdentifier: pulumi.String("string"),
DomainScope: pulumi.String("string"),
ForceHttps: pulumi.Bool(false),
CaCertIdentifier: pulumi.String("string"),
Http2Option: pulumi.String("string"),
MTlsEnabled: pulumi.Bool(false),
Protocol: pulumi.String("string"),
ResourceGroupId: pulumi.String("string"),
TlsCipherSuitesConfig: &apig.DomainTlsCipherSuitesConfigArgs{
ConfigType: pulumi.String("string"),
TlsCipherSuites: apig.DomainTlsCipherSuitesConfigTlsCipherSuiteArray{
&apig.DomainTlsCipherSuitesConfigTlsCipherSuiteArgs{
Name: pulumi.String("string"),
SupportVersions: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
TlsMax: pulumi.String("string"),
TlsMin: pulumi.String("string"),
})
resource "alicloud_apig_domain" "domainResource" {
lifecycle {
create_before_destroy = true
}
domain_name = "string"
gateway_type = "string"
client_ca_cert = "string"
cert_identifier = "string"
domain_scope = "string"
force_https = false
ca_cert_identifier = "string"
http2_option = "string"
m_tls_enabled = false
protocol = "string"
resource_group_id = "string"
tls_cipher_suites_config = {
config_type = "string"
tls_cipher_suites = [{
name = "string"
support_versions = ["string"]
}]
}
tls_max = "string"
tls_min = "string"
}
var domainResource = new com.pulumi.alicloud.apig.Domain("domainResource", com.pulumi.alicloud.apig.DomainArgs.builder()
.domainName("string")
.gatewayType("string")
.clientCaCert("string")
.certIdentifier("string")
.domainScope("string")
.forceHttps(false)
.caCertIdentifier("string")
.http2Option("string")
.mTlsEnabled(false)
.protocol("string")
.resourceGroupId("string")
.tlsCipherSuitesConfig(DomainTlsCipherSuitesConfigArgs.builder()
.configType("string")
.tlsCipherSuites(DomainTlsCipherSuitesConfigTlsCipherSuiteArgs.builder()
.name("string")
.supportVersions("string")
.build())
.build())
.tlsMax("string")
.tlsMin("string")
.build());
domain_resource = alicloud.apig.Domain("domainResource",
domain_name="string",
gateway_type="string",
client_ca_cert="string",
cert_identifier="string",
domain_scope="string",
force_https=False,
ca_cert_identifier="string",
http2_option="string",
m_tls_enabled=False,
protocol="string",
resource_group_id="string",
tls_cipher_suites_config={
"config_type": "string",
"tls_cipher_suites": [{
"name": "string",
"support_versions": ["string"],
}],
},
tls_max="string",
tls_min="string")
const domainResource = new alicloud.apig.Domain("domainResource", {
domainName: "string",
gatewayType: "string",
clientCaCert: "string",
certIdentifier: "string",
domainScope: "string",
forceHttps: false,
caCertIdentifier: "string",
http2Option: "string",
mTlsEnabled: false,
protocol: "string",
resourceGroupId: "string",
tlsCipherSuitesConfig: {
configType: "string",
tlsCipherSuites: [{
name: "string",
supportVersions: ["string"],
}],
},
tlsMax: "string",
tlsMin: "string",
});
type: alicloud:apig:Domain
properties:
caCertIdentifier: string
certIdentifier: string
clientCaCert: string
domainName: string
domainScope: string
forceHttps: false
gatewayType: string
http2Option: string
mTlsEnabled: false
protocol: string
resourceGroupId: string
tlsCipherSuitesConfig:
configType: string
tlsCipherSuites:
- name: string
supportVersions:
- string
tlsMax: string
tlsMin: 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:
- Domain
Name string - Domain name.
- Ca
Cert stringIdentifier - CA certificate identifier
- Cert
Identifier string - The certificate identifier.
- Client
Ca stringCert - client CA certificate
- Domain
Scope string - domain scope. Valid values:
Dedicated,Serverless. Defaults toDedicatedwhen not specified. Note: The parameter is immutable after resource creation. For aServerlessdomain,protocolmust be omitted (the domain is HTTPS-only, driven byforceHttps) andcertIdentifieris not required (a managed certificate is used). - Force
Https bool - Specifies whether to enable forced HTTPS redirection. Required for a
Serverlessdomain and for aDedicateddomain whenprotocolisHTTPS; not validated for aDedicateddomain whenprotocolisHTTP. - Gateway
Type string Gateway type. Valid values:
API,AI. Defaults toAPIwhen not specified.NOTE: This parameter is immutable. Changing it after creation has no effect.
- Http2Option string
- HTTP/2 settings.
- MTls
Enabled bool - Whether to enable mTLS mutual authentication
- Protocol string
- The protocol types supported by the domain. Required for a
Dedicateddomain; must be omitted for aServerlessdomain.- HTTP: Supports HTTP only.
- HTTPS: Supports HTTPS only.
- Resource
Group stringId - Resource group ID (https://help.aliyun.com/document_detail/151181.html).
- Tls
Cipher Pulumi.Suites Config Ali Cloud. Apig. Inputs. Domain Tls Cipher Suites Config - TLS cipher suites configuration. See
tlsCipherSuitesConfigbelow. - Tls
Max string - The maximum version of the TLS protocol supported, up to TLS 1.3.
- Tls
Min string - Minimum TLS protocol version. TLS 1.0 is the minimum supported version.
- Domain
Name string - Domain name.
- Ca
Cert stringIdentifier - CA certificate identifier
- Cert
Identifier string - The certificate identifier.
- Client
Ca stringCert - client CA certificate
- Domain
Scope string - domain scope. Valid values:
Dedicated,Serverless. Defaults toDedicatedwhen not specified. Note: The parameter is immutable after resource creation. For aServerlessdomain,protocolmust be omitted (the domain is HTTPS-only, driven byforceHttps) andcertIdentifieris not required (a managed certificate is used). - Force
Https bool - Specifies whether to enable forced HTTPS redirection. Required for a
Serverlessdomain and for aDedicateddomain whenprotocolisHTTPS; not validated for aDedicateddomain whenprotocolisHTTP. - Gateway
Type string Gateway type. Valid values:
API,AI. Defaults toAPIwhen not specified.NOTE: This parameter is immutable. Changing it after creation has no effect.
- Http2Option string
- HTTP/2 settings.
- MTls
Enabled bool - Whether to enable mTLS mutual authentication
- Protocol string
- The protocol types supported by the domain. Required for a
Dedicateddomain; must be omitted for aServerlessdomain.- HTTP: Supports HTTP only.
- HTTPS: Supports HTTPS only.
- Resource
Group stringId - Resource group ID (https://help.aliyun.com/document_detail/151181.html).
- Tls
Cipher DomainSuites Config Tls Cipher Suites Config Args - TLS cipher suites configuration. See
tlsCipherSuitesConfigbelow. - Tls
Max string - The maximum version of the TLS protocol supported, up to TLS 1.3.
- Tls
Min string - Minimum TLS protocol version. TLS 1.0 is the minimum supported version.
- domain_
name string - Domain name.
- ca_
cert_ stringidentifier - CA certificate identifier
- cert_
identifier string - The certificate identifier.
- client_
ca_ stringcert - client CA certificate
- domain_
scope string - domain scope. Valid values:
Dedicated,Serverless. Defaults toDedicatedwhen not specified. Note: The parameter is immutable after resource creation. For aServerlessdomain,protocolmust be omitted (the domain is HTTPS-only, driven byforceHttps) andcertIdentifieris not required (a managed certificate is used). - force_
https bool - Specifies whether to enable forced HTTPS redirection. Required for a
Serverlessdomain and for aDedicateddomain whenprotocolisHTTPS; not validated for aDedicateddomain whenprotocolisHTTP. - gateway_
type string Gateway type. Valid values:
API,AI. Defaults toAPIwhen not specified.NOTE: This parameter is immutable. Changing it after creation has no effect.
- http2_
option string - HTTP/2 settings.
- m_
tls_ boolenabled - Whether to enable mTLS mutual authentication
- protocol string
- The protocol types supported by the domain. Required for a
Dedicateddomain; must be omitted for aServerlessdomain.- HTTP: Supports HTTP only.
- HTTPS: Supports HTTPS only.
- resource_
group_ stringid - Resource group ID (https://help.aliyun.com/document_detail/151181.html).
- tls_
cipher_ objectsuites_ config - TLS cipher suites configuration. See
tlsCipherSuitesConfigbelow. - tls_
max string - The maximum version of the TLS protocol supported, up to TLS 1.3.
- tls_
min string - Minimum TLS protocol version. TLS 1.0 is the minimum supported version.
- domain
Name String - Domain name.
- ca
Cert StringIdentifier - CA certificate identifier
- cert
Identifier String - The certificate identifier.
- client
Ca StringCert - client CA certificate
- domain
Scope String - domain scope. Valid values:
Dedicated,Serverless. Defaults toDedicatedwhen not specified. Note: The parameter is immutable after resource creation. For aServerlessdomain,protocolmust be omitted (the domain is HTTPS-only, driven byforceHttps) andcertIdentifieris not required (a managed certificate is used). - force
Https Boolean - Specifies whether to enable forced HTTPS redirection. Required for a
Serverlessdomain and for aDedicateddomain whenprotocolisHTTPS; not validated for aDedicateddomain whenprotocolisHTTP. - gateway
Type String Gateway type. Valid values:
API,AI. Defaults toAPIwhen not specified.NOTE: This parameter is immutable. Changing it after creation has no effect.
- http2Option String
- HTTP/2 settings.
- m
Tls BooleanEnabled - Whether to enable mTLS mutual authentication
- protocol String
- The protocol types supported by the domain. Required for a
Dedicateddomain; must be omitted for aServerlessdomain.- HTTP: Supports HTTP only.
- HTTPS: Supports HTTPS only.
- resource
Group StringId - Resource group ID (https://help.aliyun.com/document_detail/151181.html).
- tls
Cipher DomainSuites Config Tls Cipher Suites Config - TLS cipher suites configuration. See
tlsCipherSuitesConfigbelow. - tls
Max String - The maximum version of the TLS protocol supported, up to TLS 1.3.
- tls
Min String - Minimum TLS protocol version. TLS 1.0 is the minimum supported version.
- domain
Name string - Domain name.
- ca
Cert stringIdentifier - CA certificate identifier
- cert
Identifier string - The certificate identifier.
- client
Ca stringCert - client CA certificate
- domain
Scope string - domain scope. Valid values:
Dedicated,Serverless. Defaults toDedicatedwhen not specified. Note: The parameter is immutable after resource creation. For aServerlessdomain,protocolmust be omitted (the domain is HTTPS-only, driven byforceHttps) andcertIdentifieris not required (a managed certificate is used). - force
Https boolean - Specifies whether to enable forced HTTPS redirection. Required for a
Serverlessdomain and for aDedicateddomain whenprotocolisHTTPS; not validated for aDedicateddomain whenprotocolisHTTP. - gateway
Type string Gateway type. Valid values:
API,AI. Defaults toAPIwhen not specified.NOTE: This parameter is immutable. Changing it after creation has no effect.
- http2Option string
- HTTP/2 settings.
- m
Tls booleanEnabled - Whether to enable mTLS mutual authentication
- protocol string
- The protocol types supported by the domain. Required for a
Dedicateddomain; must be omitted for aServerlessdomain.- HTTP: Supports HTTP only.
- HTTPS: Supports HTTPS only.
- resource
Group stringId - Resource group ID (https://help.aliyun.com/document_detail/151181.html).
- tls
Cipher DomainSuites Config Tls Cipher Suites Config - TLS cipher suites configuration. See
tlsCipherSuitesConfigbelow. - tls
Max string - The maximum version of the TLS protocol supported, up to TLS 1.3.
- tls
Min string - Minimum TLS protocol version. TLS 1.0 is the minimum supported version.
- domain_
name str - Domain name.
- ca_
cert_ stridentifier - CA certificate identifier
- cert_
identifier str - The certificate identifier.
- client_
ca_ strcert - client CA certificate
- domain_
scope str - domain scope. Valid values:
Dedicated,Serverless. Defaults toDedicatedwhen not specified. Note: The parameter is immutable after resource creation. For aServerlessdomain,protocolmust be omitted (the domain is HTTPS-only, driven byforceHttps) andcertIdentifieris not required (a managed certificate is used). - force_
https bool - Specifies whether to enable forced HTTPS redirection. Required for a
Serverlessdomain and for aDedicateddomain whenprotocolisHTTPS; not validated for aDedicateddomain whenprotocolisHTTP. - gateway_
type str Gateway type. Valid values:
API,AI. Defaults toAPIwhen not specified.NOTE: This parameter is immutable. Changing it after creation has no effect.
- http2_
option str - HTTP/2 settings.
- m_
tls_ boolenabled - Whether to enable mTLS mutual authentication
- protocol str
- The protocol types supported by the domain. Required for a
Dedicateddomain; must be omitted for aServerlessdomain.- HTTP: Supports HTTP only.
- HTTPS: Supports HTTPS only.
- resource_
group_ strid - Resource group ID (https://help.aliyun.com/document_detail/151181.html).
- tls_
cipher_ Domainsuites_ config Tls Cipher Suites Config Args - TLS cipher suites configuration. See
tlsCipherSuitesConfigbelow. - tls_
max str - The maximum version of the TLS protocol supported, up to TLS 1.3.
- tls_
min str - Minimum TLS protocol version. TLS 1.0 is the minimum supported version.
- domain
Name String - Domain name.
- ca
Cert StringIdentifier - CA certificate identifier
- cert
Identifier String - The certificate identifier.
- client
Ca StringCert - client CA certificate
- domain
Scope String - domain scope. Valid values:
Dedicated,Serverless. Defaults toDedicatedwhen not specified. Note: The parameter is immutable after resource creation. For aServerlessdomain,protocolmust be omitted (the domain is HTTPS-only, driven byforceHttps) andcertIdentifieris not required (a managed certificate is used). - force
Https Boolean - Specifies whether to enable forced HTTPS redirection. Required for a
Serverlessdomain and for aDedicateddomain whenprotocolisHTTPS; not validated for aDedicateddomain whenprotocolisHTTP. - gateway
Type String Gateway type. Valid values:
API,AI. Defaults toAPIwhen not specified.NOTE: This parameter is immutable. Changing it after creation has no effect.
- http2Option String
- HTTP/2 settings.
- m
Tls BooleanEnabled - Whether to enable mTLS mutual authentication
- protocol String
- The protocol types supported by the domain. Required for a
Dedicateddomain; must be omitted for aServerlessdomain.- HTTP: Supports HTTP only.
- HTTPS: Supports HTTPS only.
- resource
Group StringId - Resource group ID (https://help.aliyun.com/document_detail/151181.html).
- tls
Cipher Property MapSuites Config - TLS cipher suites configuration. See
tlsCipherSuitesConfigbelow. - tls
Max String - The maximum version of the TLS protocol supported, up to TLS 1.3.
- tls
Min String - Minimum TLS protocol version. TLS 1.0 is the minimum supported version.
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 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 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,
ca_cert_identifier: Optional[str] = None,
cert_identifier: Optional[str] = None,
client_ca_cert: Optional[str] = None,
domain_name: Optional[str] = None,
domain_scope: Optional[str] = None,
force_https: Optional[bool] = None,
gateway_type: Optional[str] = None,
http2_option: Optional[str] = None,
m_tls_enabled: Optional[bool] = None,
protocol: Optional[str] = None,
resource_group_id: Optional[str] = None,
tls_cipher_suites_config: Optional[DomainTlsCipherSuitesConfigArgs] = None,
tls_max: Optional[str] = None,
tls_min: Optional[str] = None) -> Domainfunc 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:apig:Domain get: id: ${id}import {
to = alicloud_apig_domain.example
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.
- Ca
Cert stringIdentifier - CA certificate identifier
- Cert
Identifier string - The certificate identifier.
- Client
Ca stringCert - client CA certificate
- Domain
Name string - Domain name.
- Domain
Scope string - domain scope. Valid values:
Dedicated,Serverless. Defaults toDedicatedwhen not specified. Note: The parameter is immutable after resource creation. For aServerlessdomain,protocolmust be omitted (the domain is HTTPS-only, driven byforceHttps) andcertIdentifieris not required (a managed certificate is used). - Force
Https bool - Specifies whether to enable forced HTTPS redirection. Required for a
Serverlessdomain and for aDedicateddomain whenprotocolisHTTPS; not validated for aDedicateddomain whenprotocolisHTTP. - Gateway
Type string Gateway type. Valid values:
API,AI. Defaults toAPIwhen not specified.NOTE: This parameter is immutable. Changing it after creation has no effect.
- Http2Option string
- HTTP/2 settings.
- MTls
Enabled bool - Whether to enable mTLS mutual authentication
- Protocol string
- The protocol types supported by the domain. Required for a
Dedicateddomain; must be omitted for aServerlessdomain.- HTTP: Supports HTTP only.
- HTTPS: Supports HTTPS only.
- Resource
Group stringId - Resource group ID (https://help.aliyun.com/document_detail/151181.html).
- Tls
Cipher Pulumi.Suites Config Ali Cloud. Apig. Inputs. Domain Tls Cipher Suites Config - TLS cipher suites configuration. See
tlsCipherSuitesConfigbelow. - Tls
Max string - The maximum version of the TLS protocol supported, up to TLS 1.3.
- Tls
Min string - Minimum TLS protocol version. TLS 1.0 is the minimum supported version.
- Ca
Cert stringIdentifier - CA certificate identifier
- Cert
Identifier string - The certificate identifier.
- Client
Ca stringCert - client CA certificate
- Domain
Name string - Domain name.
- Domain
Scope string - domain scope. Valid values:
Dedicated,Serverless. Defaults toDedicatedwhen not specified. Note: The parameter is immutable after resource creation. For aServerlessdomain,protocolmust be omitted (the domain is HTTPS-only, driven byforceHttps) andcertIdentifieris not required (a managed certificate is used). - Force
Https bool - Specifies whether to enable forced HTTPS redirection. Required for a
Serverlessdomain and for aDedicateddomain whenprotocolisHTTPS; not validated for aDedicateddomain whenprotocolisHTTP. - Gateway
Type string Gateway type. Valid values:
API,AI. Defaults toAPIwhen not specified.NOTE: This parameter is immutable. Changing it after creation has no effect.
- Http2Option string
- HTTP/2 settings.
- MTls
Enabled bool - Whether to enable mTLS mutual authentication
- Protocol string
- The protocol types supported by the domain. Required for a
Dedicateddomain; must be omitted for aServerlessdomain.- HTTP: Supports HTTP only.
- HTTPS: Supports HTTPS only.
- Resource
Group stringId - Resource group ID (https://help.aliyun.com/document_detail/151181.html).
- Tls
Cipher DomainSuites Config Tls Cipher Suites Config Args - TLS cipher suites configuration. See
tlsCipherSuitesConfigbelow. - Tls
Max string - The maximum version of the TLS protocol supported, up to TLS 1.3.
- Tls
Min string - Minimum TLS protocol version. TLS 1.0 is the minimum supported version.
- ca_
cert_ stringidentifier - CA certificate identifier
- cert_
identifier string - The certificate identifier.
- client_
ca_ stringcert - client CA certificate
- domain_
name string - Domain name.
- domain_
scope string - domain scope. Valid values:
Dedicated,Serverless. Defaults toDedicatedwhen not specified. Note: The parameter is immutable after resource creation. For aServerlessdomain,protocolmust be omitted (the domain is HTTPS-only, driven byforceHttps) andcertIdentifieris not required (a managed certificate is used). - force_
https bool - Specifies whether to enable forced HTTPS redirection. Required for a
Serverlessdomain and for aDedicateddomain whenprotocolisHTTPS; not validated for aDedicateddomain whenprotocolisHTTP. - gateway_
type string Gateway type. Valid values:
API,AI. Defaults toAPIwhen not specified.NOTE: This parameter is immutable. Changing it after creation has no effect.
- http2_
option string - HTTP/2 settings.
- m_
tls_ boolenabled - Whether to enable mTLS mutual authentication
- protocol string
- The protocol types supported by the domain. Required for a
Dedicateddomain; must be omitted for aServerlessdomain.- HTTP: Supports HTTP only.
- HTTPS: Supports HTTPS only.
- resource_
group_ stringid - Resource group ID (https://help.aliyun.com/document_detail/151181.html).
- tls_
cipher_ objectsuites_ config - TLS cipher suites configuration. See
tlsCipherSuitesConfigbelow. - tls_
max string - The maximum version of the TLS protocol supported, up to TLS 1.3.
- tls_
min string - Minimum TLS protocol version. TLS 1.0 is the minimum supported version.
- ca
Cert StringIdentifier - CA certificate identifier
- cert
Identifier String - The certificate identifier.
- client
Ca StringCert - client CA certificate
- domain
Name String - Domain name.
- domain
Scope String - domain scope. Valid values:
Dedicated,Serverless. Defaults toDedicatedwhen not specified. Note: The parameter is immutable after resource creation. For aServerlessdomain,protocolmust be omitted (the domain is HTTPS-only, driven byforceHttps) andcertIdentifieris not required (a managed certificate is used). - force
Https Boolean - Specifies whether to enable forced HTTPS redirection. Required for a
Serverlessdomain and for aDedicateddomain whenprotocolisHTTPS; not validated for aDedicateddomain whenprotocolisHTTP. - gateway
Type String Gateway type. Valid values:
API,AI. Defaults toAPIwhen not specified.NOTE: This parameter is immutable. Changing it after creation has no effect.
- http2Option String
- HTTP/2 settings.
- m
Tls BooleanEnabled - Whether to enable mTLS mutual authentication
- protocol String
- The protocol types supported by the domain. Required for a
Dedicateddomain; must be omitted for aServerlessdomain.- HTTP: Supports HTTP only.
- HTTPS: Supports HTTPS only.
- resource
Group StringId - Resource group ID (https://help.aliyun.com/document_detail/151181.html).
- tls
Cipher DomainSuites Config Tls Cipher Suites Config - TLS cipher suites configuration. See
tlsCipherSuitesConfigbelow. - tls
Max String - The maximum version of the TLS protocol supported, up to TLS 1.3.
- tls
Min String - Minimum TLS protocol version. TLS 1.0 is the minimum supported version.
- ca
Cert stringIdentifier - CA certificate identifier
- cert
Identifier string - The certificate identifier.
- client
Ca stringCert - client CA certificate
- domain
Name string - Domain name.
- domain
Scope string - domain scope. Valid values:
Dedicated,Serverless. Defaults toDedicatedwhen not specified. Note: The parameter is immutable after resource creation. For aServerlessdomain,protocolmust be omitted (the domain is HTTPS-only, driven byforceHttps) andcertIdentifieris not required (a managed certificate is used). - force
Https boolean - Specifies whether to enable forced HTTPS redirection. Required for a
Serverlessdomain and for aDedicateddomain whenprotocolisHTTPS; not validated for aDedicateddomain whenprotocolisHTTP. - gateway
Type string Gateway type. Valid values:
API,AI. Defaults toAPIwhen not specified.NOTE: This parameter is immutable. Changing it after creation has no effect.
- http2Option string
- HTTP/2 settings.
- m
Tls booleanEnabled - Whether to enable mTLS mutual authentication
- protocol string
- The protocol types supported by the domain. Required for a
Dedicateddomain; must be omitted for aServerlessdomain.- HTTP: Supports HTTP only.
- HTTPS: Supports HTTPS only.
- resource
Group stringId - Resource group ID (https://help.aliyun.com/document_detail/151181.html).
- tls
Cipher DomainSuites Config Tls Cipher Suites Config - TLS cipher suites configuration. See
tlsCipherSuitesConfigbelow. - tls
Max string - The maximum version of the TLS protocol supported, up to TLS 1.3.
- tls
Min string - Minimum TLS protocol version. TLS 1.0 is the minimum supported version.
- ca_
cert_ stridentifier - CA certificate identifier
- cert_
identifier str - The certificate identifier.
- client_
ca_ strcert - client CA certificate
- domain_
name str - Domain name.
- domain_
scope str - domain scope. Valid values:
Dedicated,Serverless. Defaults toDedicatedwhen not specified. Note: The parameter is immutable after resource creation. For aServerlessdomain,protocolmust be omitted (the domain is HTTPS-only, driven byforceHttps) andcertIdentifieris not required (a managed certificate is used). - force_
https bool - Specifies whether to enable forced HTTPS redirection. Required for a
Serverlessdomain and for aDedicateddomain whenprotocolisHTTPS; not validated for aDedicateddomain whenprotocolisHTTP. - gateway_
type str Gateway type. Valid values:
API,AI. Defaults toAPIwhen not specified.NOTE: This parameter is immutable. Changing it after creation has no effect.
- http2_
option str - HTTP/2 settings.
- m_
tls_ boolenabled - Whether to enable mTLS mutual authentication
- protocol str
- The protocol types supported by the domain. Required for a
Dedicateddomain; must be omitted for aServerlessdomain.- HTTP: Supports HTTP only.
- HTTPS: Supports HTTPS only.
- resource_
group_ strid - Resource group ID (https://help.aliyun.com/document_detail/151181.html).
- tls_
cipher_ Domainsuites_ config Tls Cipher Suites Config Args - TLS cipher suites configuration. See
tlsCipherSuitesConfigbelow. - tls_
max str - The maximum version of the TLS protocol supported, up to TLS 1.3.
- tls_
min str - Minimum TLS protocol version. TLS 1.0 is the minimum supported version.
- ca
Cert StringIdentifier - CA certificate identifier
- cert
Identifier String - The certificate identifier.
- client
Ca StringCert - client CA certificate
- domain
Name String - Domain name.
- domain
Scope String - domain scope. Valid values:
Dedicated,Serverless. Defaults toDedicatedwhen not specified. Note: The parameter is immutable after resource creation. For aServerlessdomain,protocolmust be omitted (the domain is HTTPS-only, driven byforceHttps) andcertIdentifieris not required (a managed certificate is used). - force
Https Boolean - Specifies whether to enable forced HTTPS redirection. Required for a
Serverlessdomain and for aDedicateddomain whenprotocolisHTTPS; not validated for aDedicateddomain whenprotocolisHTTP. - gateway
Type String Gateway type. Valid values:
API,AI. Defaults toAPIwhen not specified.NOTE: This parameter is immutable. Changing it after creation has no effect.
- http2Option String
- HTTP/2 settings.
- m
Tls BooleanEnabled - Whether to enable mTLS mutual authentication
- protocol String
- The protocol types supported by the domain. Required for a
Dedicateddomain; must be omitted for aServerlessdomain.- HTTP: Supports HTTP only.
- HTTPS: Supports HTTPS only.
- resource
Group StringId - Resource group ID (https://help.aliyun.com/document_detail/151181.html).
- tls
Cipher Property MapSuites Config - TLS cipher suites configuration. See
tlsCipherSuitesConfigbelow. - tls
Max String - The maximum version of the TLS protocol supported, up to TLS 1.3.
- tls
Min String - Minimum TLS protocol version. TLS 1.0 is the minimum supported version.
Supporting Types
DomainTlsCipherSuitesConfig, DomainTlsCipherSuitesConfigArgs
- Config
Type string - The configuration type, which can be Default or Custom.
- Tls
Cipher List<Pulumi.Suites Ali Cloud. Apig. Inputs. Domain Tls Cipher Suites Config Tls Cipher Suite> - TLS cipher suite. See
tlsCipherSuitebelow.
- Config
Type string - The configuration type, which can be Default or Custom.
- Tls
Cipher []DomainSuites Tls Cipher Suites Config Tls Cipher Suite - TLS cipher suite. See
tlsCipherSuitebelow.
- config_
type string - The configuration type, which can be Default or Custom.
- tls_
cipher_ list(object)suites - TLS cipher suite. See
tlsCipherSuitebelow.
- config
Type String - The configuration type, which can be Default or Custom.
- tls
Cipher List<DomainSuites Tls Cipher Suites Config Tls Cipher Suite> - TLS cipher suite. See
tlsCipherSuitebelow.
- config
Type string - The configuration type, which can be Default or Custom.
- tls
Cipher DomainSuites Tls Cipher Suites Config Tls Cipher Suite[] - TLS cipher suite. See
tlsCipherSuitebelow.
- config_
type str - The configuration type, which can be Default or Custom.
- tls_
cipher_ Sequence[Domainsuites Tls Cipher Suites Config Tls Cipher Suite] - TLS cipher suite. See
tlsCipherSuitebelow.
- config
Type String - The configuration type, which can be Default or Custom.
- tls
Cipher List<Property Map>Suites - TLS cipher suite. See
tlsCipherSuitebelow.
DomainTlsCipherSuitesConfigTlsCipherSuite, DomainTlsCipherSuitesConfigTlsCipherSuiteArgs
- Name string
- The name of the cipher suite.
- Support
Versions List<string> - support versions
- Name string
- The name of the cipher suite.
- Support
Versions []string - support versions
- name string
- The name of the cipher suite.
- support_
versions list(string) - support versions
- name String
- The name of the cipher suite.
- support
Versions List<String> - support versions
- name string
- The name of the cipher suite.
- support
Versions string[] - support versions
- name str
- The name of the cipher suite.
- support_
versions Sequence[str] - support versions
- name String
- The name of the cipher suite.
- support
Versions List<String> - support versions
Import
APIG Domain can be imported using the id, e.g.
$ pulumi import alicloud:apig/domain:Domain example <domain_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
alicloudTerraform Provider.
published on Monday, Aug 24, 2026 by Pulumi