1. Packages
  2. Aiven Provider
  3. API Docs
  4. StaticIp
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi

aiven.StaticIp

Explore with Pulumi AI

The aiven.StaticIp resource allows the creation and deletion of static ips. Please note that once a static ip is in the ‘assigned’ state it is bound to the node it is assigned to and cannot be deleted or disassociated until the node is recycled. Plans that would delete static ips that are in the assigned state will be blocked.

Create StaticIp Resource

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

Constructor syntax

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

@overload
def StaticIp(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             cloud_name: Optional[str] = None,
             project: Optional[str] = None)
func NewStaticIp(ctx *Context, name string, args StaticIpArgs, opts ...ResourceOption) (*StaticIp, error)
public StaticIp(string name, StaticIpArgs args, CustomResourceOptions? opts = null)
public StaticIp(String name, StaticIpArgs args)
public StaticIp(String name, StaticIpArgs args, CustomResourceOptions options)
type: aiven:StaticIp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. StaticIpArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. StaticIpArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. StaticIpArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. StaticIpArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. StaticIpArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var staticIpResource = new Aiven.StaticIp("staticIpResource", new()
{
    CloudName = "string",
    Project = "string",
});
Copy
example, err := aiven.NewStaticIp(ctx, "staticIpResource", &aiven.StaticIpArgs{
	CloudName: pulumi.String("string"),
	Project:   pulumi.String("string"),
})
Copy
var staticIpResource = new StaticIp("staticIpResource", StaticIpArgs.builder()
    .cloudName("string")
    .project("string")
    .build());
Copy
static_ip_resource = aiven.StaticIp("staticIpResource",
    cloud_name="string",
    project="string")
Copy
const staticIpResource = new aiven.StaticIp("staticIpResource", {
    cloudName: "string",
    project: "string",
});
Copy
type: aiven:StaticIp
properties:
    cloudName: string
    project: string
Copy

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

CloudName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the cloud that the static ip belongs to. Changing this property forces recreation of the resource.
Project
This property is required.
Changes to this property will trigger replacement.
string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
CloudName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the cloud that the static ip belongs to. Changing this property forces recreation of the resource.
Project
This property is required.
Changes to this property will trigger replacement.
string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
cloudName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the cloud that the static ip belongs to. Changing this property forces recreation of the resource.
project
This property is required.
Changes to this property will trigger replacement.
String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
cloudName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the cloud that the static ip belongs to. Changing this property forces recreation of the resource.
project
This property is required.
Changes to this property will trigger replacement.
string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
cloud_name
This property is required.
Changes to this property will trigger replacement.
str
Specifies the cloud that the static ip belongs to. Changing this property forces recreation of the resource.
project
This property is required.
Changes to this property will trigger replacement.
str
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
cloudName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the cloud that the static ip belongs to. Changing this property forces recreation of the resource.
project
This property is required.
Changes to this property will trigger replacement.
String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
IpAddress string
The address of the static ip.
ServiceName string
The service name the static ip is associated with.
State string
The state the static ip is in.
StaticIpAddressId string
The static ip id of the resource. Should be used as a reference elsewhere.
Id string
The provider-assigned unique ID for this managed resource.
IpAddress string
The address of the static ip.
ServiceName string
The service name the static ip is associated with.
State string
The state the static ip is in.
StaticIpAddressId string
The static ip id of the resource. Should be used as a reference elsewhere.
id String
The provider-assigned unique ID for this managed resource.
ipAddress String
The address of the static ip.
serviceName String
The service name the static ip is associated with.
state String
The state the static ip is in.
staticIpAddressId String
The static ip id of the resource. Should be used as a reference elsewhere.
id string
The provider-assigned unique ID for this managed resource.
ipAddress string
The address of the static ip.
serviceName string
The service name the static ip is associated with.
state string
The state the static ip is in.
staticIpAddressId string
The static ip id of the resource. Should be used as a reference elsewhere.
id str
The provider-assigned unique ID for this managed resource.
ip_address str
The address of the static ip.
service_name str
The service name the static ip is associated with.
state str
The state the static ip is in.
static_ip_address_id str
The static ip id of the resource. Should be used as a reference elsewhere.
id String
The provider-assigned unique ID for this managed resource.
ipAddress String
The address of the static ip.
serviceName String
The service name the static ip is associated with.
state String
The state the static ip is in.
staticIpAddressId String
The static ip id of the resource. Should be used as a reference elsewhere.

Look up Existing StaticIp Resource

Get an existing StaticIp 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?: StaticIpState, opts?: CustomResourceOptions): StaticIp
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cloud_name: Optional[str] = None,
        ip_address: Optional[str] = None,
        project: Optional[str] = None,
        service_name: Optional[str] = None,
        state: Optional[str] = None,
        static_ip_address_id: Optional[str] = None) -> StaticIp
func GetStaticIp(ctx *Context, name string, id IDInput, state *StaticIpState, opts ...ResourceOption) (*StaticIp, error)
public static StaticIp Get(string name, Input<string> id, StaticIpState? state, CustomResourceOptions? opts = null)
public static StaticIp get(String name, Output<String> id, StaticIpState state, CustomResourceOptions options)
resources:  _:    type: aiven:StaticIp    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CloudName Changes to this property will trigger replacement. string
Specifies the cloud that the static ip belongs to. Changing this property forces recreation of the resource.
IpAddress string
The address of the static ip.
Project Changes to this property will trigger replacement. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName string
The service name the static ip is associated with.
State string
The state the static ip is in.
StaticIpAddressId string
The static ip id of the resource. Should be used as a reference elsewhere.
CloudName Changes to this property will trigger replacement. string
Specifies the cloud that the static ip belongs to. Changing this property forces recreation of the resource.
IpAddress string
The address of the static ip.
Project Changes to this property will trigger replacement. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
ServiceName string
The service name the static ip is associated with.
State string
The state the static ip is in.
StaticIpAddressId string
The static ip id of the resource. Should be used as a reference elsewhere.
cloudName Changes to this property will trigger replacement. String
Specifies the cloud that the static ip belongs to. Changing this property forces recreation of the resource.
ipAddress String
The address of the static ip.
project Changes to this property will trigger replacement. String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName String
The service name the static ip is associated with.
state String
The state the static ip is in.
staticIpAddressId String
The static ip id of the resource. Should be used as a reference elsewhere.
cloudName Changes to this property will trigger replacement. string
Specifies the cloud that the static ip belongs to. Changing this property forces recreation of the resource.
ipAddress string
The address of the static ip.
project Changes to this property will trigger replacement. string
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName string
The service name the static ip is associated with.
state string
The state the static ip is in.
staticIpAddressId string
The static ip id of the resource. Should be used as a reference elsewhere.
cloud_name Changes to this property will trigger replacement. str
Specifies the cloud that the static ip belongs to. Changing this property forces recreation of the resource.
ip_address str
The address of the static ip.
project Changes to this property will trigger replacement. str
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
service_name str
The service name the static ip is associated with.
state str
The state the static ip is in.
static_ip_address_id str
The static ip id of the resource. Should be used as a reference elsewhere.
cloudName Changes to this property will trigger replacement. String
Specifies the cloud that the static ip belongs to. Changing this property forces recreation of the resource.
ipAddress String
The address of the static ip.
project Changes to this property will trigger replacement. String
The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
serviceName String
The service name the static ip is associated with.
state String
The state the static ip is in.
staticIpAddressId String
The static ip id of the resource. Should be used as a reference elsewhere.

Package Details

Repository
Aiven pulumi/pulumi-aiven
License
Apache-2.0
Notes
This Pulumi package is based on the aiven Terraform Provider.