Docs Packages
  1. Packages
  2. Volcengine
  3. API Docs
  4. transit_router
  5. TransitRouter
Volcengine v0.0.24 published on Tuesday, Jun 25, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.transit_router.TransitRouter

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.24 published on Tuesday, Jun 25, 2024 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage transit router

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var foo = new Volcengine.Transit_router.TransitRouter("foo", new()
    {
        Description = "acc-test",
        ProjectName = "default",
        Tags = new[]
        {
            new Volcengine.Transit_router.Inputs.TransitRouterTagArgs
            {
                Key = "k1",
                Value = "v1",
            },
        },
        TransitRouterName = "acc-test-tr",
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := transit_router.NewTransitRouter(ctx, "foo", &transit_router.TransitRouterArgs{
			Description: pulumi.String("acc-test"),
			ProjectName: pulumi.String("default"),
			Tags: transit_router.TransitRouterTagArray{
				&transit_router.TransitRouterTagArgs{
					Key:   pulumi.String("k1"),
					Value: pulumi.String("v1"),
				},
			},
			TransitRouterName: pulumi.String("acc-test-tr"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.transit_router.TransitRouter;
import com.pulumi.volcengine.transit_router.TransitRouterArgs;
import com.pulumi.volcengine.transit_router.inputs.TransitRouterTagArgs;
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 foo = new TransitRouter("foo", TransitRouterArgs.builder()        
            .description("acc-test")
            .projectName("default")
            .tags(TransitRouterTagArgs.builder()
                .key("k1")
                .value("v1")
                .build())
            .transitRouterName("acc-test-tr")
            .build());

    }
}

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.transit_router.TransitRouter("foo",
    description="acc-test",
    project_name="default",
    tags=[volcengine.transit_router.TransitRouterTagArgs(
        key="k1",
        value="v1",
    )],
    transit_router_name="acc-test-tr")

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

const foo = new volcengine.transit_router.TransitRouter("foo", {
    description: "acc-test",
    projectName: "default",
    tags: [{
        key: "k1",
        value: "v1",
    }],
    transitRouterName: "acc-test-tr",
});

    resources:
  foo:
    type: volcengine:transit_router:TransitRouter
    properties:
      description: acc-test
      projectName: default
      tags:
        - key: k1
          value: v1
      transitRouterName: acc-test-tr

    Create TransitRouter Resource

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

    Constructor syntax

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

@overload
def TransitRouter(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  description: Optional[str] = None,
                  project_name: Optional[str] = None,
                  tags: Optional[Sequence[TransitRouterTagArgs]] = None,
                  transit_router_name: Optional[str] = None)
    func NewTransitRouter(ctx *Context, name string, args *TransitRouterArgs, opts ...ResourceOption) (*TransitRouter, error)
    public TransitRouter(string name, TransitRouterArgs? args = null, CustomResourceOptions? opts = null)
    public TransitRouter(String name, TransitRouterArgs args)
public TransitRouter(String name, TransitRouterArgs args, CustomResourceOptions options)

    type: volcengine:transit_router:TransitRouter
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 TransitRouterArgs
    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 TransitRouterArgs
    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 TransitRouterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TransitRouterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TransitRouterArgs
    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 transitRouterResource = new Volcengine.Transit_router.TransitRouter("transitRouterResource", new()
{
    Description = "string",
    ProjectName = "string",
    Tags = new[]
    {
        new Volcengine.Transit_router.Inputs.TransitRouterTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    TransitRouterName = "string",
});

    example, err := transit_router.NewTransitRouter(ctx, "transitRouterResource", &transit_router.TransitRouterArgs{
	Description: pulumi.String("string"),
	ProjectName: pulumi.String("string"),
	Tags: transit_router.TransitRouterTagArray{
		&transit_router.TransitRouterTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	TransitRouterName: pulumi.String("string"),
})

    var transitRouterResource = new TransitRouter("transitRouterResource", TransitRouterArgs.builder()
    .description("string")
    .projectName("string")
    .tags(TransitRouterTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .transitRouterName("string")
    .build());

    transit_router_resource = volcengine.transit_router.TransitRouter("transitRouterResource",
    description="string",
    project_name="string",
    tags=[volcengine.transit_router.TransitRouterTagArgs(
        key="string",
        value="string",
    )],
    transit_router_name="string")

    const transitRouterResource = new volcengine.transit_router.TransitRouter("transitRouterResource", {
    description: "string",
    projectName: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    transitRouterName: "string",
});

    type: volcengine:transit_router:TransitRouter
properties:
    description: string
    projectName: string
    tags:
        - key: string
          value: string
    transitRouterName: string

    TransitRouter Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The TransitRouter resource accepts the following input properties:

    Description string
    The description of the transit router.
    ProjectName string
    The ProjectName of the transit router.
    Tags List<TransitRouterTag>
    Tags.
    TransitRouterName string
    The name of the transit router.
    Description string
    The description of the transit router.
    ProjectName string
    The ProjectName of the transit router.
    Tags []TransitRouterTagArgs
    Tags.
    TransitRouterName string
    The name of the transit router.
    description String
    The description of the transit router.
    projectName String
    The ProjectName of the transit router.
    tags List<TransitRouterTag>
    Tags.
    transitRouterName String
    The name of the transit router.
    description string
    The description of the transit router.
    projectName string
    The ProjectName of the transit router.
    tags TransitRouterTag[]
    Tags.
    transitRouterName string
    The name of the transit router.
    description str
    The description of the transit router.
    project_name str
    The ProjectName of the transit router.
    tags Sequence[TransitRouterTagArgs]
    Tags.
    transit_router_name str
    The name of the transit router.
    description String
    The description of the transit router.
    projectName String
    The ProjectName of the transit router.
    tags List<Property Map>
    Tags.
    transitRouterName String
    The name of the transit router.

    Outputs

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

    AccountId string
    The ID of account.
    BusinessStatus string
    The business status of the transit router.
    CreationTime string
    The create time.
    Id string
    The provider-assigned unique ID for this managed resource.
    OverdueTime string
    The overdue time.
    Status string
    The status of the transit router.
    TransitRouterAttachments List<TransitRouterTransitRouterAttachment>
    The attachments of transit router.
    TransitRouterId string
    The ID of the transit router.
    UpdateTime string
    The update time.
    AccountId string
    The ID of account.
    BusinessStatus string
    The business status of the transit router.
    CreationTime string
    The create time.
    Id string
    The provider-assigned unique ID for this managed resource.
    OverdueTime string
    The overdue time.
    Status string
    The status of the transit router.
    TransitRouterAttachments []TransitRouterTransitRouterAttachment
    The attachments of transit router.
    TransitRouterId string
    The ID of the transit router.
    UpdateTime string
    The update time.
    accountId String
    The ID of account.
    businessStatus String
    The business status of the transit router.
    creationTime String
    The create time.
    id String
    The provider-assigned unique ID for this managed resource.
    overdueTime String
    The overdue time.
    status String
    The status of the transit router.
    transitRouterAttachments List<TransitRouterTransitRouterAttachment>
    The attachments of transit router.
    transitRouterId String
    The ID of the transit router.
    updateTime String
    The update time.
    accountId string
    The ID of account.
    businessStatus string
    The business status of the transit router.
    creationTime string
    The create time.
    id string
    The provider-assigned unique ID for this managed resource.
    overdueTime string
    The overdue time.
    status string
    The status of the transit router.
    transitRouterAttachments TransitRouterTransitRouterAttachment[]
    The attachments of transit router.
    transitRouterId string
    The ID of the transit router.
    updateTime string
    The update time.
    account_id str
    The ID of account.
    business_status str
    The business status of the transit router.
    creation_time str
    The create time.
    id str
    The provider-assigned unique ID for this managed resource.
    overdue_time str
    The overdue time.
    status str
    The status of the transit router.
    transit_router_attachments Sequence[TransitRouterTransitRouterAttachment]
    The attachments of transit router.
    transit_router_id str
    The ID of the transit router.
    update_time str
    The update time.
    accountId String
    The ID of account.
    businessStatus String
    The business status of the transit router.
    creationTime String
    The create time.
    id String
    The provider-assigned unique ID for this managed resource.
    overdueTime String
    The overdue time.
    status String
    The status of the transit router.
    transitRouterAttachments List<Property Map>
    The attachments of transit router.
    transitRouterId String
    The ID of the transit router.
    updateTime String
    The update time.

    Look up Existing TransitRouter Resource

    Get an existing TransitRouter 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?: TransitRouterState, opts?: CustomResourceOptions): TransitRouter
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        business_status: Optional[str] = None,
        creation_time: Optional[str] = None,
        description: Optional[str] = None,
        overdue_time: Optional[str] = None,
        project_name: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[TransitRouterTagArgs]] = None,
        transit_router_attachments: Optional[Sequence[TransitRouterTransitRouterAttachmentArgs]] = None,
        transit_router_id: Optional[str] = None,
        transit_router_name: Optional[str] = None,
        update_time: Optional[str] = None) -> TransitRouter
    func GetTransitRouter(ctx *Context, name string, id IDInput, state *TransitRouterState, opts ...ResourceOption) (*TransitRouter, error)
    public static TransitRouter Get(string name, Input<string> id, TransitRouterState? state, CustomResourceOptions? opts = null)
    public static TransitRouter get(String name, Output<String> id, TransitRouterState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AccountId string
    The ID of account.
    BusinessStatus string
    The business status of the transit router.
    CreationTime string
    The create time.
    Description string
    The description of the transit router.
    OverdueTime string
    The overdue time.
    ProjectName string
    The ProjectName of the transit router.
    Status string
    The status of the transit router.
    Tags List<TransitRouterTag>
    Tags.
    TransitRouterAttachments List<TransitRouterTransitRouterAttachment>
    The attachments of transit router.
    TransitRouterId string
    The ID of the transit router.
    TransitRouterName string
    The name of the transit router.
    UpdateTime string
    The update time.
    AccountId string
    The ID of account.
    BusinessStatus string
    The business status of the transit router.
    CreationTime string
    The create time.
    Description string
    The description of the transit router.
    OverdueTime string
    The overdue time.
    ProjectName string
    The ProjectName of the transit router.
    Status string
    The status of the transit router.
    Tags []TransitRouterTagArgs
    Tags.
    TransitRouterAttachments []TransitRouterTransitRouterAttachmentArgs
    The attachments of transit router.
    TransitRouterId string
    The ID of the transit router.
    TransitRouterName string
    The name of the transit router.
    UpdateTime string
    The update time.
    accountId String
    The ID of account.
    businessStatus String
    The business status of the transit router.
    creationTime String
    The create time.
    description String
    The description of the transit router.
    overdueTime String
    The overdue time.
    projectName String
    The ProjectName of the transit router.
    status String
    The status of the transit router.
    tags List<TransitRouterTag>
    Tags.
    transitRouterAttachments List<TransitRouterTransitRouterAttachment>
    The attachments of transit router.
    transitRouterId String
    The ID of the transit router.
    transitRouterName String
    The name of the transit router.
    updateTime String
    The update time.
    accountId string
    The ID of account.
    businessStatus string
    The business status of the transit router.
    creationTime string
    The create time.
    description string
    The description of the transit router.
    overdueTime string
    The overdue time.
    projectName string
    The ProjectName of the transit router.
    status string
    The status of the transit router.
    tags TransitRouterTag[]
    Tags.
    transitRouterAttachments TransitRouterTransitRouterAttachment[]
    The attachments of transit router.
    transitRouterId string
    The ID of the transit router.
    transitRouterName string
    The name of the transit router.
    updateTime string
    The update time.
    account_id str
    The ID of account.
    business_status str
    The business status of the transit router.
    creation_time str
    The create time.
    description str
    The description of the transit router.
    overdue_time str
    The overdue time.
    project_name str
    The ProjectName of the transit router.
    status str
    The status of the transit router.
    tags Sequence[TransitRouterTagArgs]
    Tags.
    transit_router_attachments Sequence[TransitRouterTransitRouterAttachmentArgs]
    The attachments of transit router.
    transit_router_id str
    The ID of the transit router.
    transit_router_name str
    The name of the transit router.
    update_time str
    The update time.
    accountId String
    The ID of account.
    businessStatus String
    The business status of the transit router.
    creationTime String
    The create time.
    description String
    The description of the transit router.
    overdueTime String
    The overdue time.
    projectName String
    The ProjectName of the transit router.
    status String
    The status of the transit router.
    tags List<Property Map>
    Tags.
    transitRouterAttachments List<Property Map>
    The attachments of transit router.
    transitRouterId String
    The ID of the transit router.
    transitRouterName String
    The name of the transit router.
    updateTime String
    The update time.

    Supporting Types

    TransitRouterTag, TransitRouterTagArgs

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    TransitRouterTransitRouterAttachment, TransitRouterTransitRouterAttachmentArgs

    CreationTime string
    The create time.
    ResourceId string
    The id of resource.
    ResourceType string
    The type of resource.
    Status string
    The status of the transit router.
    TransitRouterAttachmentId string
    The id of transit router attachment.
    TransitRouterAttachmentName string
    The name of transit router attachment.
    TransitRouterRouteTableId string
    The id of transit router route table.
    UpdateTime string
    The update time.
    CreationTime string
    The create time.
    ResourceId string
    The id of resource.
    ResourceType string
    The type of resource.
    Status string
    The status of the transit router.
    TransitRouterAttachmentId string
    The id of transit router attachment.
    TransitRouterAttachmentName string
    The name of transit router attachment.
    TransitRouterRouteTableId string
    The id of transit router route table.
    UpdateTime string
    The update time.
    creationTime String
    The create time.
    resourceId String
    The id of resource.
    resourceType String
    The type of resource.
    status String
    The status of the transit router.
    transitRouterAttachmentId String
    The id of transit router attachment.
    transitRouterAttachmentName String
    The name of transit router attachment.
    transitRouterRouteTableId String
    The id of transit router route table.
    updateTime String
    The update time.
    creationTime string
    The create time.
    resourceId string
    The id of resource.
    resourceType string
    The type of resource.
    status string
    The status of the transit router.
    transitRouterAttachmentId string
    The id of transit router attachment.
    transitRouterAttachmentName string
    The name of transit router attachment.
    transitRouterRouteTableId string
    The id of transit router route table.
    updateTime string
    The update time.
    creation_time str
    The create time.
    resource_id str
    The id of resource.
    resource_type str
    The type of resource.
    status str
    The status of the transit router.
    transit_router_attachment_id str
    The id of transit router attachment.
    transit_router_attachment_name str
    The name of transit router attachment.
    transit_router_route_table_id str
    The id of transit router route table.
    update_time str
    The update time.
    creationTime String
    The create time.
    resourceId String
    The id of resource.
    resourceType String
    The type of resource.
    status String
    The status of the transit router.
    transitRouterAttachmentId String
    The id of transit router attachment.
    transitRouterAttachmentName String
    The name of transit router attachment.
    transitRouterRouteTableId String
    The id of transit router route table.
    updateTime String
    The update time.

    Import

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

     $ pulumi import volcengine:transit_router/transitRouter:TransitRouter default tr-2d6fr7mzya2gw58ozfes5g2oh

    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.24 published on Tuesday, Jun 25, 2024 by Volcengine
    volcengine/pulumi-volcengine