1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. vpc
  5. CommonBandwithPackage
Alibaba Cloud v3.68.0 published on Monday, Dec 2, 2024 by Pulumi

alicloud.vpc.CommonBandwithPackage

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.68.0 published on Monday, Dec 2, 2024 by Pulumi

    Import

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

    $ pulumi import alicloud:vpc/commonBandwithPackage:CommonBandwithPackage example <id>
    

    Create CommonBandwithPackage Resource

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

    Constructor syntax

    new CommonBandwithPackage(name: string, args: CommonBandwithPackageArgs, opts?: CustomResourceOptions);
    @overload
    def CommonBandwithPackage(resource_name: str,
                              args: CommonBandwithPackageArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def CommonBandwithPackage(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              bandwidth: Optional[str] = None,
                              bandwidth_package_name: Optional[str] = None,
                              deletion_protection: Optional[bool] = None,
                              description: Optional[str] = None,
                              force: Optional[str] = None,
                              internet_charge_type: Optional[str] = None,
                              isp: Optional[str] = None,
                              name: Optional[str] = None,
                              ratio: Optional[int] = None,
                              resource_group_id: Optional[str] = None,
                              security_protection_types: Optional[Sequence[str]] = None,
                              tags: Optional[Mapping[str, str]] = None,
                              zone: Optional[str] = None)
    func NewCommonBandwithPackage(ctx *Context, name string, args CommonBandwithPackageArgs, opts ...ResourceOption) (*CommonBandwithPackage, error)
    public CommonBandwithPackage(string name, CommonBandwithPackageArgs args, CustomResourceOptions? opts = null)
    public CommonBandwithPackage(String name, CommonBandwithPackageArgs args)
    public CommonBandwithPackage(String name, CommonBandwithPackageArgs args, CustomResourceOptions options)
    
    type: alicloud:vpc:CommonBandwithPackage
    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 CommonBandwithPackageArgs
    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 CommonBandwithPackageArgs
    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 CommonBandwithPackageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CommonBandwithPackageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CommonBandwithPackageArgs
    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 commonBandwithPackageResource = new AliCloud.Vpc.CommonBandwithPackage("commonBandwithPackageResource", new()
    {
        Bandwidth = "string",
        BandwidthPackageName = "string",
        DeletionProtection = false,
        Description = "string",
        Force = "string",
        InternetChargeType = "string",
        Isp = "string",
        Ratio = 0,
        ResourceGroupId = "string",
        SecurityProtectionTypes = new[]
        {
            "string",
        },
        Tags = 
        {
            { "string", "string" },
        },
        Zone = "string",
    });
    
    example, err := vpc.NewCommonBandwithPackage(ctx, "commonBandwithPackageResource", &vpc.CommonBandwithPackageArgs{
    	Bandwidth:            pulumi.String("string"),
    	BandwidthPackageName: pulumi.String("string"),
    	DeletionProtection:   pulumi.Bool(false),
    	Description:          pulumi.String("string"),
    	Force:                pulumi.String("string"),
    	InternetChargeType:   pulumi.String("string"),
    	Isp:                  pulumi.String("string"),
    	Ratio:                pulumi.Int(0),
    	ResourceGroupId:      pulumi.String("string"),
    	SecurityProtectionTypes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Zone: pulumi.String("string"),
    })
    
    var commonBandwithPackageResource = new CommonBandwithPackage("commonBandwithPackageResource", CommonBandwithPackageArgs.builder()
        .bandwidth("string")
        .bandwidthPackageName("string")
        .deletionProtection(false)
        .description("string")
        .force("string")
        .internetChargeType("string")
        .isp("string")
        .ratio(0)
        .resourceGroupId("string")
        .securityProtectionTypes("string")
        .tags(Map.of("string", "string"))
        .zone("string")
        .build());
    
    common_bandwith_package_resource = alicloud.vpc.CommonBandwithPackage("commonBandwithPackageResource",
        bandwidth="string",
        bandwidth_package_name="string",
        deletion_protection=False,
        description="string",
        force="string",
        internet_charge_type="string",
        isp="string",
        ratio=0,
        resource_group_id="string",
        security_protection_types=["string"],
        tags={
            "string": "string",
        },
        zone="string")
    
    const commonBandwithPackageResource = new alicloud.vpc.CommonBandwithPackage("commonBandwithPackageResource", {
        bandwidth: "string",
        bandwidthPackageName: "string",
        deletionProtection: false,
        description: "string",
        force: "string",
        internetChargeType: "string",
        isp: "string",
        ratio: 0,
        resourceGroupId: "string",
        securityProtectionTypes: ["string"],
        tags: {
            string: "string",
        },
        zone: "string",
    });
    
    type: alicloud:vpc:CommonBandwithPackage
    properties:
        bandwidth: string
        bandwidthPackageName: string
        deletionProtection: false
        description: string
        force: string
        internetChargeType: string
        isp: string
        ratio: 0
        resourceGroupId: string
        securityProtectionTypes:
            - string
        tags:
            string: string
        zone: string
    

    CommonBandwithPackage 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 CommonBandwithPackage resource accepts the following input properties:

    Bandwidth string
    The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s. Valid values: 1 to 1000. Default value: 1.
    BandwidthPackageName string
    The name of the Internet Shared Bandwidth instance. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.
    DeletionProtection bool
    Specifies whether to enable deletion protection. Valid values:
    Description string
    The description of the Internet Shared Bandwidth instance. The description must be 2 to 256 characters in length and start with a letter. The description cannot start with http:// or https://.
    Force string
    Specifies whether to forcefully delete the Internet Shared Bandwidth instance. Valid values:
    InternetChargeType string
    The billing method of the Internet Shared Bandwidth instance. Set the value to PayByTraffic, which specifies the pay-by-data-transfer billing method.
    Isp string

    The line type. Valid values:

    • BGP All regions support BGP (Multi-ISP).
    • BGP_PRO BGP (Multi-ISP) Pro lines are available in the China (Hong Kong), Singapore, Japan (Tokyo), Philippines (Manila), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and Thailand (Bangkok) regions.

    If you are allowed to use single-ISP bandwidth, you can also use one of the following values:

    • ChinaTelecom
    • ChinaUnicom
    • ChinaMobile
    • ChinaTelecom_L2
    • ChinaUnicom_L2
    • ChinaMobile_L2

    If your services are deployed in China East 1 Finance, this parameter is required and you must set the value to BGP_FinanceCloud.

    Name string
    . Field 'name' has been deprecated from provider version 1.120.0. New field 'bandwidth_package_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.120.0. New field 'bandwidth_package_name' instead.

    Ratio int

    The percentage of the minimum bandwidth commitment. Set the parameter to 20.

    NOTE: This parameter is available only on the Alibaba Cloud China site.

    ResourceGroupId string

    The ID of the resource group to which you want to move the resource.

    NOTE: You can use resource groups to facilitate resource grouping and permission management for an Alibaba Cloud. For more information, see What is resource management?

    SecurityProtectionTypes List<string>
    The edition of Anti-DDoS. If you do not set this parameter, Anti-DDoS Origin Basic is used. If you set the value to AntiDDoS_Enhanced, Anti-DDoS Pro(Premium) is used. It is valid when internet_charge_type is PayBy95.
    Tags Dictionary<string, string>
    The tag of the resource
    Zone string

    The zone of the Internet Shared Bandwidth instance. This parameter is required if you create an Internet Shared Bandwidth instance for a cloud box.

    The following arguments will be discarded. Please use new fields as soon as possible:

    Bandwidth string
    The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s. Valid values: 1 to 1000. Default value: 1.
    BandwidthPackageName string
    The name of the Internet Shared Bandwidth instance. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.
    DeletionProtection bool
    Specifies whether to enable deletion protection. Valid values:
    Description string
    The description of the Internet Shared Bandwidth instance. The description must be 2 to 256 characters in length and start with a letter. The description cannot start with http:// or https://.
    Force string
    Specifies whether to forcefully delete the Internet Shared Bandwidth instance. Valid values:
    InternetChargeType string
    The billing method of the Internet Shared Bandwidth instance. Set the value to PayByTraffic, which specifies the pay-by-data-transfer billing method.
    Isp string

    The line type. Valid values:

    • BGP All regions support BGP (Multi-ISP).
    • BGP_PRO BGP (Multi-ISP) Pro lines are available in the China (Hong Kong), Singapore, Japan (Tokyo), Philippines (Manila), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and Thailand (Bangkok) regions.

    If you are allowed to use single-ISP bandwidth, you can also use one of the following values:

    • ChinaTelecom
    • ChinaUnicom
    • ChinaMobile
    • ChinaTelecom_L2
    • ChinaUnicom_L2
    • ChinaMobile_L2

    If your services are deployed in China East 1 Finance, this parameter is required and you must set the value to BGP_FinanceCloud.

    Name string
    . Field 'name' has been deprecated from provider version 1.120.0. New field 'bandwidth_package_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.120.0. New field 'bandwidth_package_name' instead.

    Ratio int

    The percentage of the minimum bandwidth commitment. Set the parameter to 20.

    NOTE: This parameter is available only on the Alibaba Cloud China site.

    ResourceGroupId string

    The ID of the resource group to which you want to move the resource.

    NOTE: You can use resource groups to facilitate resource grouping and permission management for an Alibaba Cloud. For more information, see What is resource management?

    SecurityProtectionTypes []string
    The edition of Anti-DDoS. If you do not set this parameter, Anti-DDoS Origin Basic is used. If you set the value to AntiDDoS_Enhanced, Anti-DDoS Pro(Premium) is used. It is valid when internet_charge_type is PayBy95.
    Tags map[string]string
    The tag of the resource
    Zone string

    The zone of the Internet Shared Bandwidth instance. This parameter is required if you create an Internet Shared Bandwidth instance for a cloud box.

    The following arguments will be discarded. Please use new fields as soon as possible:

    bandwidth String
    The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s. Valid values: 1 to 1000. Default value: 1.
    bandwidthPackageName String
    The name of the Internet Shared Bandwidth instance. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.
    deletionProtection Boolean
    Specifies whether to enable deletion protection. Valid values:
    description String
    The description of the Internet Shared Bandwidth instance. The description must be 2 to 256 characters in length and start with a letter. The description cannot start with http:// or https://.
    force String
    Specifies whether to forcefully delete the Internet Shared Bandwidth instance. Valid values:
    internetChargeType String
    The billing method of the Internet Shared Bandwidth instance. Set the value to PayByTraffic, which specifies the pay-by-data-transfer billing method.
    isp String

    The line type. Valid values:

    • BGP All regions support BGP (Multi-ISP).
    • BGP_PRO BGP (Multi-ISP) Pro lines are available in the China (Hong Kong), Singapore, Japan (Tokyo), Philippines (Manila), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and Thailand (Bangkok) regions.

    If you are allowed to use single-ISP bandwidth, you can also use one of the following values:

    • ChinaTelecom
    • ChinaUnicom
    • ChinaMobile
    • ChinaTelecom_L2
    • ChinaUnicom_L2
    • ChinaMobile_L2

    If your services are deployed in China East 1 Finance, this parameter is required and you must set the value to BGP_FinanceCloud.

    name String
    . Field 'name' has been deprecated from provider version 1.120.0. New field 'bandwidth_package_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.120.0. New field 'bandwidth_package_name' instead.

    ratio Integer

    The percentage of the minimum bandwidth commitment. Set the parameter to 20.

    NOTE: This parameter is available only on the Alibaba Cloud China site.

    resourceGroupId String

    The ID of the resource group to which you want to move the resource.

    NOTE: You can use resource groups to facilitate resource grouping and permission management for an Alibaba Cloud. For more information, see What is resource management?

    securityProtectionTypes List<String>
    The edition of Anti-DDoS. If you do not set this parameter, Anti-DDoS Origin Basic is used. If you set the value to AntiDDoS_Enhanced, Anti-DDoS Pro(Premium) is used. It is valid when internet_charge_type is PayBy95.
    tags Map<String,String>
    The tag of the resource
    zone String

    The zone of the Internet Shared Bandwidth instance. This parameter is required if you create an Internet Shared Bandwidth instance for a cloud box.

    The following arguments will be discarded. Please use new fields as soon as possible:

    bandwidth string
    The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s. Valid values: 1 to 1000. Default value: 1.
    bandwidthPackageName string
    The name of the Internet Shared Bandwidth instance. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.
    deletionProtection boolean
    Specifies whether to enable deletion protection. Valid values:
    description string
    The description of the Internet Shared Bandwidth instance. The description must be 2 to 256 characters in length and start with a letter. The description cannot start with http:// or https://.
    force string
    Specifies whether to forcefully delete the Internet Shared Bandwidth instance. Valid values:
    internetChargeType string
    The billing method of the Internet Shared Bandwidth instance. Set the value to PayByTraffic, which specifies the pay-by-data-transfer billing method.
    isp string

    The line type. Valid values:

    • BGP All regions support BGP (Multi-ISP).
    • BGP_PRO BGP (Multi-ISP) Pro lines are available in the China (Hong Kong), Singapore, Japan (Tokyo), Philippines (Manila), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and Thailand (Bangkok) regions.

    If you are allowed to use single-ISP bandwidth, you can also use one of the following values:

    • ChinaTelecom
    • ChinaUnicom
    • ChinaMobile
    • ChinaTelecom_L2
    • ChinaUnicom_L2
    • ChinaMobile_L2

    If your services are deployed in China East 1 Finance, this parameter is required and you must set the value to BGP_FinanceCloud.

    name string
    . Field 'name' has been deprecated from provider version 1.120.0. New field 'bandwidth_package_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.120.0. New field 'bandwidth_package_name' instead.

    ratio number

    The percentage of the minimum bandwidth commitment. Set the parameter to 20.

    NOTE: This parameter is available only on the Alibaba Cloud China site.

    resourceGroupId string

    The ID of the resource group to which you want to move the resource.

    NOTE: You can use resource groups to facilitate resource grouping and permission management for an Alibaba Cloud. For more information, see What is resource management?

    securityProtectionTypes string[]
    The edition of Anti-DDoS. If you do not set this parameter, Anti-DDoS Origin Basic is used. If you set the value to AntiDDoS_Enhanced, Anti-DDoS Pro(Premium) is used. It is valid when internet_charge_type is PayBy95.
    tags {[key: string]: string}
    The tag of the resource
    zone string

    The zone of the Internet Shared Bandwidth instance. This parameter is required if you create an Internet Shared Bandwidth instance for a cloud box.

    The following arguments will be discarded. Please use new fields as soon as possible:

    bandwidth str
    The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s. Valid values: 1 to 1000. Default value: 1.
    bandwidth_package_name str
    The name of the Internet Shared Bandwidth instance. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.
    deletion_protection bool
    Specifies whether to enable deletion protection. Valid values:
    description str
    The description of the Internet Shared Bandwidth instance. The description must be 2 to 256 characters in length and start with a letter. The description cannot start with http:// or https://.
    force str
    Specifies whether to forcefully delete the Internet Shared Bandwidth instance. Valid values:
    internet_charge_type str
    The billing method of the Internet Shared Bandwidth instance. Set the value to PayByTraffic, which specifies the pay-by-data-transfer billing method.
    isp str

    The line type. Valid values:

    • BGP All regions support BGP (Multi-ISP).
    • BGP_PRO BGP (Multi-ISP) Pro lines are available in the China (Hong Kong), Singapore, Japan (Tokyo), Philippines (Manila), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and Thailand (Bangkok) regions.

    If you are allowed to use single-ISP bandwidth, you can also use one of the following values:

    • ChinaTelecom
    • ChinaUnicom
    • ChinaMobile
    • ChinaTelecom_L2
    • ChinaUnicom_L2
    • ChinaMobile_L2

    If your services are deployed in China East 1 Finance, this parameter is required and you must set the value to BGP_FinanceCloud.

    name str
    . Field 'name' has been deprecated from provider version 1.120.0. New field 'bandwidth_package_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.120.0. New field 'bandwidth_package_name' instead.

    ratio int

    The percentage of the minimum bandwidth commitment. Set the parameter to 20.

    NOTE: This parameter is available only on the Alibaba Cloud China site.

    resource_group_id str

    The ID of the resource group to which you want to move the resource.

    NOTE: You can use resource groups to facilitate resource grouping and permission management for an Alibaba Cloud. For more information, see What is resource management?

    security_protection_types Sequence[str]
    The edition of Anti-DDoS. If you do not set this parameter, Anti-DDoS Origin Basic is used. If you set the value to AntiDDoS_Enhanced, Anti-DDoS Pro(Premium) is used. It is valid when internet_charge_type is PayBy95.
    tags Mapping[str, str]
    The tag of the resource
    zone str

    The zone of the Internet Shared Bandwidth instance. This parameter is required if you create an Internet Shared Bandwidth instance for a cloud box.

    The following arguments will be discarded. Please use new fields as soon as possible:

    bandwidth String
    The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s. Valid values: 1 to 1000. Default value: 1.
    bandwidthPackageName String
    The name of the Internet Shared Bandwidth instance. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.
    deletionProtection Boolean
    Specifies whether to enable deletion protection. Valid values:
    description String
    The description of the Internet Shared Bandwidth instance. The description must be 2 to 256 characters in length and start with a letter. The description cannot start with http:// or https://.
    force String
    Specifies whether to forcefully delete the Internet Shared Bandwidth instance. Valid values:
    internetChargeType String
    The billing method of the Internet Shared Bandwidth instance. Set the value to PayByTraffic, which specifies the pay-by-data-transfer billing method.
    isp String

    The line type. Valid values:

    • BGP All regions support BGP (Multi-ISP).
    • BGP_PRO BGP (Multi-ISP) Pro lines are available in the China (Hong Kong), Singapore, Japan (Tokyo), Philippines (Manila), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and Thailand (Bangkok) regions.

    If you are allowed to use single-ISP bandwidth, you can also use one of the following values:

    • ChinaTelecom
    • ChinaUnicom
    • ChinaMobile
    • ChinaTelecom_L2
    • ChinaUnicom_L2
    • ChinaMobile_L2

    If your services are deployed in China East 1 Finance, this parameter is required and you must set the value to BGP_FinanceCloud.

    name String
    . Field 'name' has been deprecated from provider version 1.120.0. New field 'bandwidth_package_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.120.0. New field 'bandwidth_package_name' instead.

    ratio Number

    The percentage of the minimum bandwidth commitment. Set the parameter to 20.

    NOTE: This parameter is available only on the Alibaba Cloud China site.

    resourceGroupId String

    The ID of the resource group to which you want to move the resource.

    NOTE: You can use resource groups to facilitate resource grouping and permission management for an Alibaba Cloud. For more information, see What is resource management?

    securityProtectionTypes List<String>
    The edition of Anti-DDoS. If you do not set this parameter, Anti-DDoS Origin Basic is used. If you set the value to AntiDDoS_Enhanced, Anti-DDoS Pro(Premium) is used. It is valid when internet_charge_type is PayBy95.
    tags Map<String>
    The tag of the resource
    zone String

    The zone of the Internet Shared Bandwidth instance. This parameter is required if you create an Internet Shared Bandwidth instance for a cloud box.

    The following arguments will be discarded. Please use new fields as soon as possible:

    Outputs

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

    CreateTime string
    The creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    PaymentType string
    The billing type of the Internet Shared Bandwidth instance. Valid values: PayAsYouGo, Subscription.
    Status string
    The status of the Internet Shared Bandwidth instance. Default value: Available.
    CreateTime string
    The creation time.
    Id string
    The provider-assigned unique ID for this managed resource.
    PaymentType string
    The billing type of the Internet Shared Bandwidth instance. Valid values: PayAsYouGo, Subscription.
    Status string
    The status of the Internet Shared Bandwidth instance. Default value: Available.
    createTime String
    The creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    paymentType String
    The billing type of the Internet Shared Bandwidth instance. Valid values: PayAsYouGo, Subscription.
    status String
    The status of the Internet Shared Bandwidth instance. Default value: Available.
    createTime string
    The creation time.
    id string
    The provider-assigned unique ID for this managed resource.
    paymentType string
    The billing type of the Internet Shared Bandwidth instance. Valid values: PayAsYouGo, Subscription.
    status string
    The status of the Internet Shared Bandwidth instance. Default value: Available.
    create_time str
    The creation time.
    id str
    The provider-assigned unique ID for this managed resource.
    payment_type str
    The billing type of the Internet Shared Bandwidth instance. Valid values: PayAsYouGo, Subscription.
    status str
    The status of the Internet Shared Bandwidth instance. Default value: Available.
    createTime String
    The creation time.
    id String
    The provider-assigned unique ID for this managed resource.
    paymentType String
    The billing type of the Internet Shared Bandwidth instance. Valid values: PayAsYouGo, Subscription.
    status String
    The status of the Internet Shared Bandwidth instance. Default value: Available.

    Look up Existing CommonBandwithPackage Resource

    Get an existing CommonBandwithPackage 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?: CommonBandwithPackageState, opts?: CustomResourceOptions): CommonBandwithPackage
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            bandwidth: Optional[str] = None,
            bandwidth_package_name: Optional[str] = None,
            create_time: Optional[str] = None,
            deletion_protection: Optional[bool] = None,
            description: Optional[str] = None,
            force: Optional[str] = None,
            internet_charge_type: Optional[str] = None,
            isp: Optional[str] = None,
            name: Optional[str] = None,
            payment_type: Optional[str] = None,
            ratio: Optional[int] = None,
            resource_group_id: Optional[str] = None,
            security_protection_types: Optional[Sequence[str]] = None,
            status: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            zone: Optional[str] = None) -> CommonBandwithPackage
    func GetCommonBandwithPackage(ctx *Context, name string, id IDInput, state *CommonBandwithPackageState, opts ...ResourceOption) (*CommonBandwithPackage, error)
    public static CommonBandwithPackage Get(string name, Input<string> id, CommonBandwithPackageState? state, CustomResourceOptions? opts = null)
    public static CommonBandwithPackage get(String name, Output<String> id, CommonBandwithPackageState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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 string
    The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s. Valid values: 1 to 1000. Default value: 1.
    BandwidthPackageName string
    The name of the Internet Shared Bandwidth instance. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.
    CreateTime string
    The creation time.
    DeletionProtection bool
    Specifies whether to enable deletion protection. Valid values:
    Description string
    The description of the Internet Shared Bandwidth instance. The description must be 2 to 256 characters in length and start with a letter. The description cannot start with http:// or https://.
    Force string
    Specifies whether to forcefully delete the Internet Shared Bandwidth instance. Valid values:
    InternetChargeType string
    The billing method of the Internet Shared Bandwidth instance. Set the value to PayByTraffic, which specifies the pay-by-data-transfer billing method.
    Isp string

    The line type. Valid values:

    • BGP All regions support BGP (Multi-ISP).
    • BGP_PRO BGP (Multi-ISP) Pro lines are available in the China (Hong Kong), Singapore, Japan (Tokyo), Philippines (Manila), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and Thailand (Bangkok) regions.

    If you are allowed to use single-ISP bandwidth, you can also use one of the following values:

    • ChinaTelecom
    • ChinaUnicom
    • ChinaMobile
    • ChinaTelecom_L2
    • ChinaUnicom_L2
    • ChinaMobile_L2

    If your services are deployed in China East 1 Finance, this parameter is required and you must set the value to BGP_FinanceCloud.

    Name string
    . Field 'name' has been deprecated from provider version 1.120.0. New field 'bandwidth_package_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.120.0. New field 'bandwidth_package_name' instead.

    PaymentType string
    The billing type of the Internet Shared Bandwidth instance. Valid values: PayAsYouGo, Subscription.
    Ratio int

    The percentage of the minimum bandwidth commitment. Set the parameter to 20.

    NOTE: This parameter is available only on the Alibaba Cloud China site.

    ResourceGroupId string

    The ID of the resource group to which you want to move the resource.

    NOTE: You can use resource groups to facilitate resource grouping and permission management for an Alibaba Cloud. For more information, see What is resource management?

    SecurityProtectionTypes List<string>
    The edition of Anti-DDoS. If you do not set this parameter, Anti-DDoS Origin Basic is used. If you set the value to AntiDDoS_Enhanced, Anti-DDoS Pro(Premium) is used. It is valid when internet_charge_type is PayBy95.
    Status string
    The status of the Internet Shared Bandwidth instance. Default value: Available.
    Tags Dictionary<string, string>
    The tag of the resource
    Zone string

    The zone of the Internet Shared Bandwidth instance. This parameter is required if you create an Internet Shared Bandwidth instance for a cloud box.

    The following arguments will be discarded. Please use new fields as soon as possible:

    Bandwidth string
    The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s. Valid values: 1 to 1000. Default value: 1.
    BandwidthPackageName string
    The name of the Internet Shared Bandwidth instance. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.
    CreateTime string
    The creation time.
    DeletionProtection bool
    Specifies whether to enable deletion protection. Valid values:
    Description string
    The description of the Internet Shared Bandwidth instance. The description must be 2 to 256 characters in length and start with a letter. The description cannot start with http:// or https://.
    Force string
    Specifies whether to forcefully delete the Internet Shared Bandwidth instance. Valid values:
    InternetChargeType string
    The billing method of the Internet Shared Bandwidth instance. Set the value to PayByTraffic, which specifies the pay-by-data-transfer billing method.
    Isp string

    The line type. Valid values:

    • BGP All regions support BGP (Multi-ISP).
    • BGP_PRO BGP (Multi-ISP) Pro lines are available in the China (Hong Kong), Singapore, Japan (Tokyo), Philippines (Manila), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and Thailand (Bangkok) regions.

    If you are allowed to use single-ISP bandwidth, you can also use one of the following values:

    • ChinaTelecom
    • ChinaUnicom
    • ChinaMobile
    • ChinaTelecom_L2
    • ChinaUnicom_L2
    • ChinaMobile_L2

    If your services are deployed in China East 1 Finance, this parameter is required and you must set the value to BGP_FinanceCloud.

    Name string
    . Field 'name' has been deprecated from provider version 1.120.0. New field 'bandwidth_package_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.120.0. New field 'bandwidth_package_name' instead.

    PaymentType string
    The billing type of the Internet Shared Bandwidth instance. Valid values: PayAsYouGo, Subscription.
    Ratio int

    The percentage of the minimum bandwidth commitment. Set the parameter to 20.

    NOTE: This parameter is available only on the Alibaba Cloud China site.

    ResourceGroupId string

    The ID of the resource group to which you want to move the resource.

    NOTE: You can use resource groups to facilitate resource grouping and permission management for an Alibaba Cloud. For more information, see What is resource management?

    SecurityProtectionTypes []string
    The edition of Anti-DDoS. If you do not set this parameter, Anti-DDoS Origin Basic is used. If you set the value to AntiDDoS_Enhanced, Anti-DDoS Pro(Premium) is used. It is valid when internet_charge_type is PayBy95.
    Status string
    The status of the Internet Shared Bandwidth instance. Default value: Available.
    Tags map[string]string
    The tag of the resource
    Zone string

    The zone of the Internet Shared Bandwidth instance. This parameter is required if you create an Internet Shared Bandwidth instance for a cloud box.

    The following arguments will be discarded. Please use new fields as soon as possible:

    bandwidth String
    The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s. Valid values: 1 to 1000. Default value: 1.
    bandwidthPackageName String
    The name of the Internet Shared Bandwidth instance. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.
    createTime String
    The creation time.
    deletionProtection Boolean
    Specifies whether to enable deletion protection. Valid values:
    description String
    The description of the Internet Shared Bandwidth instance. The description must be 2 to 256 characters in length and start with a letter. The description cannot start with http:// or https://.
    force String
    Specifies whether to forcefully delete the Internet Shared Bandwidth instance. Valid values:
    internetChargeType String
    The billing method of the Internet Shared Bandwidth instance. Set the value to PayByTraffic, which specifies the pay-by-data-transfer billing method.
    isp String

    The line type. Valid values:

    • BGP All regions support BGP (Multi-ISP).
    • BGP_PRO BGP (Multi-ISP) Pro lines are available in the China (Hong Kong), Singapore, Japan (Tokyo), Philippines (Manila), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and Thailand (Bangkok) regions.

    If you are allowed to use single-ISP bandwidth, you can also use one of the following values:

    • ChinaTelecom
    • ChinaUnicom
    • ChinaMobile
    • ChinaTelecom_L2
    • ChinaUnicom_L2
    • ChinaMobile_L2

    If your services are deployed in China East 1 Finance, this parameter is required and you must set the value to BGP_FinanceCloud.

    name String
    . Field 'name' has been deprecated from provider version 1.120.0. New field 'bandwidth_package_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.120.0. New field 'bandwidth_package_name' instead.

    paymentType String
    The billing type of the Internet Shared Bandwidth instance. Valid values: PayAsYouGo, Subscription.
    ratio Integer

    The percentage of the minimum bandwidth commitment. Set the parameter to 20.

    NOTE: This parameter is available only on the Alibaba Cloud China site.

    resourceGroupId String

    The ID of the resource group to which you want to move the resource.

    NOTE: You can use resource groups to facilitate resource grouping and permission management for an Alibaba Cloud. For more information, see What is resource management?

    securityProtectionTypes List<String>
    The edition of Anti-DDoS. If you do not set this parameter, Anti-DDoS Origin Basic is used. If you set the value to AntiDDoS_Enhanced, Anti-DDoS Pro(Premium) is used. It is valid when internet_charge_type is PayBy95.
    status String
    The status of the Internet Shared Bandwidth instance. Default value: Available.
    tags Map<String,String>
    The tag of the resource
    zone String

    The zone of the Internet Shared Bandwidth instance. This parameter is required if you create an Internet Shared Bandwidth instance for a cloud box.

    The following arguments will be discarded. Please use new fields as soon as possible:

    bandwidth string
    The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s. Valid values: 1 to 1000. Default value: 1.
    bandwidthPackageName string
    The name of the Internet Shared Bandwidth instance. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.
    createTime string
    The creation time.
    deletionProtection boolean
    Specifies whether to enable deletion protection. Valid values:
    description string
    The description of the Internet Shared Bandwidth instance. The description must be 2 to 256 characters in length and start with a letter. The description cannot start with http:// or https://.
    force string
    Specifies whether to forcefully delete the Internet Shared Bandwidth instance. Valid values:
    internetChargeType string
    The billing method of the Internet Shared Bandwidth instance. Set the value to PayByTraffic, which specifies the pay-by-data-transfer billing method.
    isp string

    The line type. Valid values:

    • BGP All regions support BGP (Multi-ISP).
    • BGP_PRO BGP (Multi-ISP) Pro lines are available in the China (Hong Kong), Singapore, Japan (Tokyo), Philippines (Manila), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and Thailand (Bangkok) regions.

    If you are allowed to use single-ISP bandwidth, you can also use one of the following values:

    • ChinaTelecom
    • ChinaUnicom
    • ChinaMobile
    • ChinaTelecom_L2
    • ChinaUnicom_L2
    • ChinaMobile_L2

    If your services are deployed in China East 1 Finance, this parameter is required and you must set the value to BGP_FinanceCloud.

    name string
    . Field 'name' has been deprecated from provider version 1.120.0. New field 'bandwidth_package_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.120.0. New field 'bandwidth_package_name' instead.

    paymentType string
    The billing type of the Internet Shared Bandwidth instance. Valid values: PayAsYouGo, Subscription.
    ratio number

    The percentage of the minimum bandwidth commitment. Set the parameter to 20.

    NOTE: This parameter is available only on the Alibaba Cloud China site.

    resourceGroupId string

    The ID of the resource group to which you want to move the resource.

    NOTE: You can use resource groups to facilitate resource grouping and permission management for an Alibaba Cloud. For more information, see What is resource management?

    securityProtectionTypes string[]
    The edition of Anti-DDoS. If you do not set this parameter, Anti-DDoS Origin Basic is used. If you set the value to AntiDDoS_Enhanced, Anti-DDoS Pro(Premium) is used. It is valid when internet_charge_type is PayBy95.
    status string
    The status of the Internet Shared Bandwidth instance. Default value: Available.
    tags {[key: string]: string}
    The tag of the resource
    zone string

    The zone of the Internet Shared Bandwidth instance. This parameter is required if you create an Internet Shared Bandwidth instance for a cloud box.

    The following arguments will be discarded. Please use new fields as soon as possible:

    bandwidth str
    The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s. Valid values: 1 to 1000. Default value: 1.
    bandwidth_package_name str
    The name of the Internet Shared Bandwidth instance. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.
    create_time str
    The creation time.
    deletion_protection bool
    Specifies whether to enable deletion protection. Valid values:
    description str
    The description of the Internet Shared Bandwidth instance. The description must be 2 to 256 characters in length and start with a letter. The description cannot start with http:// or https://.
    force str
    Specifies whether to forcefully delete the Internet Shared Bandwidth instance. Valid values:
    internet_charge_type str
    The billing method of the Internet Shared Bandwidth instance. Set the value to PayByTraffic, which specifies the pay-by-data-transfer billing method.
    isp str

    The line type. Valid values:

    • BGP All regions support BGP (Multi-ISP).
    • BGP_PRO BGP (Multi-ISP) Pro lines are available in the China (Hong Kong), Singapore, Japan (Tokyo), Philippines (Manila), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and Thailand (Bangkok) regions.

    If you are allowed to use single-ISP bandwidth, you can also use one of the following values:

    • ChinaTelecom
    • ChinaUnicom
    • ChinaMobile
    • ChinaTelecom_L2
    • ChinaUnicom_L2
    • ChinaMobile_L2

    If your services are deployed in China East 1 Finance, this parameter is required and you must set the value to BGP_FinanceCloud.

    name str
    . Field 'name' has been deprecated from provider version 1.120.0. New field 'bandwidth_package_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.120.0. New field 'bandwidth_package_name' instead.

    payment_type str
    The billing type of the Internet Shared Bandwidth instance. Valid values: PayAsYouGo, Subscription.
    ratio int

    The percentage of the minimum bandwidth commitment. Set the parameter to 20.

    NOTE: This parameter is available only on the Alibaba Cloud China site.

    resource_group_id str

    The ID of the resource group to which you want to move the resource.

    NOTE: You can use resource groups to facilitate resource grouping and permission management for an Alibaba Cloud. For more information, see What is resource management?

    security_protection_types Sequence[str]
    The edition of Anti-DDoS. If you do not set this parameter, Anti-DDoS Origin Basic is used. If you set the value to AntiDDoS_Enhanced, Anti-DDoS Pro(Premium) is used. It is valid when internet_charge_type is PayBy95.
    status str
    The status of the Internet Shared Bandwidth instance. Default value: Available.
    tags Mapping[str, str]
    The tag of the resource
    zone str

    The zone of the Internet Shared Bandwidth instance. This parameter is required if you create an Internet Shared Bandwidth instance for a cloud box.

    The following arguments will be discarded. Please use new fields as soon as possible:

    bandwidth String
    The maximum bandwidth of the Internet Shared Bandwidth instance. Unit: Mbit/s. Valid values: 1 to 1000. Default value: 1.
    bandwidthPackageName String
    The name of the Internet Shared Bandwidth instance. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.
    createTime String
    The creation time.
    deletionProtection Boolean
    Specifies whether to enable deletion protection. Valid values:
    description String
    The description of the Internet Shared Bandwidth instance. The description must be 2 to 256 characters in length and start with a letter. The description cannot start with http:// or https://.
    force String
    Specifies whether to forcefully delete the Internet Shared Bandwidth instance. Valid values:
    internetChargeType String
    The billing method of the Internet Shared Bandwidth instance. Set the value to PayByTraffic, which specifies the pay-by-data-transfer billing method.
    isp String

    The line type. Valid values:

    • BGP All regions support BGP (Multi-ISP).
    • BGP_PRO BGP (Multi-ISP) Pro lines are available in the China (Hong Kong), Singapore, Japan (Tokyo), Philippines (Manila), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and Thailand (Bangkok) regions.

    If you are allowed to use single-ISP bandwidth, you can also use one of the following values:

    • ChinaTelecom
    • ChinaUnicom
    • ChinaMobile
    • ChinaTelecom_L2
    • ChinaUnicom_L2
    • ChinaMobile_L2

    If your services are deployed in China East 1 Finance, this parameter is required and you must set the value to BGP_FinanceCloud.

    name String
    . Field 'name' has been deprecated from provider version 1.120.0. New field 'bandwidth_package_name' instead.

    Deprecated: Field 'name' has been deprecated since provider version 1.120.0. New field 'bandwidth_package_name' instead.

    paymentType String
    The billing type of the Internet Shared Bandwidth instance. Valid values: PayAsYouGo, Subscription.
    ratio Number

    The percentage of the minimum bandwidth commitment. Set the parameter to 20.

    NOTE: This parameter is available only on the Alibaba Cloud China site.

    resourceGroupId String

    The ID of the resource group to which you want to move the resource.

    NOTE: You can use resource groups to facilitate resource grouping and permission management for an Alibaba Cloud. For more information, see What is resource management?

    securityProtectionTypes List<String>
    The edition of Anti-DDoS. If you do not set this parameter, Anti-DDoS Origin Basic is used. If you set the value to AntiDDoS_Enhanced, Anti-DDoS Pro(Premium) is used. It is valid when internet_charge_type is PayBy95.
    status String
    The status of the Internet Shared Bandwidth instance. Default value: Available.
    tags Map<String>
    The tag of the resource
    zone String

    The zone of the Internet Shared Bandwidth instance. This parameter is required if you create an Internet Shared Bandwidth instance for a cloud box.

    The following arguments will be discarded. Please use new fields as soon as possible:

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.68.0 published on Monday, Dec 2, 2024 by Pulumi