published on Friday, Oct 23, 2026 by opentelekomcloud
published on Friday, Oct 23, 2026 by opentelekomcloud
Up-to-date reference of API arguments for API Gateway domain service you can get at documentation portal
Manages an API Gateway domain resource within T-Cloud Public (formerly OpenTelekomCloud).
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as opentelekomcloud from "@pulumi/opentelekomcloud";
const config = new pulumi.Config();
const gatewayId = config.requireObject<any>("gatewayId");
const groupId = config.requireObject<any>("groupId");
const domainName = config.requireObject<any>("domainName");
const test = new opentelekomcloud.ApigwDomainV2("test", {
gatewayId: gatewayId,
groupId: groupId,
name: domainName,
minSslVersion: "TLSv1.2",
httpRedirectToHttps: false,
});
import pulumi
import pulumi_opentelekomcloud as opentelekomcloud
config = pulumi.Config()
gateway_id = config.require_object("gatewayId")
group_id = config.require_object("groupId")
domain_name = config.require_object("domainName")
test = opentelekomcloud.ApigwDomainV2("test",
gateway_id=gateway_id,
group_id=group_id,
name=domain_name,
min_ssl_version="TLSv1.2",
http_redirect_to_https=False)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
"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, "")
gatewayId := cfg.RequireObject("gatewayId")
groupId := cfg.RequireObject("groupId")
domainName := cfg.RequireObject("domainName")
_, err := opentelekomcloud.NewApigwDomainV2(ctx, "test", &opentelekomcloud.ApigwDomainV2Args{
GatewayId: pulumi.Any(gatewayId),
GroupId: pulumi.Any(groupId),
Name: pulumi.Any(domainName),
MinSslVersion: pulumi.String("TLSv1.2"),
HttpRedirectToHttps: pulumi.Bool(false),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var gatewayId = config.RequireObject<dynamic>("gatewayId");
var groupId = config.RequireObject<dynamic>("groupId");
var domainName = config.RequireObject<dynamic>("domainName");
var test = new Opentelekomcloud.ApigwDomainV2("test", new()
{
GatewayId = gatewayId,
GroupId = groupId,
Name = domainName,
MinSslVersion = "TLSv1.2",
HttpRedirectToHttps = false,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.ApigwDomainV2;
import com.pulumi.opentelekomcloud.ApigwDomainV2Args;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var gatewayId = config.get("gatewayId");
final var groupId = config.get("groupId");
final var domainName = config.get("domainName");
var test = new ApigwDomainV2("test", ApigwDomainV2Args.builder()
.gatewayId(gatewayId)
.groupId(groupId)
.name(domainName)
.minSslVersion("TLSv1.2")
.httpRedirectToHttps(false)
.build());
}
}
configuration:
gatewayId:
type: dynamic
groupId:
type: dynamic
domainName:
type: dynamic
resources:
test:
type: opentelekomcloud:ApigwDomainV2
properties:
gatewayId: ${gatewayId}
groupId: ${groupId}
name: ${domainName}
minSslVersion: TLSv1.2
httpRedirectToHttps: false
Example coming soon!
Notes
But due to some attributes missing from the API response, it’s required to ignore changes as below:
import * as pulumi from "@pulumi/pulumi";
import * as opentelekomcloud from "@pulumi/opentelekomcloud";
const test = new opentelekomcloud.ApigwDomainV2("test", {});
import pulumi
import pulumi_opentelekomcloud as opentelekomcloud
test = opentelekomcloud.ApigwDomainV2("test")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := opentelekomcloud.NewApigwDomainV2(ctx, "test", nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;
return await Deployment.RunAsync(() =>
{
var test = new Opentelekomcloud.ApigwDomainV2("test");
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.ApigwDomainV2;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var test = new ApigwDomainV2("test");
}
}
resources:
test:
type: opentelekomcloud:ApigwDomainV2
Example coming soon!
Create ApigwDomainV2 Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ApigwDomainV2(name: string, args: ApigwDomainV2Args, opts?: CustomResourceOptions);@overload
def ApigwDomainV2(resource_name: str,
args: ApigwDomainV2Args,
opts: Optional[ResourceOptions] = None)
@overload
def ApigwDomainV2(resource_name: str,
opts: Optional[ResourceOptions] = None,
gateway_id: Optional[str] = None,
group_id: Optional[str] = None,
apigw_domain_v2_id: Optional[str] = None,
http_redirect_to_https: Optional[bool] = None,
min_ssl_version: Optional[str] = None,
name: Optional[str] = None)func NewApigwDomainV2(ctx *Context, name string, args ApigwDomainV2Args, opts ...ResourceOption) (*ApigwDomainV2, error)public ApigwDomainV2(string name, ApigwDomainV2Args args, CustomResourceOptions? opts = null)
public ApigwDomainV2(String name, ApigwDomainV2Args args)
public ApigwDomainV2(String name, ApigwDomainV2Args args, CustomResourceOptions options)
type: opentelekomcloud:ApigwDomainV2
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "opentelekomcloud_apigw_domain_v2" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ApigwDomainV2Args
- 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 ApigwDomainV2Args
- 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 ApigwDomainV2Args
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApigwDomainV2Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApigwDomainV2Args
- 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 apigwDomainV2Resource = new Opentelekomcloud.ApigwDomainV2("apigwDomainV2Resource", new()
{
GatewayId = "string",
GroupId = "string",
ApigwDomainV2Id = "string",
HttpRedirectToHttps = false,
MinSslVersion = "string",
Name = "string",
});
example, err := opentelekomcloud.NewApigwDomainV2(ctx, "apigwDomainV2Resource", &opentelekomcloud.ApigwDomainV2Args{
GatewayId: pulumi.String("string"),
GroupId: pulumi.String("string"),
ApigwDomainV2Id: pulumi.String("string"),
HttpRedirectToHttps: pulumi.Bool(false),
MinSslVersion: pulumi.String("string"),
Name: pulumi.String("string"),
})
resource "opentelekomcloud_apigw_domain_v2" "apigwDomainV2Resource" {
lifecycle {
create_before_destroy = true
}
gateway_id = "string"
group_id = "string"
apigw_domain_v2_id = "string"
http_redirect_to_https = false
min_ssl_version = "string"
name = "string"
}
var apigwDomainV2Resource = new ApigwDomainV2("apigwDomainV2Resource", ApigwDomainV2Args.builder()
.gatewayId("string")
.groupId("string")
.apigwDomainV2Id("string")
.httpRedirectToHttps(false)
.minSslVersion("string")
.name("string")
.build());
apigw_domain_v2_resource = opentelekomcloud.ApigwDomainV2("apigwDomainV2Resource",
gateway_id="string",
group_id="string",
apigw_domain_v2_id="string",
http_redirect_to_https=False,
min_ssl_version="string",
name="string")
const apigwDomainV2Resource = new opentelekomcloud.ApigwDomainV2("apigwDomainV2Resource", {
gatewayId: "string",
groupId: "string",
apigwDomainV2Id: "string",
httpRedirectToHttps: false,
minSslVersion: "string",
name: "string",
});
type: opentelekomcloud:ApigwDomainV2
properties:
apigwDomainV2Id: string
gatewayId: string
groupId: string
httpRedirectToHttps: false
minSslVersion: string
name: string
ApigwDomainV2 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 ApigwDomainV2 resource accepts the following input properties:
- Gateway
Id string - Specifies the ID of the dedicated gateway instance to which the domain belongs. Changing this will create a new resource.
- Group
Id string - Specifies the ID of the API group to which the domain belongs. Changing this will create a new resource.
- Apigw
Domain stringV2Id - The ID of the custom domain.
- Http
Redirect boolTo Https - Specifies whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.
- Min
Ssl stringVersion - Specifies the minimum SSL version.
The valid values are
TLSv1.1andTLSv1.2. - Name string
- Specifies the custom domain name.
It can contain a maximum of
255characters and must comply with domain name specifications. Changing this will create a new resource.
- Gateway
Id string - Specifies the ID of the dedicated gateway instance to which the domain belongs. Changing this will create a new resource.
- Group
Id string - Specifies the ID of the API group to which the domain belongs. Changing this will create a new resource.
- Apigw
Domain stringV2Id - The ID of the custom domain.
- Http
Redirect boolTo Https - Specifies whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.
- Min
Ssl stringVersion - Specifies the minimum SSL version.
The valid values are
TLSv1.1andTLSv1.2. - Name string
- Specifies the custom domain name.
It can contain a maximum of
255characters and must comply with domain name specifications. Changing this will create a new resource.
- gateway_
id string - Specifies the ID of the dedicated gateway instance to which the domain belongs. Changing this will create a new resource.
- group_
id string - Specifies the ID of the API group to which the domain belongs. Changing this will create a new resource.
- apigw_
domain_ stringv2_ id - The ID of the custom domain.
- http_
redirect_ boolto_ https - Specifies whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.
- min_
ssl_ stringversion - Specifies the minimum SSL version.
The valid values are
TLSv1.1andTLSv1.2. - name string
- Specifies the custom domain name.
It can contain a maximum of
255characters and must comply with domain name specifications. Changing this will create a new resource.
- gateway
Id String - Specifies the ID of the dedicated gateway instance to which the domain belongs. Changing this will create a new resource.
- group
Id String - Specifies the ID of the API group to which the domain belongs. Changing this will create a new resource.
- apigw
Domain StringV2Id - The ID of the custom domain.
- http
Redirect BooleanTo Https - Specifies whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.
- min
Ssl StringVersion - Specifies the minimum SSL version.
The valid values are
TLSv1.1andTLSv1.2. - name String
- Specifies the custom domain name.
It can contain a maximum of
255characters and must comply with domain name specifications. Changing this will create a new resource.
- gateway
Id string - Specifies the ID of the dedicated gateway instance to which the domain belongs. Changing this will create a new resource.
- group
Id string - Specifies the ID of the API group to which the domain belongs. Changing this will create a new resource.
- apigw
Domain stringV2Id - The ID of the custom domain.
- http
Redirect booleanTo Https - Specifies whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.
- min
Ssl stringVersion - Specifies the minimum SSL version.
The valid values are
TLSv1.1andTLSv1.2. - name string
- Specifies the custom domain name.
It can contain a maximum of
255characters and must comply with domain name specifications. Changing this will create a new resource.
- gateway_
id str - Specifies the ID of the dedicated gateway instance to which the domain belongs. Changing this will create a new resource.
- group_
id str - Specifies the ID of the API group to which the domain belongs. Changing this will create a new resource.
- apigw_
domain_ strv2_ id - The ID of the custom domain.
- http_
redirect_ boolto_ https - Specifies whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.
- min_
ssl_ strversion - Specifies the minimum SSL version.
The valid values are
TLSv1.1andTLSv1.2. - name str
- Specifies the custom domain name.
It can contain a maximum of
255characters and must comply with domain name specifications. Changing this will create a new resource.
- gateway
Id String - Specifies the ID of the dedicated gateway instance to which the domain belongs. Changing this will create a new resource.
- group
Id String - Specifies the ID of the API group to which the domain belongs. Changing this will create a new resource.
- apigw
Domain StringV2Id - The ID of the custom domain.
- http
Redirect BooleanTo Https - Specifies whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.
- min
Ssl StringVersion - Specifies the minimum SSL version.
The valid values are
TLSv1.1andTLSv1.2. - name String
- Specifies the custom domain name.
It can contain a maximum of
255characters and must comply with domain name specifications. Changing this will create a new resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the ApigwDomainV2 resource produces the following output properties:
Look up Existing ApigwDomainV2 Resource
Get an existing ApigwDomainV2 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?: ApigwDomainV2State, opts?: CustomResourceOptions): ApigwDomainV2@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
apigw_domain_v2_id: Optional[str] = None,
gateway_id: Optional[str] = None,
group_id: Optional[str] = None,
http_redirect_to_https: Optional[bool] = None,
min_ssl_version: Optional[str] = None,
name: Optional[str] = None,
status: Optional[float] = None) -> ApigwDomainV2func GetApigwDomainV2(ctx *Context, name string, id IDInput, state *ApigwDomainV2State, opts ...ResourceOption) (*ApigwDomainV2, error)public static ApigwDomainV2 Get(string name, Input<string> id, ApigwDomainV2State? state, CustomResourceOptions? opts = null)public static ApigwDomainV2 get(String name, Output<String> id, ApigwDomainV2State state, CustomResourceOptions options)resources: _: type: opentelekomcloud:ApigwDomainV2 get: id: ${id}import {
to = opentelekomcloud_apigw_domain_v2.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.
- Apigw
Domain stringV2Id - The ID of the custom domain.
- Gateway
Id string - Specifies the ID of the dedicated gateway instance to which the domain belongs. Changing this will create a new resource.
- Group
Id string - Specifies the ID of the API group to which the domain belongs. Changing this will create a new resource.
- Http
Redirect boolTo Https - Specifies whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.
- Min
Ssl stringVersion - Specifies the minimum SSL version.
The valid values are
TLSv1.1andTLSv1.2. - Name string
- Specifies the custom domain name.
It can contain a maximum of
255characters and must comply with domain name specifications. Changing this will create a new resource. - Status double
- The CNAME resolution status. The valid values are as follows:
- Apigw
Domain stringV2Id - The ID of the custom domain.
- Gateway
Id string - Specifies the ID of the dedicated gateway instance to which the domain belongs. Changing this will create a new resource.
- Group
Id string - Specifies the ID of the API group to which the domain belongs. Changing this will create a new resource.
- Http
Redirect boolTo Https - Specifies whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.
- Min
Ssl stringVersion - Specifies the minimum SSL version.
The valid values are
TLSv1.1andTLSv1.2. - Name string
- Specifies the custom domain name.
It can contain a maximum of
255characters and must comply with domain name specifications. Changing this will create a new resource. - Status float64
- The CNAME resolution status. The valid values are as follows:
- apigw_
domain_ stringv2_ id - The ID of the custom domain.
- gateway_
id string - Specifies the ID of the dedicated gateway instance to which the domain belongs. Changing this will create a new resource.
- group_
id string - Specifies the ID of the API group to which the domain belongs. Changing this will create a new resource.
- http_
redirect_ boolto_ https - Specifies whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.
- min_
ssl_ stringversion - Specifies the minimum SSL version.
The valid values are
TLSv1.1andTLSv1.2. - name string
- Specifies the custom domain name.
It can contain a maximum of
255characters and must comply with domain name specifications. Changing this will create a new resource. - status number
- The CNAME resolution status. The valid values are as follows:
- apigw
Domain StringV2Id - The ID of the custom domain.
- gateway
Id String - Specifies the ID of the dedicated gateway instance to which the domain belongs. Changing this will create a new resource.
- group
Id String - Specifies the ID of the API group to which the domain belongs. Changing this will create a new resource.
- http
Redirect BooleanTo Https - Specifies whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.
- min
Ssl StringVersion - Specifies the minimum SSL version.
The valid values are
TLSv1.1andTLSv1.2. - name String
- Specifies the custom domain name.
It can contain a maximum of
255characters and must comply with domain name specifications. Changing this will create a new resource. - status Double
- The CNAME resolution status. The valid values are as follows:
- apigw
Domain stringV2Id - The ID of the custom domain.
- gateway
Id string - Specifies the ID of the dedicated gateway instance to which the domain belongs. Changing this will create a new resource.
- group
Id string - Specifies the ID of the API group to which the domain belongs. Changing this will create a new resource.
- http
Redirect booleanTo Https - Specifies whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.
- min
Ssl stringVersion - Specifies the minimum SSL version.
The valid values are
TLSv1.1andTLSv1.2. - name string
- Specifies the custom domain name.
It can contain a maximum of
255characters and must comply with domain name specifications. Changing this will create a new resource. - status number
- The CNAME resolution status. The valid values are as follows:
- apigw_
domain_ strv2_ id - The ID of the custom domain.
- gateway_
id str - Specifies the ID of the dedicated gateway instance to which the domain belongs. Changing this will create a new resource.
- group_
id str - Specifies the ID of the API group to which the domain belongs. Changing this will create a new resource.
- http_
redirect_ boolto_ https - Specifies whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.
- min_
ssl_ strversion - Specifies the minimum SSL version.
The valid values are
TLSv1.1andTLSv1.2. - name str
- Specifies the custom domain name.
It can contain a maximum of
255characters and must comply with domain name specifications. Changing this will create a new resource. - status float
- The CNAME resolution status. The valid values are as follows:
- apigw
Domain StringV2Id - The ID of the custom domain.
- gateway
Id String - Specifies the ID of the dedicated gateway instance to which the domain belongs. Changing this will create a new resource.
- group
Id String - Specifies the ID of the API group to which the domain belongs. Changing this will create a new resource.
- http
Redirect BooleanTo Https - Specifies whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.
- min
Ssl StringVersion - Specifies the minimum SSL version.
The valid values are
TLSv1.1andTLSv1.2. - name String
- Specifies the custom domain name.
It can contain a maximum of
255characters and must comply with domain name specifications. Changing this will create a new resource. - status Number
- The CNAME resolution status. The valid values are as follows:
Import
Domains can be imported using the ID of the dedicated gateway instance, the ID of the API group and the domain ID, separated by slashes, e.g.
$ pulumi import opentelekomcloud:index/apigwDomainV2:ApigwDomainV2 test <gateway_id>/<group_id>/<domain_id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
- License
- Notes
- This Pulumi package is based on the
opentelekomcloudTerraform Provider.
published on Friday, Oct 23, 2026 by opentelekomcloud