EipAddress

Provides a EIP Address resource.

For information about EIP Address and how to use it, see What is EIP Address.

NOTE: Available in v1.126.0+.

NOTE: BGP (Multi-ISP) lines are supported in all regions. BGP (Multi-ISP) Pro lines are supported only in the China (Hong Kong) region.

NOTE: The resource only supports to create PayAsYouGo PayByTraffic or Subscription PayByBandwidth elastic IP for international account. Otherwise, you will happened error COMMODITY.INVALID_COMPONENT. Your account is international if you can use it to login in International Web Console.

Example Usage

Basic Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new AliCloud.Ecs.EipAddress("example", new AliCloud.Ecs.EipAddressArgs
        {
            AddressName = "tf-testAcc1234",
            InternetChargeType = "PayByBandwidth",
            Isp = "BGP",
            PaymentType = "PayAsYouGo",
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ecs.NewEipAddress(ctx, "example", &ecs.EipAddressArgs{
			AddressName:        pulumi.String("tf-testAcc1234"),
			InternetChargeType: pulumi.String("PayByBandwidth"),
			Isp:                pulumi.String("BGP"),
			PaymentType:        pulumi.String("PayAsYouGo"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.ecs.EipAddress;
import com.pulumi.alicloud.ecs.EipAddressArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var example = new EipAddress("example", EipAddressArgs.builder()        
            .addressName("tf-testAcc1234")
            .internetChargeType("PayByBandwidth")
            .isp("BGP")
            .paymentType("PayAsYouGo")
            .build());

    }
}
import pulumi
import pulumi_alicloud as alicloud

example = alicloud.ecs.EipAddress("example",
    address_name="tf-testAcc1234",
    internet_charge_type="PayByBandwidth",
    isp="BGP",
    payment_type="PayAsYouGo")
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const example = new alicloud.ecs.EipAddress("example", {
    addressName: "tf-testAcc1234",
    internetChargeType: "PayByBandwidth",
    isp: "BGP",
    paymentType: "PayAsYouGo",
});
resources:
  example:
    type: alicloud:ecs:EipAddress
    properties:
      addressName: tf-testAcc1234
      internetChargeType: PayByBandwidth
      isp: BGP
      paymentType: PayAsYouGo

Create EipAddress Resource

new EipAddress(name: string, args?: EipAddressArgs, opts?: CustomResourceOptions);
@overload
def EipAddress(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               activity_id: Optional[str] = None,
               address_name: Optional[str] = None,
               auto_pay: Optional[bool] = None,
               bandwidth: Optional[str] = None,
               deletion_protection: Optional[bool] = None,
               description: Optional[str] = None,
               instance_charge_type: Optional[str] = None,
               internet_charge_type: Optional[str] = None,
               isp: Optional[str] = None,
               name: Optional[str] = None,
               netmode: Optional[str] = None,
               payment_type: Optional[str] = None,
               period: Optional[int] = None,
               resource_group_id: Optional[str] = None,
               tags: Optional[Mapping[str, Any]] = None)
@overload
def EipAddress(resource_name: str,
               args: Optional[EipAddressArgs] = None,
               opts: Optional[ResourceOptions] = None)
func NewEipAddress(ctx *Context, name string, args *EipAddressArgs, opts ...ResourceOption) (*EipAddress, error)
public EipAddress(string name, EipAddressArgs? args = null, CustomResourceOptions? opts = null)
public EipAddress(String name, EipAddressArgs args)
public EipAddress(String name, EipAddressArgs args, CustomResourceOptions options)
type: alicloud:ecs:EipAddress
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

EipAddress Resource Properties

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

Inputs

The EipAddress resource accepts the following input properties:

ActivityId string

The activity id.

AddressName string

The name of the EIP instance. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://.

AutoPay bool

Whether to pay automatically. Valid values: true and false. Default value: true. When auto_pay is true, The order will be automatically paid. When auto_pay is false, The order needs to go to the order center to complete the payment. NOTE: When payment_type is Subscription, this parameter is valid.

Bandwidth string

The maximum bandwidth of the EIP. Valid values: 1 to 200. Unit: Mbit/s. Default value: 5.

DeletionProtection bool

Whether enable the deletion protection or not. Default value: false.

Description string

The description of the EIP.

InstanceChargeType string

Field instance_charge_type has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute payment_type instead.

Deprecated:

Field 'instance_charge_type' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

InternetChargeType string

The metering method of the EIP. Valid values: PayByDominantTraffic, PayByBandwidth and PayByTraffic. Default to PayByBandwidth. NOTE: It must be set to "PayByBandwidth" when payment_type is "Subscription".

Isp string

The line type. You can set this parameter only when you create a PayAsYouGo EIP. Valid values: BGP: BGP (Multi-ISP) lines.Up to 89 high-quality BGP lines are available worldwide. Direct connections with multiple Internet Service Providers (ISPs), including Telecom, Unicom, Mobile, Railcom, Netcom, CERNET, China Broadcast Network, Dr. Peng, and Founder, can be established in all regions in mainland China. BGP_PRO: BGP (Multi-ISP) Pro lines optimize data transmission to mainland China and improve connection quality for international services. Compared with BGP (Multi-ISP), when BGP (Multi-ISP) Pro provides services to clients in mainland China (excluding data centers), cross-border connections are established without using international ISP services. This reduces network latency.

Name string

Field name has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute address_name instead.

Deprecated:

Field 'name' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'address_name' instead.

Netmode string

The type of the network. Valid value is public (Internet).

PaymentType string

The billing method of the EIP. Valid values: Subscription and PayAsYouGo. Default value is PayAsYouGo.

Period int

The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console.

ResourceGroupId string

The ID of the resource group.

Tags Dictionary<string, object>

A mapping of tags to assign to the resource.

ActivityId string

The activity id.

AddressName string

The name of the EIP instance. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://.

AutoPay bool

Whether to pay automatically. Valid values: true and false. Default value: true. When auto_pay is true, The order will be automatically paid. When auto_pay is false, The order needs to go to the order center to complete the payment. NOTE: When payment_type is Subscription, this parameter is valid.

Bandwidth string

The maximum bandwidth of the EIP. Valid values: 1 to 200. Unit: Mbit/s. Default value: 5.

DeletionProtection bool

Whether enable the deletion protection or not. Default value: false.

Description string

The description of the EIP.

InstanceChargeType string

Field instance_charge_type has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute payment_type instead.

Deprecated:

Field 'instance_charge_type' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

InternetChargeType string

The metering method of the EIP. Valid values: PayByDominantTraffic, PayByBandwidth and PayByTraffic. Default to PayByBandwidth. NOTE: It must be set to "PayByBandwidth" when payment_type is "Subscription".

Isp string

The line type. You can set this parameter only when you create a PayAsYouGo EIP. Valid values: BGP: BGP (Multi-ISP) lines.Up to 89 high-quality BGP lines are available worldwide. Direct connections with multiple Internet Service Providers (ISPs), including Telecom, Unicom, Mobile, Railcom, Netcom, CERNET, China Broadcast Network, Dr. Peng, and Founder, can be established in all regions in mainland China. BGP_PRO: BGP (Multi-ISP) Pro lines optimize data transmission to mainland China and improve connection quality for international services. Compared with BGP (Multi-ISP), when BGP (Multi-ISP) Pro provides services to clients in mainland China (excluding data centers), cross-border connections are established without using international ISP services. This reduces network latency.

Name string

Field name has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute address_name instead.

Deprecated:

Field 'name' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'address_name' instead.

Netmode string

The type of the network. Valid value is public (Internet).

PaymentType string

The billing method of the EIP. Valid values: Subscription and PayAsYouGo. Default value is PayAsYouGo.

Period int

The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console.

ResourceGroupId string

The ID of the resource group.

Tags map[string]interface{}

A mapping of tags to assign to the resource.

activityId String

The activity id.

addressName String

The name of the EIP instance. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://.

autoPay Boolean

Whether to pay automatically. Valid values: true and false. Default value: true. When auto_pay is true, The order will be automatically paid. When auto_pay is false, The order needs to go to the order center to complete the payment. NOTE: When payment_type is Subscription, this parameter is valid.

bandwidth String

The maximum bandwidth of the EIP. Valid values: 1 to 200. Unit: Mbit/s. Default value: 5.

deletionProtection Boolean

Whether enable the deletion protection or not. Default value: false.

description String

The description of the EIP.

instanceChargeType String

Field instance_charge_type has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute payment_type instead.

Deprecated:

Field 'instance_charge_type' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

internetChargeType String

The metering method of the EIP. Valid values: PayByDominantTraffic, PayByBandwidth and PayByTraffic. Default to PayByBandwidth. NOTE: It must be set to "PayByBandwidth" when payment_type is "Subscription".

isp String

The line type. You can set this parameter only when you create a PayAsYouGo EIP. Valid values: BGP: BGP (Multi-ISP) lines.Up to 89 high-quality BGP lines are available worldwide. Direct connections with multiple Internet Service Providers (ISPs), including Telecom, Unicom, Mobile, Railcom, Netcom, CERNET, China Broadcast Network, Dr. Peng, and Founder, can be established in all regions in mainland China. BGP_PRO: BGP (Multi-ISP) Pro lines optimize data transmission to mainland China and improve connection quality for international services. Compared with BGP (Multi-ISP), when BGP (Multi-ISP) Pro provides services to clients in mainland China (excluding data centers), cross-border connections are established without using international ISP services. This reduces network latency.

name String

Field name has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute address_name instead.

Deprecated:

Field 'name' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'address_name' instead.

netmode String

The type of the network. Valid value is public (Internet).

paymentType String

The billing method of the EIP. Valid values: Subscription and PayAsYouGo. Default value is PayAsYouGo.

period Integer

The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console.

resourceGroupId String

The ID of the resource group.

tags Map<String,Object>

A mapping of tags to assign to the resource.

activityId string

The activity id.

addressName string

The name of the EIP instance. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://.

autoPay boolean

Whether to pay automatically. Valid values: true and false. Default value: true. When auto_pay is true, The order will be automatically paid. When auto_pay is false, The order needs to go to the order center to complete the payment. NOTE: When payment_type is Subscription, this parameter is valid.

bandwidth string

The maximum bandwidth of the EIP. Valid values: 1 to 200. Unit: Mbit/s. Default value: 5.

deletionProtection boolean

Whether enable the deletion protection or not. Default value: false.

description string

The description of the EIP.

instanceChargeType string

Field instance_charge_type has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute payment_type instead.

Deprecated:

Field 'instance_charge_type' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

internetChargeType string

The metering method of the EIP. Valid values: PayByDominantTraffic, PayByBandwidth and PayByTraffic. Default to PayByBandwidth. NOTE: It must be set to "PayByBandwidth" when payment_type is "Subscription".

isp string

The line type. You can set this parameter only when you create a PayAsYouGo EIP. Valid values: BGP: BGP (Multi-ISP) lines.Up to 89 high-quality BGP lines are available worldwide. Direct connections with multiple Internet Service Providers (ISPs), including Telecom, Unicom, Mobile, Railcom, Netcom, CERNET, China Broadcast Network, Dr. Peng, and Founder, can be established in all regions in mainland China. BGP_PRO: BGP (Multi-ISP) Pro lines optimize data transmission to mainland China and improve connection quality for international services. Compared with BGP (Multi-ISP), when BGP (Multi-ISP) Pro provides services to clients in mainland China (excluding data centers), cross-border connections are established without using international ISP services. This reduces network latency.

name string

Field name has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute address_name instead.

Deprecated:

Field 'name' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'address_name' instead.

netmode string

The type of the network. Valid value is public (Internet).

paymentType string

The billing method of the EIP. Valid values: Subscription and PayAsYouGo. Default value is PayAsYouGo.

period number

The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console.

resourceGroupId string

The ID of the resource group.

tags {[key: string]: any}

A mapping of tags to assign to the resource.

activity_id str

The activity id.

address_name str

The name of the EIP instance. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://.

auto_pay bool

Whether to pay automatically. Valid values: true and false. Default value: true. When auto_pay is true, The order will be automatically paid. When auto_pay is false, The order needs to go to the order center to complete the payment. NOTE: When payment_type is Subscription, this parameter is valid.

bandwidth str

The maximum bandwidth of the EIP. Valid values: 1 to 200. Unit: Mbit/s. Default value: 5.

deletion_protection bool

Whether enable the deletion protection or not. Default value: false.

description str

The description of the EIP.

instance_charge_type str

Field instance_charge_type has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute payment_type instead.

Deprecated:

Field 'instance_charge_type' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

internet_charge_type str

The metering method of the EIP. Valid values: PayByDominantTraffic, PayByBandwidth and PayByTraffic. Default to PayByBandwidth. NOTE: It must be set to "PayByBandwidth" when payment_type is "Subscription".

isp str

The line type. You can set this parameter only when you create a PayAsYouGo EIP. Valid values: BGP: BGP (Multi-ISP) lines.Up to 89 high-quality BGP lines are available worldwide. Direct connections with multiple Internet Service Providers (ISPs), including Telecom, Unicom, Mobile, Railcom, Netcom, CERNET, China Broadcast Network, Dr. Peng, and Founder, can be established in all regions in mainland China. BGP_PRO: BGP (Multi-ISP) Pro lines optimize data transmission to mainland China and improve connection quality for international services. Compared with BGP (Multi-ISP), when BGP (Multi-ISP) Pro provides services to clients in mainland China (excluding data centers), cross-border connections are established without using international ISP services. This reduces network latency.

name str

Field name has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute address_name instead.

Deprecated:

Field 'name' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'address_name' instead.

netmode str

The type of the network. Valid value is public (Internet).

payment_type str

The billing method of the EIP. Valid values: Subscription and PayAsYouGo. Default value is PayAsYouGo.

period int

The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console.

resource_group_id str

The ID of the resource group.

tags Mapping[str, Any]

A mapping of tags to assign to the resource.

activityId String

The activity id.

addressName String

The name of the EIP instance. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://.

autoPay Boolean

Whether to pay automatically. Valid values: true and false. Default value: true. When auto_pay is true, The order will be automatically paid. When auto_pay is false, The order needs to go to the order center to complete the payment. NOTE: When payment_type is Subscription, this parameter is valid.

bandwidth String

The maximum bandwidth of the EIP. Valid values: 1 to 200. Unit: Mbit/s. Default value: 5.

deletionProtection Boolean

Whether enable the deletion protection or not. Default value: false.

description String

The description of the EIP.

instanceChargeType String

Field instance_charge_type has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute payment_type instead.

Deprecated:

Field 'instance_charge_type' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

internetChargeType String

The metering method of the EIP. Valid values: PayByDominantTraffic, PayByBandwidth and PayByTraffic. Default to PayByBandwidth. NOTE: It must be set to "PayByBandwidth" when payment_type is "Subscription".

isp String

The line type. You can set this parameter only when you create a PayAsYouGo EIP. Valid values: BGP: BGP (Multi-ISP) lines.Up to 89 high-quality BGP lines are available worldwide. Direct connections with multiple Internet Service Providers (ISPs), including Telecom, Unicom, Mobile, Railcom, Netcom, CERNET, China Broadcast Network, Dr. Peng, and Founder, can be established in all regions in mainland China. BGP_PRO: BGP (Multi-ISP) Pro lines optimize data transmission to mainland China and improve connection quality for international services. Compared with BGP (Multi-ISP), when BGP (Multi-ISP) Pro provides services to clients in mainland China (excluding data centers), cross-border connections are established without using international ISP services. This reduces network latency.

name String

Field name has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute address_name instead.

Deprecated:

Field 'name' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'address_name' instead.

netmode String

The type of the network. Valid value is public (Internet).

paymentType String

The billing method of the EIP. Valid values: Subscription and PayAsYouGo. Default value is PayAsYouGo.

period Number

The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console.

resourceGroupId String

The ID of the resource group.

tags Map<Any>

A mapping of tags to assign to the resource.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

IpAddress string

The address of the EIP.

Status string

The status of the EIP. Valid values: Associating: The EIP is being associated. Unassociating: The EIP is being disassociated. InUse: The EIP is allocated. Available:The EIP is available.

Id string

The provider-assigned unique ID for this managed resource.

IpAddress string

The address of the EIP.

Status string

The status of the EIP. Valid values: Associating: The EIP is being associated. Unassociating: The EIP is being disassociated. InUse: The EIP is allocated. Available:The EIP is available.

id String

The provider-assigned unique ID for this managed resource.

ipAddress String

The address of the EIP.

status String

The status of the EIP. Valid values: Associating: The EIP is being associated. Unassociating: The EIP is being disassociated. InUse: The EIP is allocated. Available:The EIP is available.

id string

The provider-assigned unique ID for this managed resource.

ipAddress string

The address of the EIP.

status string

The status of the EIP. Valid values: Associating: The EIP is being associated. Unassociating: The EIP is being disassociated. InUse: The EIP is allocated. Available:The EIP is available.

id str

The provider-assigned unique ID for this managed resource.

ip_address str

The address of the EIP.

status str

The status of the EIP. Valid values: Associating: The EIP is being associated. Unassociating: The EIP is being disassociated. InUse: The EIP is allocated. Available:The EIP is available.

id String

The provider-assigned unique ID for this managed resource.

ipAddress String

The address of the EIP.

status String

The status of the EIP. Valid values: Associating: The EIP is being associated. Unassociating: The EIP is being disassociated. InUse: The EIP is allocated. Available:The EIP is available.

Look up Existing EipAddress Resource

Get an existing EipAddress 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?: EipAddressState, opts?: CustomResourceOptions): EipAddress
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activity_id: Optional[str] = None,
        address_name: Optional[str] = None,
        auto_pay: Optional[bool] = None,
        bandwidth: Optional[str] = None,
        deletion_protection: Optional[bool] = None,
        description: Optional[str] = None,
        instance_charge_type: Optional[str] = None,
        internet_charge_type: Optional[str] = None,
        ip_address: Optional[str] = None,
        isp: Optional[str] = None,
        name: Optional[str] = None,
        netmode: Optional[str] = None,
        payment_type: Optional[str] = None,
        period: Optional[int] = None,
        resource_group_id: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, Any]] = None) -> EipAddress
func GetEipAddress(ctx *Context, name string, id IDInput, state *EipAddressState, opts ...ResourceOption) (*EipAddress, error)
public static EipAddress Get(string name, Input<string> id, EipAddressState? state, CustomResourceOptions? opts = null)
public static EipAddress get(String name, Output<String> id, EipAddressState 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:
ActivityId string

The activity id.

AddressName string

The name of the EIP instance. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://.

AutoPay bool

Whether to pay automatically. Valid values: true and false. Default value: true. When auto_pay is true, The order will be automatically paid. When auto_pay is false, The order needs to go to the order center to complete the payment. NOTE: When payment_type is Subscription, this parameter is valid.

Bandwidth string

The maximum bandwidth of the EIP. Valid values: 1 to 200. Unit: Mbit/s. Default value: 5.

DeletionProtection bool

Whether enable the deletion protection or not. Default value: false.

Description string

The description of the EIP.

InstanceChargeType string

Field instance_charge_type has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute payment_type instead.

Deprecated:

Field 'instance_charge_type' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

InternetChargeType string

The metering method of the EIP. Valid values: PayByDominantTraffic, PayByBandwidth and PayByTraffic. Default to PayByBandwidth. NOTE: It must be set to "PayByBandwidth" when payment_type is "Subscription".

IpAddress string

The address of the EIP.

Isp string

The line type. You can set this parameter only when you create a PayAsYouGo EIP. Valid values: BGP: BGP (Multi-ISP) lines.Up to 89 high-quality BGP lines are available worldwide. Direct connections with multiple Internet Service Providers (ISPs), including Telecom, Unicom, Mobile, Railcom, Netcom, CERNET, China Broadcast Network, Dr. Peng, and Founder, can be established in all regions in mainland China. BGP_PRO: BGP (Multi-ISP) Pro lines optimize data transmission to mainland China and improve connection quality for international services. Compared with BGP (Multi-ISP), when BGP (Multi-ISP) Pro provides services to clients in mainland China (excluding data centers), cross-border connections are established without using international ISP services. This reduces network latency.

Name string

Field name has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute address_name instead.

Deprecated:

Field 'name' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'address_name' instead.

Netmode string

The type of the network. Valid value is public (Internet).

PaymentType string

The billing method of the EIP. Valid values: Subscription and PayAsYouGo. Default value is PayAsYouGo.

Period int

The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console.

ResourceGroupId string

The ID of the resource group.

Status string

The status of the EIP. Valid values: Associating: The EIP is being associated. Unassociating: The EIP is being disassociated. InUse: The EIP is allocated. Available:The EIP is available.

Tags Dictionary<string, object>

A mapping of tags to assign to the resource.

ActivityId string

The activity id.

AddressName string

The name of the EIP instance. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://.

AutoPay bool

Whether to pay automatically. Valid values: true and false. Default value: true. When auto_pay is true, The order will be automatically paid. When auto_pay is false, The order needs to go to the order center to complete the payment. NOTE: When payment_type is Subscription, this parameter is valid.

Bandwidth string

The maximum bandwidth of the EIP. Valid values: 1 to 200. Unit: Mbit/s. Default value: 5.

DeletionProtection bool

Whether enable the deletion protection or not. Default value: false.

Description string

The description of the EIP.

InstanceChargeType string

Field instance_charge_type has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute payment_type instead.

Deprecated:

Field 'instance_charge_type' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

InternetChargeType string

The metering method of the EIP. Valid values: PayByDominantTraffic, PayByBandwidth and PayByTraffic. Default to PayByBandwidth. NOTE: It must be set to "PayByBandwidth" when payment_type is "Subscription".

IpAddress string

The address of the EIP.

Isp string

The line type. You can set this parameter only when you create a PayAsYouGo EIP. Valid values: BGP: BGP (Multi-ISP) lines.Up to 89 high-quality BGP lines are available worldwide. Direct connections with multiple Internet Service Providers (ISPs), including Telecom, Unicom, Mobile, Railcom, Netcom, CERNET, China Broadcast Network, Dr. Peng, and Founder, can be established in all regions in mainland China. BGP_PRO: BGP (Multi-ISP) Pro lines optimize data transmission to mainland China and improve connection quality for international services. Compared with BGP (Multi-ISP), when BGP (Multi-ISP) Pro provides services to clients in mainland China (excluding data centers), cross-border connections are established without using international ISP services. This reduces network latency.

Name string

Field name has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute address_name instead.

Deprecated:

Field 'name' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'address_name' instead.

Netmode string

The type of the network. Valid value is public (Internet).

PaymentType string

The billing method of the EIP. Valid values: Subscription and PayAsYouGo. Default value is PayAsYouGo.

Period int

The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console.

ResourceGroupId string

The ID of the resource group.

Status string

The status of the EIP. Valid values: Associating: The EIP is being associated. Unassociating: The EIP is being disassociated. InUse: The EIP is allocated. Available:The EIP is available.

Tags map[string]interface{}

A mapping of tags to assign to the resource.

activityId String

The activity id.

addressName String

The name of the EIP instance. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://.

autoPay Boolean

Whether to pay automatically. Valid values: true and false. Default value: true. When auto_pay is true, The order will be automatically paid. When auto_pay is false, The order needs to go to the order center to complete the payment. NOTE: When payment_type is Subscription, this parameter is valid.

bandwidth String

The maximum bandwidth of the EIP. Valid values: 1 to 200. Unit: Mbit/s. Default value: 5.

deletionProtection Boolean

Whether enable the deletion protection or not. Default value: false.

description String

The description of the EIP.

instanceChargeType String

Field instance_charge_type has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute payment_type instead.

Deprecated:

Field 'instance_charge_type' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

internetChargeType String

The metering method of the EIP. Valid values: PayByDominantTraffic, PayByBandwidth and PayByTraffic. Default to PayByBandwidth. NOTE: It must be set to "PayByBandwidth" when payment_type is "Subscription".

ipAddress String

The address of the EIP.

isp String

The line type. You can set this parameter only when you create a PayAsYouGo EIP. Valid values: BGP: BGP (Multi-ISP) lines.Up to 89 high-quality BGP lines are available worldwide. Direct connections with multiple Internet Service Providers (ISPs), including Telecom, Unicom, Mobile, Railcom, Netcom, CERNET, China Broadcast Network, Dr. Peng, and Founder, can be established in all regions in mainland China. BGP_PRO: BGP (Multi-ISP) Pro lines optimize data transmission to mainland China and improve connection quality for international services. Compared with BGP (Multi-ISP), when BGP (Multi-ISP) Pro provides services to clients in mainland China (excluding data centers), cross-border connections are established without using international ISP services. This reduces network latency.

name String

Field name has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute address_name instead.

Deprecated:

Field 'name' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'address_name' instead.

netmode String

The type of the network. Valid value is public (Internet).

paymentType String

The billing method of the EIP. Valid values: Subscription and PayAsYouGo. Default value is PayAsYouGo.

period Integer

The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console.

resourceGroupId String

The ID of the resource group.

status String

The status of the EIP. Valid values: Associating: The EIP is being associated. Unassociating: The EIP is being disassociated. InUse: The EIP is allocated. Available:The EIP is available.

tags Map<String,Object>

A mapping of tags to assign to the resource.

activityId string

The activity id.

addressName string

The name of the EIP instance. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://.

autoPay boolean

Whether to pay automatically. Valid values: true and false. Default value: true. When auto_pay is true, The order will be automatically paid. When auto_pay is false, The order needs to go to the order center to complete the payment. NOTE: When payment_type is Subscription, this parameter is valid.

bandwidth string

The maximum bandwidth of the EIP. Valid values: 1 to 200. Unit: Mbit/s. Default value: 5.

deletionProtection boolean

Whether enable the deletion protection or not. Default value: false.

description string

The description of the EIP.

instanceChargeType string

Field instance_charge_type has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute payment_type instead.

Deprecated:

Field 'instance_charge_type' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

internetChargeType string

The metering method of the EIP. Valid values: PayByDominantTraffic, PayByBandwidth and PayByTraffic. Default to PayByBandwidth. NOTE: It must be set to "PayByBandwidth" when payment_type is "Subscription".

ipAddress string

The address of the EIP.

isp string

The line type. You can set this parameter only when you create a PayAsYouGo EIP. Valid values: BGP: BGP (Multi-ISP) lines.Up to 89 high-quality BGP lines are available worldwide. Direct connections with multiple Internet Service Providers (ISPs), including Telecom, Unicom, Mobile, Railcom, Netcom, CERNET, China Broadcast Network, Dr. Peng, and Founder, can be established in all regions in mainland China. BGP_PRO: BGP (Multi-ISP) Pro lines optimize data transmission to mainland China and improve connection quality for international services. Compared with BGP (Multi-ISP), when BGP (Multi-ISP) Pro provides services to clients in mainland China (excluding data centers), cross-border connections are established without using international ISP services. This reduces network latency.

name string

Field name has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute address_name instead.

Deprecated:

Field 'name' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'address_name' instead.

netmode string

The type of the network. Valid value is public (Internet).

paymentType string

The billing method of the EIP. Valid values: Subscription and PayAsYouGo. Default value is PayAsYouGo.

period number

The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console.

resourceGroupId string

The ID of the resource group.

status string

The status of the EIP. Valid values: Associating: The EIP is being associated. Unassociating: The EIP is being disassociated. InUse: The EIP is allocated. Available:The EIP is available.

tags {[key: string]: any}

A mapping of tags to assign to the resource.

activity_id str

The activity id.

address_name str

The name of the EIP instance. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://.

auto_pay bool

Whether to pay automatically. Valid values: true and false. Default value: true. When auto_pay is true, The order will be automatically paid. When auto_pay is false, The order needs to go to the order center to complete the payment. NOTE: When payment_type is Subscription, this parameter is valid.

bandwidth str

The maximum bandwidth of the EIP. Valid values: 1 to 200. Unit: Mbit/s. Default value: 5.

deletion_protection bool

Whether enable the deletion protection or not. Default value: false.

description str

The description of the EIP.

instance_charge_type str

Field instance_charge_type has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute payment_type instead.

Deprecated:

Field 'instance_charge_type' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

internet_charge_type str

The metering method of the EIP. Valid values: PayByDominantTraffic, PayByBandwidth and PayByTraffic. Default to PayByBandwidth. NOTE: It must be set to "PayByBandwidth" when payment_type is "Subscription".

ip_address str

The address of the EIP.

isp str

The line type. You can set this parameter only when you create a PayAsYouGo EIP. Valid values: BGP: BGP (Multi-ISP) lines.Up to 89 high-quality BGP lines are available worldwide. Direct connections with multiple Internet Service Providers (ISPs), including Telecom, Unicom, Mobile, Railcom, Netcom, CERNET, China Broadcast Network, Dr. Peng, and Founder, can be established in all regions in mainland China. BGP_PRO: BGP (Multi-ISP) Pro lines optimize data transmission to mainland China and improve connection quality for international services. Compared with BGP (Multi-ISP), when BGP (Multi-ISP) Pro provides services to clients in mainland China (excluding data centers), cross-border connections are established without using international ISP services. This reduces network latency.

name str

Field name has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute address_name instead.

Deprecated:

Field 'name' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'address_name' instead.

netmode str

The type of the network. Valid value is public (Internet).

payment_type str

The billing method of the EIP. Valid values: Subscription and PayAsYouGo. Default value is PayAsYouGo.

period int

The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console.

resource_group_id str

The ID of the resource group.

status str

The status of the EIP. Valid values: Associating: The EIP is being associated. Unassociating: The EIP is being disassociated. InUse: The EIP is allocated. Available:The EIP is available.

tags Mapping[str, Any]

A mapping of tags to assign to the resource.

activityId String

The activity id.

addressName String

The name of the EIP instance. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as "-",".","_", and must not begin or end with a hyphen, and must not begin with http:// or https://.

autoPay Boolean

Whether to pay automatically. Valid values: true and false. Default value: true. When auto_pay is true, The order will be automatically paid. When auto_pay is false, The order needs to go to the order center to complete the payment. NOTE: When payment_type is Subscription, this parameter is valid.

bandwidth String

The maximum bandwidth of the EIP. Valid values: 1 to 200. Unit: Mbit/s. Default value: 5.

deletionProtection Boolean

Whether enable the deletion protection or not. Default value: false.

description String

The description of the EIP.

instanceChargeType String

Field instance_charge_type has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute payment_type instead.

Deprecated:

Field 'instance_charge_type' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'payment_type' instead.

internetChargeType String

The metering method of the EIP. Valid values: PayByDominantTraffic, PayByBandwidth and PayByTraffic. Default to PayByBandwidth. NOTE: It must be set to "PayByBandwidth" when payment_type is "Subscription".

ipAddress String

The address of the EIP.

isp String

The line type. You can set this parameter only when you create a PayAsYouGo EIP. Valid values: BGP: BGP (Multi-ISP) lines.Up to 89 high-quality BGP lines are available worldwide. Direct connections with multiple Internet Service Providers (ISPs), including Telecom, Unicom, Mobile, Railcom, Netcom, CERNET, China Broadcast Network, Dr. Peng, and Founder, can be established in all regions in mainland China. BGP_PRO: BGP (Multi-ISP) Pro lines optimize data transmission to mainland China and improve connection quality for international services. Compared with BGP (Multi-ISP), when BGP (Multi-ISP) Pro provides services to clients in mainland China (excluding data centers), cross-border connections are established without using international ISP services. This reduces network latency.

name String

Field name has been deprecated from provider version 1.126.0, and it will be removed in the future version. Please use the new attribute address_name instead.

Deprecated:

Field 'name' has been deprecated from provider version 1.126.0 and it will be remove in the future version. Please use the new attribute 'address_name' instead.

netmode String

The type of the network. Valid value is public (Internet).

paymentType String

The billing method of the EIP. Valid values: Subscription and PayAsYouGo. Default value is PayAsYouGo.

period Number

The duration that you will buy the resource, in month. It is valid when payment_type is Subscription. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify "period" and you can do that via web console.

resourceGroupId String

The ID of the resource group.

status String

The status of the EIP. Valid values: Associating: The EIP is being associated. Unassociating: The EIP is being disassociated. InUse: The EIP is allocated. Available:The EIP is available.

tags Map<Any>

A mapping of tags to assign to the resource.

Import

EIP Address can be imported using the id, e.g.

 $ pulumi import alicloud:ecs/eipAddress:EipAddress example <id>

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.