Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. transit_router
  5. BandwidthPackage
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.transit_router.BandwidthPackage

Explore with Pulumi AI

Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

Provides a resource to manage transit router bandwidth package

Example Usage

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

const foo = new volcengine.transit_router.BandwidthPackage("foo", {
    bandwidth: 2,
    description: "acc-test",
    localGeographicRegionSetId: "China",
    peerGeographicRegionSetId: "China",
    period: 1,
    projectName: "default",
    renewType: "Manual",
    tags: [{
        key: "k1",
        value: "v1",
    }],
    transitRouterBandwidthPackageName: "acc-tf-test",
});
Copy
import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.transit_router.BandwidthPackage("foo",
    bandwidth=2,
    description="acc-test",
    local_geographic_region_set_id="China",
    peer_geographic_region_set_id="China",
    period=1,
    project_name="default",
    renew_type="Manual",
    tags=[volcengine.transit_router.BandwidthPackageTagArgs(
        key="k1",
        value="v1",
    )],
    transit_router_bandwidth_package_name="acc-tf-test")
Copy
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.NewBandwidthPackage(ctx, "foo", &transit_router.BandwidthPackageArgs{
			Bandwidth:                  pulumi.Int(2),
			Description:                pulumi.String("acc-test"),
			LocalGeographicRegionSetId: pulumi.String("China"),
			PeerGeographicRegionSetId:  pulumi.String("China"),
			Period:                     pulumi.Int(1),
			ProjectName:                pulumi.String("default"),
			RenewType:                  pulumi.String("Manual"),
			Tags: transit_router.BandwidthPackageTagArray{
				&transit_router.BandwidthPackageTagArgs{
					Key:   pulumi.String("k1"),
					Value: pulumi.String("v1"),
				},
			},
			TransitRouterBandwidthPackageName: pulumi.String("acc-tf-test"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var foo = new Volcengine.Transit_router.BandwidthPackage("foo", new()
    {
        Bandwidth = 2,
        Description = "acc-test",
        LocalGeographicRegionSetId = "China",
        PeerGeographicRegionSetId = "China",
        Period = 1,
        ProjectName = "default",
        RenewType = "Manual",
        Tags = new[]
        {
            new Volcengine.Transit_router.Inputs.BandwidthPackageTagArgs
            {
                Key = "k1",
                Value = "v1",
            },
        },
        TransitRouterBandwidthPackageName = "acc-tf-test",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.transit_router.BandwidthPackage;
import com.pulumi.volcengine.transit_router.BandwidthPackageArgs;
import com.pulumi.volcengine.transit_router.inputs.BandwidthPackageTagArgs;
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 BandwidthPackage("foo", BandwidthPackageArgs.builder()        
            .bandwidth(2)
            .description("acc-test")
            .localGeographicRegionSetId("China")
            .peerGeographicRegionSetId("China")
            .period(1)
            .projectName("default")
            .renewType("Manual")
            .tags(BandwidthPackageTagArgs.builder()
                .key("k1")
                .value("v1")
                .build())
            .transitRouterBandwidthPackageName("acc-tf-test")
            .build());

    }
}
Copy
resources:
  foo:
    type: volcengine:transit_router:BandwidthPackage
    properties:
      bandwidth: 2
      description: acc-test
      localGeographicRegionSetId: China
      peerGeographicRegionSetId: China
      period: 1
      projectName: default
      renewType: Manual
      tags:
        - key: k1
          value: v1
      transitRouterBandwidthPackageName: acc-tf-test
Copy

Create BandwidthPackage Resource

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

Constructor syntax

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

@overload
def BandwidthPackage(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     bandwidth: Optional[int] = None,
                     description: Optional[str] = None,
                     local_geographic_region_set_id: Optional[str] = None,
                     peer_geographic_region_set_id: Optional[str] = None,
                     period: Optional[int] = None,
                     project_name: Optional[str] = None,
                     remain_renew_times: Optional[int] = None,
                     renew_period: Optional[int] = None,
                     renew_type: Optional[str] = None,
                     tags: Optional[Sequence[BandwidthPackageTagArgs]] = None,
                     transit_router_bandwidth_package_name: Optional[str] = None)
func NewBandwidthPackage(ctx *Context, name string, args *BandwidthPackageArgs, opts ...ResourceOption) (*BandwidthPackage, error)
public BandwidthPackage(string name, BandwidthPackageArgs? args = null, CustomResourceOptions? opts = null)
public BandwidthPackage(String name, BandwidthPackageArgs args)
public BandwidthPackage(String name, BandwidthPackageArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args BandwidthPackageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args BandwidthPackageArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args BandwidthPackageArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args BandwidthPackageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BandwidthPackageArgs
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 examplebandwidthPackageResourceResourceFromTransit_routerbandwidthPackage = new Volcengine.Transit_router.BandwidthPackage("examplebandwidthPackageResourceResourceFromTransit_routerbandwidthPackage", new()
{
    Bandwidth = 0,
    Description = "string",
    LocalGeographicRegionSetId = "string",
    PeerGeographicRegionSetId = "string",
    Period = 0,
    ProjectName = "string",
    RemainRenewTimes = 0,
    RenewPeriod = 0,
    RenewType = "string",
    Tags = new[]
    {
        new Volcengine.Transit_router.Inputs.BandwidthPackageTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    TransitRouterBandwidthPackageName = "string",
});
Copy
example, err := transit_router.NewBandwidthPackage(ctx, "examplebandwidthPackageResourceResourceFromTransit_routerbandwidthPackage", &transit_router.BandwidthPackageArgs{
	Bandwidth:                  pulumi.Int(0),
	Description:                pulumi.String("string"),
	LocalGeographicRegionSetId: pulumi.String("string"),
	PeerGeographicRegionSetId:  pulumi.String("string"),
	Period:                     pulumi.Int(0),
	ProjectName:                pulumi.String("string"),
	RemainRenewTimes:           pulumi.Int(0),
	RenewPeriod:                pulumi.Int(0),
	RenewType:                  pulumi.String("string"),
	Tags: transit_router.BandwidthPackageTagArray{
		&transit_router.BandwidthPackageTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	TransitRouterBandwidthPackageName: pulumi.String("string"),
})
Copy
var examplebandwidthPackageResourceResourceFromTransit_routerbandwidthPackage = new BandwidthPackage("examplebandwidthPackageResourceResourceFromTransit_routerbandwidthPackage", BandwidthPackageArgs.builder()
    .bandwidth(0)
    .description("string")
    .localGeographicRegionSetId("string")
    .peerGeographicRegionSetId("string")
    .period(0)
    .projectName("string")
    .remainRenewTimes(0)
    .renewPeriod(0)
    .renewType("string")
    .tags(BandwidthPackageTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .transitRouterBandwidthPackageName("string")
    .build());
Copy
examplebandwidth_package_resource_resource_from_transit_routerbandwidth_package = volcengine.transit_router.BandwidthPackage("examplebandwidthPackageResourceResourceFromTransit_routerbandwidthPackage",
    bandwidth=0,
    description="string",
    local_geographic_region_set_id="string",
    peer_geographic_region_set_id="string",
    period=0,
    project_name="string",
    remain_renew_times=0,
    renew_period=0,
    renew_type="string",
    tags=[{
        "key": "string",
        "value": "string",
    }],
    transit_router_bandwidth_package_name="string")
Copy
const examplebandwidthPackageResourceResourceFromTransit_routerbandwidthPackage = new volcengine.transit_router.BandwidthPackage("examplebandwidthPackageResourceResourceFromTransit_routerbandwidthPackage", {
    bandwidth: 0,
    description: "string",
    localGeographicRegionSetId: "string",
    peerGeographicRegionSetId: "string",
    period: 0,
    projectName: "string",
    remainRenewTimes: 0,
    renewPeriod: 0,
    renewType: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    transitRouterBandwidthPackageName: "string",
});
Copy
type: volcengine:transit_router:BandwidthPackage
properties:
    bandwidth: 0
    description: string
    localGeographicRegionSetId: string
    peerGeographicRegionSetId: string
    period: 0
    projectName: string
    remainRenewTimes: 0
    renewPeriod: 0
    renewType: string
    tags:
        - key: string
          value: string
    transitRouterBandwidthPackageName: string
Copy

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

Bandwidth int
The bandwidth peak of the transit router bandwidth package. Unit: Mbps. Valid values: 2-10000. Default is 2 Mbps.
Description string
The description of the transit router bandwidth package.
LocalGeographicRegionSetId string
The local geographic region set ID. Valid values: China, Asia. Default is China.
PeerGeographicRegionSetId string
The peer geographic region set ID. Valid values: China, Asia. Default is China.
Period int
The period of the transit router bandwidth package, the valid value range in 1~9 or 12 or 36. Default value is 12. The period unit defaults to Month.The modification of this field only takes effect when the value of the renew_type is Manual.
ProjectName string
The ProjectName of the transit router bandwidth package.
RemainRenewTimes int
The remaining renewal times of of the transit router bandwidth package. Valid values: -1 or 1~100. Default value is -1, means unlimited renewal.This field is only effective when the value of the renew_type is Auto.
RenewPeriod int
The auto renewal period of the transit router bandwidth package. Valid values: 1,2,3,6,12. Default value is 1. Unit: Month.This field is only effective when the value of the renew_type is Auto. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
RenewType string
The renewal type of the transit router bandwidth package. Valid values: Manual, Auto, NoRenew. Default is Manual.This field is only effective when modifying the bandwidth package.
Tags List<BandwidthPackageTag>
Tags.
TransitRouterBandwidthPackageName string
The name of the transit router bandwidth package.
Bandwidth int
The bandwidth peak of the transit router bandwidth package. Unit: Mbps. Valid values: 2-10000. Default is 2 Mbps.
Description string
The description of the transit router bandwidth package.
LocalGeographicRegionSetId string
The local geographic region set ID. Valid values: China, Asia. Default is China.
PeerGeographicRegionSetId string
The peer geographic region set ID. Valid values: China, Asia. Default is China.
Period int
The period of the transit router bandwidth package, the valid value range in 1~9 or 12 or 36. Default value is 12. The period unit defaults to Month.The modification of this field only takes effect when the value of the renew_type is Manual.
ProjectName string
The ProjectName of the transit router bandwidth package.
RemainRenewTimes int
The remaining renewal times of of the transit router bandwidth package. Valid values: -1 or 1~100. Default value is -1, means unlimited renewal.This field is only effective when the value of the renew_type is Auto.
RenewPeriod int
The auto renewal period of the transit router bandwidth package. Valid values: 1,2,3,6,12. Default value is 1. Unit: Month.This field is only effective when the value of the renew_type is Auto. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
RenewType string
The renewal type of the transit router bandwidth package. Valid values: Manual, Auto, NoRenew. Default is Manual.This field is only effective when modifying the bandwidth package.
Tags []BandwidthPackageTagArgs
Tags.
TransitRouterBandwidthPackageName string
The name of the transit router bandwidth package.
bandwidth Integer
The bandwidth peak of the transit router bandwidth package. Unit: Mbps. Valid values: 2-10000. Default is 2 Mbps.
description String
The description of the transit router bandwidth package.
localGeographicRegionSetId String
The local geographic region set ID. Valid values: China, Asia. Default is China.
peerGeographicRegionSetId String
The peer geographic region set ID. Valid values: China, Asia. Default is China.
period Integer
The period of the transit router bandwidth package, the valid value range in 1~9 or 12 or 36. Default value is 12. The period unit defaults to Month.The modification of this field only takes effect when the value of the renew_type is Manual.
projectName String
The ProjectName of the transit router bandwidth package.
remainRenewTimes Integer
The remaining renewal times of of the transit router bandwidth package. Valid values: -1 or 1~100. Default value is -1, means unlimited renewal.This field is only effective when the value of the renew_type is Auto.
renewPeriod Integer
The auto renewal period of the transit router bandwidth package. Valid values: 1,2,3,6,12. Default value is 1. Unit: Month.This field is only effective when the value of the renew_type is Auto. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
renewType String
The renewal type of the transit router bandwidth package. Valid values: Manual, Auto, NoRenew. Default is Manual.This field is only effective when modifying the bandwidth package.
tags List<BandwidthPackageTag>
Tags.
transitRouterBandwidthPackageName String
The name of the transit router bandwidth package.
bandwidth number
The bandwidth peak of the transit router bandwidth package. Unit: Mbps. Valid values: 2-10000. Default is 2 Mbps.
description string
The description of the transit router bandwidth package.
localGeographicRegionSetId string
The local geographic region set ID. Valid values: China, Asia. Default is China.
peerGeographicRegionSetId string
The peer geographic region set ID. Valid values: China, Asia. Default is China.
period number
The period of the transit router bandwidth package, the valid value range in 1~9 or 12 or 36. Default value is 12. The period unit defaults to Month.The modification of this field only takes effect when the value of the renew_type is Manual.
projectName string
The ProjectName of the transit router bandwidth package.
remainRenewTimes number
The remaining renewal times of of the transit router bandwidth package. Valid values: -1 or 1~100. Default value is -1, means unlimited renewal.This field is only effective when the value of the renew_type is Auto.
renewPeriod number
The auto renewal period of the transit router bandwidth package. Valid values: 1,2,3,6,12. Default value is 1. Unit: Month.This field is only effective when the value of the renew_type is Auto. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
renewType string
The renewal type of the transit router bandwidth package. Valid values: Manual, Auto, NoRenew. Default is Manual.This field is only effective when modifying the bandwidth package.
tags BandwidthPackageTag[]
Tags.
transitRouterBandwidthPackageName string
The name of the transit router bandwidth package.
bandwidth int
The bandwidth peak of the transit router bandwidth package. Unit: Mbps. Valid values: 2-10000. Default is 2 Mbps.
description str
The description of the transit router bandwidth package.
local_geographic_region_set_id str
The local geographic region set ID. Valid values: China, Asia. Default is China.
peer_geographic_region_set_id str
The peer geographic region set ID. Valid values: China, Asia. Default is China.
period int
The period of the transit router bandwidth package, the valid value range in 1~9 or 12 or 36. Default value is 12. The period unit defaults to Month.The modification of this field only takes effect when the value of the renew_type is Manual.
project_name str
The ProjectName of the transit router bandwidth package.
remain_renew_times int
The remaining renewal times of of the transit router bandwidth package. Valid values: -1 or 1~100. Default value is -1, means unlimited renewal.This field is only effective when the value of the renew_type is Auto.
renew_period int
The auto renewal period of the transit router bandwidth package. Valid values: 1,2,3,6,12. Default value is 1. Unit: Month.This field is only effective when the value of the renew_type is Auto. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
renew_type str
The renewal type of the transit router bandwidth package. Valid values: Manual, Auto, NoRenew. Default is Manual.This field is only effective when modifying the bandwidth package.
tags Sequence[BandwidthPackageTagArgs]
Tags.
transit_router_bandwidth_package_name str
The name of the transit router bandwidth package.
bandwidth Number
The bandwidth peak of the transit router bandwidth package. Unit: Mbps. Valid values: 2-10000. Default is 2 Mbps.
description String
The description of the transit router bandwidth package.
localGeographicRegionSetId String
The local geographic region set ID. Valid values: China, Asia. Default is China.
peerGeographicRegionSetId String
The peer geographic region set ID. Valid values: China, Asia. Default is China.
period Number
The period of the transit router bandwidth package, the valid value range in 1~9 or 12 or 36. Default value is 12. The period unit defaults to Month.The modification of this field only takes effect when the value of the renew_type is Manual.
projectName String
The ProjectName of the transit router bandwidth package.
remainRenewTimes Number
The remaining renewal times of of the transit router bandwidth package. Valid values: -1 or 1~100. Default value is -1, means unlimited renewal.This field is only effective when the value of the renew_type is Auto.
renewPeriod Number
The auto renewal period of the transit router bandwidth package. Valid values: 1,2,3,6,12. Default value is 1. Unit: Month.This field is only effective when the value of the renew_type is Auto. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
renewType String
The renewal type of the transit router bandwidth package. Valid values: Manual, Auto, NoRenew. Default is Manual.This field is only effective when modifying the bandwidth package.
tags List<Property Map>
Tags.
transitRouterBandwidthPackageName String
The name of the transit router bandwidth package.

Outputs

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

Allocations List<BandwidthPackageAllocation>
The detailed information on cross regional connections associated with bandwidth packets.
BusinessStatus string
The business status of the transit router bandwidth package.
CreationTime string
The create time of the transit router bandwidth package.
DeleteTime string
The delete time of the transit router bandwidth package.
ExpiredTime string
The expired time of the transit router bandwidth package.
Id string
The provider-assigned unique ID for this managed resource.
RemainingBandwidth int
The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
Status string
The status of the transit router bandwidth package.
UpdateTime string
The update time of the transit router bandwidth package.
Allocations []BandwidthPackageAllocation
The detailed information on cross regional connections associated with bandwidth packets.
BusinessStatus string
The business status of the transit router bandwidth package.
CreationTime string
The create time of the transit router bandwidth package.
DeleteTime string
The delete time of the transit router bandwidth package.
ExpiredTime string
The expired time of the transit router bandwidth package.
Id string
The provider-assigned unique ID for this managed resource.
RemainingBandwidth int
The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
Status string
The status of the transit router bandwidth package.
UpdateTime string
The update time of the transit router bandwidth package.
allocations List<BandwidthPackageAllocation>
The detailed information on cross regional connections associated with bandwidth packets.
businessStatus String
The business status of the transit router bandwidth package.
creationTime String
The create time of the transit router bandwidth package.
deleteTime String
The delete time of the transit router bandwidth package.
expiredTime String
The expired time of the transit router bandwidth package.
id String
The provider-assigned unique ID for this managed resource.
remainingBandwidth Integer
The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
status String
The status of the transit router bandwidth package.
updateTime String
The update time of the transit router bandwidth package.
allocations BandwidthPackageAllocation[]
The detailed information on cross regional connections associated with bandwidth packets.
businessStatus string
The business status of the transit router bandwidth package.
creationTime string
The create time of the transit router bandwidth package.
deleteTime string
The delete time of the transit router bandwidth package.
expiredTime string
The expired time of the transit router bandwidth package.
id string
The provider-assigned unique ID for this managed resource.
remainingBandwidth number
The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
status string
The status of the transit router bandwidth package.
updateTime string
The update time of the transit router bandwidth package.
allocations Sequence[BandwidthPackageAllocation]
The detailed information on cross regional connections associated with bandwidth packets.
business_status str
The business status of the transit router bandwidth package.
creation_time str
The create time of the transit router bandwidth package.
delete_time str
The delete time of the transit router bandwidth package.
expired_time str
The expired time of the transit router bandwidth package.
id str
The provider-assigned unique ID for this managed resource.
remaining_bandwidth int
The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
status str
The status of the transit router bandwidth package.
update_time str
The update time of the transit router bandwidth package.
allocations List<Property Map>
The detailed information on cross regional connections associated with bandwidth packets.
businessStatus String
The business status of the transit router bandwidth package.
creationTime String
The create time of the transit router bandwidth package.
deleteTime String
The delete time of the transit router bandwidth package.
expiredTime String
The expired time of the transit router bandwidth package.
id String
The provider-assigned unique ID for this managed resource.
remainingBandwidth Number
The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
status String
The status of the transit router bandwidth package.
updateTime String
The update time of the transit router bandwidth package.

Look up Existing BandwidthPackage Resource

Get an existing BandwidthPackage 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?: BandwidthPackageState, opts?: CustomResourceOptions): BandwidthPackage
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocations: Optional[Sequence[BandwidthPackageAllocationArgs]] = None,
        bandwidth: Optional[int] = None,
        business_status: Optional[str] = None,
        creation_time: Optional[str] = None,
        delete_time: Optional[str] = None,
        description: Optional[str] = None,
        expired_time: Optional[str] = None,
        local_geographic_region_set_id: Optional[str] = None,
        peer_geographic_region_set_id: Optional[str] = None,
        period: Optional[int] = None,
        project_name: Optional[str] = None,
        remain_renew_times: Optional[int] = None,
        remaining_bandwidth: Optional[int] = None,
        renew_period: Optional[int] = None,
        renew_type: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[BandwidthPackageTagArgs]] = None,
        transit_router_bandwidth_package_name: Optional[str] = None,
        update_time: Optional[str] = None) -> BandwidthPackage
func GetBandwidthPackage(ctx *Context, name string, id IDInput, state *BandwidthPackageState, opts ...ResourceOption) (*BandwidthPackage, error)
public static BandwidthPackage Get(string name, Input<string> id, BandwidthPackageState? state, CustomResourceOptions? opts = null)
public static BandwidthPackage get(String name, Output<String> id, BandwidthPackageState state, CustomResourceOptions options)
resources:  _:    type: volcengine:transit_router:BandwidthPackage    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Allocations List<BandwidthPackageAllocation>
The detailed information on cross regional connections associated with bandwidth packets.
Bandwidth int
The bandwidth peak of the transit router bandwidth package. Unit: Mbps. Valid values: 2-10000. Default is 2 Mbps.
BusinessStatus string
The business status of the transit router bandwidth package.
CreationTime string
The create time of the transit router bandwidth package.
DeleteTime string
The delete time of the transit router bandwidth package.
Description string
The description of the transit router bandwidth package.
ExpiredTime string
The expired time of the transit router bandwidth package.
LocalGeographicRegionSetId string
The local geographic region set ID. Valid values: China, Asia. Default is China.
PeerGeographicRegionSetId string
The peer geographic region set ID. Valid values: China, Asia. Default is China.
Period int
The period of the transit router bandwidth package, the valid value range in 1~9 or 12 or 36. Default value is 12. The period unit defaults to Month.The modification of this field only takes effect when the value of the renew_type is Manual.
ProjectName string
The ProjectName of the transit router bandwidth package.
RemainRenewTimes int
The remaining renewal times of of the transit router bandwidth package. Valid values: -1 or 1~100. Default value is -1, means unlimited renewal.This field is only effective when the value of the renew_type is Auto.
RemainingBandwidth int
The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
RenewPeriod int
The auto renewal period of the transit router bandwidth package. Valid values: 1,2,3,6,12. Default value is 1. Unit: Month.This field is only effective when the value of the renew_type is Auto. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
RenewType string
The renewal type of the transit router bandwidth package. Valid values: Manual, Auto, NoRenew. Default is Manual.This field is only effective when modifying the bandwidth package.
Status string
The status of the transit router bandwidth package.
Tags List<BandwidthPackageTag>
Tags.
TransitRouterBandwidthPackageName string
The name of the transit router bandwidth package.
UpdateTime string
The update time of the transit router bandwidth package.
Allocations []BandwidthPackageAllocationArgs
The detailed information on cross regional connections associated with bandwidth packets.
Bandwidth int
The bandwidth peak of the transit router bandwidth package. Unit: Mbps. Valid values: 2-10000. Default is 2 Mbps.
BusinessStatus string
The business status of the transit router bandwidth package.
CreationTime string
The create time of the transit router bandwidth package.
DeleteTime string
The delete time of the transit router bandwidth package.
Description string
The description of the transit router bandwidth package.
ExpiredTime string
The expired time of the transit router bandwidth package.
LocalGeographicRegionSetId string
The local geographic region set ID. Valid values: China, Asia. Default is China.
PeerGeographicRegionSetId string
The peer geographic region set ID. Valid values: China, Asia. Default is China.
Period int
The period of the transit router bandwidth package, the valid value range in 1~9 or 12 or 36. Default value is 12. The period unit defaults to Month.The modification of this field only takes effect when the value of the renew_type is Manual.
ProjectName string
The ProjectName of the transit router bandwidth package.
RemainRenewTimes int
The remaining renewal times of of the transit router bandwidth package. Valid values: -1 or 1~100. Default value is -1, means unlimited renewal.This field is only effective when the value of the renew_type is Auto.
RemainingBandwidth int
The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
RenewPeriod int
The auto renewal period of the transit router bandwidth package. Valid values: 1,2,3,6,12. Default value is 1. Unit: Month.This field is only effective when the value of the renew_type is Auto. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
RenewType string
The renewal type of the transit router bandwidth package. Valid values: Manual, Auto, NoRenew. Default is Manual.This field is only effective when modifying the bandwidth package.
Status string
The status of the transit router bandwidth package.
Tags []BandwidthPackageTagArgs
Tags.
TransitRouterBandwidthPackageName string
The name of the transit router bandwidth package.
UpdateTime string
The update time of the transit router bandwidth package.
allocations List<BandwidthPackageAllocation>
The detailed information on cross regional connections associated with bandwidth packets.
bandwidth Integer
The bandwidth peak of the transit router bandwidth package. Unit: Mbps. Valid values: 2-10000. Default is 2 Mbps.
businessStatus String
The business status of the transit router bandwidth package.
creationTime String
The create time of the transit router bandwidth package.
deleteTime String
The delete time of the transit router bandwidth package.
description String
The description of the transit router bandwidth package.
expiredTime String
The expired time of the transit router bandwidth package.
localGeographicRegionSetId String
The local geographic region set ID. Valid values: China, Asia. Default is China.
peerGeographicRegionSetId String
The peer geographic region set ID. Valid values: China, Asia. Default is China.
period Integer
The period of the transit router bandwidth package, the valid value range in 1~9 or 12 or 36. Default value is 12. The period unit defaults to Month.The modification of this field only takes effect when the value of the renew_type is Manual.
projectName String
The ProjectName of the transit router bandwidth package.
remainRenewTimes Integer
The remaining renewal times of of the transit router bandwidth package. Valid values: -1 or 1~100. Default value is -1, means unlimited renewal.This field is only effective when the value of the renew_type is Auto.
remainingBandwidth Integer
The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
renewPeriod Integer
The auto renewal period of the transit router bandwidth package. Valid values: 1,2,3,6,12. Default value is 1. Unit: Month.This field is only effective when the value of the renew_type is Auto. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
renewType String
The renewal type of the transit router bandwidth package. Valid values: Manual, Auto, NoRenew. Default is Manual.This field is only effective when modifying the bandwidth package.
status String
The status of the transit router bandwidth package.
tags List<BandwidthPackageTag>
Tags.
transitRouterBandwidthPackageName String
The name of the transit router bandwidth package.
updateTime String
The update time of the transit router bandwidth package.
allocations BandwidthPackageAllocation[]
The detailed information on cross regional connections associated with bandwidth packets.
bandwidth number
The bandwidth peak of the transit router bandwidth package. Unit: Mbps. Valid values: 2-10000. Default is 2 Mbps.
businessStatus string
The business status of the transit router bandwidth package.
creationTime string
The create time of the transit router bandwidth package.
deleteTime string
The delete time of the transit router bandwidth package.
description string
The description of the transit router bandwidth package.
expiredTime string
The expired time of the transit router bandwidth package.
localGeographicRegionSetId string
The local geographic region set ID. Valid values: China, Asia. Default is China.
peerGeographicRegionSetId string
The peer geographic region set ID. Valid values: China, Asia. Default is China.
period number
The period of the transit router bandwidth package, the valid value range in 1~9 or 12 or 36. Default value is 12. The period unit defaults to Month.The modification of this field only takes effect when the value of the renew_type is Manual.
projectName string
The ProjectName of the transit router bandwidth package.
remainRenewTimes number
The remaining renewal times of of the transit router bandwidth package. Valid values: -1 or 1~100. Default value is -1, means unlimited renewal.This field is only effective when the value of the renew_type is Auto.
remainingBandwidth number
The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
renewPeriod number
The auto renewal period of the transit router bandwidth package. Valid values: 1,2,3,6,12. Default value is 1. Unit: Month.This field is only effective when the value of the renew_type is Auto. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
renewType string
The renewal type of the transit router bandwidth package. Valid values: Manual, Auto, NoRenew. Default is Manual.This field is only effective when modifying the bandwidth package.
status string
The status of the transit router bandwidth package.
tags BandwidthPackageTag[]
Tags.
transitRouterBandwidthPackageName string
The name of the transit router bandwidth package.
updateTime string
The update time of the transit router bandwidth package.
allocations Sequence[BandwidthPackageAllocationArgs]
The detailed information on cross regional connections associated with bandwidth packets.
bandwidth int
The bandwidth peak of the transit router bandwidth package. Unit: Mbps. Valid values: 2-10000. Default is 2 Mbps.
business_status str
The business status of the transit router bandwidth package.
creation_time str
The create time of the transit router bandwidth package.
delete_time str
The delete time of the transit router bandwidth package.
description str
The description of the transit router bandwidth package.
expired_time str
The expired time of the transit router bandwidth package.
local_geographic_region_set_id str
The local geographic region set ID. Valid values: China, Asia. Default is China.
peer_geographic_region_set_id str
The peer geographic region set ID. Valid values: China, Asia. Default is China.
period int
The period of the transit router bandwidth package, the valid value range in 1~9 or 12 or 36. Default value is 12. The period unit defaults to Month.The modification of this field only takes effect when the value of the renew_type is Manual.
project_name str
The ProjectName of the transit router bandwidth package.
remain_renew_times int
The remaining renewal times of of the transit router bandwidth package. Valid values: -1 or 1~100. Default value is -1, means unlimited renewal.This field is only effective when the value of the renew_type is Auto.
remaining_bandwidth int
The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
renew_period int
The auto renewal period of the transit router bandwidth package. Valid values: 1,2,3,6,12. Default value is 1. Unit: Month.This field is only effective when the value of the renew_type is Auto. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
renew_type str
The renewal type of the transit router bandwidth package. Valid values: Manual, Auto, NoRenew. Default is Manual.This field is only effective when modifying the bandwidth package.
status str
The status of the transit router bandwidth package.
tags Sequence[BandwidthPackageTagArgs]
Tags.
transit_router_bandwidth_package_name str
The name of the transit router bandwidth package.
update_time str
The update time of the transit router bandwidth package.
allocations List<Property Map>
The detailed information on cross regional connections associated with bandwidth packets.
bandwidth Number
The bandwidth peak of the transit router bandwidth package. Unit: Mbps. Valid values: 2-10000. Default is 2 Mbps.
businessStatus String
The business status of the transit router bandwidth package.
creationTime String
The create time of the transit router bandwidth package.
deleteTime String
The delete time of the transit router bandwidth package.
description String
The description of the transit router bandwidth package.
expiredTime String
The expired time of the transit router bandwidth package.
localGeographicRegionSetId String
The local geographic region set ID. Valid values: China, Asia. Default is China.
peerGeographicRegionSetId String
The peer geographic region set ID. Valid values: China, Asia. Default is China.
period Number
The period of the transit router bandwidth package, the valid value range in 1~9 or 12 or 36. Default value is 12. The period unit defaults to Month.The modification of this field only takes effect when the value of the renew_type is Manual.
projectName String
The ProjectName of the transit router bandwidth package.
remainRenewTimes Number
The remaining renewal times of of the transit router bandwidth package. Valid values: -1 or 1~100. Default value is -1, means unlimited renewal.This field is only effective when the value of the renew_type is Auto.
remainingBandwidth Number
The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
renewPeriod Number
The auto renewal period of the transit router bandwidth package. Valid values: 1,2,3,6,12. Default value is 1. Unit: Month.This field is only effective when the value of the renew_type is Auto. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
renewType String
The renewal type of the transit router bandwidth package. Valid values: Manual, Auto, NoRenew. Default is Manual.This field is only effective when modifying the bandwidth package.
status String
The status of the transit router bandwidth package.
tags List<Property Map>
Tags.
transitRouterBandwidthPackageName String
The name of the transit router bandwidth package.
updateTime String
The update time of the transit router bandwidth package.

Supporting Types

BandwidthPackageAllocation
, BandwidthPackageAllocationArgs

AllocateTime string
The delete time of the transit router bandwidth package.
DeleteTime string
The delete time of the transit router bandwidth package.
LocalRegionId string
The local region id of the transit router.
TransitRouterPeerAttachmentId string
The ID of the peer attachment.
AllocateTime string
The delete time of the transit router bandwidth package.
DeleteTime string
The delete time of the transit router bandwidth package.
LocalRegionId string
The local region id of the transit router.
TransitRouterPeerAttachmentId string
The ID of the peer attachment.
allocateTime String
The delete time of the transit router bandwidth package.
deleteTime String
The delete time of the transit router bandwidth package.
localRegionId String
The local region id of the transit router.
transitRouterPeerAttachmentId String
The ID of the peer attachment.
allocateTime string
The delete time of the transit router bandwidth package.
deleteTime string
The delete time of the transit router bandwidth package.
localRegionId string
The local region id of the transit router.
transitRouterPeerAttachmentId string
The ID of the peer attachment.
allocate_time str
The delete time of the transit router bandwidth package.
delete_time str
The delete time of the transit router bandwidth package.
local_region_id str
The local region id of the transit router.
transit_router_peer_attachment_id str
The ID of the peer attachment.
allocateTime String
The delete time of the transit router bandwidth package.
deleteTime String
The delete time of the transit router bandwidth package.
localRegionId String
The local region id of the transit router.
transitRouterPeerAttachmentId String
The ID of the peer attachment.

BandwidthPackageTag
, BandwidthPackageTagArgs

Key This property is required. string
The Key of Tags.
Value This property is required. string
The Value of Tags.
Key This property is required. string
The Key of Tags.
Value This property is required. string
The Value of Tags.
key This property is required. String
The Key of Tags.
value This property is required. String
The Value of Tags.
key This property is required. string
The Key of Tags.
value This property is required. string
The Value of Tags.
key This property is required. str
The Key of Tags.
value This property is required. str
The Value of Tags.
key This property is required. String
The Key of Tags.
value This property is required. String
The Value of Tags.

Import

TransitRouterBandwidthPackage can be imported using the Id, e.g.

$ pulumi import volcengine:transit_router/bandwidthPackage:BandwidthPackage default tbp-cd-2felfww0i6pkw59gp68bq****
Copy

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 v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine