Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. ga
  5. BandwidthPackage
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.ga.BandwidthPackage

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

Provides a Global Accelerator (GA) Bandwidth Package resource.

For information about Global Accelerator (GA) Bandwidth Package and how to use it, see What is Bandwidth Package.

NOTE: At present, The alicloud.ga.BandwidthPackage created with Subscription cannot be deleted. you need to wait until the resource is outdated and released automatically.

NOTE: Available since v1.112.0.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const example = new alicloud.ga.BandwidthPackage("example", {
    bandwidth: 20,
    type: "Basic",
    bandwidthType: "Basic",
    duration: "1",
    autoPay: true,
});
Copy
import pulumi
import pulumi_alicloud as alicloud

example = alicloud.ga.BandwidthPackage("example",
    bandwidth=20,
    type="Basic",
    bandwidth_type="Basic",
    duration="1",
    auto_pay=True)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ga.NewBandwidthPackage(ctx, "example", &ga.BandwidthPackageArgs{
			Bandwidth:     pulumi.Int(20),
			Type:          pulumi.String("Basic"),
			BandwidthType: pulumi.String("Basic"),
			Duration:      pulumi.String("1"),
			AutoPay:       pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var example = new AliCloud.Ga.BandwidthPackage("example", new()
    {
        Bandwidth = 20,
        Type = "Basic",
        BandwidthType = "Basic",
        Duration = "1",
        AutoPay = true,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.ga.BandwidthPackage;
import com.pulumi.alicloud.ga.BandwidthPackageArgs;
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 example = new BandwidthPackage("example", BandwidthPackageArgs.builder()
            .bandwidth(20)
            .type("Basic")
            .bandwidthType("Basic")
            .duration(1)
            .autoPay(true)
            .build());

    }
}
Copy
resources:
  example:
    type: alicloud:ga:BandwidthPackage
    properties:
      bandwidth: 20
      type: Basic
      bandwidthType: Basic
      duration: 1
      autoPay: true
Copy

Create BandwidthPackage Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new BandwidthPackage(name: string, args: BandwidthPackageArgs, opts?: CustomResourceOptions);
@overload
def BandwidthPackage(resource_name: str,
                     args: BandwidthPackageArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def BandwidthPackage(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     bandwidth: Optional[int] = None,
                     type: Optional[str] = None,
                     cbn_geographic_region_idb: Optional[str] = None,
                     description: Optional[str] = None,
                     bandwidth_package_name: Optional[str] = None,
                     bandwidth_type: Optional[str] = None,
                     billing_type: Optional[str] = None,
                     cbn_geographic_region_ida: Optional[str] = None,
                     auto_pay: Optional[bool] = None,
                     auto_use_coupon: Optional[bool] = None,
                     duration: Optional[str] = None,
                     payment_type: Optional[str] = None,
                     promotion_option_no: Optional[str] = None,
                     ratio: Optional[int] = None,
                     renewal_status: Optional[str] = None,
                     resource_group_id: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     auto_renew_duration: Optional[int] = None)
func NewBandwidthPackage(ctx *Context, name string, args BandwidthPackageArgs, opts ...ResourceOption) (*BandwidthPackage, error)
public BandwidthPackage(string name, BandwidthPackageArgs args, CustomResourceOptions? opts = null)
public BandwidthPackage(String name, BandwidthPackageArgs args)
public BandwidthPackage(String name, BandwidthPackageArgs args, CustomResourceOptions options)

type: alicloud:ga:BandwidthPackage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. BandwidthPackageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. BandwidthPackageArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. BandwidthPackageArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. BandwidthPackageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. BandwidthPackageArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var alicloudBandwidthPackageResource = new AliCloud.Ga.BandwidthPackage("alicloudBandwidthPackageResource", new()
{
    Bandwidth = 0,
    Type = "string",
    CbnGeographicRegionIdb = "string",
    Description = "string",
    BandwidthPackageName = "string",
    BandwidthType = "string",
    BillingType = "string",
    CbnGeographicRegionIda = "string",
    AutoPay = false,
    AutoUseCoupon = false,
    Duration = "string",
    PaymentType = "string",
    PromotionOptionNo = "string",
    Ratio = 0,
    RenewalStatus = "string",
    ResourceGroupId = "string",
    Tags = 
    {
        { "string", "string" },
    },
    AutoRenewDuration = 0,
});
Copy
example, err := ga.NewBandwidthPackage(ctx, "alicloudBandwidthPackageResource", &ga.BandwidthPackageArgs{
	Bandwidth:              pulumi.Int(0),
	Type:                   pulumi.String("string"),
	CbnGeographicRegionIdb: pulumi.String("string"),
	Description:            pulumi.String("string"),
	BandwidthPackageName:   pulumi.String("string"),
	BandwidthType:          pulumi.String("string"),
	BillingType:            pulumi.String("string"),
	CbnGeographicRegionIda: pulumi.String("string"),
	AutoPay:                pulumi.Bool(false),
	AutoUseCoupon:          pulumi.Bool(false),
	Duration:               pulumi.String("string"),
	PaymentType:            pulumi.String("string"),
	PromotionOptionNo:      pulumi.String("string"),
	Ratio:                  pulumi.Int(0),
	RenewalStatus:          pulumi.String("string"),
	ResourceGroupId:        pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	AutoRenewDuration: pulumi.Int(0),
})
Copy
var alicloudBandwidthPackageResource = new com.pulumi.alicloud.ga.BandwidthPackage("alicloudBandwidthPackageResource", com.pulumi.alicloud.ga.BandwidthPackageArgs.builder()
    .bandwidth(0)
    .type("string")
    .cbnGeographicRegionIdb("string")
    .description("string")
    .bandwidthPackageName("string")
    .bandwidthType("string")
    .billingType("string")
    .cbnGeographicRegionIda("string")
    .autoPay(false)
    .autoUseCoupon(false)
    .duration("string")
    .paymentType("string")
    .promotionOptionNo("string")
    .ratio(0)
    .renewalStatus("string")
    .resourceGroupId("string")
    .tags(Map.of("string", "string"))
    .autoRenewDuration(0)
    .build());
Copy
alicloud_bandwidth_package_resource = alicloud.ga.BandwidthPackage("alicloudBandwidthPackageResource",
    bandwidth=0,
    type="string",
    cbn_geographic_region_idb="string",
    description="string",
    bandwidth_package_name="string",
    bandwidth_type="string",
    billing_type="string",
    cbn_geographic_region_ida="string",
    auto_pay=False,
    auto_use_coupon=False,
    duration="string",
    payment_type="string",
    promotion_option_no="string",
    ratio=0,
    renewal_status="string",
    resource_group_id="string",
    tags={
        "string": "string",
    },
    auto_renew_duration=0)
Copy
const alicloudBandwidthPackageResource = new alicloud.ga.BandwidthPackage("alicloudBandwidthPackageResource", {
    bandwidth: 0,
    type: "string",
    cbnGeographicRegionIdb: "string",
    description: "string",
    bandwidthPackageName: "string",
    bandwidthType: "string",
    billingType: "string",
    cbnGeographicRegionIda: "string",
    autoPay: false,
    autoUseCoupon: false,
    duration: "string",
    paymentType: "string",
    promotionOptionNo: "string",
    ratio: 0,
    renewalStatus: "string",
    resourceGroupId: "string",
    tags: {
        string: "string",
    },
    autoRenewDuration: 0,
});
Copy
type: alicloud:ga:BandwidthPackage
properties:
    autoPay: false
    autoRenewDuration: 0
    autoUseCoupon: false
    bandwidth: 0
    bandwidthPackageName: string
    bandwidthType: string
    billingType: string
    cbnGeographicRegionIda: string
    cbnGeographicRegionIdb: string
    description: string
    duration: string
    paymentType: string
    promotionOptionNo: string
    ratio: 0
    renewalStatus: string
    resourceGroupId: string
    tags:
        string: string
    type: string
Copy

BandwidthPackage Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The BandwidthPackage resource accepts the following input properties:

Bandwidth This property is required. int
The bandwidth value of bandwidth packet.
Type
This property is required.
Changes to this property will trigger replacement.
string
The type of the bandwidth packet. China station only supports return to basic. Valid values: Basic, CrossDomain.
AutoPay bool
Whether to pay automatically. Valid values:
AutoRenewDuration int
Auto renewal period of a bandwidth packet, in the unit of month. Valid values: 1 to 12.
AutoUseCoupon bool
Whether use vouchers. Default value: false. Valid values:
BandwidthPackageName string
The name of the bandwidth packet.
BandwidthType string

The bandwidth type of the bandwidth. Valid values: Advanced, Basic, Enhanced. If type is set to Basic, this parameter is required.

NOTE: At present, only basic can be configured to enhanced, but not enhanced and advanced to other types of accelerated bandwidth.

BillingType Changes to this property will trigger replacement. string
The billing type. Valid values: PayBy95, PayByTraffic. NOTE: billing_type is valid only when payment_type is set to PayAsYouGo.
CbnGeographicRegionIda Changes to this property will trigger replacement. string
Interworking area A of cross domain acceleration package. Only international stations support returning this parameter. Default value: China-mainland.
CbnGeographicRegionIdb Changes to this property will trigger replacement. string
Interworking area B of cross domain acceleration package. Only international stations support returning this parameter. Default value: Global.
Description string
The description of bandwidth package.
Duration string
The subscription duration. NOTE: The ForceNew attribute has be removed from version 1.148.0. If payment_type is set to Subscription, this parameter is required.
PaymentType Changes to this property will trigger replacement. string
The payment type of the bandwidth. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
PromotionOptionNo string
The code of the coupon. NOTE: The promotion_option_no takes effect only for accounts registered on the international site (alibabacloud.com).
Ratio Changes to this property will trigger replacement. int
The minimum percentage for the pay-by-95th-percentile metering method. Valid values: 30 to 100. NOTE: ratio is valid only when billing_type is set to PayBy95.
RenewalStatus string
Whether to renew a bandwidth packet. automatically or not. Valid values:

  • AutoRenewal: Enable auto renewal.
  • Normal: Disable auto renewal.
  • NotRenewal: No renewal any longer. After you specify this value, Alibaba Cloud stop sending notification of instance expiry, and only gives a brief reminder on the third day before the instance expiry.
ResourceGroupId string
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
Bandwidth This property is required. int
The bandwidth value of bandwidth packet.
Type
This property is required.
Changes to this property will trigger replacement.
string
The type of the bandwidth packet. China station only supports return to basic. Valid values: Basic, CrossDomain.
AutoPay bool
Whether to pay automatically. Valid values:
AutoRenewDuration int
Auto renewal period of a bandwidth packet, in the unit of month. Valid values: 1 to 12.
AutoUseCoupon bool
Whether use vouchers. Default value: false. Valid values:
BandwidthPackageName string
The name of the bandwidth packet.
BandwidthType string

The bandwidth type of the bandwidth. Valid values: Advanced, Basic, Enhanced. If type is set to Basic, this parameter is required.

NOTE: At present, only basic can be configured to enhanced, but not enhanced and advanced to other types of accelerated bandwidth.

BillingType Changes to this property will trigger replacement. string
The billing type. Valid values: PayBy95, PayByTraffic. NOTE: billing_type is valid only when payment_type is set to PayAsYouGo.
CbnGeographicRegionIda Changes to this property will trigger replacement. string
Interworking area A of cross domain acceleration package. Only international stations support returning this parameter. Default value: China-mainland.
CbnGeographicRegionIdb Changes to this property will trigger replacement. string
Interworking area B of cross domain acceleration package. Only international stations support returning this parameter. Default value: Global.
Description string
The description of bandwidth package.
Duration string
The subscription duration. NOTE: The ForceNew attribute has be removed from version 1.148.0. If payment_type is set to Subscription, this parameter is required.
PaymentType Changes to this property will trigger replacement. string
The payment type of the bandwidth. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
PromotionOptionNo string
The code of the coupon. NOTE: The promotion_option_no takes effect only for accounts registered on the international site (alibabacloud.com).
Ratio Changes to this property will trigger replacement. int
The minimum percentage for the pay-by-95th-percentile metering method. Valid values: 30 to 100. NOTE: ratio is valid only when billing_type is set to PayBy95.
RenewalStatus string
Whether to renew a bandwidth packet. automatically or not. Valid values:

  • AutoRenewal: Enable auto renewal.
  • Normal: Disable auto renewal.
  • NotRenewal: No renewal any longer. After you specify this value, Alibaba Cloud stop sending notification of instance expiry, and only gives a brief reminder on the third day before the instance expiry.
ResourceGroupId string
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
Tags map[string]string
A mapping of tags to assign to the resource.
bandwidth This property is required. Integer
The bandwidth value of bandwidth packet.
type
This property is required.
Changes to this property will trigger replacement.
String
The type of the bandwidth packet. China station only supports return to basic. Valid values: Basic, CrossDomain.
autoPay Boolean
Whether to pay automatically. Valid values:
autoRenewDuration Integer
Auto renewal period of a bandwidth packet, in the unit of month. Valid values: 1 to 12.
autoUseCoupon Boolean
Whether use vouchers. Default value: false. Valid values:
bandwidthPackageName String
The name of the bandwidth packet.
bandwidthType String

The bandwidth type of the bandwidth. Valid values: Advanced, Basic, Enhanced. If type is set to Basic, this parameter is required.

NOTE: At present, only basic can be configured to enhanced, but not enhanced and advanced to other types of accelerated bandwidth.

billingType Changes to this property will trigger replacement. String
The billing type. Valid values: PayBy95, PayByTraffic. NOTE: billing_type is valid only when payment_type is set to PayAsYouGo.
cbnGeographicRegionIda Changes to this property will trigger replacement. String
Interworking area A of cross domain acceleration package. Only international stations support returning this parameter. Default value: China-mainland.
cbnGeographicRegionIdb Changes to this property will trigger replacement. String
Interworking area B of cross domain acceleration package. Only international stations support returning this parameter. Default value: Global.
description String
The description of bandwidth package.
duration String
The subscription duration. NOTE: The ForceNew attribute has be removed from version 1.148.0. If payment_type is set to Subscription, this parameter is required.
paymentType Changes to this property will trigger replacement. String
The payment type of the bandwidth. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
promotionOptionNo String
The code of the coupon. NOTE: The promotion_option_no takes effect only for accounts registered on the international site (alibabacloud.com).
ratio Changes to this property will trigger replacement. Integer
The minimum percentage for the pay-by-95th-percentile metering method. Valid values: 30 to 100. NOTE: ratio is valid only when billing_type is set to PayBy95.
renewalStatus String
Whether to renew a bandwidth packet. automatically or not. Valid values:

  • AutoRenewal: Enable auto renewal.
  • Normal: Disable auto renewal.
  • NotRenewal: No renewal any longer. After you specify this value, Alibaba Cloud stop sending notification of instance expiry, and only gives a brief reminder on the third day before the instance expiry.
resourceGroupId String
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
tags Map<String,String>
A mapping of tags to assign to the resource.
bandwidth This property is required. number
The bandwidth value of bandwidth packet.
type
This property is required.
Changes to this property will trigger replacement.
string
The type of the bandwidth packet. China station only supports return to basic. Valid values: Basic, CrossDomain.
autoPay boolean
Whether to pay automatically. Valid values:
autoRenewDuration number
Auto renewal period of a bandwidth packet, in the unit of month. Valid values: 1 to 12.
autoUseCoupon boolean
Whether use vouchers. Default value: false. Valid values:
bandwidthPackageName string
The name of the bandwidth packet.
bandwidthType string

The bandwidth type of the bandwidth. Valid values: Advanced, Basic, Enhanced. If type is set to Basic, this parameter is required.

NOTE: At present, only basic can be configured to enhanced, but not enhanced and advanced to other types of accelerated bandwidth.

billingType Changes to this property will trigger replacement. string
The billing type. Valid values: PayBy95, PayByTraffic. NOTE: billing_type is valid only when payment_type is set to PayAsYouGo.
cbnGeographicRegionIda Changes to this property will trigger replacement. string
Interworking area A of cross domain acceleration package. Only international stations support returning this parameter. Default value: China-mainland.
cbnGeographicRegionIdb Changes to this property will trigger replacement. string
Interworking area B of cross domain acceleration package. Only international stations support returning this parameter. Default value: Global.
description string
The description of bandwidth package.
duration string
The subscription duration. NOTE: The ForceNew attribute has be removed from version 1.148.0. If payment_type is set to Subscription, this parameter is required.
paymentType Changes to this property will trigger replacement. string
The payment type of the bandwidth. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
promotionOptionNo string
The code of the coupon. NOTE: The promotion_option_no takes effect only for accounts registered on the international site (alibabacloud.com).
ratio Changes to this property will trigger replacement. number
The minimum percentage for the pay-by-95th-percentile metering method. Valid values: 30 to 100. NOTE: ratio is valid only when billing_type is set to PayBy95.
renewalStatus string
Whether to renew a bandwidth packet. automatically or not. Valid values:

  • AutoRenewal: Enable auto renewal.
  • Normal: Disable auto renewal.
  • NotRenewal: No renewal any longer. After you specify this value, Alibaba Cloud stop sending notification of instance expiry, and only gives a brief reminder on the third day before the instance expiry.
resourceGroupId string
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
bandwidth This property is required. int
The bandwidth value of bandwidth packet.
type
This property is required.
Changes to this property will trigger replacement.
str
The type of the bandwidth packet. China station only supports return to basic. Valid values: Basic, CrossDomain.
auto_pay bool
Whether to pay automatically. Valid values:
auto_renew_duration int
Auto renewal period of a bandwidth packet, in the unit of month. Valid values: 1 to 12.
auto_use_coupon bool
Whether use vouchers. Default value: false. Valid values:
bandwidth_package_name str
The name of the bandwidth packet.
bandwidth_type str

The bandwidth type of the bandwidth. Valid values: Advanced, Basic, Enhanced. If type is set to Basic, this parameter is required.

NOTE: At present, only basic can be configured to enhanced, but not enhanced and advanced to other types of accelerated bandwidth.

billing_type Changes to this property will trigger replacement. str
The billing type. Valid values: PayBy95, PayByTraffic. NOTE: billing_type is valid only when payment_type is set to PayAsYouGo.
cbn_geographic_region_ida Changes to this property will trigger replacement. str
Interworking area A of cross domain acceleration package. Only international stations support returning this parameter. Default value: China-mainland.
cbn_geographic_region_idb Changes to this property will trigger replacement. str
Interworking area B of cross domain acceleration package. Only international stations support returning this parameter. Default value: Global.
description str
The description of bandwidth package.
duration str
The subscription duration. NOTE: The ForceNew attribute has be removed from version 1.148.0. If payment_type is set to Subscription, this parameter is required.
payment_type Changes to this property will trigger replacement. str
The payment type of the bandwidth. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
promotion_option_no str
The code of the coupon. NOTE: The promotion_option_no takes effect only for accounts registered on the international site (alibabacloud.com).
ratio Changes to this property will trigger replacement. int
The minimum percentage for the pay-by-95th-percentile metering method. Valid values: 30 to 100. NOTE: ratio is valid only when billing_type is set to PayBy95.
renewal_status str
Whether to renew a bandwidth packet. automatically or not. Valid values:

  • AutoRenewal: Enable auto renewal.
  • Normal: Disable auto renewal.
  • NotRenewal: No renewal any longer. After you specify this value, Alibaba Cloud stop sending notification of instance expiry, and only gives a brief reminder on the third day before the instance expiry.
resource_group_id str
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
bandwidth This property is required. Number
The bandwidth value of bandwidth packet.
type
This property is required.
Changes to this property will trigger replacement.
String
The type of the bandwidth packet. China station only supports return to basic. Valid values: Basic, CrossDomain.
autoPay Boolean
Whether to pay automatically. Valid values:
autoRenewDuration Number
Auto renewal period of a bandwidth packet, in the unit of month. Valid values: 1 to 12.
autoUseCoupon Boolean
Whether use vouchers. Default value: false. Valid values:
bandwidthPackageName String
The name of the bandwidth packet.
bandwidthType String

The bandwidth type of the bandwidth. Valid values: Advanced, Basic, Enhanced. If type is set to Basic, this parameter is required.

NOTE: At present, only basic can be configured to enhanced, but not enhanced and advanced to other types of accelerated bandwidth.

billingType Changes to this property will trigger replacement. String
The billing type. Valid values: PayBy95, PayByTraffic. NOTE: billing_type is valid only when payment_type is set to PayAsYouGo.
cbnGeographicRegionIda Changes to this property will trigger replacement. String
Interworking area A of cross domain acceleration package. Only international stations support returning this parameter. Default value: China-mainland.
cbnGeographicRegionIdb Changes to this property will trigger replacement. String
Interworking area B of cross domain acceleration package. Only international stations support returning this parameter. Default value: Global.
description String
The description of bandwidth package.
duration String
The subscription duration. NOTE: The ForceNew attribute has be removed from version 1.148.0. If payment_type is set to Subscription, this parameter is required.
paymentType Changes to this property will trigger replacement. String
The payment type of the bandwidth. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
promotionOptionNo String
The code of the coupon. NOTE: The promotion_option_no takes effect only for accounts registered on the international site (alibabacloud.com).
ratio Changes to this property will trigger replacement. Number
The minimum percentage for the pay-by-95th-percentile metering method. Valid values: 30 to 100. NOTE: ratio is valid only when billing_type is set to PayBy95.
renewalStatus String
Whether to renew a bandwidth packet. automatically or not. Valid values:

  • AutoRenewal: Enable auto renewal.
  • Normal: Disable auto renewal.
  • NotRenewal: No renewal any longer. After you specify this value, Alibaba Cloud stop sending notification of instance expiry, and only gives a brief reminder on the third day before the instance expiry.
resourceGroupId String
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
tags Map<String>
A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the BandwidthPackage resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Status string
The status of the Bandwidth Package.
Id string
The provider-assigned unique ID for this managed resource.
Status string
The status of the Bandwidth Package.
id String
The provider-assigned unique ID for this managed resource.
status String
The status of the Bandwidth Package.
id string
The provider-assigned unique ID for this managed resource.
status string
The status of the Bandwidth Package.
id str
The provider-assigned unique ID for this managed resource.
status str
The status of the Bandwidth Package.
id String
The provider-assigned unique ID for this managed resource.
status String
The status of the Bandwidth Package.

Look up Existing BandwidthPackage Resource

Get an existing BandwidthPackage resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: BandwidthPackageState, opts?: CustomResourceOptions): BandwidthPackage
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_pay: Optional[bool] = None,
        auto_renew_duration: Optional[int] = None,
        auto_use_coupon: Optional[bool] = None,
        bandwidth: Optional[int] = None,
        bandwidth_package_name: Optional[str] = None,
        bandwidth_type: Optional[str] = None,
        billing_type: Optional[str] = None,
        cbn_geographic_region_ida: Optional[str] = None,
        cbn_geographic_region_idb: Optional[str] = None,
        description: Optional[str] = None,
        duration: Optional[str] = None,
        payment_type: Optional[str] = None,
        promotion_option_no: Optional[str] = None,
        ratio: Optional[int] = None,
        renewal_status: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        type: Optional[str] = None) -> BandwidthPackage
func GetBandwidthPackage(ctx *Context, name string, id IDInput, state *BandwidthPackageState, opts ...ResourceOption) (*BandwidthPackage, error)
public static BandwidthPackage Get(string name, Input<string> id, BandwidthPackageState? state, CustomResourceOptions? opts = null)
public static BandwidthPackage get(String name, Output<String> id, BandwidthPackageState state, CustomResourceOptions options)
resources:  _:    type: alicloud:ga:BandwidthPackage    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AutoPay bool
Whether to pay automatically. Valid values:
AutoRenewDuration int
Auto renewal period of a bandwidth packet, in the unit of month. Valid values: 1 to 12.
AutoUseCoupon bool
Whether use vouchers. Default value: false. Valid values:
Bandwidth int
The bandwidth value of bandwidth packet.
BandwidthPackageName string
The name of the bandwidth packet.
BandwidthType string

The bandwidth type of the bandwidth. Valid values: Advanced, Basic, Enhanced. If type is set to Basic, this parameter is required.

NOTE: At present, only basic can be configured to enhanced, but not enhanced and advanced to other types of accelerated bandwidth.

BillingType Changes to this property will trigger replacement. string
The billing type. Valid values: PayBy95, PayByTraffic. NOTE: billing_type is valid only when payment_type is set to PayAsYouGo.
CbnGeographicRegionIda Changes to this property will trigger replacement. string
Interworking area A of cross domain acceleration package. Only international stations support returning this parameter. Default value: China-mainland.
CbnGeographicRegionIdb Changes to this property will trigger replacement. string
Interworking area B of cross domain acceleration package. Only international stations support returning this parameter. Default value: Global.
Description string
The description of bandwidth package.
Duration string
The subscription duration. NOTE: The ForceNew attribute has be removed from version 1.148.0. If payment_type is set to Subscription, this parameter is required.
PaymentType Changes to this property will trigger replacement. string
The payment type of the bandwidth. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
PromotionOptionNo string
The code of the coupon. NOTE: The promotion_option_no takes effect only for accounts registered on the international site (alibabacloud.com).
Ratio Changes to this property will trigger replacement. int
The minimum percentage for the pay-by-95th-percentile metering method. Valid values: 30 to 100. NOTE: ratio is valid only when billing_type is set to PayBy95.
RenewalStatus string
Whether to renew a bandwidth packet. automatically or not. Valid values:

  • AutoRenewal: Enable auto renewal.
  • Normal: Disable auto renewal.
  • NotRenewal: No renewal any longer. After you specify this value, Alibaba Cloud stop sending notification of instance expiry, and only gives a brief reminder on the third day before the instance expiry.
ResourceGroupId string
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
Status string
The status of the Bandwidth Package.
Tags Dictionary<string, string>
A mapping of tags to assign to the resource.
Type Changes to this property will trigger replacement. string
The type of the bandwidth packet. China station only supports return to basic. Valid values: Basic, CrossDomain.
AutoPay bool
Whether to pay automatically. Valid values:
AutoRenewDuration int
Auto renewal period of a bandwidth packet, in the unit of month. Valid values: 1 to 12.
AutoUseCoupon bool
Whether use vouchers. Default value: false. Valid values:
Bandwidth int
The bandwidth value of bandwidth packet.
BandwidthPackageName string
The name of the bandwidth packet.
BandwidthType string

The bandwidth type of the bandwidth. Valid values: Advanced, Basic, Enhanced. If type is set to Basic, this parameter is required.

NOTE: At present, only basic can be configured to enhanced, but not enhanced and advanced to other types of accelerated bandwidth.

BillingType Changes to this property will trigger replacement. string
The billing type. Valid values: PayBy95, PayByTraffic. NOTE: billing_type is valid only when payment_type is set to PayAsYouGo.
CbnGeographicRegionIda Changes to this property will trigger replacement. string
Interworking area A of cross domain acceleration package. Only international stations support returning this parameter. Default value: China-mainland.
CbnGeographicRegionIdb Changes to this property will trigger replacement. string
Interworking area B of cross domain acceleration package. Only international stations support returning this parameter. Default value: Global.
Description string
The description of bandwidth package.
Duration string
The subscription duration. NOTE: The ForceNew attribute has be removed from version 1.148.0. If payment_type is set to Subscription, this parameter is required.
PaymentType Changes to this property will trigger replacement. string
The payment type of the bandwidth. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
PromotionOptionNo string
The code of the coupon. NOTE: The promotion_option_no takes effect only for accounts registered on the international site (alibabacloud.com).
Ratio Changes to this property will trigger replacement. int
The minimum percentage for the pay-by-95th-percentile metering method. Valid values: 30 to 100. NOTE: ratio is valid only when billing_type is set to PayBy95.
RenewalStatus string
Whether to renew a bandwidth packet. automatically or not. Valid values:

  • AutoRenewal: Enable auto renewal.
  • Normal: Disable auto renewal.
  • NotRenewal: No renewal any longer. After you specify this value, Alibaba Cloud stop sending notification of instance expiry, and only gives a brief reminder on the third day before the instance expiry.
ResourceGroupId string
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
Status string
The status of the Bandwidth Package.
Tags map[string]string
A mapping of tags to assign to the resource.
Type Changes to this property will trigger replacement. string
The type of the bandwidth packet. China station only supports return to basic. Valid values: Basic, CrossDomain.
autoPay Boolean
Whether to pay automatically. Valid values:
autoRenewDuration Integer
Auto renewal period of a bandwidth packet, in the unit of month. Valid values: 1 to 12.
autoUseCoupon Boolean
Whether use vouchers. Default value: false. Valid values:
bandwidth Integer
The bandwidth value of bandwidth packet.
bandwidthPackageName String
The name of the bandwidth packet.
bandwidthType String

The bandwidth type of the bandwidth. Valid values: Advanced, Basic, Enhanced. If type is set to Basic, this parameter is required.

NOTE: At present, only basic can be configured to enhanced, but not enhanced and advanced to other types of accelerated bandwidth.

billingType Changes to this property will trigger replacement. String
The billing type. Valid values: PayBy95, PayByTraffic. NOTE: billing_type is valid only when payment_type is set to PayAsYouGo.
cbnGeographicRegionIda Changes to this property will trigger replacement. String
Interworking area A of cross domain acceleration package. Only international stations support returning this parameter. Default value: China-mainland.
cbnGeographicRegionIdb Changes to this property will trigger replacement. String
Interworking area B of cross domain acceleration package. Only international stations support returning this parameter. Default value: Global.
description String
The description of bandwidth package.
duration String
The subscription duration. NOTE: The ForceNew attribute has be removed from version 1.148.0. If payment_type is set to Subscription, this parameter is required.
paymentType Changes to this property will trigger replacement. String
The payment type of the bandwidth. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
promotionOptionNo String
The code of the coupon. NOTE: The promotion_option_no takes effect only for accounts registered on the international site (alibabacloud.com).
ratio Changes to this property will trigger replacement. Integer
The minimum percentage for the pay-by-95th-percentile metering method. Valid values: 30 to 100. NOTE: ratio is valid only when billing_type is set to PayBy95.
renewalStatus String
Whether to renew a bandwidth packet. automatically or not. Valid values:

  • AutoRenewal: Enable auto renewal.
  • Normal: Disable auto renewal.
  • NotRenewal: No renewal any longer. After you specify this value, Alibaba Cloud stop sending notification of instance expiry, and only gives a brief reminder on the third day before the instance expiry.
resourceGroupId String
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
status String
The status of the Bandwidth Package.
tags Map<String,String>
A mapping of tags to assign to the resource.
type Changes to this property will trigger replacement. String
The type of the bandwidth packet. China station only supports return to basic. Valid values: Basic, CrossDomain.
autoPay boolean
Whether to pay automatically. Valid values:
autoRenewDuration number
Auto renewal period of a bandwidth packet, in the unit of month. Valid values: 1 to 12.
autoUseCoupon boolean
Whether use vouchers. Default value: false. Valid values:
bandwidth number
The bandwidth value of bandwidth packet.
bandwidthPackageName string
The name of the bandwidth packet.
bandwidthType string

The bandwidth type of the bandwidth. Valid values: Advanced, Basic, Enhanced. If type is set to Basic, this parameter is required.

NOTE: At present, only basic can be configured to enhanced, but not enhanced and advanced to other types of accelerated bandwidth.

billingType Changes to this property will trigger replacement. string
The billing type. Valid values: PayBy95, PayByTraffic. NOTE: billing_type is valid only when payment_type is set to PayAsYouGo.
cbnGeographicRegionIda Changes to this property will trigger replacement. string
Interworking area A of cross domain acceleration package. Only international stations support returning this parameter. Default value: China-mainland.
cbnGeographicRegionIdb Changes to this property will trigger replacement. string
Interworking area B of cross domain acceleration package. Only international stations support returning this parameter. Default value: Global.
description string
The description of bandwidth package.
duration string
The subscription duration. NOTE: The ForceNew attribute has be removed from version 1.148.0. If payment_type is set to Subscription, this parameter is required.
paymentType Changes to this property will trigger replacement. string
The payment type of the bandwidth. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
promotionOptionNo string
The code of the coupon. NOTE: The promotion_option_no takes effect only for accounts registered on the international site (alibabacloud.com).
ratio Changes to this property will trigger replacement. number
The minimum percentage for the pay-by-95th-percentile metering method. Valid values: 30 to 100. NOTE: ratio is valid only when billing_type is set to PayBy95.
renewalStatus string
Whether to renew a bandwidth packet. automatically or not. Valid values:

  • AutoRenewal: Enable auto renewal.
  • Normal: Disable auto renewal.
  • NotRenewal: No renewal any longer. After you specify this value, Alibaba Cloud stop sending notification of instance expiry, and only gives a brief reminder on the third day before the instance expiry.
resourceGroupId string
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
status string
The status of the Bandwidth Package.
tags {[key: string]: string}
A mapping of tags to assign to the resource.
type Changes to this property will trigger replacement. string
The type of the bandwidth packet. China station only supports return to basic. Valid values: Basic, CrossDomain.
auto_pay bool
Whether to pay automatically. Valid values:
auto_renew_duration int
Auto renewal period of a bandwidth packet, in the unit of month. Valid values: 1 to 12.
auto_use_coupon bool
Whether use vouchers. Default value: false. Valid values:
bandwidth int
The bandwidth value of bandwidth packet.
bandwidth_package_name str
The name of the bandwidth packet.
bandwidth_type str

The bandwidth type of the bandwidth. Valid values: Advanced, Basic, Enhanced. If type is set to Basic, this parameter is required.

NOTE: At present, only basic can be configured to enhanced, but not enhanced and advanced to other types of accelerated bandwidth.

billing_type Changes to this property will trigger replacement. str
The billing type. Valid values: PayBy95, PayByTraffic. NOTE: billing_type is valid only when payment_type is set to PayAsYouGo.
cbn_geographic_region_ida Changes to this property will trigger replacement. str
Interworking area A of cross domain acceleration package. Only international stations support returning this parameter. Default value: China-mainland.
cbn_geographic_region_idb Changes to this property will trigger replacement. str
Interworking area B of cross domain acceleration package. Only international stations support returning this parameter. Default value: Global.
description str
The description of bandwidth package.
duration str
The subscription duration. NOTE: The ForceNew attribute has be removed from version 1.148.0. If payment_type is set to Subscription, this parameter is required.
payment_type Changes to this property will trigger replacement. str
The payment type of the bandwidth. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
promotion_option_no str
The code of the coupon. NOTE: The promotion_option_no takes effect only for accounts registered on the international site (alibabacloud.com).
ratio Changes to this property will trigger replacement. int
The minimum percentage for the pay-by-95th-percentile metering method. Valid values: 30 to 100. NOTE: ratio is valid only when billing_type is set to PayBy95.
renewal_status str
Whether to renew a bandwidth packet. automatically or not. Valid values:

  • AutoRenewal: Enable auto renewal.
  • Normal: Disable auto renewal.
  • NotRenewal: No renewal any longer. After you specify this value, Alibaba Cloud stop sending notification of instance expiry, and only gives a brief reminder on the third day before the instance expiry.
resource_group_id str
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
status str
The status of the Bandwidth Package.
tags Mapping[str, str]
A mapping of tags to assign to the resource.
type Changes to this property will trigger replacement. str
The type of the bandwidth packet. China station only supports return to basic. Valid values: Basic, CrossDomain.
autoPay Boolean
Whether to pay automatically. Valid values:
autoRenewDuration Number
Auto renewal period of a bandwidth packet, in the unit of month. Valid values: 1 to 12.
autoUseCoupon Boolean
Whether use vouchers. Default value: false. Valid values:
bandwidth Number
The bandwidth value of bandwidth packet.
bandwidthPackageName String
The name of the bandwidth packet.
bandwidthType String

The bandwidth type of the bandwidth. Valid values: Advanced, Basic, Enhanced. If type is set to Basic, this parameter is required.

NOTE: At present, only basic can be configured to enhanced, but not enhanced and advanced to other types of accelerated bandwidth.

billingType Changes to this property will trigger replacement. String
The billing type. Valid values: PayBy95, PayByTraffic. NOTE: billing_type is valid only when payment_type is set to PayAsYouGo.
cbnGeographicRegionIda Changes to this property will trigger replacement. String
Interworking area A of cross domain acceleration package. Only international stations support returning this parameter. Default value: China-mainland.
cbnGeographicRegionIdb Changes to this property will trigger replacement. String
Interworking area B of cross domain acceleration package. Only international stations support returning this parameter. Default value: Global.
description String
The description of bandwidth package.
duration String
The subscription duration. NOTE: The ForceNew attribute has be removed from version 1.148.0. If payment_type is set to Subscription, this parameter is required.
paymentType Changes to this property will trigger replacement. String
The payment type of the bandwidth. Default value: Subscription. Valid values: PayAsYouGo, Subscription.
promotionOptionNo String
The code of the coupon. NOTE: The promotion_option_no takes effect only for accounts registered on the international site (alibabacloud.com).
ratio Changes to this property will trigger replacement. Number
The minimum percentage for the pay-by-95th-percentile metering method. Valid values: 30 to 100. NOTE: ratio is valid only when billing_type is set to PayBy95.
renewalStatus String
Whether to renew a bandwidth packet. automatically or not. Valid values:

  • AutoRenewal: Enable auto renewal.
  • Normal: Disable auto renewal.
  • NotRenewal: No renewal any longer. After you specify this value, Alibaba Cloud stop sending notification of instance expiry, and only gives a brief reminder on the third day before the instance expiry.
resourceGroupId String
The ID of the resource group. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
status String
The status of the Bandwidth Package.
tags Map<String>
A mapping of tags to assign to the resource.
type Changes to this property will trigger replacement. String
The type of the bandwidth packet. China station only supports return to basic. Valid values: Basic, CrossDomain.

Import

Ga Bandwidth Package can be imported using the id, e.g.

$ pulumi import alicloud:ga/bandwidthPackage:BandwidthPackage example <id>
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud