volcengine.transit_router.BandwidthPackage
Explore with Pulumi AI
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",
});
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")
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
})
}
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",
});
});
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());
}
}
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
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 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 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 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 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 String
- The unique name of the resource.
- args 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",
});
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"),
})
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());
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")
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",
});
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
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.
- Local
Geographic stringRegion Set Id - The local geographic region set ID. Valid values:
China
,Asia
. Default is China. - Peer
Geographic stringRegion Set Id - 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 therenew_type
isManual
. - Project
Name string - The ProjectName of the transit router bandwidth package.
- Remain
Renew intTimes - 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
isAuto
. - 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
isAuto
. 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 string - The renewal type of the transit router bandwidth package. Valid values:
Manual
,Auto
,NoRenew
. Default isManual
.This field is only effective when modifying the bandwidth package. - List<Bandwidth
Package Tag> - Tags.
- Transit
Router stringBandwidth Package Name - 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.
- Local
Geographic stringRegion Set Id - The local geographic region set ID. Valid values:
China
,Asia
. Default is China. - Peer
Geographic stringRegion Set Id - 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 therenew_type
isManual
. - Project
Name string - The ProjectName of the transit router bandwidth package.
- Remain
Renew intTimes - 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
isAuto
. - 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
isAuto
. 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 string - The renewal type of the transit router bandwidth package. Valid values:
Manual
,Auto
,NoRenew
. Default isManual
.This field is only effective when modifying the bandwidth package. - []Bandwidth
Package Tag Args - Tags.
- Transit
Router stringBandwidth Package Name - 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.
- local
Geographic StringRegion Set Id - The local geographic region set ID. Valid values:
China
,Asia
. Default is China. - peer
Geographic StringRegion Set Id - 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 therenew_type
isManual
. - project
Name String - The ProjectName of the transit router bandwidth package.
- remain
Renew IntegerTimes - 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
isAuto
. - renew
Period 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
isAuto
. 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 String - The renewal type of the transit router bandwidth package. Valid values:
Manual
,Auto
,NoRenew
. Default isManual
.This field is only effective when modifying the bandwidth package. - List<Bandwidth
Package Tag> - Tags.
- transit
Router StringBandwidth Package Name - 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.
- local
Geographic stringRegion Set Id - The local geographic region set ID. Valid values:
China
,Asia
. Default is China. - peer
Geographic stringRegion Set Id - 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 therenew_type
isManual
. - project
Name string - The ProjectName of the transit router bandwidth package.
- remain
Renew numberTimes - 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
isAuto
. - renew
Period 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
isAuto
. 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 string - The renewal type of the transit router bandwidth package. Valid values:
Manual
,Auto
,NoRenew
. Default isManual
.This field is only effective when modifying the bandwidth package. - Bandwidth
Package Tag[] - Tags.
- transit
Router stringBandwidth Package Name - 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_ strregion_ set_ id - The local geographic region set ID. Valid values:
China
,Asia
. Default is China. - peer_
geographic_ strregion_ set_ id - 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 therenew_type
isManual
. - project_
name str - The ProjectName of the transit router bandwidth package.
- remain_
renew_ inttimes - 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
isAuto
. - 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
isAuto
. 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 isManual
.This field is only effective when modifying the bandwidth package. - Sequence[Bandwidth
Package Tag Args] - Tags.
- transit_
router_ strbandwidth_ package_ name - 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.
- local
Geographic StringRegion Set Id - The local geographic region set ID. Valid values:
China
,Asia
. Default is China. - peer
Geographic StringRegion Set Id - 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 therenew_type
isManual
. - project
Name String - The ProjectName of the transit router bandwidth package.
- remain
Renew NumberTimes - 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
isAuto
. - renew
Period 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
isAuto
. 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 String - The renewal type of the transit router bandwidth package. Valid values:
Manual
,Auto
,NoRenew
. Default isManual
.This field is only effective when modifying the bandwidth package. - List<Property Map>
- Tags.
- transit
Router StringBandwidth Package Name - 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<Bandwidth
Package Allocation> - The detailed information on cross regional connections associated with bandwidth packets.
- Business
Status string - The business status of the transit router bandwidth package.
- Creation
Time string - The create time of the transit router bandwidth package.
- Delete
Time string - The delete time of the transit router bandwidth package.
- Expired
Time string - The expired time of the transit router bandwidth package.
- Id string
- The provider-assigned unique ID for this managed resource.
- Remaining
Bandwidth int - The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
- Status string
- The status of the transit router bandwidth package.
- Update
Time string - The update time of the transit router bandwidth package.
- Allocations
[]Bandwidth
Package Allocation - The detailed information on cross regional connections associated with bandwidth packets.
- Business
Status string - The business status of the transit router bandwidth package.
- Creation
Time string - The create time of the transit router bandwidth package.
- Delete
Time string - The delete time of the transit router bandwidth package.
- Expired
Time string - The expired time of the transit router bandwidth package.
- Id string
- The provider-assigned unique ID for this managed resource.
- Remaining
Bandwidth int - The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
- Status string
- The status of the transit router bandwidth package.
- Update
Time string - The update time of the transit router bandwidth package.
- allocations
List<Bandwidth
Package Allocation> - The detailed information on cross regional connections associated with bandwidth packets.
- business
Status String - The business status of the transit router bandwidth package.
- creation
Time String - The create time of the transit router bandwidth package.
- delete
Time String - The delete time of the transit router bandwidth package.
- expired
Time String - The expired time of the transit router bandwidth package.
- id String
- The provider-assigned unique ID for this managed resource.
- remaining
Bandwidth Integer - The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
- status String
- The status of the transit router bandwidth package.
- update
Time String - The update time of the transit router bandwidth package.
- allocations
Bandwidth
Package Allocation[] - The detailed information on cross regional connections associated with bandwidth packets.
- business
Status string - The business status of the transit router bandwidth package.
- creation
Time string - The create time of the transit router bandwidth package.
- delete
Time string - The delete time of the transit router bandwidth package.
- expired
Time string - The expired time of the transit router bandwidth package.
- id string
- The provider-assigned unique ID for this managed resource.
- remaining
Bandwidth number - The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
- status string
- The status of the transit router bandwidth package.
- update
Time string - The update time of the transit router bandwidth package.
- allocations
Sequence[Bandwidth
Package Allocation] - 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.
- business
Status String - The business status of the transit router bandwidth package.
- creation
Time String - The create time of the transit router bandwidth package.
- delete
Time String - The delete time of the transit router bandwidth package.
- expired
Time String - The expired time of the transit router bandwidth package.
- id String
- The provider-assigned unique ID for this managed resource.
- remaining
Bandwidth Number - The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
- status String
- The status of the transit router bandwidth package.
- update
Time 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)
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.
- Allocations
List<Bandwidth
Package Allocation> - 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 string - The business status of the transit router bandwidth package.
- Creation
Time string - The create time of the transit router bandwidth package.
- Delete
Time string - The delete time of the transit router bandwidth package.
- Description string
- The description of the transit router bandwidth package.
- Expired
Time string - The expired time of the transit router bandwidth package.
- Local
Geographic stringRegion Set Id - The local geographic region set ID. Valid values:
China
,Asia
. Default is China. - Peer
Geographic stringRegion Set Id - 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 therenew_type
isManual
. - Project
Name string - The ProjectName of the transit router bandwidth package.
- Remain
Renew intTimes - 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
isAuto
. - 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
isAuto
. 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 string - The renewal type of the transit router bandwidth package. Valid values:
Manual
,Auto
,NoRenew
. Default isManual
.This field is only effective when modifying the bandwidth package. - Status string
- The status of the transit router bandwidth package.
- List<Bandwidth
Package Tag> - Tags.
- Transit
Router stringBandwidth Package Name - The name of the transit router bandwidth package.
- Update
Time string - The update time of the transit router bandwidth package.
- Allocations
[]Bandwidth
Package Allocation Args - 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 string - The business status of the transit router bandwidth package.
- Creation
Time string - The create time of the transit router bandwidth package.
- Delete
Time string - The delete time of the transit router bandwidth package.
- Description string
- The description of the transit router bandwidth package.
- Expired
Time string - The expired time of the transit router bandwidth package.
- Local
Geographic stringRegion Set Id - The local geographic region set ID. Valid values:
China
,Asia
. Default is China. - Peer
Geographic stringRegion Set Id - 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 therenew_type
isManual
. - Project
Name string - The ProjectName of the transit router bandwidth package.
- Remain
Renew intTimes - 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
isAuto
. - 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
isAuto
. 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 string - The renewal type of the transit router bandwidth package. Valid values:
Manual
,Auto
,NoRenew
. Default isManual
.This field is only effective when modifying the bandwidth package. - Status string
- The status of the transit router bandwidth package.
- []Bandwidth
Package Tag Args - Tags.
- Transit
Router stringBandwidth Package Name - The name of the transit router bandwidth package.
- Update
Time string - The update time of the transit router bandwidth package.
- allocations
List<Bandwidth
Package Allocation> - 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.
- business
Status String - The business status of the transit router bandwidth package.
- creation
Time String - The create time of the transit router bandwidth package.
- delete
Time String - The delete time of the transit router bandwidth package.
- description String
- The description of the transit router bandwidth package.
- expired
Time String - The expired time of the transit router bandwidth package.
- local
Geographic StringRegion Set Id - The local geographic region set ID. Valid values:
China
,Asia
. Default is China. - peer
Geographic StringRegion Set Id - 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 therenew_type
isManual
. - project
Name String - The ProjectName of the transit router bandwidth package.
- remain
Renew IntegerTimes - 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
isAuto
. - remaining
Bandwidth Integer - The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
- renew
Period 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
isAuto
. 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 String - The renewal type of the transit router bandwidth package. Valid values:
Manual
,Auto
,NoRenew
. Default isManual
.This field is only effective when modifying the bandwidth package. - status String
- The status of the transit router bandwidth package.
- List<Bandwidth
Package Tag> - Tags.
- transit
Router StringBandwidth Package Name - The name of the transit router bandwidth package.
- update
Time String - The update time of the transit router bandwidth package.
- allocations
Bandwidth
Package Allocation[] - 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.
- business
Status string - The business status of the transit router bandwidth package.
- creation
Time string - The create time of the transit router bandwidth package.
- delete
Time string - The delete time of the transit router bandwidth package.
- description string
- The description of the transit router bandwidth package.
- expired
Time string - The expired time of the transit router bandwidth package.
- local
Geographic stringRegion Set Id - The local geographic region set ID. Valid values:
China
,Asia
. Default is China. - peer
Geographic stringRegion Set Id - 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 therenew_type
isManual
. - project
Name string - The ProjectName of the transit router bandwidth package.
- remain
Renew numberTimes - 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
isAuto
. - remaining
Bandwidth number - The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
- renew
Period 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
isAuto
. 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 string - The renewal type of the transit router bandwidth package. Valid values:
Manual
,Auto
,NoRenew
. Default isManual
.This field is only effective when modifying the bandwidth package. - status string
- The status of the transit router bandwidth package.
- Bandwidth
Package Tag[] - Tags.
- transit
Router stringBandwidth Package Name - The name of the transit router bandwidth package.
- update
Time string - The update time of the transit router bandwidth package.
- allocations
Sequence[Bandwidth
Package Allocation Args] - 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_ strregion_ set_ id - The local geographic region set ID. Valid values:
China
,Asia
. Default is China. - peer_
geographic_ strregion_ set_ id - 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 therenew_type
isManual
. - project_
name str - The ProjectName of the transit router bandwidth package.
- remain_
renew_ inttimes - 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
isAuto
. - 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
isAuto
. 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 isManual
.This field is only effective when modifying the bandwidth package. - status str
- The status of the transit router bandwidth package.
- Sequence[Bandwidth
Package Tag Args] - Tags.
- transit_
router_ strbandwidth_ package_ name - 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.
- business
Status String - The business status of the transit router bandwidth package.
- creation
Time String - The create time of the transit router bandwidth package.
- delete
Time String - The delete time of the transit router bandwidth package.
- description String
- The description of the transit router bandwidth package.
- expired
Time String - The expired time of the transit router bandwidth package.
- local
Geographic StringRegion Set Id - The local geographic region set ID. Valid values:
China
,Asia
. Default is China. - peer
Geographic StringRegion Set Id - 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 therenew_type
isManual
. - project
Name String - The ProjectName of the transit router bandwidth package.
- remain
Renew NumberTimes - 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
isAuto
. - remaining
Bandwidth Number - The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
- renew
Period 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
isAuto
. 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 String - The renewal type of the transit router bandwidth package. Valid values:
Manual
,Auto
,NoRenew
. Default isManual
.This field is only effective when modifying the bandwidth package. - status String
- The status of the transit router bandwidth package.
- List<Property Map>
- Tags.
- transit
Router StringBandwidth Package Name - The name of the transit router bandwidth package.
- update
Time String - The update time of the transit router bandwidth package.
Supporting Types
BandwidthPackageAllocation, BandwidthPackageAllocationArgs
- Allocate
Time string - The delete time of the transit router bandwidth package.
- Delete
Time string - The delete time of the transit router bandwidth package.
- Local
Region stringId - The local region id of the transit router.
- Transit
Router stringPeer Attachment Id - The ID of the peer attachment.
- Allocate
Time string - The delete time of the transit router bandwidth package.
- Delete
Time string - The delete time of the transit router bandwidth package.
- Local
Region stringId - The local region id of the transit router.
- Transit
Router stringPeer Attachment Id - The ID of the peer attachment.
- allocate
Time String - The delete time of the transit router bandwidth package.
- delete
Time String - The delete time of the transit router bandwidth package.
- local
Region StringId - The local region id of the transit router.
- transit
Router StringPeer Attachment Id - The ID of the peer attachment.
- allocate
Time string - The delete time of the transit router bandwidth package.
- delete
Time string - The delete time of the transit router bandwidth package.
- local
Region stringId - The local region id of the transit router.
- transit
Router stringPeer Attachment Id - 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_ strid - The local region id of the transit router.
- transit_
router_ strpeer_ attachment_ id - The ID of the peer attachment.
- allocate
Time String - The delete time of the transit router bandwidth package.
- delete
Time String - The delete time of the transit router bandwidth package.
- local
Region StringId - The local region id of the transit router.
- transit
Router StringPeer Attachment Id - The ID of the peer attachment.
BandwidthPackageTag, BandwidthPackageTagArgs
Import
TransitRouterBandwidthPackage can be imported using the Id, e.g.
$ pulumi import volcengine:transit_router/bandwidthPackage:BandwidthPackage default tbp-cd-2felfww0i6pkw59gp68bq****
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.