1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. vpc
  5. getCommonBandwidthPackages
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

alicloud.vpc.getCommonBandwidthPackages

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

    This data source provides a list of Common Bandwidth Packages owned by an Alibaba Cloud account.

    NOTE: Available in 1.36.0+.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const fooCommonBandwithPackage = new alicloud.vpc.CommonBandwithPackage("foo", {
        bandwidth: "2",
        name: "tf-testAccCommonBandwidthPackage",
        description: "tf-testAcc-CommonBandwidthPackage",
    });
    const foo = alicloud.vpc.getCommonBandwidthPackagesOutput({
        nameRegex: "^tf-testAcc.*",
        ids: [fooCommonBandwithPackage.id],
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    foo_common_bandwith_package = alicloud.vpc.CommonBandwithPackage("foo",
        bandwidth="2",
        name="tf-testAccCommonBandwidthPackage",
        description="tf-testAcc-CommonBandwidthPackage")
    foo = alicloud.vpc.get_common_bandwidth_packages_output(name_regex="^tf-testAcc.*",
        ids=[foo_common_bandwith_package.id])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		fooCommonBandwithPackage, err := vpc.NewCommonBandwithPackage(ctx, "foo", &vpc.CommonBandwithPackageArgs{
    			Bandwidth:   pulumi.String("2"),
    			Name:        pulumi.String("tf-testAccCommonBandwidthPackage"),
    			Description: pulumi.String("tf-testAcc-CommonBandwidthPackage"),
    		})
    		if err != nil {
    			return err
    		}
    		_ = vpc.GetCommonBandwidthPackagesOutput(ctx, vpc.GetCommonBandwidthPackagesOutputArgs{
    			NameRegex: pulumi.String("^tf-testAcc.*"),
    			Ids: pulumi.StringArray{
    				fooCommonBandwithPackage.ID(),
    			},
    		}, nil)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var fooCommonBandwithPackage = new AliCloud.Vpc.CommonBandwithPackage("foo", new()
        {
            Bandwidth = "2",
            Name = "tf-testAccCommonBandwidthPackage",
            Description = "tf-testAcc-CommonBandwidthPackage",
        });
    
        var foo = AliCloud.Vpc.GetCommonBandwidthPackages.Invoke(new()
        {
            NameRegex = "^tf-testAcc.*",
            Ids = new[]
            {
                fooCommonBandwithPackage.Id,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.vpc.CommonBandwithPackage;
    import com.pulumi.alicloud.vpc.CommonBandwithPackageArgs;
    import com.pulumi.alicloud.vpc.VpcFunctions;
    import com.pulumi.alicloud.vpc.inputs.GetCommonBandwidthPackagesArgs;
    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) {
            var fooCommonBandwithPackage = new CommonBandwithPackage("fooCommonBandwithPackage", CommonBandwithPackageArgs.builder()
                .bandwidth("2")
                .name("tf-testAccCommonBandwidthPackage")
                .description("tf-testAcc-CommonBandwidthPackage")
                .build());
    
            final var foo = VpcFunctions.getCommonBandwidthPackages(GetCommonBandwidthPackagesArgs.builder()
                .nameRegex("^tf-testAcc.*")
                .ids(fooCommonBandwithPackage.id())
                .build());
    
        }
    }
    
    resources:
      fooCommonBandwithPackage:
        type: alicloud:vpc:CommonBandwithPackage
        name: foo
        properties:
          bandwidth: '2'
          name: tf-testAccCommonBandwidthPackage
          description: tf-testAcc-CommonBandwidthPackage
    variables:
      foo:
        fn::invoke:
          Function: alicloud:vpc:getCommonBandwidthPackages
          Arguments:
            nameRegex: ^tf-testAcc.*
            ids:
              - ${fooCommonBandwithPackage.id}
    

    Public ip addresses Block

    The public ip addresses mapping supports the following:

    • ip_address - The address of the EIP.
    • allocation_id - The ID of the EIP instance.
    • bandwidth_package_ip_relation_status - The IP relation status of bandwidth package.

    Using getCommonBandwidthPackages

    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 getCommonBandwidthPackages(args: GetCommonBandwidthPackagesArgs, opts?: InvokeOptions): Promise<GetCommonBandwidthPackagesResult>
    function getCommonBandwidthPackagesOutput(args: GetCommonBandwidthPackagesOutputArgs, opts?: InvokeOptions): Output<GetCommonBandwidthPackagesResult>
    def get_common_bandwidth_packages(bandwidth_package_name: Optional[str] = None,
                                      dry_run: Optional[bool] = None,
                                      ids: Optional[Sequence[str]] = None,
                                      include_reservation_data: Optional[bool] = None,
                                      name_regex: Optional[str] = None,
                                      output_file: Optional[str] = None,
                                      resource_group_id: Optional[str] = None,
                                      status: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetCommonBandwidthPackagesResult
    def get_common_bandwidth_packages_output(bandwidth_package_name: Optional[pulumi.Input[str]] = None,
                                      dry_run: Optional[pulumi.Input[bool]] = None,
                                      ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                      include_reservation_data: Optional[pulumi.Input[bool]] = None,
                                      name_regex: Optional[pulumi.Input[str]] = None,
                                      output_file: Optional[pulumi.Input[str]] = None,
                                      resource_group_id: Optional[pulumi.Input[str]] = None,
                                      status: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetCommonBandwidthPackagesResult]
    func GetCommonBandwidthPackages(ctx *Context, args *GetCommonBandwidthPackagesArgs, opts ...InvokeOption) (*GetCommonBandwidthPackagesResult, error)
    func GetCommonBandwidthPackagesOutput(ctx *Context, args *GetCommonBandwidthPackagesOutputArgs, opts ...InvokeOption) GetCommonBandwidthPackagesResultOutput

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

    public static class GetCommonBandwidthPackages 
    {
        public static Task<GetCommonBandwidthPackagesResult> InvokeAsync(GetCommonBandwidthPackagesArgs args, InvokeOptions? opts = null)
        public static Output<GetCommonBandwidthPackagesResult> Invoke(GetCommonBandwidthPackagesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCommonBandwidthPackagesResult> getCommonBandwidthPackages(GetCommonBandwidthPackagesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: alicloud:vpc/getCommonBandwidthPackages:getCommonBandwidthPackages
      arguments:
        # arguments dictionary

    The following arguments are supported:

    BandwidthPackageName string
    The name of bandwidth package.
    DryRun bool
    Specifies whether to precheck only the request.
    Ids List<string>
    A list of Common Bandwidth Packages IDs.
    IncludeReservationData bool
    Specifies whether to return data of orders that have not taken effect.
    NameRegex string
    A regex string to filter results by name.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    ResourceGroupId string
    The Id of resource group which the common bandwidth package belongs.
    Status string
    The status of bandwidth package. Valid values: Available and Pending.
    BandwidthPackageName string
    The name of bandwidth package.
    DryRun bool
    Specifies whether to precheck only the request.
    Ids []string
    A list of Common Bandwidth Packages IDs.
    IncludeReservationData bool
    Specifies whether to return data of orders that have not taken effect.
    NameRegex string
    A regex string to filter results by name.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    ResourceGroupId string
    The Id of resource group which the common bandwidth package belongs.
    Status string
    The status of bandwidth package. Valid values: Available and Pending.
    bandwidthPackageName String
    The name of bandwidth package.
    dryRun Boolean
    Specifies whether to precheck only the request.
    ids List<String>
    A list of Common Bandwidth Packages IDs.
    includeReservationData Boolean
    Specifies whether to return data of orders that have not taken effect.
    nameRegex String
    A regex string to filter results by name.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    resourceGroupId String
    The Id of resource group which the common bandwidth package belongs.
    status String
    The status of bandwidth package. Valid values: Available and Pending.
    bandwidthPackageName string
    The name of bandwidth package.
    dryRun boolean
    Specifies whether to precheck only the request.
    ids string[]
    A list of Common Bandwidth Packages IDs.
    includeReservationData boolean
    Specifies whether to return data of orders that have not taken effect.
    nameRegex string
    A regex string to filter results by name.
    outputFile string
    File name where to save data source results (after running pulumi preview).
    resourceGroupId string
    The Id of resource group which the common bandwidth package belongs.
    status string
    The status of bandwidth package. Valid values: Available and Pending.
    bandwidth_package_name str
    The name of bandwidth package.
    dry_run bool
    Specifies whether to precheck only the request.
    ids Sequence[str]
    A list of Common Bandwidth Packages IDs.
    include_reservation_data bool
    Specifies whether to return data of orders that have not taken effect.
    name_regex str
    A regex string to filter results by name.
    output_file str
    File name where to save data source results (after running pulumi preview).
    resource_group_id str
    The Id of resource group which the common bandwidth package belongs.
    status str
    The status of bandwidth package. Valid values: Available and Pending.
    bandwidthPackageName String
    The name of bandwidth package.
    dryRun Boolean
    Specifies whether to precheck only the request.
    ids List<String>
    A list of Common Bandwidth Packages IDs.
    includeReservationData Boolean
    Specifies whether to return data of orders that have not taken effect.
    nameRegex String
    A regex string to filter results by name.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    resourceGroupId String
    The Id of resource group which the common bandwidth package belongs.
    status String
    The status of bandwidth package. Valid values: Available and Pending.

    getCommonBandwidthPackages Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Ids List<string>
    (Optional) A list of Common Bandwidth Packages IDs.
    Names List<string>
    A list of Common Bandwidth Packages names.
    Packages List<Pulumi.AliCloud.Vpc.Outputs.GetCommonBandwidthPackagesPackage>
    A list of Common Bandwidth Packages. Each element contains the following attributes:
    BandwidthPackageName string
    The name of bandwidth package.
    DryRun bool
    IncludeReservationData bool
    NameRegex string
    OutputFile string
    ResourceGroupId string
    The Id of resource group which the common bandwidth package belongs.
    Status string
    Status of the Common Bandwidth Package.
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    (Optional) A list of Common Bandwidth Packages IDs.
    Names []string
    A list of Common Bandwidth Packages names.
    Packages []GetCommonBandwidthPackagesPackage
    A list of Common Bandwidth Packages. Each element contains the following attributes:
    BandwidthPackageName string
    The name of bandwidth package.
    DryRun bool
    IncludeReservationData bool
    NameRegex string
    OutputFile string
    ResourceGroupId string
    The Id of resource group which the common bandwidth package belongs.
    Status string
    Status of the Common Bandwidth Package.
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    (Optional) A list of Common Bandwidth Packages IDs.
    names List<String>
    A list of Common Bandwidth Packages names.
    packages List<GetCommonBandwidthPackagesPackage>
    A list of Common Bandwidth Packages. Each element contains the following attributes:
    bandwidthPackageName String
    The name of bandwidth package.
    dryRun Boolean
    includeReservationData Boolean
    nameRegex String
    outputFile String
    resourceGroupId String
    The Id of resource group which the common bandwidth package belongs.
    status String
    Status of the Common Bandwidth Package.
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    (Optional) A list of Common Bandwidth Packages IDs.
    names string[]
    A list of Common Bandwidth Packages names.
    packages GetCommonBandwidthPackagesPackage[]
    A list of Common Bandwidth Packages. Each element contains the following attributes:
    bandwidthPackageName string
    The name of bandwidth package.
    dryRun boolean
    includeReservationData boolean
    nameRegex string
    outputFile string
    resourceGroupId string
    The Id of resource group which the common bandwidth package belongs.
    status string
    Status of the Common Bandwidth Package.
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    (Optional) A list of Common Bandwidth Packages IDs.
    names Sequence[str]
    A list of Common Bandwidth Packages names.
    packages Sequence[GetCommonBandwidthPackagesPackage]
    A list of Common Bandwidth Packages. Each element contains the following attributes:
    bandwidth_package_name str
    The name of bandwidth package.
    dry_run bool
    include_reservation_data bool
    name_regex str
    output_file str
    resource_group_id str
    The Id of resource group which the common bandwidth package belongs.
    status str
    Status of the Common Bandwidth Package.
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    (Optional) A list of Common Bandwidth Packages IDs.
    names List<String>
    A list of Common Bandwidth Packages names.
    packages List<Property Map>
    A list of Common Bandwidth Packages. Each element contains the following attributes:
    bandwidthPackageName String
    The name of bandwidth package.
    dryRun Boolean
    includeReservationData Boolean
    nameRegex String
    outputFile String
    resourceGroupId String
    The Id of resource group which the common bandwidth package belongs.
    status String
    Status of the Common Bandwidth Package.

    Supporting Types

    GetCommonBandwidthPackagesPackage

    Bandwidth string
    The peak bandwidth of the Internet Shared Bandwidth instance.
    BandwidthPackageId string
    The resource ID of bandwidth package.
    BandwidthPackageName string
    The name of bandwidth package.
    BusinessStatus string
    The business status of the Common Bandwidth Package instance.
    DeletionProtection bool
    The deletion protection of bandwidth package.
    Description string
    The description of the Common Bandwidth Package instance.
    ExpiredTime string
    The expired time of bandwidth package.
    HasReservationData bool
    Is has reservation data.
    Id string
    ID of the Common Bandwidth Package.
    InternetChargeType string
    The internet charge type of bandwidth package.
    Isp string
    ISP of the Common Bandwidth Package.
    Name string
    Name of the Common Bandwidth Package.
    PaymentType string
    The payment type of bandwidth package.
    PublicIpAddresses List<Pulumi.AliCloud.Vpc.Inputs.GetCommonBandwidthPackagesPackagePublicIpAddress>
    Public ip addresses that in the Common Bandwidth Pakcage.
    Ratio int
    The ratio of bandwidth package.
    ReservationActiveTime string
    The active time of reservation.
    ReservationBandwidth string
    The bandwidth of reservation.
    ReservationInternetChargeType string
    The charge type of reservation internet.
    ReservationOrderType string
    The type of reservation order.
    ResourceGroupId string
    The Id of resource group which the common bandwidth package belongs.
    ServiceManaged int
    The service managed.
    Status string
    The status of bandwidth package. Valid values: Available and Pending.
    Bandwidth string
    The peak bandwidth of the Internet Shared Bandwidth instance.
    BandwidthPackageId string
    The resource ID of bandwidth package.
    BandwidthPackageName string
    The name of bandwidth package.
    BusinessStatus string
    The business status of the Common Bandwidth Package instance.
    DeletionProtection bool
    The deletion protection of bandwidth package.
    Description string
    The description of the Common Bandwidth Package instance.
    ExpiredTime string
    The expired time of bandwidth package.
    HasReservationData bool
    Is has reservation data.
    Id string
    ID of the Common Bandwidth Package.
    InternetChargeType string
    The internet charge type of bandwidth package.
    Isp string
    ISP of the Common Bandwidth Package.
    Name string
    Name of the Common Bandwidth Package.
    PaymentType string
    The payment type of bandwidth package.
    PublicIpAddresses []GetCommonBandwidthPackagesPackagePublicIpAddress
    Public ip addresses that in the Common Bandwidth Pakcage.
    Ratio int
    The ratio of bandwidth package.
    ReservationActiveTime string
    The active time of reservation.
    ReservationBandwidth string
    The bandwidth of reservation.
    ReservationInternetChargeType string
    The charge type of reservation internet.
    ReservationOrderType string
    The type of reservation order.
    ResourceGroupId string
    The Id of resource group which the common bandwidth package belongs.
    ServiceManaged int
    The service managed.
    Status string
    The status of bandwidth package. Valid values: Available and Pending.
    bandwidth String
    The peak bandwidth of the Internet Shared Bandwidth instance.
    bandwidthPackageId String
    The resource ID of bandwidth package.
    bandwidthPackageName String
    The name of bandwidth package.
    businessStatus String
    The business status of the Common Bandwidth Package instance.
    deletionProtection Boolean
    The deletion protection of bandwidth package.
    description String
    The description of the Common Bandwidth Package instance.
    expiredTime String
    The expired time of bandwidth package.
    hasReservationData Boolean
    Is has reservation data.
    id String
    ID of the Common Bandwidth Package.
    internetChargeType String
    The internet charge type of bandwidth package.
    isp String
    ISP of the Common Bandwidth Package.
    name String
    Name of the Common Bandwidth Package.
    paymentType String
    The payment type of bandwidth package.
    publicIpAddresses List<GetCommonBandwidthPackagesPackagePublicIpAddress>
    Public ip addresses that in the Common Bandwidth Pakcage.
    ratio Integer
    The ratio of bandwidth package.
    reservationActiveTime String
    The active time of reservation.
    reservationBandwidth String
    The bandwidth of reservation.
    reservationInternetChargeType String
    The charge type of reservation internet.
    reservationOrderType String
    The type of reservation order.
    resourceGroupId String
    The Id of resource group which the common bandwidth package belongs.
    serviceManaged Integer
    The service managed.
    status String
    The status of bandwidth package. Valid values: Available and Pending.
    bandwidth string
    The peak bandwidth of the Internet Shared Bandwidth instance.
    bandwidthPackageId string
    The resource ID of bandwidth package.
    bandwidthPackageName string
    The name of bandwidth package.
    businessStatus string
    The business status of the Common Bandwidth Package instance.
    deletionProtection boolean
    The deletion protection of bandwidth package.
    description string
    The description of the Common Bandwidth Package instance.
    expiredTime string
    The expired time of bandwidth package.
    hasReservationData boolean
    Is has reservation data.
    id string
    ID of the Common Bandwidth Package.
    internetChargeType string
    The internet charge type of bandwidth package.
    isp string
    ISP of the Common Bandwidth Package.
    name string
    Name of the Common Bandwidth Package.
    paymentType string
    The payment type of bandwidth package.
    publicIpAddresses GetCommonBandwidthPackagesPackagePublicIpAddress[]
    Public ip addresses that in the Common Bandwidth Pakcage.
    ratio number
    The ratio of bandwidth package.
    reservationActiveTime string
    The active time of reservation.
    reservationBandwidth string
    The bandwidth of reservation.
    reservationInternetChargeType string
    The charge type of reservation internet.
    reservationOrderType string
    The type of reservation order.
    resourceGroupId string
    The Id of resource group which the common bandwidth package belongs.
    serviceManaged number
    The service managed.
    status string
    The status of bandwidth package. Valid values: Available and Pending.
    bandwidth str
    The peak bandwidth of the Internet Shared Bandwidth instance.
    bandwidth_package_id str
    The resource ID of bandwidth package.
    bandwidth_package_name str
    The name of bandwidth package.
    business_status str
    The business status of the Common Bandwidth Package instance.
    deletion_protection bool
    The deletion protection of bandwidth package.
    description str
    The description of the Common Bandwidth Package instance.
    expired_time str
    The expired time of bandwidth package.
    has_reservation_data bool
    Is has reservation data.
    id str
    ID of the Common Bandwidth Package.
    internet_charge_type str
    The internet charge type of bandwidth package.
    isp str
    ISP of the Common Bandwidth Package.
    name str
    Name of the Common Bandwidth Package.
    payment_type str
    The payment type of bandwidth package.
    public_ip_addresses Sequence[GetCommonBandwidthPackagesPackagePublicIpAddress]
    Public ip addresses that in the Common Bandwidth Pakcage.
    ratio int
    The ratio of bandwidth package.
    reservation_active_time str
    The active time of reservation.
    reservation_bandwidth str
    The bandwidth of reservation.
    reservation_internet_charge_type str
    The charge type of reservation internet.
    reservation_order_type str
    The type of reservation order.
    resource_group_id str
    The Id of resource group which the common bandwidth package belongs.
    service_managed int
    The service managed.
    status str
    The status of bandwidth package. Valid values: Available and Pending.
    bandwidth String
    The peak bandwidth of the Internet Shared Bandwidth instance.
    bandwidthPackageId String
    The resource ID of bandwidth package.
    bandwidthPackageName String
    The name of bandwidth package.
    businessStatus String
    The business status of the Common Bandwidth Package instance.
    deletionProtection Boolean
    The deletion protection of bandwidth package.
    description String
    The description of the Common Bandwidth Package instance.
    expiredTime String
    The expired time of bandwidth package.
    hasReservationData Boolean
    Is has reservation data.
    id String
    ID of the Common Bandwidth Package.
    internetChargeType String
    The internet charge type of bandwidth package.
    isp String
    ISP of the Common Bandwidth Package.
    name String
    Name of the Common Bandwidth Package.
    paymentType String
    The payment type of bandwidth package.
    publicIpAddresses List<Property Map>
    Public ip addresses that in the Common Bandwidth Pakcage.
    ratio Number
    The ratio of bandwidth package.
    reservationActiveTime String
    The active time of reservation.
    reservationBandwidth String
    The bandwidth of reservation.
    reservationInternetChargeType String
    The charge type of reservation internet.
    reservationOrderType String
    The type of reservation order.
    resourceGroupId String
    The Id of resource group which the common bandwidth package belongs.
    serviceManaged Number
    The service managed.
    status String
    The status of bandwidth package. Valid values: Available and Pending.

    GetCommonBandwidthPackagesPackagePublicIpAddress

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi