@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
267 lines (266 loc) • 11.7 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a resource to manage transit router bandwidth package
* ## Example Usage
*
* ```typescript
* 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
*
* TransitRouterBandwidthPackage can be imported using the Id, e.g.
*
* ```sh
* $ pulumi import volcengine:transit_router/bandwidthPackage:BandwidthPackage default tbp-cd-2felfww0i6pkw59gp68bq****
* ```
*/
export declare class BandwidthPackage extends pulumi.CustomResource {
/**
* Get an existing BandwidthPackage resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BandwidthPackageState, opts?: pulumi.CustomResourceOptions): BandwidthPackage;
/**
* Returns true if the given object is an instance of BandwidthPackage. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is BandwidthPackage;
/**
* The detailed information on cross regional connections associated with bandwidth packets.
*/
readonly allocations: pulumi.Output<outputs.transit_router.BandwidthPackageAllocation[]>;
/**
* The bandwidth peak of the transit router bandwidth package. Unit: Mbps. Valid values: 2-10000. Default is 2 Mbps.
*/
readonly bandwidth: pulumi.Output<number | undefined>;
/**
* The business status of the transit router bandwidth package.
*/
readonly businessStatus: pulumi.Output<string>;
/**
* The create time of the transit router bandwidth package.
*/
readonly creationTime: pulumi.Output<string>;
/**
* The delete time of the transit router bandwidth package.
*/
readonly deleteTime: pulumi.Output<string>;
/**
* The description of the transit router bandwidth package.
*/
readonly description: pulumi.Output<string>;
/**
* The expired time of the transit router bandwidth package.
*/
readonly expiredTime: pulumi.Output<string>;
/**
* The local geographic region set ID. Valid values: `China`, `Asia`. Default is China.
*/
readonly localGeographicRegionSetId: pulumi.Output<string | undefined>;
/**
* The peer geographic region set ID. Valid values: `China`, `Asia`. Default is China.
*/
readonly peerGeographicRegionSetId: pulumi.Output<string | undefined>;
/**
* 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 `renewType` is `Manual`.
*/
readonly period: pulumi.Output<number | undefined>;
/**
* The ProjectName of the transit router bandwidth package.
*/
readonly projectName: pulumi.Output<string>;
/**
* 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 `renewType` is `Auto`.
*/
readonly remainRenewTimes: pulumi.Output<number | undefined>;
/**
* The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
*/
readonly remainingBandwidth: pulumi.Output<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 `renewType` is `Auto`. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
readonly renewPeriod: pulumi.Output<number | undefined>;
/**
* 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.
*/
readonly renewType: pulumi.Output<string | undefined>;
/**
* The status of the transit router bandwidth package.
*/
readonly status: pulumi.Output<string>;
/**
* Tags.
*/
readonly tags: pulumi.Output<outputs.transit_router.BandwidthPackageTag[] | undefined>;
/**
* The name of the transit router bandwidth package.
*/
readonly transitRouterBandwidthPackageName: pulumi.Output<string>;
/**
* The update time of the transit router bandwidth package.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a BandwidthPackage resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: BandwidthPackageArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering BandwidthPackage resources.
*/
export interface BandwidthPackageState {
/**
* The detailed information on cross regional connections associated with bandwidth packets.
*/
allocations?: pulumi.Input<pulumi.Input<inputs.transit_router.BandwidthPackageAllocation>[]>;
/**
* The bandwidth peak of the transit router bandwidth package. Unit: Mbps. Valid values: 2-10000. Default is 2 Mbps.
*/
bandwidth?: pulumi.Input<number>;
/**
* The business status of the transit router bandwidth package.
*/
businessStatus?: pulumi.Input<string>;
/**
* The create time of the transit router bandwidth package.
*/
creationTime?: pulumi.Input<string>;
/**
* The delete time of the transit router bandwidth package.
*/
deleteTime?: pulumi.Input<string>;
/**
* The description of the transit router bandwidth package.
*/
description?: pulumi.Input<string>;
/**
* The expired time of the transit router bandwidth package.
*/
expiredTime?: pulumi.Input<string>;
/**
* The local geographic region set ID. Valid values: `China`, `Asia`. Default is China.
*/
localGeographicRegionSetId?: pulumi.Input<string>;
/**
* The peer geographic region set ID. Valid values: `China`, `Asia`. Default is China.
*/
peerGeographicRegionSetId?: pulumi.Input<string>;
/**
* 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 `renewType` is `Manual`.
*/
period?: pulumi.Input<number>;
/**
* The ProjectName of the transit router bandwidth package.
*/
projectName?: pulumi.Input<string>;
/**
* 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 `renewType` is `Auto`.
*/
remainRenewTimes?: pulumi.Input<number>;
/**
* The remaining bandwidth of the transit router bandwidth package. Unit: Mbps.
*/
remainingBandwidth?: pulumi.Input<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 `renewType` is `Auto`. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
renewPeriod?: pulumi.Input<number>;
/**
* 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.
*/
renewType?: pulumi.Input<string>;
/**
* The status of the transit router bandwidth package.
*/
status?: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.transit_router.BandwidthPackageTag>[]>;
/**
* The name of the transit router bandwidth package.
*/
transitRouterBandwidthPackageName?: pulumi.Input<string>;
/**
* The update time of the transit router bandwidth package.
*/
updateTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a BandwidthPackage resource.
*/
export interface BandwidthPackageArgs {
/**
* The bandwidth peak of the transit router bandwidth package. Unit: Mbps. Valid values: 2-10000. Default is 2 Mbps.
*/
bandwidth?: pulumi.Input<number>;
/**
* The description of the transit router bandwidth package.
*/
description?: pulumi.Input<string>;
/**
* The local geographic region set ID. Valid values: `China`, `Asia`. Default is China.
*/
localGeographicRegionSetId?: pulumi.Input<string>;
/**
* The peer geographic region set ID. Valid values: `China`, `Asia`. Default is China.
*/
peerGeographicRegionSetId?: pulumi.Input<string>;
/**
* 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 `renewType` is `Manual`.
*/
period?: pulumi.Input<number>;
/**
* The ProjectName of the transit router bandwidth package.
*/
projectName?: pulumi.Input<string>;
/**
* 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 `renewType` is `Auto`.
*/
remainRenewTimes?: pulumi.Input<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 `renewType` is `Auto`. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignoreChanges ignore changes in fields.
*/
renewPeriod?: pulumi.Input<number>;
/**
* 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.
*/
renewType?: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.transit_router.BandwidthPackageTag>[]>;
/**
* The name of the transit router bandwidth package.
*/
transitRouterBandwidthPackageName?: pulumi.Input<string>;
}