Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. apig
  5. ApigCustomDomain
Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.apig.ApigCustomDomain

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage apig custom domain

    Example Usage

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

const fooZones = volcengine.ecs.getZones({});
const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
    vpcName: "acc-test-vpc",
    cidrBlock: "172.16.0.0/16",
});
const foo1 = new volcengine.vpc.Subnet("foo1", {
    subnetName: "acc-test-subnet",
    cidrBlock: "172.16.0.0/24",
    zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
    vpcId: fooVpc.id,
});
const foo2 = new volcengine.vpc.Subnet("foo2", {
    subnetName: "acc-test-subnet",
    cidrBlock: "172.16.1.0/24",
    zoneId: fooZones.then(fooZones => fooZones.zones?.[1]?.id),
    vpcId: fooVpc.id,
});
const fooApigGateway = new volcengine.apig.ApigGateway("fooApigGateway", {
    type: "standard",
    comments: "acc-test",
    projectName: "default",
    tags: [{
        key: "k1",
        value: "v1",
    }],
    networkSpec: {
        vpcId: fooVpc.id,
        subnetIds: [
            foo1.id,
            foo2.id,
        ],
    },
    resourceSpec: {
        replicas: 2,
        instanceSpecCode: "1c2g",
        clbSpecCode: "small_1",
        publicNetworkBillingType: "bandwidth",
        publicNetworkBandwidth: 1,
        networkType: {
            enablePublicNetwork: true,
            enablePrivateNetwork: true,
        },
    },
    logSpec: {
        enable: true,
        projectId: "d3cb87c0-faeb-4074-b1ee-9bd747865a76",
        topicId: "d339482e-d86d-4bd8-a9bb-f270417f00a1",
    },
    monitorSpec: {
        enable: true,
        workspaceId: "4ed1caf3-279d-4c5f-8301-87ea38e92ffc",
    },
});
const fooApigGatewayService = new volcengine.apig.ApigGatewayService("fooApigGatewayService", {
    gatewayId: fooApigGateway.id,
    serviceName: "acc-test-apig-service",
    comments: "acc-test",
    protocols: [
        "HTTP",
        "HTTPS",
    ],
    authSpec: {
        enable: false,
    },
});
const fooApigCustomDomain = new volcengine.apig.ApigCustomDomain("fooApigCustomDomain", {
    serviceId: fooApigGatewayService.id,
    domain: "test.com",
    protocols: ["HTTP"],
    comments: "acc-test-new",
    sslRedirect: false,
    resourceType: "Console",
});

    import pulumi
import pulumi_volcengine as volcengine

foo_zones = volcengine.ecs.get_zones()
foo_vpc = volcengine.vpc.Vpc("fooVpc",
    vpc_name="acc-test-vpc",
    cidr_block="172.16.0.0/16")
foo1 = volcengine.vpc.Subnet("foo1",
    subnet_name="acc-test-subnet",
    cidr_block="172.16.0.0/24",
    zone_id=foo_zones.zones[0].id,
    vpc_id=foo_vpc.id)
foo2 = volcengine.vpc.Subnet("foo2",
    subnet_name="acc-test-subnet",
    cidr_block="172.16.1.0/24",
    zone_id=foo_zones.zones[1].id,
    vpc_id=foo_vpc.id)
foo_apig_gateway = volcengine.apig.ApigGateway("fooApigGateway",
    type="standard",
    comments="acc-test",
    project_name="default",
    tags=[volcengine.apig.ApigGatewayTagArgs(
        key="k1",
        value="v1",
    )],
    network_spec=volcengine.apig.ApigGatewayNetworkSpecArgs(
        vpc_id=foo_vpc.id,
        subnet_ids=[
            foo1.id,
            foo2.id,
        ],
    ),
    resource_spec=volcengine.apig.ApigGatewayResourceSpecArgs(
        replicas=2,
        instance_spec_code="1c2g",
        clb_spec_code="small_1",
        public_network_billing_type="bandwidth",
        public_network_bandwidth=1,
        network_type=volcengine.apig.ApigGatewayResourceSpecNetworkTypeArgs(
            enable_public_network=True,
            enable_private_network=True,
        ),
    ),
    log_spec=volcengine.apig.ApigGatewayLogSpecArgs(
        enable=True,
        project_id="d3cb87c0-faeb-4074-b1ee-9bd747865a76",
        topic_id="d339482e-d86d-4bd8-a9bb-f270417f00a1",
    ),
    monitor_spec=volcengine.apig.ApigGatewayMonitorSpecArgs(
        enable=True,
        workspace_id="4ed1caf3-279d-4c5f-8301-87ea38e92ffc",
    ))
foo_apig_gateway_service = volcengine.apig.ApigGatewayService("fooApigGatewayService",
    gateway_id=foo_apig_gateway.id,
    service_name="acc-test-apig-service",
    comments="acc-test",
    protocols=[
        "HTTP",
        "HTTPS",
    ],
    auth_spec=volcengine.apig.ApigGatewayServiceAuthSpecArgs(
        enable=False,
    ))
foo_apig_custom_domain = volcengine.apig.ApigCustomDomain("fooApigCustomDomain",
    service_id=foo_apig_gateway_service.id,
    domain="test.com",
    protocols=["HTTP"],
    comments="acc-test-new",
    ssl_redirect=False,
    resource_type="Console")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/apig"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fooZones, err := ecs.GetZones(ctx, nil, nil)
		if err != nil {
			return err
		}
		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
			VpcName:   pulumi.String("acc-test-vpc"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
		})
		if err != nil {
			return err
		}
		foo1, err := vpc.NewSubnet(ctx, "foo1", &vpc.SubnetArgs{
			SubnetName: pulumi.String("acc-test-subnet"),
			CidrBlock:  pulumi.String("172.16.0.0/24"),
			ZoneId:     pulumi.String(fooZones.Zones[0].Id),
			VpcId:      fooVpc.ID(),
		})
		if err != nil {
			return err
		}
		foo2, err := vpc.NewSubnet(ctx, "foo2", &vpc.SubnetArgs{
			SubnetName: pulumi.String("acc-test-subnet"),
			CidrBlock:  pulumi.String("172.16.1.0/24"),
			ZoneId:     pulumi.String(fooZones.Zones[1].Id),
			VpcId:      fooVpc.ID(),
		})
		if err != nil {
			return err
		}
		fooApigGateway, err := apig.NewApigGateway(ctx, "fooApigGateway", &apig.ApigGatewayArgs{
			Type:        pulumi.String("standard"),
			Comments:    pulumi.String("acc-test"),
			ProjectName: pulumi.String("default"),
			Tags: apig.ApigGatewayTagArray{
				&apig.ApigGatewayTagArgs{
					Key:   pulumi.String("k1"),
					Value: pulumi.String("v1"),
				},
			},
			NetworkSpec: &apig.ApigGatewayNetworkSpecArgs{
				VpcId: fooVpc.ID(),
				SubnetIds: pulumi.StringArray{
					foo1.ID(),
					foo2.ID(),
				},
			},
			ResourceSpec: &apig.ApigGatewayResourceSpecArgs{
				Replicas:                 pulumi.Int(2),
				InstanceSpecCode:         pulumi.String("1c2g"),
				ClbSpecCode:              pulumi.String("small_1"),
				PublicNetworkBillingType: pulumi.String("bandwidth"),
				PublicNetworkBandwidth:   pulumi.Int(1),
				NetworkType: &apig.ApigGatewayResourceSpecNetworkTypeArgs{
					EnablePublicNetwork:  pulumi.Bool(true),
					EnablePrivateNetwork: pulumi.Bool(true),
				},
			},
			LogSpec: &apig.ApigGatewayLogSpecArgs{
				Enable:    pulumi.Bool(true),
				ProjectId: pulumi.String("d3cb87c0-faeb-4074-b1ee-9bd747865a76"),
				TopicId:   pulumi.String("d339482e-d86d-4bd8-a9bb-f270417f00a1"),
			},
			MonitorSpec: &apig.ApigGatewayMonitorSpecArgs{
				Enable:      pulumi.Bool(true),
				WorkspaceId: pulumi.String("4ed1caf3-279d-4c5f-8301-87ea38e92ffc"),
			},
		})
		if err != nil {
			return err
		}
		fooApigGatewayService, err := apig.NewApigGatewayService(ctx, "fooApigGatewayService", &apig.ApigGatewayServiceArgs{
			GatewayId:   fooApigGateway.ID(),
			ServiceName: pulumi.String("acc-test-apig-service"),
			Comments:    pulumi.String("acc-test"),
			Protocols: pulumi.StringArray{
				pulumi.String("HTTP"),
				pulumi.String("HTTPS"),
			},
			AuthSpec: &apig.ApigGatewayServiceAuthSpecArgs{
				Enable: pulumi.Bool(false),
			},
		})
		if err != nil {
			return err
		}
		_, err = apig.NewApigCustomDomain(ctx, "fooApigCustomDomain", &apig.ApigCustomDomainArgs{
			ServiceId: fooApigGatewayService.ID(),
			Domain:    pulumi.String("test.com"),
			Protocols: pulumi.StringArray{
				pulumi.String("HTTP"),
			},
			Comments:     pulumi.String("acc-test-new"),
			SslRedirect:  pulumi.Bool(false),
			ResourceType: pulumi.String("Console"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var fooZones = Volcengine.Ecs.GetZones.Invoke();

    var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
    {
        VpcName = "acc-test-vpc",
        CidrBlock = "172.16.0.0/16",
    });

    var foo1 = new Volcengine.Vpc.Subnet("foo1", new()
    {
        SubnetName = "acc-test-subnet",
        CidrBlock = "172.16.0.0/24",
        ZoneId = fooZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        VpcId = fooVpc.Id,
    });

    var foo2 = new Volcengine.Vpc.Subnet("foo2", new()
    {
        SubnetName = "acc-test-subnet",
        CidrBlock = "172.16.1.0/24",
        ZoneId = fooZones.Apply(getZonesResult => getZonesResult.Zones[1]?.Id),
        VpcId = fooVpc.Id,
    });

    var fooApigGateway = new Volcengine.Apig.ApigGateway("fooApigGateway", new()
    {
        Type = "standard",
        Comments = "acc-test",
        ProjectName = "default",
        Tags = new[]
        {
            new Volcengine.Apig.Inputs.ApigGatewayTagArgs
            {
                Key = "k1",
                Value = "v1",
            },
        },
        NetworkSpec = new Volcengine.Apig.Inputs.ApigGatewayNetworkSpecArgs
        {
            VpcId = fooVpc.Id,
            SubnetIds = new[]
            {
                foo1.Id,
                foo2.Id,
            },
        },
        ResourceSpec = new Volcengine.Apig.Inputs.ApigGatewayResourceSpecArgs
        {
            Replicas = 2,
            InstanceSpecCode = "1c2g",
            ClbSpecCode = "small_1",
            PublicNetworkBillingType = "bandwidth",
            PublicNetworkBandwidth = 1,
            NetworkType = new Volcengine.Apig.Inputs.ApigGatewayResourceSpecNetworkTypeArgs
            {
                EnablePublicNetwork = true,
                EnablePrivateNetwork = true,
            },
        },
        LogSpec = new Volcengine.Apig.Inputs.ApigGatewayLogSpecArgs
        {
            Enable = true,
            ProjectId = "d3cb87c0-faeb-4074-b1ee-9bd747865a76",
            TopicId = "d339482e-d86d-4bd8-a9bb-f270417f00a1",
        },
        MonitorSpec = new Volcengine.Apig.Inputs.ApigGatewayMonitorSpecArgs
        {
            Enable = true,
            WorkspaceId = "4ed1caf3-279d-4c5f-8301-87ea38e92ffc",
        },
    });

    var fooApigGatewayService = new Volcengine.Apig.ApigGatewayService("fooApigGatewayService", new()
    {
        GatewayId = fooApigGateway.Id,
        ServiceName = "acc-test-apig-service",
        Comments = "acc-test",
        Protocols = new[]
        {
            "HTTP",
            "HTTPS",
        },
        AuthSpec = new Volcengine.Apig.Inputs.ApigGatewayServiceAuthSpecArgs
        {
            Enable = false,
        },
    });

    var fooApigCustomDomain = new Volcengine.Apig.ApigCustomDomain("fooApigCustomDomain", new()
    {
        ServiceId = fooApigGatewayService.Id,
        Domain = "test.com",
        Protocols = new[]
        {
            "HTTP",
        },
        Comments = "acc-test-new",
        SslRedirect = false,
        ResourceType = "Console",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.ecs.EcsFunctions;
import com.pulumi.volcengine.ecs.inputs.GetZonesArgs;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.apig.ApigGateway;
import com.pulumi.volcengine.apig.ApigGatewayArgs;
import com.pulumi.volcengine.apig.inputs.ApigGatewayTagArgs;
import com.pulumi.volcengine.apig.inputs.ApigGatewayNetworkSpecArgs;
import com.pulumi.volcengine.apig.inputs.ApigGatewayResourceSpecArgs;
import com.pulumi.volcengine.apig.inputs.ApigGatewayResourceSpecNetworkTypeArgs;
import com.pulumi.volcengine.apig.inputs.ApigGatewayLogSpecArgs;
import com.pulumi.volcengine.apig.inputs.ApigGatewayMonitorSpecArgs;
import com.pulumi.volcengine.apig.ApigGatewayService;
import com.pulumi.volcengine.apig.ApigGatewayServiceArgs;
import com.pulumi.volcengine.apig.inputs.ApigGatewayServiceAuthSpecArgs;
import com.pulumi.volcengine.apig.ApigCustomDomain;
import com.pulumi.volcengine.apig.ApigCustomDomainArgs;
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 fooZones = EcsFunctions.getZones();

        var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .vpcName("acc-test-vpc")
            .cidrBlock("172.16.0.0/16")
            .build());

        var foo1 = new Subnet("foo1", SubnetArgs.builder()        
            .subnetName("acc-test-subnet")
            .cidrBlock("172.16.0.0/24")
            .zoneId(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .vpcId(fooVpc.id())
            .build());

        var foo2 = new Subnet("foo2", SubnetArgs.builder()        
            .subnetName("acc-test-subnet")
            .cidrBlock("172.16.1.0/24")
            .zoneId(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[1].id()))
            .vpcId(fooVpc.id())
            .build());

        var fooApigGateway = new ApigGateway("fooApigGateway", ApigGatewayArgs.builder()        
            .type("standard")
            .comments("acc-test")
            .projectName("default")
            .tags(ApigGatewayTagArgs.builder()
                .key("k1")
                .value("v1")
                .build())
            .networkSpec(ApigGatewayNetworkSpecArgs.builder()
                .vpcId(fooVpc.id())
                .subnetIds(                
                    foo1.id(),
                    foo2.id())
                .build())
            .resourceSpec(ApigGatewayResourceSpecArgs.builder()
                .replicas(2)
                .instanceSpecCode("1c2g")
                .clbSpecCode("small_1")
                .publicNetworkBillingType("bandwidth")
                .publicNetworkBandwidth(1)
                .networkType(ApigGatewayResourceSpecNetworkTypeArgs.builder()
                    .enablePublicNetwork(true)
                    .enablePrivateNetwork(true)
                    .build())
                .build())
            .logSpec(ApigGatewayLogSpecArgs.builder()
                .enable(true)
                .projectId("d3cb87c0-faeb-4074-b1ee-9bd747865a76")
                .topicId("d339482e-d86d-4bd8-a9bb-f270417f00a1")
                .build())
            .monitorSpec(ApigGatewayMonitorSpecArgs.builder()
                .enable(true)
                .workspaceId("4ed1caf3-279d-4c5f-8301-87ea38e92ffc")
                .build())
            .build());

        var fooApigGatewayService = new ApigGatewayService("fooApigGatewayService", ApigGatewayServiceArgs.builder()        
            .gatewayId(fooApigGateway.id())
            .serviceName("acc-test-apig-service")
            .comments("acc-test")
            .protocols(            
                "HTTP",
                "HTTPS")
            .authSpec(ApigGatewayServiceAuthSpecArgs.builder()
                .enable(false)
                .build())
            .build());

        var fooApigCustomDomain = new ApigCustomDomain("fooApigCustomDomain", ApigCustomDomainArgs.builder()        
            .serviceId(fooApigGatewayService.id())
            .domain("test.com")
            .protocols("HTTP")
            .comments("acc-test-new")
            .sslRedirect(false)
            .resourceType("Console")
            .build());

    }
}

    resources:
  fooVpc:
    type: volcengine:vpc:Vpc
    properties:
      vpcName: acc-test-vpc
      cidrBlock: 172.16.0.0/16
  foo1:
    type: volcengine:vpc:Subnet
    properties:
      subnetName: acc-test-subnet
      cidrBlock: 172.16.0.0/24
      zoneId: ${fooZones.zones[0].id}
      vpcId: ${fooVpc.id}
  foo2:
    type: volcengine:vpc:Subnet
    properties:
      subnetName: acc-test-subnet
      cidrBlock: 172.16.1.0/24
      zoneId: ${fooZones.zones[1].id}
      vpcId: ${fooVpc.id}
  fooApigGateway:
    type: volcengine:apig:ApigGateway
    properties:
      type: standard
      comments: acc-test
      projectName: default
      tags:
        - key: k1
          value: v1
      networkSpec:
        vpcId: ${fooVpc.id}
        subnetIds:
          - ${foo1.id}
          - ${foo2.id}
      resourceSpec:
        replicas: 2
        instanceSpecCode: 1c2g
        clbSpecCode: small_1
        publicNetworkBillingType: bandwidth
        publicNetworkBandwidth: 1
        networkType:
          enablePublicNetwork: true
          enablePrivateNetwork: true
      logSpec:
        enable: true
        projectId: d3cb87c0-faeb-4074-b1ee-9bd747865a76
        topicId: d339482e-d86d-4bd8-a9bb-f270417f00a1
      monitorSpec:
        enable: true
        workspaceId: 4ed1caf3-279d-4c5f-8301-87ea38e92ffc
  fooApigGatewayService:
    type: volcengine:apig:ApigGatewayService
    properties:
      gatewayId: ${fooApigGateway.id}
      serviceName: acc-test-apig-service
      comments: acc-test
      protocols:
        - HTTP
        - HTTPS
      authSpec:
        enable: false
  fooApigCustomDomain:
    type: volcengine:apig:ApigCustomDomain
    properties:
      serviceId: ${fooApigGatewayService.id}
      domain: test.com
      protocols:
        - HTTP
      comments: acc-test-new
      sslRedirect: false
      resourceType: Console
variables:
  fooZones:
    fn::invoke:
      Function: volcengine:ecs:getZones
      Arguments: {}

    Create ApigCustomDomain Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ApigCustomDomain(name: string, args: ApigCustomDomainArgs, opts?: CustomResourceOptions);
    @overload
def ApigCustomDomain(resource_name: str,
                     args: ApigCustomDomainArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def ApigCustomDomain(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     domain: Optional[str] = None,
                     service_id: Optional[str] = None,
                     certificate_id: Optional[str] = None,
                     comments: Optional[str] = None,
                     protocols: Optional[Sequence[str]] = None,
                     resource_type: Optional[str] = None,
                     ssl_redirect: Optional[bool] = None)
    func NewApigCustomDomain(ctx *Context, name string, args ApigCustomDomainArgs, opts ...ResourceOption) (*ApigCustomDomain, error)
    public ApigCustomDomain(string name, ApigCustomDomainArgs args, CustomResourceOptions? opts = null)
    public ApigCustomDomain(String name, ApigCustomDomainArgs args)
public ApigCustomDomain(String name, ApigCustomDomainArgs args, CustomResourceOptions options)

    type: volcengine:apig:ApigCustomDomain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ApigCustomDomainArgs
    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 ApigCustomDomainArgs
    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 ApigCustomDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApigCustomDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApigCustomDomainArgs
    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 apigCustomDomainResource = new Volcengine.Apig.ApigCustomDomain("apigCustomDomainResource", new()
{
    Domain = "string",
    ServiceId = "string",
    CertificateId = "string",
    Comments = "string",
    Protocols = new[]
    {
        "string",
    },
    ResourceType = "string",
    SslRedirect = false,
});

    example, err := apig.NewApigCustomDomain(ctx, "apigCustomDomainResource", &apig.ApigCustomDomainArgs{
	Domain:        pulumi.String("string"),
	ServiceId:     pulumi.String("string"),
	CertificateId: pulumi.String("string"),
	Comments:      pulumi.String("string"),
	Protocols: pulumi.StringArray{
		pulumi.String("string"),
	},
	ResourceType: pulumi.String("string"),
	SslRedirect:  pulumi.Bool(false),
})

    var apigCustomDomainResource = new ApigCustomDomain("apigCustomDomainResource", ApigCustomDomainArgs.builder()
    .domain("string")
    .serviceId("string")
    .certificateId("string")
    .comments("string")
    .protocols("string")
    .resourceType("string")
    .sslRedirect(false)
    .build());

    apig_custom_domain_resource = volcengine.apig.ApigCustomDomain("apigCustomDomainResource",
    domain="string",
    service_id="string",
    certificate_id="string",
    comments="string",
    protocols=["string"],
    resource_type="string",
    ssl_redirect=False)

    const apigCustomDomainResource = new volcengine.apig.ApigCustomDomain("apigCustomDomainResource", {
    domain: "string",
    serviceId: "string",
    certificateId: "string",
    comments: "string",
    protocols: ["string"],
    resourceType: "string",
    sslRedirect: false,
});

    type: volcengine:apig:ApigCustomDomain
properties:
    certificateId: string
    comments: string
    domain: string
    protocols:
        - string
    resourceType: string
    serviceId: string
    sslRedirect: false

    ApigCustomDomain 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 ApigCustomDomain resource accepts the following input properties:

    Domain string
    The custom domain of the api gateway service.
    ServiceId string
    The id of the api gateway service.
    CertificateId string
    The id of the certificate.
    Comments string
    The comments of the custom domain.
    Protocols List<string>
    The protocol of the custom domain.
    ResourceType string
    The resource type of domain. Valid values: Console, Ingress.
    SslRedirect bool
    Whether to redirect https.
    Domain string
    The custom domain of the api gateway service.
    ServiceId string
    The id of the api gateway service.
    CertificateId string
    The id of the certificate.
    Comments string
    The comments of the custom domain.
    Protocols []string
    The protocol of the custom domain.
    ResourceType string
    The resource type of domain. Valid values: Console, Ingress.
    SslRedirect bool
    Whether to redirect https.
    domain String
    The custom domain of the api gateway service.
    serviceId String
    The id of the api gateway service.
    certificateId String
    The id of the certificate.
    comments String
    The comments of the custom domain.
    protocols List<String>
    The protocol of the custom domain.
    resourceType String
    The resource type of domain. Valid values: Console, Ingress.
    sslRedirect Boolean
    Whether to redirect https.
    domain string
    The custom domain of the api gateway service.
    serviceId string
    The id of the api gateway service.
    certificateId string
    The id of the certificate.
    comments string
    The comments of the custom domain.
    protocols string[]
    The protocol of the custom domain.
    resourceType string
    The resource type of domain. Valid values: Console, Ingress.
    sslRedirect boolean
    Whether to redirect https.
    domain str
    The custom domain of the api gateway service.
    service_id str
    The id of the api gateway service.
    certificate_id str
    The id of the certificate.
    comments str
    The comments of the custom domain.
    protocols Sequence[str]
    The protocol of the custom domain.
    resource_type str
    The resource type of domain. Valid values: Console, Ingress.
    ssl_redirect bool
    Whether to redirect https.
    domain String
    The custom domain of the api gateway service.
    serviceId String
    The id of the api gateway service.
    certificateId String
    The id of the certificate.
    comments String
    The comments of the custom domain.
    protocols List<String>
    The protocol of the custom domain.
    resourceType String
    The resource type of domain. Valid values: Console, Ingress.
    sslRedirect Boolean
    Whether to redirect https.

    Outputs

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

    CreateTime string
    The create time of the custom domain.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the custom domain.
    Type string
    The type of the domain.
    UpdateTime string
    The update time of the custom domain.
    CreateTime string
    The create time of the custom domain.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the custom domain.
    Type string
    The type of the domain.
    UpdateTime string
    The update time of the custom domain.
    createTime String
    The create time of the custom domain.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the custom domain.
    type String
    The type of the domain.
    updateTime String
    The update time of the custom domain.
    createTime string
    The create time of the custom domain.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the custom domain.
    type string
    The type of the domain.
    updateTime string
    The update time of the custom domain.
    create_time str
    The create time of the custom domain.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of the custom domain.
    type str
    The type of the domain.
    update_time str
    The update time of the custom domain.
    createTime String
    The create time of the custom domain.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the custom domain.
    type String
    The type of the domain.
    updateTime String
    The update time of the custom domain.

    Look up Existing ApigCustomDomain Resource

    Get an existing ApigCustomDomain 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?: ApigCustomDomainState, opts?: CustomResourceOptions): ApigCustomDomain
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        certificate_id: Optional[str] = None,
        comments: Optional[str] = None,
        create_time: Optional[str] = None,
        domain: Optional[str] = None,
        protocols: Optional[Sequence[str]] = None,
        resource_type: Optional[str] = None,
        service_id: Optional[str] = None,
        ssl_redirect: Optional[bool] = None,
        status: Optional[str] = None,
        type: Optional[str] = None,
        update_time: Optional[str] = None) -> ApigCustomDomain
    func GetApigCustomDomain(ctx *Context, name string, id IDInput, state *ApigCustomDomainState, opts ...ResourceOption) (*ApigCustomDomain, error)
    public static ApigCustomDomain Get(string name, Input<string> id, ApigCustomDomainState? state, CustomResourceOptions? opts = null)
    public static ApigCustomDomain get(String name, Output<String> id, ApigCustomDomainState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:apig:ApigCustomDomain    get:      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.
    The following state arguments are supported:
    CertificateId string
    The id of the certificate.
    Comments string
    The comments of the custom domain.
    CreateTime string
    The create time of the custom domain.
    Domain string
    The custom domain of the api gateway service.
    Protocols List<string>
    The protocol of the custom domain.
    ResourceType string
    The resource type of domain. Valid values: Console, Ingress.
    ServiceId string
    The id of the api gateway service.
    SslRedirect bool
    Whether to redirect https.
    Status string
    The status of the custom domain.
    Type string
    The type of the domain.
    UpdateTime string
    The update time of the custom domain.
    CertificateId string
    The id of the certificate.
    Comments string
    The comments of the custom domain.
    CreateTime string
    The create time of the custom domain.
    Domain string
    The custom domain of the api gateway service.
    Protocols []string
    The protocol of the custom domain.
    ResourceType string
    The resource type of domain. Valid values: Console, Ingress.
    ServiceId string
    The id of the api gateway service.
    SslRedirect bool
    Whether to redirect https.
    Status string
    The status of the custom domain.
    Type string
    The type of the domain.
    UpdateTime string
    The update time of the custom domain.
    certificateId String
    The id of the certificate.
    comments String
    The comments of the custom domain.
    createTime String
    The create time of the custom domain.
    domain String
    The custom domain of the api gateway service.
    protocols List<String>
    The protocol of the custom domain.
    resourceType String
    The resource type of domain. Valid values: Console, Ingress.
    serviceId String
    The id of the api gateway service.
    sslRedirect Boolean
    Whether to redirect https.
    status String
    The status of the custom domain.
    type String
    The type of the domain.
    updateTime String
    The update time of the custom domain.
    certificateId string
    The id of the certificate.
    comments string
    The comments of the custom domain.
    createTime string
    The create time of the custom domain.
    domain string
    The custom domain of the api gateway service.
    protocols string[]
    The protocol of the custom domain.
    resourceType string
    The resource type of domain. Valid values: Console, Ingress.
    serviceId string
    The id of the api gateway service.
    sslRedirect boolean
    Whether to redirect https.
    status string
    The status of the custom domain.
    type string
    The type of the domain.
    updateTime string
    The update time of the custom domain.
    certificate_id str
    The id of the certificate.
    comments str
    The comments of the custom domain.
    create_time str
    The create time of the custom domain.
    domain str
    The custom domain of the api gateway service.
    protocols Sequence[str]
    The protocol of the custom domain.
    resource_type str
    The resource type of domain. Valid values: Console, Ingress.
    service_id str
    The id of the api gateway service.
    ssl_redirect bool
    Whether to redirect https.
    status str
    The status of the custom domain.
    type str
    The type of the domain.
    update_time str
    The update time of the custom domain.
    certificateId String
    The id of the certificate.
    comments String
    The comments of the custom domain.
    createTime String
    The create time of the custom domain.
    domain String
    The custom domain of the api gateway service.
    protocols List<String>
    The protocol of the custom domain.
    resourceType String
    The resource type of domain. Valid values: Console, Ingress.
    serviceId String
    The id of the api gateway service.
    sslRedirect Boolean
    Whether to redirect https.
    status String
    The status of the custom domain.
    type String
    The type of the domain.
    updateTime String
    The update time of the custom domain.

    Import

    ApigCustomDomain can be imported using the id, e.g.

    $ pulumi import volcengine:apig/apigCustomDomain:ApigCustomDomain default resource_id

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine
    volcengine/pulumi-volcengine