Exoscale v0.46.0, Feb 27 23

exoscale.ElasticIP

Corresponding data source: exoscale_elastic_ip.

Create ElasticIP Resource

new ElasticIP(name: string, args: ElasticIPArgs, opts?: CustomResourceOptions);

@overload
def ElasticIP(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              address_family: Optional[str] = None,
              description: Optional[str] = None,
              healthcheck: Optional[ElasticIPHealthcheckArgs] = None,
              labels: Optional[Mapping[str, str]] = None,
              reverse_dns: Optional[str] = None,
              zone: Optional[str] = None)
@overload
def ElasticIP(resource_name: str,
              args: ElasticIPArgs,
              opts: Optional[ResourceOptions] = None)

func NewElasticIP(ctx *Context, name string, args ElasticIPArgs, opts ...ResourceOption) (*ElasticIP, error)

public ElasticIP(string name, ElasticIPArgs args, CustomResourceOptions? opts = null)

public ElasticIP(String name, ElasticIPArgs args)
public ElasticIP(String name, ElasticIPArgs args, CustomResourceOptions options)

type: exoscale:ElasticIP
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

name string: The unique name of the resource.
args ElasticIPArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ElasticIPArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

Zone string: The Exoscale [Zone][zone] name.
AddressFamily string: The Elastic IP (EIP) address family (inet4 or inet6; default: inet4).
Description string: A free-form text describing the Elastic IP (EIP).
Healthcheck Pulumiverse.Exoscale.Inputs.ElasticIPHealthcheckArgs: Healthcheck configuration for managed EIPs. It can not be added to an existing Unmanaged EIP. Structure is documented below:
Labels Dictionary<string, string>: A map of key/value labels.
ReverseDns string: Domain name for reverse DNS record.

Zone string: The Exoscale [Zone][zone] name.
AddressFamily string: The Elastic IP (EIP) address family (inet4 or inet6; default: inet4).
Description string: A free-form text describing the Elastic IP (EIP).
Healthcheck ElasticIPHealthcheckArgs: Healthcheck configuration for managed EIPs. It can not be added to an existing Unmanaged EIP. Structure is documented below:
Labels map[string]string: A map of key/value labels.
ReverseDns string: Domain name for reverse DNS record.

zone String: The Exoscale [Zone][zone] name.
addressFamily String: The Elastic IP (EIP) address family (inet4 or inet6; default: inet4).
description String: A free-form text describing the Elastic IP (EIP).
healthcheck ElasticIPHealthcheckArgs: Healthcheck configuration for managed EIPs. It can not be added to an existing Unmanaged EIP. Structure is documented below:
labels Map<String,String>: A map of key/value labels.
reverseDns String: Domain name for reverse DNS record.

zone string: The Exoscale [Zone][zone] name.
addressFamily string: The Elastic IP (EIP) address family (inet4 or inet6; default: inet4).
description string: A free-form text describing the Elastic IP (EIP).
healthcheck ElasticIPHealthcheckArgs: Healthcheck configuration for managed EIPs. It can not be added to an existing Unmanaged EIP. Structure is documented below:
labels {[key: string]: string}: A map of key/value labels.
reverseDns string: Domain name for reverse DNS record.

zone str: The Exoscale [Zone][zone] name.
address_family str: The Elastic IP (EIP) address family (inet4 or inet6; default: inet4).
description str: A free-form text describing the Elastic IP (EIP).
healthcheck ElasticIPHealthcheckArgs: Healthcheck configuration for managed EIPs. It can not be added to an existing Unmanaged EIP. Structure is documented below:
labels Mapping[str, str]: A map of key/value labels.
reverse_dns str: Domain name for reverse DNS record.

zone String: The Exoscale [Zone][zone] name.
addressFamily String: The Elastic IP (EIP) address family (inet4 or inet6; default: inet4).
description String: A free-form text describing the Elastic IP (EIP).
healthcheck Property Map: Healthcheck configuration for managed EIPs. It can not be added to an existing Unmanaged EIP. Structure is documented below:
labels Map<String>: A map of key/value labels.
reverseDns String: Domain name for reverse DNS record.

Outputs

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

Cidr string: The Elastic IP (EIP) CIDR.
Id string: The provider-assigned unique ID for this managed resource.
IpAddress string: The Elastic IP (EIP) IPv4 or IPv6 address.

Cidr string: The Elastic IP (EIP) CIDR.
Id string: The provider-assigned unique ID for this managed resource.
IpAddress string: The Elastic IP (EIP) IPv4 or IPv6 address.

cidr String: The Elastic IP (EIP) CIDR.
id String: The provider-assigned unique ID for this managed resource.
ipAddress String: The Elastic IP (EIP) IPv4 or IPv6 address.

cidr string: The Elastic IP (EIP) CIDR.
id string: The provider-assigned unique ID for this managed resource.
ipAddress string: The Elastic IP (EIP) IPv4 or IPv6 address.

cidr str: The Elastic IP (EIP) CIDR.
id str: The provider-assigned unique ID for this managed resource.
ip_address str: The Elastic IP (EIP) IPv4 or IPv6 address.

cidr String: The Elastic IP (EIP) CIDR.
id String: The provider-assigned unique ID for this managed resource.
ipAddress String: The Elastic IP (EIP) IPv4 or IPv6 address.

Look up Existing ElasticIP Resource

Get an existing ElasticIP 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?: ElasticIPState, opts?: CustomResourceOptions): ElasticIP

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address_family: Optional[str] = None,
        cidr: Optional[str] = None,
        description: Optional[str] = None,
        healthcheck: Optional[ElasticIPHealthcheckArgs] = None,
        ip_address: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        reverse_dns: Optional[str] = None,
        zone: Optional[str] = None) -> ElasticIP

func GetElasticIP(ctx *Context, name string, id IDInput, state *ElasticIPState, opts ...ResourceOption) (*ElasticIP, error)

public static ElasticIP Get(string name, Input<string> id, ElasticIPState? state, CustomResourceOptions? opts = null)

public static ElasticIP get(String name, Output<String> id, ElasticIPState 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:

AddressFamily string: The Elastic IP (EIP) address family (inet4 or inet6; default: inet4).
Cidr string: The Elastic IP (EIP) CIDR.
Description string: A free-form text describing the Elastic IP (EIP).
Healthcheck Pulumiverse.Exoscale.Inputs.ElasticIPHealthcheckArgs: Healthcheck configuration for managed EIPs. It can not be added to an existing Unmanaged EIP. Structure is documented below:
IpAddress string: The Elastic IP (EIP) IPv4 or IPv6 address.
Labels Dictionary<string, string>: A map of key/value labels.
ReverseDns string: Domain name for reverse DNS record.
Zone string: The Exoscale [Zone][zone] name.

AddressFamily string: The Elastic IP (EIP) address family (inet4 or inet6; default: inet4).
Cidr string: The Elastic IP (EIP) CIDR.
Description string: A free-form text describing the Elastic IP (EIP).
Healthcheck ElasticIPHealthcheckArgs: Healthcheck configuration for managed EIPs. It can not be added to an existing Unmanaged EIP. Structure is documented below:
IpAddress string: The Elastic IP (EIP) IPv4 or IPv6 address.
Labels map[string]string: A map of key/value labels.
ReverseDns string: Domain name for reverse DNS record.
Zone string: The Exoscale [Zone][zone] name.

addressFamily String: The Elastic IP (EIP) address family (inet4 or inet6; default: inet4).
cidr String: The Elastic IP (EIP) CIDR.
description String: A free-form text describing the Elastic IP (EIP).
healthcheck ElasticIPHealthcheckArgs: Healthcheck configuration for managed EIPs. It can not be added to an existing Unmanaged EIP. Structure is documented below:
ipAddress String: The Elastic IP (EIP) IPv4 or IPv6 address.
labels Map<String,String>: A map of key/value labels.
reverseDns String: Domain name for reverse DNS record.
zone String: The Exoscale [Zone][zone] name.

addressFamily string: The Elastic IP (EIP) address family (inet4 or inet6; default: inet4).
cidr string: The Elastic IP (EIP) CIDR.
description string: A free-form text describing the Elastic IP (EIP).
healthcheck ElasticIPHealthcheckArgs: Healthcheck configuration for managed EIPs. It can not be added to an existing Unmanaged EIP. Structure is documented below:
ipAddress string: The Elastic IP (EIP) IPv4 or IPv6 address.
labels {[key: string]: string}: A map of key/value labels.
reverseDns string: Domain name for reverse DNS record.
zone string: The Exoscale [Zone][zone] name.

address_family str: The Elastic IP (EIP) address family (inet4 or inet6; default: inet4).
cidr str: The Elastic IP (EIP) CIDR.
description str: A free-form text describing the Elastic IP (EIP).
healthcheck ElasticIPHealthcheckArgs: Healthcheck configuration for managed EIPs. It can not be added to an existing Unmanaged EIP. Structure is documented below:
ip_address str: The Elastic IP (EIP) IPv4 or IPv6 address.
labels Mapping[str, str]: A map of key/value labels.
reverse_dns str: Domain name for reverse DNS record.
zone str: The Exoscale [Zone][zone] name.

addressFamily String: The Elastic IP (EIP) address family (inet4 or inet6; default: inet4).
cidr String: The Elastic IP (EIP) CIDR.
description String: A free-form text describing the Elastic IP (EIP).
healthcheck Property Map: Healthcheck configuration for managed EIPs. It can not be added to an existing Unmanaged EIP. Structure is documented below:
ipAddress String: The Elastic IP (EIP) IPv4 or IPv6 address.
labels Map<String>: A map of key/value labels.
reverseDns String: Domain name for reverse DNS record.
zone String: The Exoscale [Zone][zone] name.

Supporting Types

ElasticIPHealthcheck

Mode string: The healthcheck mode (tcp, http or https; may only be set at creation time).
Port int: The healthcheck target port (must be between 1 and 65535).
Interval int: The healthcheck interval (seconds; must be between 5 and 300; default: 10).
StrikesFail int: The number of failed healthcheck attempts before considering the target unhealthy (must be between 1 and 20; default: 2).
StrikesOk int: The number of successful healthcheck attempts before considering the target healthy (must be between 1 and 20; default: 3).
Timeout int: The time before considering a healthcheck probing failed (seconds; must be between 2 and 60; default: 3).
TlsSkipVerify bool: Disable TLS certificate verification for healthcheck in https mode (boolean; default: false).
TlsSni string: The healthcheck server name to present with SNI in https mode.
Uri string: The healthcheck target URI (required in http(s) modes).

Mode string: The healthcheck mode (tcp, http or https; may only be set at creation time).
Port int: The healthcheck target port (must be between 1 and 65535).
Interval int: The healthcheck interval (seconds; must be between 5 and 300; default: 10).
StrikesFail int: The number of failed healthcheck attempts before considering the target unhealthy (must be between 1 and 20; default: 2).
StrikesOk int: The number of successful healthcheck attempts before considering the target healthy (must be between 1 and 20; default: 3).
Timeout int: The time before considering a healthcheck probing failed (seconds; must be between 2 and 60; default: 3).
TlsSkipVerify bool: Disable TLS certificate verification for healthcheck in https mode (boolean; default: false).
TlsSni string: The healthcheck server name to present with SNI in https mode.
Uri string: The healthcheck target URI (required in http(s) modes).

mode String: The healthcheck mode (tcp, http or https; may only be set at creation time).
port Integer: The healthcheck target port (must be between 1 and 65535).
interval Integer: The healthcheck interval (seconds; must be between 5 and 300; default: 10).
strikesFail Integer: The number of failed healthcheck attempts before considering the target unhealthy (must be between 1 and 20; default: 2).
strikesOk Integer: The number of successful healthcheck attempts before considering the target healthy (must be between 1 and 20; default: 3).
timeout Integer: The time before considering a healthcheck probing failed (seconds; must be between 2 and 60; default: 3).
tlsSkipVerify Boolean: Disable TLS certificate verification for healthcheck in https mode (boolean; default: false).
tlsSni String: The healthcheck server name to present with SNI in https mode.
uri String: The healthcheck target URI (required in http(s) modes).

mode string: The healthcheck mode (tcp, http or https; may only be set at creation time).
port number: The healthcheck target port (must be between 1 and 65535).
interval number: The healthcheck interval (seconds; must be between 5 and 300; default: 10).
strikesFail number: The number of failed healthcheck attempts before considering the target unhealthy (must be between 1 and 20; default: 2).
strikesOk number: The number of successful healthcheck attempts before considering the target healthy (must be between 1 and 20; default: 3).
timeout number: The time before considering a healthcheck probing failed (seconds; must be between 2 and 60; default: 3).
tlsSkipVerify boolean: Disable TLS certificate verification for healthcheck in https mode (boolean; default: false).
tlsSni string: The healthcheck server name to present with SNI in https mode.
uri string: The healthcheck target URI (required in http(s) modes).

mode str: The healthcheck mode (tcp, http or https; may only be set at creation time).
port int: The healthcheck target port (must be between 1 and 65535).
interval int: The healthcheck interval (seconds; must be between 5 and 300; default: 10).
strikes_fail int: The number of failed healthcheck attempts before considering the target unhealthy (must be between 1 and 20; default: 2).
strikes_ok int: The number of successful healthcheck attempts before considering the target healthy (must be between 1 and 20; default: 3).
timeout int: The time before considering a healthcheck probing failed (seconds; must be between 2 and 60; default: 3).
tls_skip_verify bool: Disable TLS certificate verification for healthcheck in https mode (boolean; default: false).
tls_sni str: The healthcheck server name to present with SNI in https mode.
uri str: The healthcheck target URI (required in http(s) modes).

mode String: The healthcheck mode (tcp, http or https; may only be set at creation time).
port Number: The healthcheck target port (must be between 1 and 65535).
interval Number: The healthcheck interval (seconds; must be between 5 and 300; default: 10).
strikesFail Number: The number of failed healthcheck attempts before considering the target unhealthy (must be between 1 and 20; default: 2).
strikesOk Number: The number of successful healthcheck attempts before considering the target healthy (must be between 1 and 20; default: 3).
timeout Number: The time before considering a healthcheck probing failed (seconds; must be between 2 and 60; default: 3).
tlsSkipVerify Boolean: Disable TLS certificate verification for healthcheck in https mode (boolean; default: false).
tlsSni String: The healthcheck server name to present with SNI in https mode.
uri String: The healthcheck target URI (required in http(s) modes).

Import

An existing Elastic IP (EIP) may be imported by <ID>@<zone>console

 $ pulumi import exoscale:index/elasticIP:ElasticIP \

exoscale_elastic_ip.my_elastic_ip \

f81d4fae-7dec-11d0-a765-00a0c91e6bf6@ch-gva-2

Package Details

Repository: exoscale pulumiverse/pulumi-exoscale
License: Apache-2.0
Notes: This Pulumi package is based on the exoscale Terraform Provider.