1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. vpc
  6. BandwidthPackage
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.vpc.BandwidthPackage

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    A shared bandwidth package is a cloud resource that supports multiplexing and sharing bandwidth. Add multiple public IPs or IPv6 public bandwidths within a single region to a shared bandwidth package instance to share one bandwidth.

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  bandwidthPackageDemo:
    type: volcenginecc:vpc:BandwidthPackage
    name: BandwidthPackageDemo
    properties:
      period: 1
      periodUnit: 1
      protocol: Dual-stack
      tags:
        - key: env
          value: test
      bandwidthPackageName: BandwidthPackageDemo
      description: BandwidthPackageDemo
      isp: BGP
      billingType: 2
      bandwidth: 2
      projectName: default
      eipAddresses:
        - allocation_id: eip-2f90y2a8sczcw4f4pzzx1xxxx
          eip_address: 101.126.*.143

    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,
                     bandwidth_package_name: Optional[str] = None,
                     billing_type: Optional[int] = None,
                     description: Optional[str] = None,
                     eip_addresses: Optional[Sequence[BandwidthPackageEipAddressArgs]] = None,
                     enable_dual_stack: Optional[bool] = None,
                     isp: Optional[str] = None,
                     period: Optional[int] = None,
                     period_unit: Optional[int] = None,
                     project_name: Optional[str] = None,
                     protocol: Optional[str] = None,
                     security_protection_types: Optional[Sequence[str]] = None,
                     tags: Optional[Sequence[BandwidthPackageTagArgs]] = 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: volcenginecc:vpc:BandwidthPackage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args BandwidthPackageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args BandwidthPackageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BandwidthPackageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BandwidthPackageArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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 int
    Bandwidth cap of the shared bandwidth package, unit: Mbps. If BillingType is 1: range is 5–5000. If BillingType is 2, 3, or 4: range is 2–5000.
    BandwidthPackageName string
    Bandwidth package name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).
    BillingType int
    Billing methods for shared bandwidth packages. Options are: 1: Annual/monthly subscription. 2: Billed by bandwidth cap (default). 3: Billed by peak traffic. 4: Billed by traditional 95th percentile (minimum ratio defaults to 20%).
    Description string
    Description, limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    EipAddresses List<Volcengine.BandwidthPackageEipAddress>
    EnableDualStack bool
    Enable dual stack. Options: true: enable dual stack; false: do not enable dual stack.
    Isp string
    Line type, default is BGP. BGP: BGP (multi-line). 1. If your account has applied for and enabled static single line permissions, you can use the following values: 1.1, ChinaMobile: China Mobile static single line. 1.2, ChinaTelecom: China Telecom static single line. 1.3, ChinaUnicom: China Unicom static single line. 2. If your account has applied for and enabled BGP single line permissions, you can use SingleLineBGP. 3. If your account has applied for and enabled Premium BGP permissions, you can use PremiumBGP. 4. If your account has applied for and enabled Fusion BGP permissions, you can use FusionBGP. 5. If your account has applied for and enabled Economical static single line permissions, you can use the following values: 5.1, ChinaMobileValue: China Mobile economical static single line. 5.2, ChinaUnicomValue: China Unicom economical static single line. 5.3, ChinaTelecomValue: China Telecom economical static single line.
    Period int
    Duration for purchasing yearly/monthly shared bandwidth package, default is '1'. If PeriodUnit is 1, Period can be 1–9, 12, 24, or 36. If PeriodUnit is 2, Period can be 1–3.
    PeriodUnit int
    Unit for the duration when purchasing an annual/monthly subscription shared bandwidth package. Options are: 1: Month (default). 2: Year.
    ProjectName string
    Project name. If not specified, added to the default project.
    Protocol string
    IP protocol of the shared bandwidth package. Options are: Dual-stack: Dual-stack protocol type. IPv4: IPv4 protocol type. This parameter supports Dual-stack only when BillingType is 2 or 4.
    SecurityProtectionTypes List<string>
    Security protection type of the shared bandwidth package. AntiDDoS_Enhanced: Create an enhanced protection shared bandwidth package, which supports adding public IPs with basic protection. If not specified, it means a basic protection shared bandwidth package, which supports adding public IPs with enhanced protection.
    Tags List<Volcengine.BandwidthPackageTag>
    Bandwidth int
    Bandwidth cap of the shared bandwidth package, unit: Mbps. If BillingType is 1: range is 5–5000. If BillingType is 2, 3, or 4: range is 2–5000.
    BandwidthPackageName string
    Bandwidth package name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).
    BillingType int
    Billing methods for shared bandwidth packages. Options are: 1: Annual/monthly subscription. 2: Billed by bandwidth cap (default). 3: Billed by peak traffic. 4: Billed by traditional 95th percentile (minimum ratio defaults to 20%).
    Description string
    Description, limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    EipAddresses []BandwidthPackageEipAddressArgs
    EnableDualStack bool
    Enable dual stack. Options: true: enable dual stack; false: do not enable dual stack.
    Isp string
    Line type, default is BGP. BGP: BGP (multi-line). 1. If your account has applied for and enabled static single line permissions, you can use the following values: 1.1, ChinaMobile: China Mobile static single line. 1.2, ChinaTelecom: China Telecom static single line. 1.3, ChinaUnicom: China Unicom static single line. 2. If your account has applied for and enabled BGP single line permissions, you can use SingleLineBGP. 3. If your account has applied for and enabled Premium BGP permissions, you can use PremiumBGP. 4. If your account has applied for and enabled Fusion BGP permissions, you can use FusionBGP. 5. If your account has applied for and enabled Economical static single line permissions, you can use the following values: 5.1, ChinaMobileValue: China Mobile economical static single line. 5.2, ChinaUnicomValue: China Unicom economical static single line. 5.3, ChinaTelecomValue: China Telecom economical static single line.
    Period int
    Duration for purchasing yearly/monthly shared bandwidth package, default is '1'. If PeriodUnit is 1, Period can be 1–9, 12, 24, or 36. If PeriodUnit is 2, Period can be 1–3.
    PeriodUnit int
    Unit for the duration when purchasing an annual/monthly subscription shared bandwidth package. Options are: 1: Month (default). 2: Year.
    ProjectName string
    Project name. If not specified, added to the default project.
    Protocol string
    IP protocol of the shared bandwidth package. Options are: Dual-stack: Dual-stack protocol type. IPv4: IPv4 protocol type. This parameter supports Dual-stack only when BillingType is 2 or 4.
    SecurityProtectionTypes []string
    Security protection type of the shared bandwidth package. AntiDDoS_Enhanced: Create an enhanced protection shared bandwidth package, which supports adding public IPs with basic protection. If not specified, it means a basic protection shared bandwidth package, which supports adding public IPs with enhanced protection.
    Tags []BandwidthPackageTagArgs
    bandwidth Integer
    Bandwidth cap of the shared bandwidth package, unit: Mbps. If BillingType is 1: range is 5–5000. If BillingType is 2, 3, or 4: range is 2–5000.
    bandwidthPackageName String
    Bandwidth package name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).
    billingType Integer
    Billing methods for shared bandwidth packages. Options are: 1: Annual/monthly subscription. 2: Billed by bandwidth cap (default). 3: Billed by peak traffic. 4: Billed by traditional 95th percentile (minimum ratio defaults to 20%).
    description String
    Description, limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    eipAddresses List<BandwidthPackageEipAddress>
    enableDualStack Boolean
    Enable dual stack. Options: true: enable dual stack; false: do not enable dual stack.
    isp String
    Line type, default is BGP. BGP: BGP (multi-line). 1. If your account has applied for and enabled static single line permissions, you can use the following values: 1.1, ChinaMobile: China Mobile static single line. 1.2, ChinaTelecom: China Telecom static single line. 1.3, ChinaUnicom: China Unicom static single line. 2. If your account has applied for and enabled BGP single line permissions, you can use SingleLineBGP. 3. If your account has applied for and enabled Premium BGP permissions, you can use PremiumBGP. 4. If your account has applied for and enabled Fusion BGP permissions, you can use FusionBGP. 5. If your account has applied for and enabled Economical static single line permissions, you can use the following values: 5.1, ChinaMobileValue: China Mobile economical static single line. 5.2, ChinaUnicomValue: China Unicom economical static single line. 5.3, ChinaTelecomValue: China Telecom economical static single line.
    period Integer
    Duration for purchasing yearly/monthly shared bandwidth package, default is '1'. If PeriodUnit is 1, Period can be 1–9, 12, 24, or 36. If PeriodUnit is 2, Period can be 1–3.
    periodUnit Integer
    Unit for the duration when purchasing an annual/monthly subscription shared bandwidth package. Options are: 1: Month (default). 2: Year.
    projectName String
    Project name. If not specified, added to the default project.
    protocol String
    IP protocol of the shared bandwidth package. Options are: Dual-stack: Dual-stack protocol type. IPv4: IPv4 protocol type. This parameter supports Dual-stack only when BillingType is 2 or 4.
    securityProtectionTypes List<String>
    Security protection type of the shared bandwidth package. AntiDDoS_Enhanced: Create an enhanced protection shared bandwidth package, which supports adding public IPs with basic protection. If not specified, it means a basic protection shared bandwidth package, which supports adding public IPs with enhanced protection.
    tags List<BandwidthPackageTag>
    bandwidth number
    Bandwidth cap of the shared bandwidth package, unit: Mbps. If BillingType is 1: range is 5–5000. If BillingType is 2, 3, or 4: range is 2–5000.
    bandwidthPackageName string
    Bandwidth package name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).
    billingType number
    Billing methods for shared bandwidth packages. Options are: 1: Annual/monthly subscription. 2: Billed by bandwidth cap (default). 3: Billed by peak traffic. 4: Billed by traditional 95th percentile (minimum ratio defaults to 20%).
    description string
    Description, limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    eipAddresses BandwidthPackageEipAddress[]
    enableDualStack boolean
    Enable dual stack. Options: true: enable dual stack; false: do not enable dual stack.
    isp string
    Line type, default is BGP. BGP: BGP (multi-line). 1. If your account has applied for and enabled static single line permissions, you can use the following values: 1.1, ChinaMobile: China Mobile static single line. 1.2, ChinaTelecom: China Telecom static single line. 1.3, ChinaUnicom: China Unicom static single line. 2. If your account has applied for and enabled BGP single line permissions, you can use SingleLineBGP. 3. If your account has applied for and enabled Premium BGP permissions, you can use PremiumBGP. 4. If your account has applied for and enabled Fusion BGP permissions, you can use FusionBGP. 5. If your account has applied for and enabled Economical static single line permissions, you can use the following values: 5.1, ChinaMobileValue: China Mobile economical static single line. 5.2, ChinaUnicomValue: China Unicom economical static single line. 5.3, ChinaTelecomValue: China Telecom economical static single line.
    period number
    Duration for purchasing yearly/monthly shared bandwidth package, default is '1'. If PeriodUnit is 1, Period can be 1–9, 12, 24, or 36. If PeriodUnit is 2, Period can be 1–3.
    periodUnit number
    Unit for the duration when purchasing an annual/monthly subscription shared bandwidth package. Options are: 1: Month (default). 2: Year.
    projectName string
    Project name. If not specified, added to the default project.
    protocol string
    IP protocol of the shared bandwidth package. Options are: Dual-stack: Dual-stack protocol type. IPv4: IPv4 protocol type. This parameter supports Dual-stack only when BillingType is 2 or 4.
    securityProtectionTypes string[]
    Security protection type of the shared bandwidth package. AntiDDoS_Enhanced: Create an enhanced protection shared bandwidth package, which supports adding public IPs with basic protection. If not specified, it means a basic protection shared bandwidth package, which supports adding public IPs with enhanced protection.
    tags BandwidthPackageTag[]
    bandwidth int
    Bandwidth cap of the shared bandwidth package, unit: Mbps. If BillingType is 1: range is 5–5000. If BillingType is 2, 3, or 4: range is 2–5000.
    bandwidth_package_name str
    Bandwidth package name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).
    billing_type int
    Billing methods for shared bandwidth packages. Options are: 1: Annual/monthly subscription. 2: Billed by bandwidth cap (default). 3: Billed by peak traffic. 4: Billed by traditional 95th percentile (minimum ratio defaults to 20%).
    description str
    Description, limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    eip_addresses Sequence[BandwidthPackageEipAddressArgs]
    enable_dual_stack bool
    Enable dual stack. Options: true: enable dual stack; false: do not enable dual stack.
    isp str
    Line type, default is BGP. BGP: BGP (multi-line). 1. If your account has applied for and enabled static single line permissions, you can use the following values: 1.1, ChinaMobile: China Mobile static single line. 1.2, ChinaTelecom: China Telecom static single line. 1.3, ChinaUnicom: China Unicom static single line. 2. If your account has applied for and enabled BGP single line permissions, you can use SingleLineBGP. 3. If your account has applied for and enabled Premium BGP permissions, you can use PremiumBGP. 4. If your account has applied for and enabled Fusion BGP permissions, you can use FusionBGP. 5. If your account has applied for and enabled Economical static single line permissions, you can use the following values: 5.1, ChinaMobileValue: China Mobile economical static single line. 5.2, ChinaUnicomValue: China Unicom economical static single line. 5.3, ChinaTelecomValue: China Telecom economical static single line.
    period int
    Duration for purchasing yearly/monthly shared bandwidth package, default is '1'. If PeriodUnit is 1, Period can be 1–9, 12, 24, or 36. If PeriodUnit is 2, Period can be 1–3.
    period_unit int
    Unit for the duration when purchasing an annual/monthly subscription shared bandwidth package. Options are: 1: Month (default). 2: Year.
    project_name str
    Project name. If not specified, added to the default project.
    protocol str
    IP protocol of the shared bandwidth package. Options are: Dual-stack: Dual-stack protocol type. IPv4: IPv4 protocol type. This parameter supports Dual-stack only when BillingType is 2 or 4.
    security_protection_types Sequence[str]
    Security protection type of the shared bandwidth package. AntiDDoS_Enhanced: Create an enhanced protection shared bandwidth package, which supports adding public IPs with basic protection. If not specified, it means a basic protection shared bandwidth package, which supports adding public IPs with enhanced protection.
    tags Sequence[BandwidthPackageTagArgs]
    bandwidth Number
    Bandwidth cap of the shared bandwidth package, unit: Mbps. If BillingType is 1: range is 5–5000. If BillingType is 2, 3, or 4: range is 2–5000.
    bandwidthPackageName String
    Bandwidth package name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).
    billingType Number
    Billing methods for shared bandwidth packages. Options are: 1: Annual/monthly subscription. 2: Billed by bandwidth cap (default). 3: Billed by peak traffic. 4: Billed by traditional 95th percentile (minimum ratio defaults to 20%).
    description String
    Description, limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    eipAddresses List<Property Map>
    enableDualStack Boolean
    Enable dual stack. Options: true: enable dual stack; false: do not enable dual stack.
    isp String
    Line type, default is BGP. BGP: BGP (multi-line). 1. If your account has applied for and enabled static single line permissions, you can use the following values: 1.1, ChinaMobile: China Mobile static single line. 1.2, ChinaTelecom: China Telecom static single line. 1.3, ChinaUnicom: China Unicom static single line. 2. If your account has applied for and enabled BGP single line permissions, you can use SingleLineBGP. 3. If your account has applied for and enabled Premium BGP permissions, you can use PremiumBGP. 4. If your account has applied for and enabled Fusion BGP permissions, you can use FusionBGP. 5. If your account has applied for and enabled Economical static single line permissions, you can use the following values: 5.1, ChinaMobileValue: China Mobile economical static single line. 5.2, ChinaUnicomValue: China Unicom economical static single line. 5.3, ChinaTelecomValue: China Telecom economical static single line.
    period Number
    Duration for purchasing yearly/monthly shared bandwidth package, default is '1'. If PeriodUnit is 1, Period can be 1–9, 12, 24, or 36. If PeriodUnit is 2, Period can be 1–3.
    periodUnit Number
    Unit for the duration when purchasing an annual/monthly subscription shared bandwidth package. Options are: 1: Month (default). 2: Year.
    projectName String
    Project name. If not specified, added to the default project.
    protocol String
    IP protocol of the shared bandwidth package. Options are: Dual-stack: Dual-stack protocol type. IPv4: IPv4 protocol type. This parameter supports Dual-stack only when BillingType is 2 or 4.
    securityProtectionTypes List<String>
    Security protection type of the shared bandwidth package. AntiDDoS_Enhanced: Create an enhanced protection shared bandwidth package, which supports adding public IPs with basic protection. If not specified, it means a basic protection shared bandwidth package, which supports adding public IPs with enhanced protection.
    tags List<Property Map>

    Outputs

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

    BandwidthPackageId string
    Bandwidth package ID
    BusinessStatus string
    Billing status
    CreatedTime string
    Creation time
    DeletedTime string
    Deletion time
    ExpiredTime string
    Expiration time
    Id string
    The provider-assigned unique ID for this managed resource.
    OverdueTime string
    Overdue time
    Ratio int
    95 billing minimum ratio, unit: %, this parameter is returned only for 95 billing shared bandwidth package instances.
    Status string
    Status of the shared bandwidth package. Creating: In progress. Available: Available. Deleting: In progress.
    UpdatedTime string
    Update time
    BandwidthPackageId string
    Bandwidth package ID
    BusinessStatus string
    Billing status
    CreatedTime string
    Creation time
    DeletedTime string
    Deletion time
    ExpiredTime string
    Expiration time
    Id string
    The provider-assigned unique ID for this managed resource.
    OverdueTime string
    Overdue time
    Ratio int
    95 billing minimum ratio, unit: %, this parameter is returned only for 95 billing shared bandwidth package instances.
    Status string
    Status of the shared bandwidth package. Creating: In progress. Available: Available. Deleting: In progress.
    UpdatedTime string
    Update time
    bandwidthPackageId String
    Bandwidth package ID
    businessStatus String
    Billing status
    createdTime String
    Creation time
    deletedTime String
    Deletion time
    expiredTime String
    Expiration time
    id String
    The provider-assigned unique ID for this managed resource.
    overdueTime String
    Overdue time
    ratio Integer
    95 billing minimum ratio, unit: %, this parameter is returned only for 95 billing shared bandwidth package instances.
    status String
    Status of the shared bandwidth package. Creating: In progress. Available: Available. Deleting: In progress.
    updatedTime String
    Update time
    bandwidthPackageId string
    Bandwidth package ID
    businessStatus string
    Billing status
    createdTime string
    Creation time
    deletedTime string
    Deletion time
    expiredTime string
    Expiration time
    id string
    The provider-assigned unique ID for this managed resource.
    overdueTime string
    Overdue time
    ratio number
    95 billing minimum ratio, unit: %, this parameter is returned only for 95 billing shared bandwidth package instances.
    status string
    Status of the shared bandwidth package. Creating: In progress. Available: Available. Deleting: In progress.
    updatedTime string
    Update time
    bandwidth_package_id str
    Bandwidth package ID
    business_status str
    Billing status
    created_time str
    Creation time
    deleted_time str
    Deletion time
    expired_time str
    Expiration time
    id str
    The provider-assigned unique ID for this managed resource.
    overdue_time str
    Overdue time
    ratio int
    95 billing minimum ratio, unit: %, this parameter is returned only for 95 billing shared bandwidth package instances.
    status str
    Status of the shared bandwidth package. Creating: In progress. Available: Available. Deleting: In progress.
    updated_time str
    Update time
    bandwidthPackageId String
    Bandwidth package ID
    businessStatus String
    Billing status
    createdTime String
    Creation time
    deletedTime String
    Deletion time
    expiredTime String
    Expiration time
    id String
    The provider-assigned unique ID for this managed resource.
    overdueTime String
    Overdue time
    ratio Number
    95 billing minimum ratio, unit: %, this parameter is returned only for 95 billing shared bandwidth package instances.
    status String
    Status of the shared bandwidth package. Creating: In progress. Available: Available. Deleting: In progress.
    updatedTime String
    Update time

    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,
        bandwidth: Optional[int] = None,
        bandwidth_package_id: Optional[str] = None,
        bandwidth_package_name: Optional[str] = None,
        billing_type: Optional[int] = None,
        business_status: Optional[str] = None,
        created_time: Optional[str] = None,
        deleted_time: Optional[str] = None,
        description: Optional[str] = None,
        eip_addresses: Optional[Sequence[BandwidthPackageEipAddressArgs]] = None,
        enable_dual_stack: Optional[bool] = None,
        expired_time: Optional[str] = None,
        isp: Optional[str] = None,
        overdue_time: Optional[str] = None,
        period: Optional[int] = None,
        period_unit: Optional[int] = None,
        project_name: Optional[str] = None,
        protocol: Optional[str] = None,
        ratio: Optional[int] = None,
        security_protection_types: Optional[Sequence[str]] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[BandwidthPackageTagArgs]] = None,
        updated_time: 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: volcenginecc:vpc:BandwidthPackage    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Bandwidth int
    Bandwidth cap of the shared bandwidth package, unit: Mbps. If BillingType is 1: range is 5–5000. If BillingType is 2, 3, or 4: range is 2–5000.
    BandwidthPackageId string
    Bandwidth package ID
    BandwidthPackageName string
    Bandwidth package name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).
    BillingType int
    Billing methods for shared bandwidth packages. Options are: 1: Annual/monthly subscription. 2: Billed by bandwidth cap (default). 3: Billed by peak traffic. 4: Billed by traditional 95th percentile (minimum ratio defaults to 20%).
    BusinessStatus string
    Billing status
    CreatedTime string
    Creation time
    DeletedTime string
    Deletion time
    Description string
    Description, limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    EipAddresses List<Volcengine.BandwidthPackageEipAddress>
    EnableDualStack bool
    Enable dual stack. Options: true: enable dual stack; false: do not enable dual stack.
    ExpiredTime string
    Expiration time
    Isp string
    Line type, default is BGP. BGP: BGP (multi-line). 1. If your account has applied for and enabled static single line permissions, you can use the following values: 1.1, ChinaMobile: China Mobile static single line. 1.2, ChinaTelecom: China Telecom static single line. 1.3, ChinaUnicom: China Unicom static single line. 2. If your account has applied for and enabled BGP single line permissions, you can use SingleLineBGP. 3. If your account has applied for and enabled Premium BGP permissions, you can use PremiumBGP. 4. If your account has applied for and enabled Fusion BGP permissions, you can use FusionBGP. 5. If your account has applied for and enabled Economical static single line permissions, you can use the following values: 5.1, ChinaMobileValue: China Mobile economical static single line. 5.2, ChinaUnicomValue: China Unicom economical static single line. 5.3, ChinaTelecomValue: China Telecom economical static single line.
    OverdueTime string
    Overdue time
    Period int
    Duration for purchasing yearly/monthly shared bandwidth package, default is '1'. If PeriodUnit is 1, Period can be 1–9, 12, 24, or 36. If PeriodUnit is 2, Period can be 1–3.
    PeriodUnit int
    Unit for the duration when purchasing an annual/monthly subscription shared bandwidth package. Options are: 1: Month (default). 2: Year.
    ProjectName string
    Project name. If not specified, added to the default project.
    Protocol string
    IP protocol of the shared bandwidth package. Options are: Dual-stack: Dual-stack protocol type. IPv4: IPv4 protocol type. This parameter supports Dual-stack only when BillingType is 2 or 4.
    Ratio int
    95 billing minimum ratio, unit: %, this parameter is returned only for 95 billing shared bandwidth package instances.
    SecurityProtectionTypes List<string>
    Security protection type of the shared bandwidth package. AntiDDoS_Enhanced: Create an enhanced protection shared bandwidth package, which supports adding public IPs with basic protection. If not specified, it means a basic protection shared bandwidth package, which supports adding public IPs with enhanced protection.
    Status string
    Status of the shared bandwidth package. Creating: In progress. Available: Available. Deleting: In progress.
    Tags List<Volcengine.BandwidthPackageTag>
    UpdatedTime string
    Update time
    Bandwidth int
    Bandwidth cap of the shared bandwidth package, unit: Mbps. If BillingType is 1: range is 5–5000. If BillingType is 2, 3, or 4: range is 2–5000.
    BandwidthPackageId string
    Bandwidth package ID
    BandwidthPackageName string
    Bandwidth package name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).
    BillingType int
    Billing methods for shared bandwidth packages. Options are: 1: Annual/monthly subscription. 2: Billed by bandwidth cap (default). 3: Billed by peak traffic. 4: Billed by traditional 95th percentile (minimum ratio defaults to 20%).
    BusinessStatus string
    Billing status
    CreatedTime string
    Creation time
    DeletedTime string
    Deletion time
    Description string
    Description, limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    EipAddresses []BandwidthPackageEipAddressArgs
    EnableDualStack bool
    Enable dual stack. Options: true: enable dual stack; false: do not enable dual stack.
    ExpiredTime string
    Expiration time
    Isp string
    Line type, default is BGP. BGP: BGP (multi-line). 1. If your account has applied for and enabled static single line permissions, you can use the following values: 1.1, ChinaMobile: China Mobile static single line. 1.2, ChinaTelecom: China Telecom static single line. 1.3, ChinaUnicom: China Unicom static single line. 2. If your account has applied for and enabled BGP single line permissions, you can use SingleLineBGP. 3. If your account has applied for and enabled Premium BGP permissions, you can use PremiumBGP. 4. If your account has applied for and enabled Fusion BGP permissions, you can use FusionBGP. 5. If your account has applied for and enabled Economical static single line permissions, you can use the following values: 5.1, ChinaMobileValue: China Mobile economical static single line. 5.2, ChinaUnicomValue: China Unicom economical static single line. 5.3, ChinaTelecomValue: China Telecom economical static single line.
    OverdueTime string
    Overdue time
    Period int
    Duration for purchasing yearly/monthly shared bandwidth package, default is '1'. If PeriodUnit is 1, Period can be 1–9, 12, 24, or 36. If PeriodUnit is 2, Period can be 1–3.
    PeriodUnit int
    Unit for the duration when purchasing an annual/monthly subscription shared bandwidth package. Options are: 1: Month (default). 2: Year.
    ProjectName string
    Project name. If not specified, added to the default project.
    Protocol string
    IP protocol of the shared bandwidth package. Options are: Dual-stack: Dual-stack protocol type. IPv4: IPv4 protocol type. This parameter supports Dual-stack only when BillingType is 2 or 4.
    Ratio int
    95 billing minimum ratio, unit: %, this parameter is returned only for 95 billing shared bandwidth package instances.
    SecurityProtectionTypes []string
    Security protection type of the shared bandwidth package. AntiDDoS_Enhanced: Create an enhanced protection shared bandwidth package, which supports adding public IPs with basic protection. If not specified, it means a basic protection shared bandwidth package, which supports adding public IPs with enhanced protection.
    Status string
    Status of the shared bandwidth package. Creating: In progress. Available: Available. Deleting: In progress.
    Tags []BandwidthPackageTagArgs
    UpdatedTime string
    Update time
    bandwidth Integer
    Bandwidth cap of the shared bandwidth package, unit: Mbps. If BillingType is 1: range is 5–5000. If BillingType is 2, 3, or 4: range is 2–5000.
    bandwidthPackageId String
    Bandwidth package ID
    bandwidthPackageName String
    Bandwidth package name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).
    billingType Integer
    Billing methods for shared bandwidth packages. Options are: 1: Annual/monthly subscription. 2: Billed by bandwidth cap (default). 3: Billed by peak traffic. 4: Billed by traditional 95th percentile (minimum ratio defaults to 20%).
    businessStatus String
    Billing status
    createdTime String
    Creation time
    deletedTime String
    Deletion time
    description String
    Description, limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    eipAddresses List<BandwidthPackageEipAddress>
    enableDualStack Boolean
    Enable dual stack. Options: true: enable dual stack; false: do not enable dual stack.
    expiredTime String
    Expiration time
    isp String
    Line type, default is BGP. BGP: BGP (multi-line). 1. If your account has applied for and enabled static single line permissions, you can use the following values: 1.1, ChinaMobile: China Mobile static single line. 1.2, ChinaTelecom: China Telecom static single line. 1.3, ChinaUnicom: China Unicom static single line. 2. If your account has applied for and enabled BGP single line permissions, you can use SingleLineBGP. 3. If your account has applied for and enabled Premium BGP permissions, you can use PremiumBGP. 4. If your account has applied for and enabled Fusion BGP permissions, you can use FusionBGP. 5. If your account has applied for and enabled Economical static single line permissions, you can use the following values: 5.1, ChinaMobileValue: China Mobile economical static single line. 5.2, ChinaUnicomValue: China Unicom economical static single line. 5.3, ChinaTelecomValue: China Telecom economical static single line.
    overdueTime String
    Overdue time
    period Integer
    Duration for purchasing yearly/monthly shared bandwidth package, default is '1'. If PeriodUnit is 1, Period can be 1–9, 12, 24, or 36. If PeriodUnit is 2, Period can be 1–3.
    periodUnit Integer
    Unit for the duration when purchasing an annual/monthly subscription shared bandwidth package. Options are: 1: Month (default). 2: Year.
    projectName String
    Project name. If not specified, added to the default project.
    protocol String
    IP protocol of the shared bandwidth package. Options are: Dual-stack: Dual-stack protocol type. IPv4: IPv4 protocol type. This parameter supports Dual-stack only when BillingType is 2 or 4.
    ratio Integer
    95 billing minimum ratio, unit: %, this parameter is returned only for 95 billing shared bandwidth package instances.
    securityProtectionTypes List<String>
    Security protection type of the shared bandwidth package. AntiDDoS_Enhanced: Create an enhanced protection shared bandwidth package, which supports adding public IPs with basic protection. If not specified, it means a basic protection shared bandwidth package, which supports adding public IPs with enhanced protection.
    status String
    Status of the shared bandwidth package. Creating: In progress. Available: Available. Deleting: In progress.
    tags List<BandwidthPackageTag>
    updatedTime String
    Update time
    bandwidth number
    Bandwidth cap of the shared bandwidth package, unit: Mbps. If BillingType is 1: range is 5–5000. If BillingType is 2, 3, or 4: range is 2–5000.
    bandwidthPackageId string
    Bandwidth package ID
    bandwidthPackageName string
    Bandwidth package name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).
    billingType number
    Billing methods for shared bandwidth packages. Options are: 1: Annual/monthly subscription. 2: Billed by bandwidth cap (default). 3: Billed by peak traffic. 4: Billed by traditional 95th percentile (minimum ratio defaults to 20%).
    businessStatus string
    Billing status
    createdTime string
    Creation time
    deletedTime string
    Deletion time
    description string
    Description, limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    eipAddresses BandwidthPackageEipAddress[]
    enableDualStack boolean
    Enable dual stack. Options: true: enable dual stack; false: do not enable dual stack.
    expiredTime string
    Expiration time
    isp string
    Line type, default is BGP. BGP: BGP (multi-line). 1. If your account has applied for and enabled static single line permissions, you can use the following values: 1.1, ChinaMobile: China Mobile static single line. 1.2, ChinaTelecom: China Telecom static single line. 1.3, ChinaUnicom: China Unicom static single line. 2. If your account has applied for and enabled BGP single line permissions, you can use SingleLineBGP. 3. If your account has applied for and enabled Premium BGP permissions, you can use PremiumBGP. 4. If your account has applied for and enabled Fusion BGP permissions, you can use FusionBGP. 5. If your account has applied for and enabled Economical static single line permissions, you can use the following values: 5.1, ChinaMobileValue: China Mobile economical static single line. 5.2, ChinaUnicomValue: China Unicom economical static single line. 5.3, ChinaTelecomValue: China Telecom economical static single line.
    overdueTime string
    Overdue time
    period number
    Duration for purchasing yearly/monthly shared bandwidth package, default is '1'. If PeriodUnit is 1, Period can be 1–9, 12, 24, or 36. If PeriodUnit is 2, Period can be 1–3.
    periodUnit number
    Unit for the duration when purchasing an annual/monthly subscription shared bandwidth package. Options are: 1: Month (default). 2: Year.
    projectName string
    Project name. If not specified, added to the default project.
    protocol string
    IP protocol of the shared bandwidth package. Options are: Dual-stack: Dual-stack protocol type. IPv4: IPv4 protocol type. This parameter supports Dual-stack only when BillingType is 2 or 4.
    ratio number
    95 billing minimum ratio, unit: %, this parameter is returned only for 95 billing shared bandwidth package instances.
    securityProtectionTypes string[]
    Security protection type of the shared bandwidth package. AntiDDoS_Enhanced: Create an enhanced protection shared bandwidth package, which supports adding public IPs with basic protection. If not specified, it means a basic protection shared bandwidth package, which supports adding public IPs with enhanced protection.
    status string
    Status of the shared bandwidth package. Creating: In progress. Available: Available. Deleting: In progress.
    tags BandwidthPackageTag[]
    updatedTime string
    Update time
    bandwidth int
    Bandwidth cap of the shared bandwidth package, unit: Mbps. If BillingType is 1: range is 5–5000. If BillingType is 2, 3, or 4: range is 2–5000.
    bandwidth_package_id str
    Bandwidth package ID
    bandwidth_package_name str
    Bandwidth package name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).
    billing_type int
    Billing methods for shared bandwidth packages. Options are: 1: Annual/monthly subscription. 2: Billed by bandwidth cap (default). 3: Billed by peak traffic. 4: Billed by traditional 95th percentile (minimum ratio defaults to 20%).
    business_status str
    Billing status
    created_time str
    Creation time
    deleted_time str
    Deletion time
    description str
    Description, limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    eip_addresses Sequence[BandwidthPackageEipAddressArgs]
    enable_dual_stack bool
    Enable dual stack. Options: true: enable dual stack; false: do not enable dual stack.
    expired_time str
    Expiration time
    isp str
    Line type, default is BGP. BGP: BGP (multi-line). 1. If your account has applied for and enabled static single line permissions, you can use the following values: 1.1, ChinaMobile: China Mobile static single line. 1.2, ChinaTelecom: China Telecom static single line. 1.3, ChinaUnicom: China Unicom static single line. 2. If your account has applied for and enabled BGP single line permissions, you can use SingleLineBGP. 3. If your account has applied for and enabled Premium BGP permissions, you can use PremiumBGP. 4. If your account has applied for and enabled Fusion BGP permissions, you can use FusionBGP. 5. If your account has applied for and enabled Economical static single line permissions, you can use the following values: 5.1, ChinaMobileValue: China Mobile economical static single line. 5.2, ChinaUnicomValue: China Unicom economical static single line. 5.3, ChinaTelecomValue: China Telecom economical static single line.
    overdue_time str
    Overdue time
    period int
    Duration for purchasing yearly/monthly shared bandwidth package, default is '1'. If PeriodUnit is 1, Period can be 1–9, 12, 24, or 36. If PeriodUnit is 2, Period can be 1–3.
    period_unit int
    Unit for the duration when purchasing an annual/monthly subscription shared bandwidth package. Options are: 1: Month (default). 2: Year.
    project_name str
    Project name. If not specified, added to the default project.
    protocol str
    IP protocol of the shared bandwidth package. Options are: Dual-stack: Dual-stack protocol type. IPv4: IPv4 protocol type. This parameter supports Dual-stack only when BillingType is 2 or 4.
    ratio int
    95 billing minimum ratio, unit: %, this parameter is returned only for 95 billing shared bandwidth package instances.
    security_protection_types Sequence[str]
    Security protection type of the shared bandwidth package. AntiDDoS_Enhanced: Create an enhanced protection shared bandwidth package, which supports adding public IPs with basic protection. If not specified, it means a basic protection shared bandwidth package, which supports adding public IPs with enhanced protection.
    status str
    Status of the shared bandwidth package. Creating: In progress. Available: Available. Deleting: In progress.
    tags Sequence[BandwidthPackageTagArgs]
    updated_time str
    Update time
    bandwidth Number
    Bandwidth cap of the shared bandwidth package, unit: Mbps. If BillingType is 1: range is 5–5000. If BillingType is 2, 3, or 4: range is 2–5000.
    bandwidthPackageId String
    Bandwidth package ID
    bandwidthPackageName String
    Bandwidth package name, limited to 1–128 characters. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-).
    billingType Number
    Billing methods for shared bandwidth packages. Options are: 1: Annual/monthly subscription. 2: Billed by bandwidth cap (default). 3: Billed by peak traffic. 4: Billed by traditional 95th percentile (minimum ratio defaults to 20%).
    businessStatus String
    Billing status
    createdTime String
    Creation time
    deletedTime String
    Deletion time
    description String
    Description, limited to 0–255 characters. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    eipAddresses List<Property Map>
    enableDualStack Boolean
    Enable dual stack. Options: true: enable dual stack; false: do not enable dual stack.
    expiredTime String
    Expiration time
    isp String
    Line type, default is BGP. BGP: BGP (multi-line). 1. If your account has applied for and enabled static single line permissions, you can use the following values: 1.1, ChinaMobile: China Mobile static single line. 1.2, ChinaTelecom: China Telecom static single line. 1.3, ChinaUnicom: China Unicom static single line. 2. If your account has applied for and enabled BGP single line permissions, you can use SingleLineBGP. 3. If your account has applied for and enabled Premium BGP permissions, you can use PremiumBGP. 4. If your account has applied for and enabled Fusion BGP permissions, you can use FusionBGP. 5. If your account has applied for and enabled Economical static single line permissions, you can use the following values: 5.1, ChinaMobileValue: China Mobile economical static single line. 5.2, ChinaUnicomValue: China Unicom economical static single line. 5.3, ChinaTelecomValue: China Telecom economical static single line.
    overdueTime String
    Overdue time
    period Number
    Duration for purchasing yearly/monthly shared bandwidth package, default is '1'. If PeriodUnit is 1, Period can be 1–9, 12, 24, or 36. If PeriodUnit is 2, Period can be 1–3.
    periodUnit Number
    Unit for the duration when purchasing an annual/monthly subscription shared bandwidth package. Options are: 1: Month (default). 2: Year.
    projectName String
    Project name. If not specified, added to the default project.
    protocol String
    IP protocol of the shared bandwidth package. Options are: Dual-stack: Dual-stack protocol type. IPv4: IPv4 protocol type. This parameter supports Dual-stack only when BillingType is 2 or 4.
    ratio Number
    95 billing minimum ratio, unit: %, this parameter is returned only for 95 billing shared bandwidth package instances.
    securityProtectionTypes List<String>
    Security protection type of the shared bandwidth package. AntiDDoS_Enhanced: Create an enhanced protection shared bandwidth package, which supports adding public IPs with basic protection. If not specified, it means a basic protection shared bandwidth package, which supports adding public IPs with enhanced protection.
    status String
    Status of the shared bandwidth package. Creating: In progress. Available: Available. Deleting: In progress.
    tags List<Property Map>
    updatedTime String
    Update time

    Supporting Types

    BandwidthPackageEipAddress, BandwidthPackageEipAddressArgs

    AllocationId string
    Allocation ID
    AllocationId string
    Allocation ID
    allocationId String
    Allocation ID
    allocationId string
    Allocation ID
    allocation_id str
    Allocation ID
    allocationId String
    Allocation ID

    BandwidthPackageTag, BandwidthPackageTagArgs

    Key string
    User tag key.
    Value string
    User tag value.
    Key string
    User tag key.
    Value string
    User tag value.
    key String
    User tag key.
    value String
    User tag value.
    key string
    User tag key.
    value string
    User tag value.
    key str
    User tag key.
    value str
    User tag value.
    key String
    User tag key.
    value String
    User tag value.

    Import

    $ pulumi import volcenginecc:vpc/bandwidthPackage:BandwidthPackage example "bandwidth_package_id"

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

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.