Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ucloud Provider
  3. API Docs
  4. getEips
ucloud 1.39.1 published on Monday, Apr 14, 2025 by ucloud
ucloud/terraform-provider-ucloud

ucloud.getEips

Explore with Pulumi AI

ucloud logo
ucloud 1.39.1 published on Monday, Apr 14, 2025 by ucloud
ucloud/terraform-provider-ucloud

    This data source provides a list of EIP resources (Elastic IP address) according to their EIP ID.

    Using getEips

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEips(args: GetEipsArgs, opts?: InvokeOptions): Promise<GetEipsResult>
function getEipsOutput(args: GetEipsOutputArgs, opts?: InvokeOptions): Output<GetEipsResult>
    def get_eips(id: Optional[str] = None,
             ids: Optional[Sequence[str]] = None,
             name_regex: Optional[str] = None,
             output_file: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetEipsResult
def get_eips_output(id: Optional[pulumi.Input[str]] = None,
             ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
             name_regex: Optional[pulumi.Input[str]] = None,
             output_file: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetEipsResult]
    func GetEips(ctx *Context, args *GetEipsArgs, opts ...InvokeOption) (*GetEipsResult, error)
func GetEipsOutput(ctx *Context, args *GetEipsOutputArgs, opts ...InvokeOption) GetEipsResultOutput

    > Note: This function is named GetEips in the Go SDK.

    public static class GetEips 
{
    public static Task<GetEipsResult> InvokeAsync(GetEipsArgs args, InvokeOptions? opts = null)
    public static Output<GetEipsResult> Invoke(GetEipsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEipsResult> getEips(GetEipsArgs args, InvokeOptions options)
public static Output<GetEipsResult> getEips(GetEipsArgs args, InvokeOptions options)

    fn::invoke:
  function: ucloud:index/getEips:getEips
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Ids List<string>
    A list of Elastic IP IDs, all the EIPs belong to this region will be retrieved if the ID is [].
    NameRegex string
    A regex string to filter resulting eips by name.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    Id string
    Ids []string
    A list of Elastic IP IDs, all the EIPs belong to this region will be retrieved if the ID is [].
    NameRegex string
    A regex string to filter resulting eips by name.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    id String
    ids List<String>
    A list of Elastic IP IDs, all the EIPs belong to this region will be retrieved if the ID is [].
    nameRegex String
    A regex string to filter resulting eips by name.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    id string
    ids string[]
    A list of Elastic IP IDs, all the EIPs belong to this region will be retrieved if the ID is [].
    nameRegex string
    A regex string to filter resulting eips by name.
    outputFile string
    File name where to save data source results (after running pulumi preview).
    id str
    ids Sequence[str]
    A list of Elastic IP IDs, all the EIPs belong to this region will be retrieved if the ID is [].
    name_regex str
    A regex string to filter resulting eips by name.
    output_file str
    File name where to save data source results (after running pulumi preview).
    id String
    ids List<String>
    A list of Elastic IP IDs, all the EIPs belong to this region will be retrieved if the ID is [].
    nameRegex String
    A regex string to filter resulting eips by name.
    outputFile String
    File name where to save data source results (after running pulumi preview).

    getEips Result

    The following output properties are available:

    Eips List<GetEipsEip>
    It is a nested type which documented below.
    Id string
    Ids List<string>
    TotalCount double
    Total number of Elastic IPs that satisfy the condition.
    NameRegex string
    OutputFile string
    Eips []GetEipsEip
    It is a nested type which documented below.
    Id string
    Ids []string
    TotalCount float64
    Total number of Elastic IPs that satisfy the condition.
    NameRegex string
    OutputFile string
    eips List<GetEipsEip>
    It is a nested type which documented below.
    id String
    ids List<String>
    totalCount Double
    Total number of Elastic IPs that satisfy the condition.
    nameRegex String
    outputFile String
    eips GetEipsEip[]
    It is a nested type which documented below.
    id string
    ids string[]
    totalCount number
    Total number of Elastic IPs that satisfy the condition.
    nameRegex string
    outputFile string
    eips Sequence[GetEipsEip]
    It is a nested type which documented below.
    id str
    ids Sequence[str]
    total_count float
    Total number of Elastic IPs that satisfy the condition.
    name_regex str
    output_file str
    eips List<Property Map>
    It is a nested type which documented below.
    id String
    ids List<String>
    totalCount Number
    Total number of Elastic IPs that satisfy the condition.
    nameRegex String
    outputFile String

    Supporting Types

    GetEipsEip

    Bandwidth double
    Maximum bandwidth to the elastic public network, measured in Mbps.
    ChargeMode string
    The charge mode of Elastic IP. Possible values are: traffic as pay by traffic, bandwidth as pay by bandwidth.
    ChargeType string
    The charge type of Elastic IP. Possible values are: year as pay by year, month as pay by month, dynamic as pay by hour.
    CreateTime string
    The creation time of Elastic IP, formatted in RFC3339 time string.
    ExpireTime string
    The expiration time for Elastic IP, formatted in RFC3339 time string.
    IpSets List<GetEipsEipIpSet>
    It is a nested type which documented below.
    Name string
    The name of Elastic IP.
    Remark string
    The remarks of Elastic IP.
    Status string
    Elastic IP status. Possible values are: used as in use, free as available and freeze as associating.
    Tag string
    A tag assigned to Elastic IP.
    Bandwidth float64
    Maximum bandwidth to the elastic public network, measured in Mbps.
    ChargeMode string
    The charge mode of Elastic IP. Possible values are: traffic as pay by traffic, bandwidth as pay by bandwidth.
    ChargeType string
    The charge type of Elastic IP. Possible values are: year as pay by year, month as pay by month, dynamic as pay by hour.
    CreateTime string
    The creation time of Elastic IP, formatted in RFC3339 time string.
    ExpireTime string
    The expiration time for Elastic IP, formatted in RFC3339 time string.
    IpSets []GetEipsEipIpSet
    It is a nested type which documented below.
    Name string
    The name of Elastic IP.
    Remark string
    The remarks of Elastic IP.
    Status string
    Elastic IP status. Possible values are: used as in use, free as available and freeze as associating.
    Tag string
    A tag assigned to Elastic IP.
    bandwidth Double
    Maximum bandwidth to the elastic public network, measured in Mbps.
    chargeMode String
    The charge mode of Elastic IP. Possible values are: traffic as pay by traffic, bandwidth as pay by bandwidth.
    chargeType String
    The charge type of Elastic IP. Possible values are: year as pay by year, month as pay by month, dynamic as pay by hour.
    createTime String
    The creation time of Elastic IP, formatted in RFC3339 time string.
    expireTime String
    The expiration time for Elastic IP, formatted in RFC3339 time string.
    ipSets List<GetEipsEipIpSet>
    It is a nested type which documented below.
    name String
    The name of Elastic IP.
    remark String
    The remarks of Elastic IP.
    status String
    Elastic IP status. Possible values are: used as in use, free as available and freeze as associating.
    tag String
    A tag assigned to Elastic IP.
    bandwidth number
    Maximum bandwidth to the elastic public network, measured in Mbps.
    chargeMode string
    The charge mode of Elastic IP. Possible values are: traffic as pay by traffic, bandwidth as pay by bandwidth.
    chargeType string
    The charge type of Elastic IP. Possible values are: year as pay by year, month as pay by month, dynamic as pay by hour.
    createTime string
    The creation time of Elastic IP, formatted in RFC3339 time string.
    expireTime string
    The expiration time for Elastic IP, formatted in RFC3339 time string.
    ipSets GetEipsEipIpSet[]
    It is a nested type which documented below.
    name string
    The name of Elastic IP.
    remark string
    The remarks of Elastic IP.
    status string
    Elastic IP status. Possible values are: used as in use, free as available and freeze as associating.
    tag string
    A tag assigned to Elastic IP.
    bandwidth float
    Maximum bandwidth to the elastic public network, measured in Mbps.
    charge_mode str
    The charge mode of Elastic IP. Possible values are: traffic as pay by traffic, bandwidth as pay by bandwidth.
    charge_type str
    The charge type of Elastic IP. Possible values are: year as pay by year, month as pay by month, dynamic as pay by hour.
    create_time str
    The creation time of Elastic IP, formatted in RFC3339 time string.
    expire_time str
    The expiration time for Elastic IP, formatted in RFC3339 time string.
    ip_sets Sequence[GetEipsEipIpSet]
    It is a nested type which documented below.
    name str
    The name of Elastic IP.
    remark str
    The remarks of Elastic IP.
    status str
    Elastic IP status. Possible values are: used as in use, free as available and freeze as associating.
    tag str
    A tag assigned to Elastic IP.
    bandwidth Number
    Maximum bandwidth to the elastic public network, measured in Mbps.
    chargeMode String
    The charge mode of Elastic IP. Possible values are: traffic as pay by traffic, bandwidth as pay by bandwidth.
    chargeType String
    The charge type of Elastic IP. Possible values are: year as pay by year, month as pay by month, dynamic as pay by hour.
    createTime String
    The creation time of Elastic IP, formatted in RFC3339 time string.
    expireTime String
    The expiration time for Elastic IP, formatted in RFC3339 time string.
    ipSets List<Property Map>
    It is a nested type which documented below.
    name String
    The name of Elastic IP.
    remark String
    The remarks of Elastic IP.
    status String
    Elastic IP status. Possible values are: used as in use, free as available and freeze as associating.
    tag String
    A tag assigned to Elastic IP.

    GetEipsEipIpSet

    InternetType string
    Type of Elastic IP routes.
    Ip string
    Elastic IP address.
    InternetType string
    Type of Elastic IP routes.
    Ip string
    Elastic IP address.
    internetType String
    Type of Elastic IP routes.
    ip String
    Elastic IP address.
    internetType string
    Type of Elastic IP routes.
    ip string
    Elastic IP address.
    internet_type str
    Type of Elastic IP routes.
    ip str
    Elastic IP address.
    internetType String
    Type of Elastic IP routes.
    ip String
    Elastic IP address.

    Package Details

    Repository
    ucloud ucloud/terraform-provider-ucloud
    License
    Notes
    This Pulumi package is based on the ucloud Terraform Provider.
    ucloud logo
    ucloud 1.39.1 published on Monday, Apr 14, 2025 by ucloud
    ucloud/terraform-provider-ucloud