@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
283 lines (282 loc) • 9.83 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as volcengine from "@volcengine/pulumi";
*
* const foo = new volcengine.cen.BandwidthPackage("foo", {
* bandwidth: 2,
* billingType: "PrePaid",
* cenBandwidthPackageName: "acc-test-cen-bp",
* description: "acc-test",
* localGeographicRegionSetId: "China",
* peerGeographicRegionSetId: "China",
* period: 1,
* periodUnit: "Month",
* projectName: "default",
* tags: [{
* key: "k1",
* value: "v1",
* }],
* });
* ```
*
* ## Import
*
* CenBandwidthPackage can be imported using the id, e.g.
*
* ```sh
* $ pulumi import volcengine:cen/bandwidthPackage:BandwidthPackage default cbp-4c2zaavbvh5f42****
* ```
*/
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 account ID of the cen bandwidth package.
*/
readonly accountId: pulumi.Output<string>;
/**
* The bandwidth of the cen bandwidth package. Value: 2~10000.
*/
readonly bandwidth: pulumi.Output<number>;
/**
* The billing type of the cen bandwidth package. Only support `PrePaid` and `PayBy95Peak`, default value is `PrePaid`.
*/
readonly billingType: pulumi.Output<string | undefined>;
/**
* The business status of the cen bandwidth package.
*/
readonly businessStatus: pulumi.Output<string>;
/**
* The ID of the cen bandwidth package.
*/
readonly cenBandwidthPackageId: pulumi.Output<string>;
/**
* The name of the cen bandwidth package.
*/
readonly cenBandwidthPackageName: pulumi.Output<string>;
/**
* The cen IDs of the bandwidth package.
*/
readonly cenIds: pulumi.Output<string[]>;
/**
* The create time of the cen bandwidth package.
*/
readonly creationTime: pulumi.Output<string>;
/**
* The deleted time of the cen bandwidth package.
*/
readonly deletedTime: pulumi.Output<string>;
/**
* The description of the cen bandwidth package.
*/
readonly description: pulumi.Output<string>;
/**
* The expired time of the cen bandwidth package.
*/
readonly expiredTime: pulumi.Output<string>;
/**
* The line operator of the cen bandwidth package. Valid value: `ChinaUnicom`, `ChinaTelecom`. This field is only valid when `localGeographicRegionSetId` and `peerGeographicRegionSetId` are different.
*/
readonly lineOperator: pulumi.Output<string | undefined>;
/**
* The local geographic region set id of the cen bandwidth package. Valid value: `China`, `Asia`.
*/
readonly localGeographicRegionSetId: pulumi.Output<string | undefined>;
/**
* The peer geographic region set id of the cen bandwidth package. Valid value: `China`, `Asia`.
*/
readonly peerGeographicRegionSetId: pulumi.Output<string | undefined>;
/**
* The period of the cen bandwidth package. Default value is 1.
*/
readonly period: pulumi.Output<number | undefined>;
/**
* The period unit of the cen bandwidth package. Value: `Month`, `Year`. Default value is `Month`.
*/
readonly periodUnit: pulumi.Output<string | undefined>;
/**
* The ProjectName of the cen bandwidth package.
*/
readonly projectName: pulumi.Output<string>;
/**
* The remain bandwidth of the cen bandwidth package.
*/
readonly remainingBandwidth: pulumi.Output<number>;
/**
* The status of the cen bandwidth package.
*/
readonly status: pulumi.Output<string>;
/**
* Tags.
*/
readonly tags: pulumi.Output<outputs.cen.BandwidthPackageTag[] | undefined>;
/**
* The update time of the cen 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 account ID of the cen bandwidth package.
*/
accountId?: pulumi.Input<string>;
/**
* The bandwidth of the cen bandwidth package. Value: 2~10000.
*/
bandwidth?: pulumi.Input<number>;
/**
* The billing type of the cen bandwidth package. Only support `PrePaid` and `PayBy95Peak`, default value is `PrePaid`.
*/
billingType?: pulumi.Input<string>;
/**
* The business status of the cen bandwidth package.
*/
businessStatus?: pulumi.Input<string>;
/**
* The ID of the cen bandwidth package.
*/
cenBandwidthPackageId?: pulumi.Input<string>;
/**
* The name of the cen bandwidth package.
*/
cenBandwidthPackageName?: pulumi.Input<string>;
/**
* The cen IDs of the bandwidth package.
*/
cenIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The create time of the cen bandwidth package.
*/
creationTime?: pulumi.Input<string>;
/**
* The deleted time of the cen bandwidth package.
*/
deletedTime?: pulumi.Input<string>;
/**
* The description of the cen bandwidth package.
*/
description?: pulumi.Input<string>;
/**
* The expired time of the cen bandwidth package.
*/
expiredTime?: pulumi.Input<string>;
/**
* The line operator of the cen bandwidth package. Valid value: `ChinaUnicom`, `ChinaTelecom`. This field is only valid when `localGeographicRegionSetId` and `peerGeographicRegionSetId` are different.
*/
lineOperator?: pulumi.Input<string>;
/**
* The local geographic region set id of the cen bandwidth package. Valid value: `China`, `Asia`.
*/
localGeographicRegionSetId?: pulumi.Input<string>;
/**
* The peer geographic region set id of the cen bandwidth package. Valid value: `China`, `Asia`.
*/
peerGeographicRegionSetId?: pulumi.Input<string>;
/**
* The period of the cen bandwidth package. Default value is 1.
*/
period?: pulumi.Input<number>;
/**
* The period unit of the cen bandwidth package. Value: `Month`, `Year`. Default value is `Month`.
*/
periodUnit?: pulumi.Input<string>;
/**
* The ProjectName of the cen bandwidth package.
*/
projectName?: pulumi.Input<string>;
/**
* The remain bandwidth of the cen bandwidth package.
*/
remainingBandwidth?: pulumi.Input<number>;
/**
* The status of the cen bandwidth package.
*/
status?: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.cen.BandwidthPackageTag>[]>;
/**
* The update time of the cen bandwidth package.
*/
updateTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a BandwidthPackage resource.
*/
export interface BandwidthPackageArgs {
/**
* The bandwidth of the cen bandwidth package. Value: 2~10000.
*/
bandwidth?: pulumi.Input<number>;
/**
* The billing type of the cen bandwidth package. Only support `PrePaid` and `PayBy95Peak`, default value is `PrePaid`.
*/
billingType?: pulumi.Input<string>;
/**
* The name of the cen bandwidth package.
*/
cenBandwidthPackageName?: pulumi.Input<string>;
/**
* The description of the cen bandwidth package.
*/
description?: pulumi.Input<string>;
/**
* The line operator of the cen bandwidth package. Valid value: `ChinaUnicom`, `ChinaTelecom`. This field is only valid when `localGeographicRegionSetId` and `peerGeographicRegionSetId` are different.
*/
lineOperator?: pulumi.Input<string>;
/**
* The local geographic region set id of the cen bandwidth package. Valid value: `China`, `Asia`.
*/
localGeographicRegionSetId?: pulumi.Input<string>;
/**
* The peer geographic region set id of the cen bandwidth package. Valid value: `China`, `Asia`.
*/
peerGeographicRegionSetId?: pulumi.Input<string>;
/**
* The period of the cen bandwidth package. Default value is 1.
*/
period?: pulumi.Input<number>;
/**
* The period unit of the cen bandwidth package. Value: `Month`, `Year`. Default value is `Month`.
*/
periodUnit?: pulumi.Input<string>;
/**
* The ProjectName of the cen bandwidth package.
*/
projectName?: pulumi.Input<string>;
/**
* Tags.
*/
tags?: pulumi.Input<pulumi.Input<inputs.cen.BandwidthPackageTag>[]>;
}