Alibaba Cloud

v3.28.0 published on Tuesday, Aug 16, 2022 by Pulumi

getBandwidthPackages

This data source provides CEN Bandwidth Packages available to the user.

Example Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(AliCloud.Cen.GetBandwidthPackages.InvokeAsync(new AliCloud.Cen.GetBandwidthPackagesArgs
        {
            InstanceId = "cen-id1",
            NameRegex = "^foo",
        }));
        this.FirstCenBandwidthPackageId = example.Apply(example => example.Packages?[0]?.Id);
    }

    [Output("firstCenBandwidthPackageId")]
    public Output<string> FirstCenBandwidthPackageId { get; set; }
}
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/cen"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := cen.GetBandwidthPackages(ctx, &cen.GetBandwidthPackagesArgs{
			InstanceId: pulumi.StringRef("cen-id1"),
			NameRegex:  pulumi.StringRef("^foo"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("firstCenBandwidthPackageId", example.Packages[0].Id)
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.cen.CenFunctions;
import com.pulumi.alicloud.cen.inputs.GetBandwidthPackagesArgs;
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) {
        final var example = CenFunctions.getBandwidthPackages(GetBandwidthPackagesArgs.builder()
            .instanceId("cen-id1")
            .nameRegex("^foo")
            .build());

        ctx.export("firstCenBandwidthPackageId", example.applyValue(getBandwidthPackagesResult -> getBandwidthPackagesResult.packages()[0].id()));
    }
}
import pulumi
import pulumi_alicloud as alicloud

example = alicloud.cen.get_bandwidth_packages(instance_id="cen-id1",
    name_regex="^foo")
pulumi.export("firstCenBandwidthPackageId", example.packages[0].id)
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const example = alicloud.cen.getBandwidthPackages({
    instanceId: "cen-id1",
    nameRegex: "^foo",
});
export const firstCenBandwidthPackageId = example.then(example => example.packages?[0]?.id);
variables:
  example:
    Fn::Invoke:
      Function: alicloud:cen:getBandwidthPackages
      Arguments:
        instanceId: cen-id1
        nameRegex: ^foo
outputs:
  firstCenBandwidthPackageId: ${example.packages[0].id}

Using getBandwidthPackages

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getBandwidthPackages(args: GetBandwidthPackagesArgs, opts?: InvokeOptions): Promise<GetBandwidthPackagesResult>
function getBandwidthPackagesOutput(args: GetBandwidthPackagesOutputArgs, opts?: InvokeOptions): Output<GetBandwidthPackagesResult>
def get_bandwidth_packages(ids: Optional[Sequence[str]] = None,
                           include_reservation_data: Optional[bool] = None,
                           instance_id: Optional[str] = None,
                           name_regex: Optional[str] = None,
                           output_file: Optional[str] = None,
                           status: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetBandwidthPackagesResult
def get_bandwidth_packages_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                           include_reservation_data: Optional[pulumi.Input[bool]] = None,
                           instance_id: Optional[pulumi.Input[str]] = None,
                           name_regex: Optional[pulumi.Input[str]] = None,
                           output_file: Optional[pulumi.Input[str]] = None,
                           status: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetBandwidthPackagesResult]
func GetBandwidthPackages(ctx *Context, args *GetBandwidthPackagesArgs, opts ...InvokeOption) (*GetBandwidthPackagesResult, error)
func GetBandwidthPackagesOutput(ctx *Context, args *GetBandwidthPackagesOutputArgs, opts ...InvokeOption) GetBandwidthPackagesResultOutput

> Note: This function is named GetBandwidthPackages in the Go SDK.

public static class GetBandwidthPackages 
{
    public static Task<GetBandwidthPackagesResult> InvokeAsync(GetBandwidthPackagesArgs args, InvokeOptions? opts = null)
    public static Output<GetBandwidthPackagesResult> Invoke(GetBandwidthPackagesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetBandwidthPackagesResult> getBandwidthPackages(GetBandwidthPackagesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: alicloud:cen/getBandwidthPackages:getBandwidthPackages
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Ids List<string>

Limit search to a list of specific CEN Bandwidth Package IDs.

IncludeReservationData bool

-Indicates whether to include renewal data. Valid values: true: Return renewal data in the response. false: Do not return renewal data in the response.

InstanceId string

ID of a CEN instance.

NameRegex string

A regex string to filter CEN Bandwidth Package by name.

OutputFile string
Status string

Status of the CEN Bandwidth Package in CEN instance, Valid value: Idle and InUse.

Ids []string

Limit search to a list of specific CEN Bandwidth Package IDs.

IncludeReservationData bool

-Indicates whether to include renewal data. Valid values: true: Return renewal data in the response. false: Do not return renewal data in the response.

InstanceId string

ID of a CEN instance.

NameRegex string

A regex string to filter CEN Bandwidth Package by name.

OutputFile string
Status string

Status of the CEN Bandwidth Package in CEN instance, Valid value: Idle and InUse.

ids List<String>

Limit search to a list of specific CEN Bandwidth Package IDs.

includeReservationData Boolean

-Indicates whether to include renewal data. Valid values: true: Return renewal data in the response. false: Do not return renewal data in the response.

instanceId String

ID of a CEN instance.

nameRegex String

A regex string to filter CEN Bandwidth Package by name.

outputFile String
status String

Status of the CEN Bandwidth Package in CEN instance, Valid value: Idle and InUse.

ids string[]

Limit search to a list of specific CEN Bandwidth Package IDs.

includeReservationData boolean

-Indicates whether to include renewal data. Valid values: true: Return renewal data in the response. false: Do not return renewal data in the response.

instanceId string

ID of a CEN instance.

nameRegex string

A regex string to filter CEN Bandwidth Package by name.

outputFile string
status string

Status of the CEN Bandwidth Package in CEN instance, Valid value: Idle and InUse.

ids Sequence[str]

Limit search to a list of specific CEN Bandwidth Package IDs.

include_reservation_data bool

-Indicates whether to include renewal data. Valid values: true: Return renewal data in the response. false: Do not return renewal data in the response.

instance_id str

ID of a CEN instance.

name_regex str

A regex string to filter CEN Bandwidth Package by name.

output_file str
status str

Status of the CEN Bandwidth Package in CEN instance, Valid value: Idle and InUse.

ids List<String>

Limit search to a list of specific CEN Bandwidth Package IDs.

includeReservationData Boolean

-Indicates whether to include renewal data. Valid values: true: Return renewal data in the response. false: Do not return renewal data in the response.

instanceId String

ID of a CEN instance.

nameRegex String

A regex string to filter CEN Bandwidth Package by name.

outputFile String
status String

Status of the CEN Bandwidth Package in CEN instance, Valid value: Idle and InUse.

getBandwidthPackages Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Ids List<string>

A list of specific CEN Bandwidth Package IDs.

  • names (Available in 1.98.0+) - A list of CEN Bandwidth Package Names.
Names List<string>
Packages List<Pulumi.AliCloud.Cen.Outputs.GetBandwidthPackagesPackage>

A list of CEN bandwidth package. Each element contains the following attributes:

IncludeReservationData bool
InstanceId string

The ID of the CEN instance that are associated with the bandwidth package.

NameRegex string
OutputFile string
Status string

Status of the CEN Bandwidth Package in CEN instance, including Idle and InUse.

Id string

The provider-assigned unique ID for this managed resource.

Ids []string

A list of specific CEN Bandwidth Package IDs.

  • names (Available in 1.98.0+) - A list of CEN Bandwidth Package Names.
Names []string
Packages []GetBandwidthPackagesPackage

A list of CEN bandwidth package. Each element contains the following attributes:

IncludeReservationData bool
InstanceId string

The ID of the CEN instance that are associated with the bandwidth package.

NameRegex string
OutputFile string
Status string

Status of the CEN Bandwidth Package in CEN instance, including Idle and InUse.

id String

The provider-assigned unique ID for this managed resource.

ids List<String>

A list of specific CEN Bandwidth Package IDs.

  • names (Available in 1.98.0+) - A list of CEN Bandwidth Package Names.
names List<String>
packages List<GetBandwidthPackagesPackage>

A list of CEN bandwidth package. Each element contains the following attributes:

includeReservationData Boolean
instanceId String

The ID of the CEN instance that are associated with the bandwidth package.

nameRegex String
outputFile String
status String

Status of the CEN Bandwidth Package in CEN instance, including Idle and InUse.

id string

The provider-assigned unique ID for this managed resource.

ids string[]

A list of specific CEN Bandwidth Package IDs.

  • names (Available in 1.98.0+) - A list of CEN Bandwidth Package Names.
names string[]
packages GetBandwidthPackagesPackage[]

A list of CEN bandwidth package. Each element contains the following attributes:

includeReservationData boolean
instanceId string

The ID of the CEN instance that are associated with the bandwidth package.

nameRegex string
outputFile string
status string

Status of the CEN Bandwidth Package in CEN instance, including Idle and InUse.

id str

The provider-assigned unique ID for this managed resource.

ids Sequence[str]

A list of specific CEN Bandwidth Package IDs.

  • names (Available in 1.98.0+) - A list of CEN Bandwidth Package Names.
names Sequence[str]
packages Sequence[GetBandwidthPackagesPackage]

A list of CEN bandwidth package. Each element contains the following attributes:

include_reservation_data bool
instance_id str

The ID of the CEN instance that are associated with the bandwidth package.

name_regex str
output_file str
status str

Status of the CEN Bandwidth Package in CEN instance, including Idle and InUse.

id String

The provider-assigned unique ID for this managed resource.

ids List<String>

A list of specific CEN Bandwidth Package IDs.

  • names (Available in 1.98.0+) - A list of CEN Bandwidth Package Names.
names List<String>
packages List<Property Map>

A list of CEN bandwidth package. Each element contains the following attributes:

includeReservationData Boolean
instanceId String

The ID of the CEN instance that are associated with the bandwidth package.

nameRegex String
outputFile String
status String

Status of the CEN Bandwidth Package in CEN instance, including Idle and InUse.

Supporting Types

GetBandwidthPackagesPackage

Bandwidth int

The bandwidth in Mbps of the CEN bandwidth package.

BandwidthPackageChargeType string

The billing method, including POSTPAY and PREPAY.

BusinessStatus string

Status of the CEN Bandwidth Package, including Normal, FinancialLocked and SecurityLocked.

CenBandwidthPackageId string

The ID of the bandwidth package.

CenBandwidthPackageName string

The name of the bandwidth package.

CenIds List<string>

The list of CEN instances that are associated with the bandwidth package.

Description string

Description of the CEN Bandwidth Package.

ExpiredTime string
GeographicRegionAId string

Region ID of the interconnected regions.

GeographicRegionBId string

Region ID of the interconnected regions.

GeographicSpanId string

The area ID of the cross-area connection.

HasReservationData string

Indicates whether renewal data is involved.

Id string

ID of the CEN Bandwidth Package.

InstanceId string

ID of a CEN instance.

IsCrossBorder bool

Indicates whether the bandwidth package is a cross-border bandwidth package.

Name string

Name of the CEN Bandwidth Package.

PaymentType string

The billing method of the bandwidth package.

ReservationActiveTime string

The expiration time of the temporary upgrade.

ReservationBandwidth string

The restored bandwidth after the temporary upgrade.

ReservationInternetChargeType string

The billing method after the configuration change.

ReservationOrderType string

The type of the configuration change.

Status string

Status of the CEN Bandwidth Package in CEN instance, Valid value: Idle and InUse.

Bandwidth int

The bandwidth in Mbps of the CEN bandwidth package.

BandwidthPackageChargeType string

The billing method, including POSTPAY and PREPAY.

BusinessStatus string

Status of the CEN Bandwidth Package, including Normal, FinancialLocked and SecurityLocked.

CenBandwidthPackageId string

The ID of the bandwidth package.

CenBandwidthPackageName string

The name of the bandwidth package.

CenIds []string

The list of CEN instances that are associated with the bandwidth package.

Description string

Description of the CEN Bandwidth Package.

ExpiredTime string
GeographicRegionAId string

Region ID of the interconnected regions.

GeographicRegionBId string

Region ID of the interconnected regions.

GeographicSpanId string

The area ID of the cross-area connection.

HasReservationData string

Indicates whether renewal data is involved.

Id string

ID of the CEN Bandwidth Package.

InstanceId string

ID of a CEN instance.

IsCrossBorder bool

Indicates whether the bandwidth package is a cross-border bandwidth package.

Name string

Name of the CEN Bandwidth Package.

PaymentType string

The billing method of the bandwidth package.

ReservationActiveTime string

The expiration time of the temporary upgrade.

ReservationBandwidth string

The restored bandwidth after the temporary upgrade.

ReservationInternetChargeType string

The billing method after the configuration change.

ReservationOrderType string

The type of the configuration change.

Status string

Status of the CEN Bandwidth Package in CEN instance, Valid value: Idle and InUse.

bandwidth Integer

The bandwidth in Mbps of the CEN bandwidth package.

bandwidthPackageChargeType String

The billing method, including POSTPAY and PREPAY.

businessStatus String

Status of the CEN Bandwidth Package, including Normal, FinancialLocked and SecurityLocked.

cenBandwidthPackageId String

The ID of the bandwidth package.

cenBandwidthPackageName String

The name of the bandwidth package.

cenIds List<String>

The list of CEN instances that are associated with the bandwidth package.

description String

Description of the CEN Bandwidth Package.

expiredTime String
geographicRegionAId String

Region ID of the interconnected regions.

geographicRegionBId String

Region ID of the interconnected regions.

geographicSpanId String

The area ID of the cross-area connection.

hasReservationData String

Indicates whether renewal data is involved.

id String

ID of the CEN Bandwidth Package.

instanceId String

ID of a CEN instance.

isCrossBorder Boolean

Indicates whether the bandwidth package is a cross-border bandwidth package.

name String

Name of the CEN Bandwidth Package.

paymentType String

The billing method of the bandwidth package.

reservationActiveTime String

The expiration time of the temporary upgrade.

reservationBandwidth String

The restored bandwidth after the temporary upgrade.

reservationInternetChargeType String

The billing method after the configuration change.

reservationOrderType String

The type of the configuration change.

status String

Status of the CEN Bandwidth Package in CEN instance, Valid value: Idle and InUse.

bandwidth number

The bandwidth in Mbps of the CEN bandwidth package.

bandwidthPackageChargeType string

The billing method, including POSTPAY and PREPAY.

businessStatus string

Status of the CEN Bandwidth Package, including Normal, FinancialLocked and SecurityLocked.

cenBandwidthPackageId string

The ID of the bandwidth package.

cenBandwidthPackageName string

The name of the bandwidth package.

cenIds string[]

The list of CEN instances that are associated with the bandwidth package.

description string

Description of the CEN Bandwidth Package.

expiredTime string
geographicRegionAId string

Region ID of the interconnected regions.

geographicRegionBId string

Region ID of the interconnected regions.

geographicSpanId string

The area ID of the cross-area connection.

hasReservationData string

Indicates whether renewal data is involved.

id string

ID of the CEN Bandwidth Package.

instanceId string

ID of a CEN instance.

isCrossBorder boolean

Indicates whether the bandwidth package is a cross-border bandwidth package.

name string

Name of the CEN Bandwidth Package.

paymentType string

The billing method of the bandwidth package.

reservationActiveTime string

The expiration time of the temporary upgrade.

reservationBandwidth string

The restored bandwidth after the temporary upgrade.

reservationInternetChargeType string

The billing method after the configuration change.

reservationOrderType string

The type of the configuration change.

status string

Status of the CEN Bandwidth Package in CEN instance, Valid value: Idle and InUse.

bandwidth int

The bandwidth in Mbps of the CEN bandwidth package.

bandwidth_package_charge_type str

The billing method, including POSTPAY and PREPAY.

business_status str

Status of the CEN Bandwidth Package, including Normal, FinancialLocked and SecurityLocked.

cen_bandwidth_package_id str

The ID of the bandwidth package.

cen_bandwidth_package_name str

The name of the bandwidth package.

cen_ids Sequence[str]

The list of CEN instances that are associated with the bandwidth package.

description str

Description of the CEN Bandwidth Package.

expired_time str
geographic_region_a_id str

Region ID of the interconnected regions.

geographic_region_b_id str

Region ID of the interconnected regions.

geographic_span_id str

The area ID of the cross-area connection.

has_reservation_data str

Indicates whether renewal data is involved.

id str

ID of the CEN Bandwidth Package.

instance_id str

ID of a CEN instance.

is_cross_border bool

Indicates whether the bandwidth package is a cross-border bandwidth package.

name str

Name of the CEN Bandwidth Package.

payment_type str

The billing method of the bandwidth package.

reservation_active_time str

The expiration time of the temporary upgrade.

reservation_bandwidth str

The restored bandwidth after the temporary upgrade.

reservation_internet_charge_type str

The billing method after the configuration change.

reservation_order_type str

The type of the configuration change.

status str

Status of the CEN Bandwidth Package in CEN instance, Valid value: Idle and InUse.

bandwidth Number

The bandwidth in Mbps of the CEN bandwidth package.

bandwidthPackageChargeType String

The billing method, including POSTPAY and PREPAY.

businessStatus String

Status of the CEN Bandwidth Package, including Normal, FinancialLocked and SecurityLocked.

cenBandwidthPackageId String

The ID of the bandwidth package.

cenBandwidthPackageName String

The name of the bandwidth package.

cenIds List<String>

The list of CEN instances that are associated with the bandwidth package.

description String

Description of the CEN Bandwidth Package.

expiredTime String
geographicRegionAId String

Region ID of the interconnected regions.

geographicRegionBId String

Region ID of the interconnected regions.

geographicSpanId String

The area ID of the cross-area connection.

hasReservationData String

Indicates whether renewal data is involved.

id String

ID of the CEN Bandwidth Package.

instanceId String

ID of a CEN instance.

isCrossBorder Boolean

Indicates whether the bandwidth package is a cross-border bandwidth package.

name String

Name of the CEN Bandwidth Package.

paymentType String

The billing method of the bandwidth package.

reservationActiveTime String

The expiration time of the temporary upgrade.

reservationBandwidth String

The restored bandwidth after the temporary upgrade.

reservationInternetChargeType String

The billing method after the configuration change.

reservationOrderType String

The type of the configuration change.

status String

Status of the CEN Bandwidth Package in CEN instance, Valid value: Idle and InUse.

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.