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

volcenginecc.vpc.Eip

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

    Public IP (Elastic IP Address, EIP) and its public outbound bandwidth are IP connectivity services provided by Volcano Engine for cloud resources, which can be purchased and held independently. Public IP supports direct binding to cloud servers (including ECS cloud servers, EBM bare metal servers, GPU cloud servers), and also supports binding to public NAT gateways, load balancers, and secondary network interfaces, providing public network connectivity for cloud servers.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";

const eipDemo = new volcenginecc.vpc.Eip("EipDemo", {
    name: "EipDemo",
    description: "EipDemo description",
    isp: "BGP",
    billingType: 2,
    bandwidth: 3,
    period: 5,
    projectName: "default",
    bandwidthPackageId: "bwp-ij5gz1lf66m874o8cth*****",
    tags: [{
        key: "env",
        value: "test",
    }],
    instanceId: "i-ye48ymyy9s5i3z4*****",
    instanceType: "EcsInstance",
    directMode: true,
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

eip_demo = volcenginecc.vpc.Eip("EipDemo",
    name="EipDemo",
    description="EipDemo description",
    isp="BGP",
    billing_type=2,
    bandwidth=3,
    period=5,
    project_name="default",
    bandwidth_package_id="bwp-ij5gz1lf66m874o8cth*****",
    tags=[{
        "key": "env",
        "value": "test",
    }],
    instance_id="i-ye48ymyy9s5i3z4*****",
    instance_type="EcsInstance",
    direct_mode=True)

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/vpc"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vpc.NewEip(ctx, "EipDemo", &vpc.EipArgs{
			Name:               pulumi.String("EipDemo"),
			Description:        pulumi.String("EipDemo description"),
			Isp:                pulumi.String("BGP"),
			BillingType:        pulumi.Int(2),
			Bandwidth:          pulumi.Int(3),
			Period:             pulumi.Int(5),
			ProjectName:        pulumi.String("default"),
			BandwidthPackageId: pulumi.String("bwp-ij5gz1lf66m874o8cth*****"),
			Tags: vpc.EipTagArray{
				&vpc.EipTagArgs{
					Key:   pulumi.String("env"),
					Value: pulumi.String("test"),
				},
			},
			InstanceId:   pulumi.String("i-ye48ymyy9s5i3z4*****"),
			InstanceType: pulumi.String("EcsInstance"),
			DirectMode:   pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcenginecc = Volcengine.Pulumi.Volcenginecc;

return await Deployment.RunAsync(() => 
{
    var eipDemo = new Volcenginecc.Vpc.Eip("EipDemo", new()
    {
        Name = "EipDemo",
        Description = "EipDemo description",
        Isp = "BGP",
        BillingType = 2,
        Bandwidth = 3,
        Period = 5,
        ProjectName = "default",
        BandwidthPackageId = "bwp-ij5gz1lf66m874o8cth*****",
        Tags = new[]
        {
            new Volcenginecc.Vpc.Inputs.EipTagArgs
            {
                Key = "env",
                Value = "test",
            },
        },
        InstanceId = "i-ye48ymyy9s5i3z4*****",
        InstanceType = "EcsInstance",
        DirectMode = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.vpc.Eip;
import com.volcengine.volcenginecc.vpc.EipArgs;
import com.pulumi.volcenginecc.vpc.inputs.EipTagArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var eipDemo = new Eip("eipDemo", EipArgs.builder()
            .name("EipDemo")
            .description("EipDemo description")
            .isp("BGP")
            .billingType(2)
            .bandwidth(3)
            .period(5)
            .projectName("default")
            .bandwidthPackageId("bwp-ij5gz1lf66m874o8cth*****")
            .tags(EipTagArgs.builder()
                .key("env")
                .value("test")
                .build())
            .instanceId("i-ye48ymyy9s5i3z4*****")
            .instanceType("EcsInstance")
            .directMode(true)
            .build());

    }
}

    resources:
  eipDemo:
    type: volcenginecc:vpc:Eip
    name: EipDemo
    properties:
      name: EipDemo
      description: EipDemo description
      isp: BGP
      billingType: 2
      bandwidth: 3
      period: 5
      projectName: default
      bandwidthPackageId: bwp-ij5gz1lf66m874o8cth*****
      tags:
        - key: env
          value: test
      instanceId: i-ye48ymyy9s5i3z4*****
      instanceType: EcsInstance
      directMode: true

    Create Eip Resource

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

    Constructor syntax

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

@overload
def Eip(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        billing_type: Optional[int] = None,
        name: Optional[str] = None,
        bandwidth_package_id: Optional[str] = None,
        description: Optional[str] = None,
        direct_mode: Optional[bool] = None,
        instance_id: Optional[str] = None,
        instance_type: Optional[str] = None,
        ip_address: Optional[str] = None,
        ip_address_pool_id: Optional[str] = None,
        bandwidth: Optional[int] = None,
        isp: Optional[str] = None,
        private_ip_address: Optional[str] = None,
        period_unit: Optional[int] = None,
        period: Optional[int] = None,
        project_name: Optional[str] = None,
        release_with_instance: Optional[bool] = None,
        renew_period_times: Optional[int] = None,
        renew_type: Optional[int] = None,
        security_protection_instance_id: Optional[int] = None,
        security_protection_types: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[EipTagArgs]] = None)
    func NewEip(ctx *Context, name string, args EipArgs, opts ...ResourceOption) (*Eip, error)
    public Eip(string name, EipArgs args, CustomResourceOptions? opts = null)
    public Eip(String name, EipArgs args)
public Eip(String name, EipArgs args, CustomResourceOptions options)

    type: volcenginecc:vpc:Eip
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 EipArgs
    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 EipArgs
    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 EipArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EipArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EipArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    BillingType int
    Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.
    Bandwidth int
    Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.
    BandwidthPackageId string
    Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.
    Description string
    Description of the public IP.
    DirectMode bool
    Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.
    InstanceId string
    Currently bound instance ID.
    InstanceType string
    Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.
    IpAddress string
    Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address
    IpAddressPoolId string
    IP address pool ID.
    Isp string
    Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLineBGP: BGP single line. FusionBGP: Fusion BGP. ChinaMobileValue: China Mobile Value static single line. ChinaUnicomValue: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.
    Name string
    Name of the public IP.
    Period int
    When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.
    PeriodUnit int
    Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.
    PrivateIpAddress string
    Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.
    ProjectName string
    Name of the project to which the public IP belongs.
    ReleaseWithInstance bool
    Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.
    RenewPeriodTimes int
    Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.
    RenewType int
    Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.
    SecurityProtectionInstanceId int
    DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    SecurityProtectionTypes List<string>
    Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.
    Tags List<Volcengine.EipTag>
    BillingType int
    Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.
    Bandwidth int
    Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.
    BandwidthPackageId string
    Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.
    Description string
    Description of the public IP.
    DirectMode bool
    Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.
    InstanceId string
    Currently bound instance ID.
    InstanceType string
    Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.
    IpAddress string
    Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address
    IpAddressPoolId string
    IP address pool ID.
    Isp string
    Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLineBGP: BGP single line. FusionBGP: Fusion BGP. ChinaMobileValue: China Mobile Value static single line. ChinaUnicomValue: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.
    Name string
    Name of the public IP.
    Period int
    When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.
    PeriodUnit int
    Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.
    PrivateIpAddress string
    Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.
    ProjectName string
    Name of the project to which the public IP belongs.
    ReleaseWithInstance bool
    Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.
    RenewPeriodTimes int
    Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.
    RenewType int
    Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.
    SecurityProtectionInstanceId int
    DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    SecurityProtectionTypes []string
    Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.
    Tags []EipTagArgs
    billingType Integer
    Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.
    bandwidth Integer
    Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.
    bandwidthPackageId String
    Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.
    description String
    Description of the public IP.
    directMode Boolean
    Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.
    instanceId String
    Currently bound instance ID.
    instanceType String
    Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.
    ipAddress String
    Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address
    ipAddressPoolId String
    IP address pool ID.
    isp String
    Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLineBGP: BGP single line. FusionBGP: Fusion BGP. ChinaMobileValue: China Mobile Value static single line. ChinaUnicomValue: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.
    name String
    Name of the public IP.
    period Integer
    When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.
    periodUnit Integer
    Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.
    privateIpAddress String
    Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.
    projectName String
    Name of the project to which the public IP belongs.
    releaseWithInstance Boolean
    Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.
    renewPeriodTimes Integer
    Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.
    renewType Integer
    Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.
    securityProtectionInstanceId Integer
    DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    securityProtectionTypes List<String>
    Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.
    tags List<EipTag>
    billingType number
    Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.
    bandwidth number
    Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.
    bandwidthPackageId string
    Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.
    description string
    Description of the public IP.
    directMode boolean
    Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.
    instanceId string
    Currently bound instance ID.
    instanceType string
    Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.
    ipAddress string
    Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address
    ipAddressPoolId string
    IP address pool ID.
    isp string
    Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLineBGP: BGP single line. FusionBGP: Fusion BGP. ChinaMobileValue: China Mobile Value static single line. ChinaUnicomValue: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.
    name string
    Name of the public IP.
    period number
    When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.
    periodUnit number
    Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.
    privateIpAddress string
    Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.
    projectName string
    Name of the project to which the public IP belongs.
    releaseWithInstance boolean
    Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.
    renewPeriodTimes number
    Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.
    renewType number
    Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.
    securityProtectionInstanceId number
    DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    securityProtectionTypes string[]
    Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.
    tags EipTag[]
    billing_type int
    Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.
    bandwidth int
    Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.
    bandwidth_package_id str
    Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.
    description str
    Description of the public IP.
    direct_mode bool
    Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.
    instance_id str
    Currently bound instance ID.
    instance_type str
    Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.
    ip_address str
    Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address
    ip_address_pool_id str
    IP address pool ID.
    isp str
    Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLineBGP: BGP single line. FusionBGP: Fusion BGP. ChinaMobileValue: China Mobile Value static single line. ChinaUnicomValue: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.
    name str
    Name of the public IP.
    period int
    When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.
    period_unit int
    Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.
    private_ip_address str
    Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.
    project_name str
    Name of the project to which the public IP belongs.
    release_with_instance bool
    Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.
    renew_period_times int
    Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.
    renew_type int
    Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.
    security_protection_instance_id int
    DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    security_protection_types Sequence[str]
    Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.
    tags Sequence[EipTagArgs]
    billingType Number
    Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.
    bandwidth Number
    Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.
    bandwidthPackageId String
    Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.
    description String
    Description of the public IP.
    directMode Boolean
    Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.
    instanceId String
    Currently bound instance ID.
    instanceType String
    Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.
    ipAddress String
    Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address
    ipAddressPoolId String
    IP address pool ID.
    isp String
    Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLineBGP: BGP single line. FusionBGP: Fusion BGP. ChinaMobileValue: China Mobile Value static single line. ChinaUnicomValue: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.
    name String
    Name of the public IP.
    period Number
    When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.
    periodUnit Number
    Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.
    privateIpAddress String
    Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.
    projectName String
    Name of the project to which the public IP belongs.
    releaseWithInstance Boolean
    Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.
    renewPeriodTimes Number
    Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.
    renewType Number
    Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.
    securityProtectionInstanceId Number
    DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    securityProtectionTypes List<String>
    Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.
    tags List<Property Map>

    Outputs

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

    AllocationId string
    Public IP ID.
    BusinessStatus string
    Whether the public IP is locked. Normal: normal. FinancialLocked: locked.
    CreatedTime string
    Creation time of the public IP.
    DeletedTime string
    Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.
    EipAddress string
    Public IP address.
    ExpiredTime string
    Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsBlocked bool
    Whether it is blocked. true: yes. false: no.
    LockReason string
    Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.
    OverdueTime string
    Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.
    ServiceManaged bool
    Managed by service
    Status string
    Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.
    UpdatedTime string
    Time when the public IP was updated.
    AllocationId string
    Public IP ID.
    BusinessStatus string
    Whether the public IP is locked. Normal: normal. FinancialLocked: locked.
    CreatedTime string
    Creation time of the public IP.
    DeletedTime string
    Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.
    EipAddress string
    Public IP address.
    ExpiredTime string
    Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsBlocked bool
    Whether it is blocked. true: yes. false: no.
    LockReason string
    Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.
    OverdueTime string
    Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.
    ServiceManaged bool
    Managed by service
    Status string
    Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.
    UpdatedTime string
    Time when the public IP was updated.
    allocationId String
    Public IP ID.
    businessStatus String
    Whether the public IP is locked. Normal: normal. FinancialLocked: locked.
    createdTime String
    Creation time of the public IP.
    deletedTime String
    Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.
    eipAddress String
    Public IP address.
    expiredTime String
    Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.
    id String
    The provider-assigned unique ID for this managed resource.
    isBlocked Boolean
    Whether it is blocked. true: yes. false: no.
    lockReason String
    Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.
    overdueTime String
    Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.
    serviceManaged Boolean
    Managed by service
    status String
    Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.
    updatedTime String
    Time when the public IP was updated.
    allocationId string
    Public IP ID.
    businessStatus string
    Whether the public IP is locked. Normal: normal. FinancialLocked: locked.
    createdTime string
    Creation time of the public IP.
    deletedTime string
    Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.
    eipAddress string
    Public IP address.
    expiredTime string
    Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.
    id string
    The provider-assigned unique ID for this managed resource.
    isBlocked boolean
    Whether it is blocked. true: yes. false: no.
    lockReason string
    Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.
    overdueTime string
    Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.
    serviceManaged boolean
    Managed by service
    status string
    Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.
    updatedTime string
    Time when the public IP was updated.
    allocation_id str
    Public IP ID.
    business_status str
    Whether the public IP is locked. Normal: normal. FinancialLocked: locked.
    created_time str
    Creation time of the public IP.
    deleted_time str
    Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.
    eip_address str
    Public IP address.
    expired_time str
    Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.
    id str
    The provider-assigned unique ID for this managed resource.
    is_blocked bool
    Whether it is blocked. true: yes. false: no.
    lock_reason str
    Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.
    overdue_time str
    Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.
    service_managed bool
    Managed by service
    status str
    Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.
    updated_time str
    Time when the public IP was updated.
    allocationId String
    Public IP ID.
    businessStatus String
    Whether the public IP is locked. Normal: normal. FinancialLocked: locked.
    createdTime String
    Creation time of the public IP.
    deletedTime String
    Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.
    eipAddress String
    Public IP address.
    expiredTime String
    Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.
    id String
    The provider-assigned unique ID for this managed resource.
    isBlocked Boolean
    Whether it is blocked. true: yes. false: no.
    lockReason String
    Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.
    overdueTime String
    Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.
    serviceManaged Boolean
    Managed by service
    status String
    Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.
    updatedTime String
    Time when the public IP was updated.

    Look up Existing Eip Resource

    Get an existing Eip 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?: EipState, opts?: CustomResourceOptions): Eip
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allocation_id: Optional[str] = None,
        bandwidth: Optional[int] = None,
        bandwidth_package_id: 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,
        direct_mode: Optional[bool] = None,
        eip_address: Optional[str] = None,
        expired_time: Optional[str] = None,
        instance_id: Optional[str] = None,
        instance_type: Optional[str] = None,
        ip_address: Optional[str] = None,
        ip_address_pool_id: Optional[str] = None,
        is_blocked: Optional[bool] = None,
        isp: Optional[str] = None,
        lock_reason: Optional[str] = None,
        name: Optional[str] = None,
        overdue_time: Optional[str] = None,
        period: Optional[int] = None,
        period_unit: Optional[int] = None,
        private_ip_address: Optional[str] = None,
        project_name: Optional[str] = None,
        release_with_instance: Optional[bool] = None,
        renew_period_times: Optional[int] = None,
        renew_type: Optional[int] = None,
        security_protection_instance_id: Optional[int] = None,
        security_protection_types: Optional[Sequence[str]] = None,
        service_managed: Optional[bool] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[EipTagArgs]] = None,
        updated_time: Optional[str] = None) -> Eip
    func GetEip(ctx *Context, name string, id IDInput, state *EipState, opts ...ResourceOption) (*Eip, error)
    public static Eip Get(string name, Input<string> id, EipState? state, CustomResourceOptions? opts = null)
    public static Eip get(String name, Output<String> id, EipState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:vpc:Eip    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:
    AllocationId string
    Public IP ID.
    Bandwidth int
    Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.
    BandwidthPackageId string
    Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.
    BillingType int
    Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.
    BusinessStatus string
    Whether the public IP is locked. Normal: normal. FinancialLocked: locked.
    CreatedTime string
    Creation time of the public IP.
    DeletedTime string
    Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.
    Description string
    Description of the public IP.
    DirectMode bool
    Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.
    EipAddress string
    Public IP address.
    ExpiredTime string
    Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.
    InstanceId string
    Currently bound instance ID.
    InstanceType string
    Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.
    IpAddress string
    Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address
    IpAddressPoolId string
    IP address pool ID.
    IsBlocked bool
    Whether it is blocked. true: yes. false: no.
    Isp string
    Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLineBGP: BGP single line. FusionBGP: Fusion BGP. ChinaMobileValue: China Mobile Value static single line. ChinaUnicomValue: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.
    LockReason string
    Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.
    Name string
    Name of the public IP.
    OverdueTime string
    Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.
    Period int
    When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.
    PeriodUnit int
    Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.
    PrivateIpAddress string
    Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.
    ProjectName string
    Name of the project to which the public IP belongs.
    ReleaseWithInstance bool
    Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.
    RenewPeriodTimes int
    Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.
    RenewType int
    Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.
    SecurityProtectionInstanceId int
    DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    SecurityProtectionTypes List<string>
    Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.
    ServiceManaged bool
    Managed by service
    Status string
    Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.
    Tags List<Volcengine.EipTag>
    UpdatedTime string
    Time when the public IP was updated.
    AllocationId string
    Public IP ID.
    Bandwidth int
    Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.
    BandwidthPackageId string
    Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.
    BillingType int
    Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.
    BusinessStatus string
    Whether the public IP is locked. Normal: normal. FinancialLocked: locked.
    CreatedTime string
    Creation time of the public IP.
    DeletedTime string
    Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.
    Description string
    Description of the public IP.
    DirectMode bool
    Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.
    EipAddress string
    Public IP address.
    ExpiredTime string
    Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.
    InstanceId string
    Currently bound instance ID.
    InstanceType string
    Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.
    IpAddress string
    Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address
    IpAddressPoolId string
    IP address pool ID.
    IsBlocked bool
    Whether it is blocked. true: yes. false: no.
    Isp string
    Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLineBGP: BGP single line. FusionBGP: Fusion BGP. ChinaMobileValue: China Mobile Value static single line. ChinaUnicomValue: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.
    LockReason string
    Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.
    Name string
    Name of the public IP.
    OverdueTime string
    Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.
    Period int
    When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.
    PeriodUnit int
    Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.
    PrivateIpAddress string
    Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.
    ProjectName string
    Name of the project to which the public IP belongs.
    ReleaseWithInstance bool
    Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.
    RenewPeriodTimes int
    Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.
    RenewType int
    Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.
    SecurityProtectionInstanceId int
    DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    SecurityProtectionTypes []string
    Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.
    ServiceManaged bool
    Managed by service
    Status string
    Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.
    Tags []EipTagArgs
    UpdatedTime string
    Time when the public IP was updated.
    allocationId String
    Public IP ID.
    bandwidth Integer
    Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.
    bandwidthPackageId String
    Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.
    billingType Integer
    Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.
    businessStatus String
    Whether the public IP is locked. Normal: normal. FinancialLocked: locked.
    createdTime String
    Creation time of the public IP.
    deletedTime String
    Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.
    description String
    Description of the public IP.
    directMode Boolean
    Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.
    eipAddress String
    Public IP address.
    expiredTime String
    Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.
    instanceId String
    Currently bound instance ID.
    instanceType String
    Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.
    ipAddress String
    Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address
    ipAddressPoolId String
    IP address pool ID.
    isBlocked Boolean
    Whether it is blocked. true: yes. false: no.
    isp String
    Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLineBGP: BGP single line. FusionBGP: Fusion BGP. ChinaMobileValue: China Mobile Value static single line. ChinaUnicomValue: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.
    lockReason String
    Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.
    name String
    Name of the public IP.
    overdueTime String
    Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.
    period Integer
    When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.
    periodUnit Integer
    Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.
    privateIpAddress String
    Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.
    projectName String
    Name of the project to which the public IP belongs.
    releaseWithInstance Boolean
    Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.
    renewPeriodTimes Integer
    Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.
    renewType Integer
    Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.
    securityProtectionInstanceId Integer
    DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    securityProtectionTypes List<String>
    Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.
    serviceManaged Boolean
    Managed by service
    status String
    Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.
    tags List<EipTag>
    updatedTime String
    Time when the public IP was updated.
    allocationId string
    Public IP ID.
    bandwidth number
    Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.
    bandwidthPackageId string
    Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.
    billingType number
    Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.
    businessStatus string
    Whether the public IP is locked. Normal: normal. FinancialLocked: locked.
    createdTime string
    Creation time of the public IP.
    deletedTime string
    Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.
    description string
    Description of the public IP.
    directMode boolean
    Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.
    eipAddress string
    Public IP address.
    expiredTime string
    Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.
    instanceId string
    Currently bound instance ID.
    instanceType string
    Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.
    ipAddress string
    Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address
    ipAddressPoolId string
    IP address pool ID.
    isBlocked boolean
    Whether it is blocked. true: yes. false: no.
    isp string
    Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLineBGP: BGP single line. FusionBGP: Fusion BGP. ChinaMobileValue: China Mobile Value static single line. ChinaUnicomValue: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.
    lockReason string
    Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.
    name string
    Name of the public IP.
    overdueTime string
    Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.
    period number
    When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.
    periodUnit number
    Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.
    privateIpAddress string
    Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.
    projectName string
    Name of the project to which the public IP belongs.
    releaseWithInstance boolean
    Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.
    renewPeriodTimes number
    Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.
    renewType number
    Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.
    securityProtectionInstanceId number
    DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    securityProtectionTypes string[]
    Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.
    serviceManaged boolean
    Managed by service
    status string
    Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.
    tags EipTag[]
    updatedTime string
    Time when the public IP was updated.
    allocation_id str
    Public IP ID.
    bandwidth int
    Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.
    bandwidth_package_id str
    Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.
    billing_type int
    Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.
    business_status str
    Whether the public IP is locked. Normal: normal. FinancialLocked: locked.
    created_time str
    Creation time of the public IP.
    deleted_time str
    Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.
    description str
    Description of the public IP.
    direct_mode bool
    Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.
    eip_address str
    Public IP address.
    expired_time str
    Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.
    instance_id str
    Currently bound instance ID.
    instance_type str
    Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.
    ip_address str
    Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address
    ip_address_pool_id str
    IP address pool ID.
    is_blocked bool
    Whether it is blocked. true: yes. false: no.
    isp str
    Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLineBGP: BGP single line. FusionBGP: Fusion BGP. ChinaMobileValue: China Mobile Value static single line. ChinaUnicomValue: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.
    lock_reason str
    Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.
    name str
    Name of the public IP.
    overdue_time str
    Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.
    period int
    When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.
    period_unit int
    Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.
    private_ip_address str
    Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.
    project_name str
    Name of the project to which the public IP belongs.
    release_with_instance bool
    Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.
    renew_period_times int
    Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.
    renew_type int
    Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.
    security_protection_instance_id int
    DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    security_protection_types Sequence[str]
    Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.
    service_managed bool
    Managed by service
    status str
    Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.
    tags Sequence[EipTagArgs]
    updated_time str
    Time when the public IP was updated.
    allocationId String
    Public IP ID.
    bandwidth Number
    Maximum bandwidth of the public IP. Default is '1', unit: Mbps. If BillingType is 1: range is 1~500. If BillingType is 2: range is 1~500. If BillingType is 3: range is 1~200.
    bandwidthPackageId String
    Shared bandwidth package ID, indicating the public IP is added to a shared bandwidth package. To add a public IP to a shared bandwidth package, the following conditions must be met: Both have the same security protection type. Both are in the same region. The public IP must use pay-as-you-go billing. The shared bandwidth package must be IPv4 type.
    billingType Number
    Billing method for public IP. Values: 1: annual/monthly. 2: pay-as-you-go - based on bandwidth cap. 3: pay-as-you-go - based on actual traffic.
    businessStatus String
    Whether the public IP is locked. Normal: normal. FinancialLocked: locked.
    createdTime String
    Creation time of the public IP.
    deletedTime String
    Expected forced resource recycle time. For subscription public IPs, this parameter returns a value. For pay-as-you-go public IPs, this parameter returns a value only when frozen due to overdue payment.
    description String
    Description of the public IP.
    directMode Boolean
    Whether to enable passthrough mode when binding public IP. Enter the following enum values exactly as shown; do not use other values. false (default): passthrough mode not enabled. true: passthrough mode enabled.
    eipAddress String
    Public IP address.
    expiredTime String
    Expiration time of the public IP. For subscription billing, the return value is the expiration time. For pay-as-you-go billing, the return value is empty.
    instanceId String
    Currently bound instance ID.
    instanceType String
    Current bound instance type. Nat: public NAT gateway. NetworkInterface: elastic network interface. ClbInstance: load balancer. EcsInstance: cloud server. HaVip: high availability virtual IP.
    ipAddress String
    Apply for a specified public IP address. Only supports entering IP addresses that have been released after use; if not specified, the IP address is assigned automatically. Specified public IP address
    ipAddressPoolId String
    IP address pool ID.
    isBlocked Boolean
    Whether it is blocked. true: yes. false: no.
    isp String
    Line type. BGP: BGP (multi-line). ChinaMobile: China Mobile static single line. ChinaTelecom: China Telecom static single line. ChinaUnicom: China Unicom static single line. SingleLineBGP: BGP single line. FusionBGP: Fusion BGP. ChinaMobileValue: China Mobile Value static single line. ChinaUnicomValue: China Unicom Value static single line. ChinaTelecom_Value: China Telecom Value static single line.
    lockReason String
    Reason for public IP lock. financial: locked due to overdue payment. unlock: restoring after recharge following suspension for overdue payment. Empty value: not locked.
    name String
    Name of the public IP.
    overdueTime String
    Resource freeze time. This parameter returns a value only when the resource is frozen due to overdue payment.
    period Number
    When representing the duration for purchasing a subscription public IP, the default is '1'. If PeriodUnit is set to 1, Period can be 1~9, 12, 24, 36, 48, or 60. If PeriodUnit is set to 2, Period can be 1~5. When representing the duration for temporary upgrade, the unit is hours, and the range is 1~720.
    periodUnit Number
    Unit for the duration when purchasing annual/monthly public IP. Values: 1 (default): month. 2: year.
    privateIpAddress String
    Private IP address of the instance to bind the public IP to. Only ECS primary network interface private IP addresses and secondary network interface IP addresses are supported. If not specified: If InstanceType is EcsInstance, binds to the primary private IP address of the ECS primary network interface. If InstanceType is NetworkInterface, binds to the primary private IP address of the secondary network interface.
    projectName String
    Name of the project to which the public IP belongs.
    releaseWithInstance Boolean
    Whether to release the public IP when the cloud server instance is deleted. Only valid for pay-as-you-go public IPs. When enabled, the public IP is released together with the instance when the system automatically recycles the instance (24 hours after unsubscription, upon expiration, or due to overdue payment) or when the DeleteInstances API is called. true: yes. false: no.
    renewPeriodTimes Number
    Duration for automatic renewal. Valid values: 1, 2, 3, 6, 12. Unit: month. If RenewType is 2, RenewPeriodTimes must be specified.
    renewType Number
    Renewal method for annual/monthly public IP. Values: 1 (default): manual renewal. 2: automatic renewal. 3: do not renew upon expiration.
    securityProtectionInstanceId Number
    DDoS native protection (Enterprise Edition) ID. You can call the DescInstanceList API to query the ID of DDoS native protection (Enterprise Edition). When SecurityProtectionTypes is set to AntiDDoS_Enhanced, this parameter is required.
    securityProtectionTypes List<String>
    Protection type. AntiDDoS_Enhanced: Public IPs with enhanced protection can be added to DDoS Native Protection (Enterprise Edition) instances. Null value: Public IPs with default protection type.
    serviceManaged Boolean
    Managed by service
    status String
    Status of the public IP. Attaching: binding in progress. Detaching: unbinding in progress. Attached: bound. Available: available. Deleting: deleting.
    tags List<Property Map>
    updatedTime String
    Time when the public IP was updated.

    Supporting Types

    EipTag, EipTagArgs

    Key string
    Tag key.
    Value string
    Tag value.
    Key string
    Tag key.
    Value string
    Tag value.
    key String
    Tag key.
    value String
    Tag value.
    key string
    Tag key.
    value string
    Tag value.
    key str
    Tag key.
    value str
    Tag value.
    key String
    Tag key.
    value String
    Tag value.

    Import

    $ pulumi import volcenginecc:vpc/eip:Eip example "allocation_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.