Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. gtm
  6. Routing
Viewing docs for volcenginecc v0.0.43
published on Monday, Jun 15, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.gtm.Routing

volcenginecc logo
Viewing docs for volcenginecc v0.0.43
published on Monday, Jun 15, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Used to start or stop a GTM instance. After starting, the GTM instance configures DNS resolution for the scheduling domain, and initiates health checks and failover. After stopping, health checks and failover for the GTM instance also stop. However, DNS resolution from the scheduling domain to the target address does not stop. If you need to delete DNS resolution from the scheduling domain to the target address, you can call the DeleteGtm API to delete the GTM instance.

    Example Usage

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

const gTMRoutingDemo = new volcenginecc.gtm.Routing("GTMRoutingDemo", {
    gtmId: "gtm_id_xxxxx",
    routingEnabled: true,
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

g_tm_routing_demo = volcenginecc.gtm.Routing("GTMRoutingDemo",
    gtm_id="gtm_id_xxxxx",
    routing_enabled=True)

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/gtm"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gtm.NewRouting(ctx, "GTMRoutingDemo", &gtm.RoutingArgs{
			GtmId:          pulumi.String("gtm_id_xxxxx"),
			RoutingEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var gTMRoutingDemo = new Volcenginecc.Gtm.Routing("GTMRoutingDemo", new()
    {
        GtmId = "gtm_id_xxxxx",
        RoutingEnabled = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.gtm.Routing;
import com.volcengine.volcenginecc.gtm.RoutingArgs;
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 gTMRoutingDemo = new Routing("gTMRoutingDemo", RoutingArgs.builder()
            .gtmId("gtm_id_xxxxx")
            .routingEnabled(true)
            .build());

    }
}

    resources:
  gTMRoutingDemo:
    type: volcenginecc:gtm:Routing
    name: GTMRoutingDemo
    properties:
      gtmId: gtm_id_xxxxx
      routingEnabled: true

    Example coming soon!

    Create Routing Resource

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

    Constructor syntax

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

@overload
def Routing(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            gtm_id: Optional[str] = None,
            routing_enabled: Optional[bool] = None)
    func NewRouting(ctx *Context, name string, args *RoutingArgs, opts ...ResourceOption) (*Routing, error)
    public Routing(string name, RoutingArgs? args = null, CustomResourceOptions? opts = null)
    public Routing(String name, RoutingArgs args)
public Routing(String name, RoutingArgs args, CustomResourceOptions options)

    type: volcenginecc:gtm:Routing
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "volcenginecc_gtm_routing" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args RoutingArgs
    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 RoutingArgs
    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 RoutingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RoutingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RoutingArgs
    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 routingResource = new Volcenginecc.Gtm.Routing("routingResource", new()
{
    GtmId = "string",
    RoutingEnabled = false,
});

    example, err := gtm.NewRouting(ctx, "routingResource", &gtm.RoutingArgs{
	GtmId:          pulumi.String("string"),
	RoutingEnabled: pulumi.Bool(false),
})

    resource "volcenginecc_gtm_routing" "routingResource" {
  gtm_id          = "string"
  routing_enabled = false
}

    var routingResource = new Routing("routingResource", RoutingArgs.builder()
    .gtmId("string")
    .routingEnabled(false)
    .build());

    routing_resource = volcenginecc.gtm.Routing("routingResource",
    gtm_id="string",
    routing_enabled=False)

    const routingResource = new volcenginecc.gtm.Routing("routingResource", {
    gtmId: "string",
    routingEnabled: false,
});

    type: volcenginecc:gtm:Routing
properties:
    gtmId: string
    routingEnabled: false

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

    GtmId string
    UUID of the GTM instance. You can obtain GtmId via the ListGtms API.
    RoutingEnabled bool
    Start/stop GTM instance. true: Start GTM instance. false: Stop GTM instance.
    GtmId string
    UUID of the GTM instance. You can obtain GtmId via the ListGtms API.
    RoutingEnabled bool
    Start/stop GTM instance. true: Start GTM instance. false: Stop GTM instance.
    gtm_id string
    UUID of the GTM instance. You can obtain GtmId via the ListGtms API.
    routing_enabled bool
    Start/stop GTM instance. true: Start GTM instance. false: Stop GTM instance.
    gtmId String
    UUID of the GTM instance. You can obtain GtmId via the ListGtms API.
    routingEnabled Boolean
    Start/stop GTM instance. true: Start GTM instance. false: Stop GTM instance.
    gtmId string
    UUID of the GTM instance. You can obtain GtmId via the ListGtms API.
    routingEnabled boolean
    Start/stop GTM instance. true: Start GTM instance. false: Stop GTM instance.
    gtm_id str
    UUID of the GTM instance. You can obtain GtmId via the ListGtms API.
    routing_enabled bool
    Start/stop GTM instance. true: Start GTM instance. false: Stop GTM instance.
    gtmId String
    UUID of the GTM instance. You can obtain GtmId via the ListGtms API.
    routingEnabled Boolean
    Start/stop GTM instance. true: Start GTM instance. false: Stop GTM instance.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    RoutingStatus string
    Indicates the current lifecycle state of the GTM instance. Value description: init: The GTM instance has been successfully created but not yet configured. configuring_address: Basic rule configuration for GTM is complete, but target address configuration is not yet finished. editing: Both basic configuration and target address have been completed, but the instance is not yet enabled. running: The instance is officially enabled.
    Id string
    The provider-assigned unique ID for this managed resource.
    RoutingStatus string
    Indicates the current lifecycle state of the GTM instance. Value description: init: The GTM instance has been successfully created but not yet configured. configuring_address: Basic rule configuration for GTM is complete, but target address configuration is not yet finished. editing: Both basic configuration and target address have been completed, but the instance is not yet enabled. running: The instance is officially enabled.
    id string
    The provider-assigned unique ID for this managed resource.
    routing_status string
    Indicates the current lifecycle state of the GTM instance. Value description: init: The GTM instance has been successfully created but not yet configured. configuring_address: Basic rule configuration for GTM is complete, but target address configuration is not yet finished. editing: Both basic configuration and target address have been completed, but the instance is not yet enabled. running: The instance is officially enabled.
    id String
    The provider-assigned unique ID for this managed resource.
    routingStatus String
    Indicates the current lifecycle state of the GTM instance. Value description: init: The GTM instance has been successfully created but not yet configured. configuring_address: Basic rule configuration for GTM is complete, but target address configuration is not yet finished. editing: Both basic configuration and target address have been completed, but the instance is not yet enabled. running: The instance is officially enabled.
    id string
    The provider-assigned unique ID for this managed resource.
    routingStatus string
    Indicates the current lifecycle state of the GTM instance. Value description: init: The GTM instance has been successfully created but not yet configured. configuring_address: Basic rule configuration for GTM is complete, but target address configuration is not yet finished. editing: Both basic configuration and target address have been completed, but the instance is not yet enabled. running: The instance is officially enabled.
    id str
    The provider-assigned unique ID for this managed resource.
    routing_status str
    Indicates the current lifecycle state of the GTM instance. Value description: init: The GTM instance has been successfully created but not yet configured. configuring_address: Basic rule configuration for GTM is complete, but target address configuration is not yet finished. editing: Both basic configuration and target address have been completed, but the instance is not yet enabled. running: The instance is officially enabled.
    id String
    The provider-assigned unique ID for this managed resource.
    routingStatus String
    Indicates the current lifecycle state of the GTM instance. Value description: init: The GTM instance has been successfully created but not yet configured. configuring_address: Basic rule configuration for GTM is complete, but target address configuration is not yet finished. editing: Both basic configuration and target address have been completed, but the instance is not yet enabled. running: The instance is officially enabled.

    Look up Existing Routing Resource

    Get an existing Routing 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?: RoutingState, opts?: CustomResourceOptions): Routing
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        gtm_id: Optional[str] = None,
        routing_enabled: Optional[bool] = None,
        routing_status: Optional[str] = None) -> Routing
    func GetRouting(ctx *Context, name string, id IDInput, state *RoutingState, opts ...ResourceOption) (*Routing, error)
    public static Routing Get(string name, Input<string> id, RoutingState? state, CustomResourceOptions? opts = null)
    public static Routing get(String name, Output<String> id, RoutingState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:gtm:Routing    get:      id: ${id}
    import {
  to = volcenginecc_gtm_routing.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.
    The following state arguments are supported:
    GtmId string
    UUID of the GTM instance. You can obtain GtmId via the ListGtms API.
    RoutingEnabled bool
    Start/stop GTM instance. true: Start GTM instance. false: Stop GTM instance.
    RoutingStatus string
    Indicates the current lifecycle state of the GTM instance. Value description: init: The GTM instance has been successfully created but not yet configured. configuring_address: Basic rule configuration for GTM is complete, but target address configuration is not yet finished. editing: Both basic configuration and target address have been completed, but the instance is not yet enabled. running: The instance is officially enabled.
    GtmId string
    UUID of the GTM instance. You can obtain GtmId via the ListGtms API.
    RoutingEnabled bool
    Start/stop GTM instance. true: Start GTM instance. false: Stop GTM instance.
    RoutingStatus string
    Indicates the current lifecycle state of the GTM instance. Value description: init: The GTM instance has been successfully created but not yet configured. configuring_address: Basic rule configuration for GTM is complete, but target address configuration is not yet finished. editing: Both basic configuration and target address have been completed, but the instance is not yet enabled. running: The instance is officially enabled.
    gtm_id string
    UUID of the GTM instance. You can obtain GtmId via the ListGtms API.
    routing_enabled bool
    Start/stop GTM instance. true: Start GTM instance. false: Stop GTM instance.
    routing_status string
    Indicates the current lifecycle state of the GTM instance. Value description: init: The GTM instance has been successfully created but not yet configured. configuring_address: Basic rule configuration for GTM is complete, but target address configuration is not yet finished. editing: Both basic configuration and target address have been completed, but the instance is not yet enabled. running: The instance is officially enabled.
    gtmId String
    UUID of the GTM instance. You can obtain GtmId via the ListGtms API.
    routingEnabled Boolean
    Start/stop GTM instance. true: Start GTM instance. false: Stop GTM instance.
    routingStatus String
    Indicates the current lifecycle state of the GTM instance. Value description: init: The GTM instance has been successfully created but not yet configured. configuring_address: Basic rule configuration for GTM is complete, but target address configuration is not yet finished. editing: Both basic configuration and target address have been completed, but the instance is not yet enabled. running: The instance is officially enabled.
    gtmId string
    UUID of the GTM instance. You can obtain GtmId via the ListGtms API.
    routingEnabled boolean
    Start/stop GTM instance. true: Start GTM instance. false: Stop GTM instance.
    routingStatus string
    Indicates the current lifecycle state of the GTM instance. Value description: init: The GTM instance has been successfully created but not yet configured. configuring_address: Basic rule configuration for GTM is complete, but target address configuration is not yet finished. editing: Both basic configuration and target address have been completed, but the instance is not yet enabled. running: The instance is officially enabled.
    gtm_id str
    UUID of the GTM instance. You can obtain GtmId via the ListGtms API.
    routing_enabled bool
    Start/stop GTM instance. true: Start GTM instance. false: Stop GTM instance.
    routing_status str
    Indicates the current lifecycle state of the GTM instance. Value description: init: The GTM instance has been successfully created but not yet configured. configuring_address: Basic rule configuration for GTM is complete, but target address configuration is not yet finished. editing: Both basic configuration and target address have been completed, but the instance is not yet enabled. running: The instance is officially enabled.
    gtmId String
    UUID of the GTM instance. You can obtain GtmId via the ListGtms API.
    routingEnabled Boolean
    Start/stop GTM instance. true: Start GTM instance. false: Stop GTM instance.
    routingStatus String
    Indicates the current lifecycle state of the GTM instance. Value description: init: The GTM instance has been successfully created but not yet configured. configuring_address: Basic rule configuration for GTM is complete, but target address configuration is not yet finished. editing: Both basic configuration and target address have been completed, but the instance is not yet enabled. running: The instance is officially enabled.

    Import

    $ pulumi import volcenginecc:gtm/routing:Routing example "gtm_id"

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

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.43
    published on Monday, Jun 15, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial