UNPKG

@volcengine/pulumi

Version:

A Pulumi package for creating and managing volcengine cloud resources.

186 lines (185 loc) 5.93 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Use this data source to query detailed information of bandwidth packages * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as volcengine from "@pulumi/volcengine"; * import * as volcengine from "@volcengine/pulumi"; * * const fooBandwidthPackage: volcengine.bandwidth_package.BandwidthPackage[] = []; * for (const range = {value: 0}; range.value < 2; range.value++) { * fooBandwidthPackage.push(new volcengine.bandwidth_package.BandwidthPackage(`fooBandwidthPackage-${range.value}`, { * bandwidthPackageName: "acc-test-bp", * billingType: "PostPaidByBandwidth", * isp: "BGP", * description: "acc-test", * bandwidth: 2, * protocol: "IPv4", * securityProtectionTypes: ["AntiDDoS_Enhanced"], * tags: [{ * key: "k1", * value: "v1", * }], * })); * } * const fooBandwidthPackages = volcengine.bandwidth_package.getBandwidthPackagesOutput({ * ids: fooBandwidthPackage.map(__item => __item.id), * }); * ``` */ export declare function getBandwidthPackages(args?: GetBandwidthPackagesArgs, opts?: pulumi.InvokeOptions): Promise<GetBandwidthPackagesResult>; /** * A collection of arguments for invoking getBandwidthPackages. */ export interface GetBandwidthPackagesArgs { /** * Shared bandwidth package name to be queried. */ bandwidthPackageName?: string; /** * Shared bandwidth package instance ID to be queried. */ ids?: string[]; /** * Line types for shared bandwidth packages. */ isp?: string; /** * A Name Regex of Resource. */ nameRegex?: string; /** * File name where to save data source results. */ outputFile?: string; /** * The project name of the bandwidth package to be queried. */ projectName?: string; /** * The IP protocol values for shared bandwidth packages are as follows: `IPv4`: IPv4 protocol. `IPv6`: IPv6 protocol. */ protocol?: string; /** * Security protection types for shared bandwidth packages. */ securityProtectionEnabled?: boolean; /** * A list of tags. */ tagFilters?: inputs.bandwidth_package.GetBandwidthPackagesTagFilter[]; } /** * A collection of values returned by getBandwidthPackages. */ export interface GetBandwidthPackagesResult { /** * The name of the bandwidth package. */ readonly bandwidthPackageName?: string; /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; readonly ids?: string[]; /** * The line type. */ readonly isp?: string; readonly nameRegex?: string; readonly outputFile?: string; /** * The collection of query. */ readonly packages: outputs.bandwidth_package.GetBandwidthPackagesPackage[]; /** * The project name of the bandwidth package. */ readonly projectName?: string; /** * The protocol of the bandwidth package. */ readonly protocol?: string; readonly securityProtectionEnabled?: boolean; readonly tagFilters?: outputs.bandwidth_package.GetBandwidthPackagesTagFilter[]; /** * The total count of query. */ readonly totalCount: number; } /** * Use this data source to query detailed information of bandwidth packages * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as volcengine from "@pulumi/volcengine"; * import * as volcengine from "@volcengine/pulumi"; * * const fooBandwidthPackage: volcengine.bandwidth_package.BandwidthPackage[] = []; * for (const range = {value: 0}; range.value < 2; range.value++) { * fooBandwidthPackage.push(new volcengine.bandwidth_package.BandwidthPackage(`fooBandwidthPackage-${range.value}`, { * bandwidthPackageName: "acc-test-bp", * billingType: "PostPaidByBandwidth", * isp: "BGP", * description: "acc-test", * bandwidth: 2, * protocol: "IPv4", * securityProtectionTypes: ["AntiDDoS_Enhanced"], * tags: [{ * key: "k1", * value: "v1", * }], * })); * } * const fooBandwidthPackages = volcengine.bandwidth_package.getBandwidthPackagesOutput({ * ids: fooBandwidthPackage.map(__item => __item.id), * }); * ``` */ export declare function getBandwidthPackagesOutput(args?: GetBandwidthPackagesOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetBandwidthPackagesResult>; /** * A collection of arguments for invoking getBandwidthPackages. */ export interface GetBandwidthPackagesOutputArgs { /** * Shared bandwidth package name to be queried. */ bandwidthPackageName?: pulumi.Input<string>; /** * Shared bandwidth package instance ID to be queried. */ ids?: pulumi.Input<pulumi.Input<string>[]>; /** * Line types for shared bandwidth packages. */ isp?: pulumi.Input<string>; /** * A Name Regex of Resource. */ nameRegex?: pulumi.Input<string>; /** * File name where to save data source results. */ outputFile?: pulumi.Input<string>; /** * The project name of the bandwidth package to be queried. */ projectName?: pulumi.Input<string>; /** * The IP protocol values for shared bandwidth packages are as follows: `IPv4`: IPv4 protocol. `IPv6`: IPv6 protocol. */ protocol?: pulumi.Input<string>; /** * Security protection types for shared bandwidth packages. */ securityProtectionEnabled?: pulumi.Input<boolean>; /** * A list of tags. */ tagFilters?: pulumi.Input<pulumi.Input<inputs.bandwidth_package.GetBandwidthPackagesTagFilterArgs>[]>; }