@huaweicloudos/pulumi/eip/getBandwidth.d.ts

A Pulumi package for creating and managing Huaweicloud cloud resources.

import * as pulumi from "@pulumi/pulumi";
import { output as outputs } from "../types";
/**
 * Provides details about a specific bandwidth.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as huaweicloud from "@pulumi/huaweicloud";
 *
 * const config = new pulumi.Config();
 * const bandwidthName = config.requireObject("bandwidthName");
 * const bandwidth1 = huaweicloud.Eip.getBandwidth({
 *     name: bandwidthName,
 * });
 * ```
 */
export declare function getBandwidth(args: GetBandwidthArgs, opts?: pulumi.InvokeOptions): Promise<GetBandwidthResult>;
/**
 * A collection of arguments for invoking getBandwidth.
 */
export interface GetBandwidthArgs {
    /**
     * The enterprise project id of the Shared Bandwidth to retrieve.
     */
    enterpriseProjectId?: string;
    /**
     * The name of the Shared Bandwidth to retrieve.
     */
    name: string;
    /**
     * The region in which to obtain the bandwidth. If omitted, the provider-level region will
     * be used.
     */
    region?: string;
    /**
     * The size of the Shared Bandwidth to retrieve. The value ranges from 5 Mbit/s to 2000 Mbit/s.
     */
    size?: number;
}
/**
 * A collection of values returned by getBandwidth.
 */
export interface GetBandwidthResult {
    /**
     * Indicates the bandwidth type.
     */
    readonly bandwidthType: string;
    /**
     * Indicates whether the billing is based on traffic, bandwidth, or 95th percentile bandwidth (enhanced).
     */
    readonly chargeMode: string;
    readonly enterpriseProjectId: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly name: string;
    /**
     * An array of EIPs that use the bandwidth. The object includes the following:
     */
    readonly publicips: outputs.Eip.GetBandwidthPublicip[];
    readonly region: string;
    /**
     * Indicates whether the bandwidth is shared or dedicated.
     */
    readonly shareType: string;
    readonly size: number;
    /**
     * Indicates the bandwidth status.
     */
    readonly status: string;
}
export declare function getBandwidthOutput(args: GetBandwidthOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetBandwidthResult>;
/**
 * A collection of arguments for invoking getBandwidth.
 */
export interface GetBandwidthOutputArgs {
    /**
     * The enterprise project id of the Shared Bandwidth to retrieve.
     */
    enterpriseProjectId?: pulumi.Input<string>;
    /**
     * The name of the Shared Bandwidth to retrieve.
     */
    name: pulumi.Input<string>;
    /**
     * The region in which to obtain the bandwidth. If omitted, the provider-level region will
     * be used.
     */
    region?: pulumi.Input<string>;
    /**
     * The size of the Shared Bandwidth to retrieve. The value ranges from 5 Mbit/s to 2000 Mbit/s.
     */
    size?: pulumi.Input<number>;
}