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

volcengine.apig.ApigGatewayService

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 gateway service

    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,
    },
});

    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,
    ))

    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
		}
		_, 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
		}
		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,
        },
    });

});

    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 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());

    }
}

    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
variables:
  fooZones:
    fn::invoke:
      Function: volcengine:ecs:getZones
      Arguments: {}

    Create ApigGatewayService Resource

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

    Constructor syntax

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

@overload
def ApigGatewayService(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       auth_spec: Optional[ApigGatewayServiceAuthSpecArgs] = None,
                       gateway_id: Optional[str] = None,
                       protocols: Optional[Sequence[str]] = None,
                       service_name: Optional[str] = None,
                       comments: Optional[str] = None)
    func NewApigGatewayService(ctx *Context, name string, args ApigGatewayServiceArgs, opts ...ResourceOption) (*ApigGatewayService, error)
    public ApigGatewayService(string name, ApigGatewayServiceArgs args, CustomResourceOptions? opts = null)
    public ApigGatewayService(String name, ApigGatewayServiceArgs args)
public ApigGatewayService(String name, ApigGatewayServiceArgs args, CustomResourceOptions options)

    type: volcengine:apig:ApigGatewayService
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 ApigGatewayServiceArgs
    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 ApigGatewayServiceArgs
    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 ApigGatewayServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApigGatewayServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApigGatewayServiceArgs
    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 apigGatewayServiceResource = new Volcengine.Apig.ApigGatewayService("apigGatewayServiceResource", new()
{
    AuthSpec = new Volcengine.Apig.Inputs.ApigGatewayServiceAuthSpecArgs
    {
        Enable = false,
    },
    GatewayId = "string",
    Protocols = new[]
    {
        "string",
    },
    ServiceName = "string",
    Comments = "string",
});

    example, err := apig.NewApigGatewayService(ctx, "apigGatewayServiceResource", &apig.ApigGatewayServiceArgs{
	AuthSpec: &apig.ApigGatewayServiceAuthSpecArgs{
		Enable: pulumi.Bool(false),
	},
	GatewayId: pulumi.String("string"),
	Protocols: pulumi.StringArray{
		pulumi.String("string"),
	},
	ServiceName: pulumi.String("string"),
	Comments:    pulumi.String("string"),
})

    var apigGatewayServiceResource = new ApigGatewayService("apigGatewayServiceResource", ApigGatewayServiceArgs.builder()
    .authSpec(ApigGatewayServiceAuthSpecArgs.builder()
        .enable(false)
        .build())
    .gatewayId("string")
    .protocols("string")
    .serviceName("string")
    .comments("string")
    .build());

    apig_gateway_service_resource = volcengine.apig.ApigGatewayService("apigGatewayServiceResource",
    auth_spec={
        "enable": False,
    },
    gateway_id="string",
    protocols=["string"],
    service_name="string",
    comments="string")

    const apigGatewayServiceResource = new volcengine.apig.ApigGatewayService("apigGatewayServiceResource", {
    authSpec: {
        enable: false,
    },
    gatewayId: "string",
    protocols: ["string"],
    serviceName: "string",
    comments: "string",
});

    type: volcengine:apig:ApigGatewayService
properties:
    authSpec:
        enable: false
    comments: string
    gatewayId: string
    protocols:
        - string
    serviceName: string

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

    AuthSpec ApigGatewayServiceAuthSpec
    The auth spec of the api gateway service.
    GatewayId string
    The gateway id of api gateway service.
    Protocols List<string>
    The protocol of api gateway service.
    ServiceName string
    The name of api gateway service.
    Comments string
    The comments of api gateway service.
    AuthSpec ApigGatewayServiceAuthSpecArgs
    The auth spec of the api gateway service.
    GatewayId string
    The gateway id of api gateway service.
    Protocols []string
    The protocol of api gateway service.
    ServiceName string
    The name of api gateway service.
    Comments string
    The comments of api gateway service.
    authSpec ApigGatewayServiceAuthSpec
    The auth spec of the api gateway service.
    gatewayId String
    The gateway id of api gateway service.
    protocols List<String>
    The protocol of api gateway service.
    serviceName String
    The name of api gateway service.
    comments String
    The comments of api gateway service.
    authSpec ApigGatewayServiceAuthSpec
    The auth spec of the api gateway service.
    gatewayId string
    The gateway id of api gateway service.
    protocols string[]
    The protocol of api gateway service.
    serviceName string
    The name of api gateway service.
    comments string
    The comments of api gateway service.
    auth_spec ApigGatewayServiceAuthSpecArgs
    The auth spec of the api gateway service.
    gateway_id str
    The gateway id of api gateway service.
    protocols Sequence[str]
    The protocol of api gateway service.
    service_name str
    The name of api gateway service.
    comments str
    The comments of api gateway service.
    authSpec Property Map
    The auth spec of the api gateway service.
    gatewayId String
    The gateway id of api gateway service.
    protocols List<String>
    The protocol of api gateway service.
    serviceName String
    The name of api gateway service.
    comments String
    The comments of api gateway service.

    Outputs

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

    CreateTime string
    The create time of the api gateway service.
    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    The error message of the api gateway service.
    Status string
    The status of the api gateway service.
    CreateTime string
    The create time of the api gateway service.
    Id string
    The provider-assigned unique ID for this managed resource.
    Message string
    The error message of the api gateway service.
    Status string
    The status of the api gateway service.
    createTime String
    The create time of the api gateway service.
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    The error message of the api gateway service.
    status String
    The status of the api gateway service.
    createTime string
    The create time of the api gateway service.
    id string
    The provider-assigned unique ID for this managed resource.
    message string
    The error message of the api gateway service.
    status string
    The status of the api gateway service.
    create_time str
    The create time of the api gateway service.
    id str
    The provider-assigned unique ID for this managed resource.
    message str
    The error message of the api gateway service.
    status str
    The status of the api gateway service.
    createTime String
    The create time of the api gateway service.
    id String
    The provider-assigned unique ID for this managed resource.
    message String
    The error message of the api gateway service.
    status String
    The status of the api gateway service.

    Look up Existing ApigGatewayService Resource

    Get an existing ApigGatewayService 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?: ApigGatewayServiceState, opts?: CustomResourceOptions): ApigGatewayService
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_spec: Optional[ApigGatewayServiceAuthSpecArgs] = None,
        comments: Optional[str] = None,
        create_time: Optional[str] = None,
        gateway_id: Optional[str] = None,
        message: Optional[str] = None,
        protocols: Optional[Sequence[str]] = None,
        service_name: Optional[str] = None,
        status: Optional[str] = None) -> ApigGatewayService
    func GetApigGatewayService(ctx *Context, name string, id IDInput, state *ApigGatewayServiceState, opts ...ResourceOption) (*ApigGatewayService, error)
    public static ApigGatewayService Get(string name, Input<string> id, ApigGatewayServiceState? state, CustomResourceOptions? opts = null)
    public static ApigGatewayService get(String name, Output<String> id, ApigGatewayServiceState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:apig:ApigGatewayService    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:
    AuthSpec ApigGatewayServiceAuthSpec
    The auth spec of the api gateway service.
    Comments string
    The comments of api gateway service.
    CreateTime string
    The create time of the api gateway service.
    GatewayId string
    The gateway id of api gateway service.
    Message string
    The error message of the api gateway service.
    Protocols List<string>
    The protocol of api gateway service.
    ServiceName string
    The name of api gateway service.
    Status string
    The status of the api gateway service.
    AuthSpec ApigGatewayServiceAuthSpecArgs
    The auth spec of the api gateway service.
    Comments string
    The comments of api gateway service.
    CreateTime string
    The create time of the api gateway service.
    GatewayId string
    The gateway id of api gateway service.
    Message string
    The error message of the api gateway service.
    Protocols []string
    The protocol of api gateway service.
    ServiceName string
    The name of api gateway service.
    Status string
    The status of the api gateway service.
    authSpec ApigGatewayServiceAuthSpec
    The auth spec of the api gateway service.
    comments String
    The comments of api gateway service.
    createTime String
    The create time of the api gateway service.
    gatewayId String
    The gateway id of api gateway service.
    message String
    The error message of the api gateway service.
    protocols List<String>
    The protocol of api gateway service.
    serviceName String
    The name of api gateway service.
    status String
    The status of the api gateway service.
    authSpec ApigGatewayServiceAuthSpec
    The auth spec of the api gateway service.
    comments string
    The comments of api gateway service.
    createTime string
    The create time of the api gateway service.
    gatewayId string
    The gateway id of api gateway service.
    message string
    The error message of the api gateway service.
    protocols string[]
    The protocol of api gateway service.
    serviceName string
    The name of api gateway service.
    status string
    The status of the api gateway service.
    auth_spec ApigGatewayServiceAuthSpecArgs
    The auth spec of the api gateway service.
    comments str
    The comments of api gateway service.
    create_time str
    The create time of the api gateway service.
    gateway_id str
    The gateway id of api gateway service.
    message str
    The error message of the api gateway service.
    protocols Sequence[str]
    The protocol of api gateway service.
    service_name str
    The name of api gateway service.
    status str
    The status of the api gateway service.
    authSpec Property Map
    The auth spec of the api gateway service.
    comments String
    The comments of api gateway service.
    createTime String
    The create time of the api gateway service.
    gatewayId String
    The gateway id of api gateway service.
    message String
    The error message of the api gateway service.
    protocols List<String>
    The protocol of api gateway service.
    serviceName String
    The name of api gateway service.
    status String
    The status of the api gateway service.

    Supporting Types

    ApigGatewayServiceAuthSpec, ApigGatewayServiceAuthSpecArgs

    Enable bool
    Whether the api gateway service enable auth.
    Enable bool
    Whether the api gateway service enable auth.
    enable Boolean
    Whether the api gateway service enable auth.
    enable boolean
    Whether the api gateway service enable auth.
    enable bool
    Whether the api gateway service enable auth.
    enable Boolean
    Whether the api gateway service enable auth.

    Import

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

    $ pulumi import volcengine:apig/apigGatewayService:ApigGatewayService 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