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

aiven.getFlink

Explore with Pulumi AI

Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi

Gets information about an Aiven for Apache Flink® service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const exampleFlink = aiven.getFlink({
    project: exampleProject.project,
    serviceName: "example-flink-service",
});
Copy
import pulumi
import pulumi_aiven as aiven

example_flink = aiven.get_flink(project=example_project["project"],
    service_name="example-flink-service")
Copy
package main

import (
	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.LookupFlink(ctx, &aiven.LookupFlinkArgs{
			Project:     exampleProject.Project,
			ServiceName: "example-flink-service",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var exampleFlink = Aiven.GetFlink.Invoke(new()
    {
        Project = exampleProject.Project,
        ServiceName = "example-flink-service",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.AivenFunctions;
import com.pulumi.aiven.inputs.GetFlinkArgs;
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) {
        final var exampleFlink = AivenFunctions.getFlink(GetFlinkArgs.builder()
            .project(exampleProject.project())
            .serviceName("example-flink-service")
            .build());

    }
}
Copy
variables:
  exampleFlink:
    fn::invoke:
      function: aiven:getFlink
      arguments:
        project: ${exampleProject.project}
        serviceName: example-flink-service
Copy

Using getFlink

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 getFlink(args: GetFlinkArgs, opts?: InvokeOptions): Promise<GetFlinkResult>
function getFlinkOutput(args: GetFlinkOutputArgs, opts?: InvokeOptions): Output<GetFlinkResult>
Copy
def get_flink(project: Optional[str] = None,
              service_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetFlinkResult
def get_flink_output(project: Optional[pulumi.Input[str]] = None,
              service_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetFlinkResult]
Copy
func LookupFlink(ctx *Context, args *LookupFlinkArgs, opts ...InvokeOption) (*LookupFlinkResult, error)
func LookupFlinkOutput(ctx *Context, args *LookupFlinkOutputArgs, opts ...InvokeOption) LookupFlinkResultOutput
Copy

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

public static class GetFlink 
{
    public static Task<GetFlinkResult> InvokeAsync(GetFlinkArgs args, InvokeOptions? opts = null)
    public static Output<GetFlinkResult> Invoke(GetFlinkInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFlinkResult> getFlink(GetFlinkArgs args, InvokeOptions options)
public static Output<GetFlinkResult> getFlink(GetFlinkArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aiven:index/getFlink:getFlink
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Project This property is required. 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 This property is required. string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
Project This property is required. 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 This property is required. string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
project This property is required. 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 This property is required. String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
project This property is required. 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 This property is required. string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
project This property is required. 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 This property is required. str
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
project This property is required. 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 This property is required. String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

getFlink Result

The following output properties are available:

AdditionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
Components List<GetFlinkComponent>
Service component information objects
DiskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using
FlinkUserConfigs List<GetFlinkFlinkUserConfig>
Flink user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
Flinks List<GetFlinkFlink>
Values provided by the Flink server.
Id string
The provider-assigned unique ID for this managed resource.
MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
Plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
Project 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.
ProjectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceHost string
The hostname of the service.
ServiceIntegrations List<GetFlinkServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
StaticIps List<string>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
Tags List<GetFlinkTag>
Tags are key-value pairs that allow you to categorize services.
TechEmails List<GetFlinkTechEmail>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
AdditionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
Components []GetFlinkComponent
Service component information objects
DiskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using
FlinkUserConfigs []GetFlinkFlinkUserConfig
Flink user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
Flinks []GetFlinkFlink
Values provided by the Flink server.
Id string
The provider-assigned unique ID for this managed resource.
MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
Plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
Project 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.
ProjectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceHost string
The hostname of the service.
ServiceIntegrations []GetFlinkServiceIntegration
Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
StaticIps []string
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
Tags []GetFlinkTag
Tags are key-value pairs that allow you to categorize services.
TechEmails []GetFlinkTechEmail
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
additionalDiskSpace String
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components List<GetFlinkComponent>
Service component information objects
diskSpace String
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using
flinkUserConfigs List<GetFlinkFlinkUserConfig>
Flink user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
flinks List<GetFlinkFlink>
Values provided by the Flink server.
id String
The provider-assigned unique ID for this managed resource.
maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
plan String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project 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.
projectVpcId String
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceHost String
The hostname of the service.
serviceIntegrations List<GetFlinkServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Integer
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String
staticIps List<String>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags List<GetFlinkTag>
Tags are key-value pairs that allow you to categorize services.
techEmails List<GetFlinkTechEmail>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
additionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components GetFlinkComponent[]
Service component information objects
diskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
diskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed string
Disk space that service is currently using
flinkUserConfigs GetFlinkFlinkUserConfig[]
Flink user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
flinks GetFlinkFlink[]
Values provided by the Flink server.
id string
The provider-assigned unique ID for this managed resource.
maintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project 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.
projectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceHost string
The hostname of the service.
serviceIntegrations GetFlinkServiceIntegration[]
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
servicePassword string
Password used for connecting to the service, if applicable
servicePort number
The port of the service
serviceType string
Aiven internal service type code
serviceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername string
Username used for connecting to the service, if applicable
state string
staticIps string[]
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags GetFlinkTag[]
Tags are key-value pairs that allow you to categorize services.
techEmails GetFlinkTechEmail[]
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
additional_disk_space str
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloud_name str
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components Sequence[GetFlinkComponent]
Service component information objects
disk_space str
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
disk_space_cap str
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
disk_space_default str
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
disk_space_step str
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
disk_space_used str
Disk space that service is currently using
flink_user_configs Sequence[GetFlinkFlinkUserConfig]
Flink user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
flinks Sequence[GetFlinkFlink]
Values provided by the Flink server.
id str
The provider-assigned unique ID for this managed resource.
maintenance_window_dow str
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenance_window_time str
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
plan str
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project 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.
project_vpc_id str
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
service_host str
The hostname of the service.
service_integrations Sequence[GetFlinkServiceIntegration]
Service integrations to specify when creating a service. Not applied after initial service creation
service_name str
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
service_password str
Password used for connecting to the service, if applicable
service_port int
The port of the service
service_type str
Aiven internal service type code
service_uri str
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
service_username str
Username used for connecting to the service, if applicable
state str
static_ips Sequence[str]
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags Sequence[GetFlinkTag]
Tags are key-value pairs that allow you to categorize services.
tech_emails Sequence[GetFlinkTechEmail]
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
termination_protection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
additionalDiskSpace String
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components List<Property Map>
Service component information objects
diskSpace String
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.
diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using
flinkUserConfigs List<Property Map>
Flink user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
flinks List<Property Map>
Values provided by the Flink server.
id String
The provider-assigned unique ID for this managed resource.
maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
plan String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
project 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.
projectVpcId String
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceHost String
The hostname of the service.
serviceIntegrations List<Property Map>
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Number
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String
staticIps List<String>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags List<Property Map>
Tags are key-value pairs that allow you to categorize services.
techEmails List<Property Map>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

Supporting Types

GetFlinkComponent

Component This property is required. string
Service component name
ConnectionUri This property is required. string
Connection info for connecting to the service component. This is a combination of host and port.
Host This property is required. string
Host name for connecting to the service component
KafkaAuthenticationMethod This property is required. string
Kafka authentication method. This is a value specific to the 'kafka' service component
KafkaSslCa This property is required. string
Kafka certificate used. The possible values are letsencrypt and project_ca.
Port This property is required. int
Port number for connecting to the service component
Route This property is required. string
Network access route
Ssl This property is required. bool
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
Usage This property is required. string
DNS usage name
Component This property is required. string
Service component name
ConnectionUri This property is required. string
Connection info for connecting to the service component. This is a combination of host and port.
Host This property is required. string
Host name for connecting to the service component
KafkaAuthenticationMethod This property is required. string
Kafka authentication method. This is a value specific to the 'kafka' service component
KafkaSslCa This property is required. string
Kafka certificate used. The possible values are letsencrypt and project_ca.
Port This property is required. int
Port number for connecting to the service component
Route This property is required. string
Network access route
Ssl This property is required. bool
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
Usage This property is required. string
DNS usage name
component This property is required. String
Service component name
connectionUri This property is required. String
Connection info for connecting to the service component. This is a combination of host and port.
host This property is required. String
Host name for connecting to the service component
kafkaAuthenticationMethod This property is required. String
Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa This property is required. String
Kafka certificate used. The possible values are letsencrypt and project_ca.
port This property is required. Integer
Port number for connecting to the service component
route This property is required. String
Network access route
ssl This property is required. Boolean
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage This property is required. String
DNS usage name
component This property is required. string
Service component name
connectionUri This property is required. string
Connection info for connecting to the service component. This is a combination of host and port.
host This property is required. string
Host name for connecting to the service component
kafkaAuthenticationMethod This property is required. string
Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa This property is required. string
Kafka certificate used. The possible values are letsencrypt and project_ca.
port This property is required. number
Port number for connecting to the service component
route This property is required. string
Network access route
ssl This property is required. boolean
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage This property is required. string
DNS usage name
component This property is required. str
Service component name
connection_uri This property is required. str
Connection info for connecting to the service component. This is a combination of host and port.
host This property is required. str
Host name for connecting to the service component
kafka_authentication_method This property is required. str
Kafka authentication method. This is a value specific to the 'kafka' service component
kafka_ssl_ca This property is required. str
Kafka certificate used. The possible values are letsencrypt and project_ca.
port This property is required. int
Port number for connecting to the service component
route This property is required. str
Network access route
ssl This property is required. bool
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage This property is required. str
DNS usage name
component This property is required. String
Service component name
connectionUri This property is required. String
Connection info for connecting to the service component. This is a combination of host and port.
host This property is required. String
Host name for connecting to the service component
kafkaAuthenticationMethod This property is required. String
Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa This property is required. String
Kafka certificate used. The possible values are letsencrypt and project_ca.
port This property is required. Number
Port number for connecting to the service component
route This property is required. String
Network access route
ssl This property is required. Boolean
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage This property is required. String
DNS usage name
HostPorts This property is required. List<string>
The host and port of a Flink server.
HostPorts This property is required. []string
The host and port of a Flink server.
hostPorts This property is required. List<String>
The host and port of a Flink server.
hostPorts This property is required. string[]
The host and port of a Flink server.
host_ports This property is required. Sequence[str]
The host and port of a Flink server.
hostPorts This property is required. List<String>
The host and port of a Flink server.

GetFlinkFlinkUserConfig

AdditionalBackupRegions string
Additional Cloud Regions for Backup Replication.

Deprecated: This property is deprecated.

CustomCode bool
Enable to upload Custom JARs for Flink applications.
FlinkVersion string
Enum: 1.16, 1.19, 1.20, and newer. Flink major version.
IpFilterObjects List<GetFlinkFlinkUserConfigIpFilterObject>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
IpFilterStrings List<string>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
IpFilters List<string>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

NumberOfTaskSlots int
Task slots per node. For a 3 node plan, total number of task slots is 3x this value. Example: 1.
PekkoAskTimeoutS int
Timeout in seconds used for all futures and blocking Pekko requests. Example: 10.
PekkoFramesizeB int
Maximum size in bytes for messages exchanged between the JobManager and the TaskManagers. Example: 10485760.
PrivatelinkAccess GetFlinkFlinkUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
PublicAccess GetFlinkFlinkUserConfigPublicAccess
Allow access to selected service ports from the public Internet
ServiceLog bool
Store logs for the service so that they are available in the HTTP API and console.
StaticIps bool
Use static public IP addresses.
AdditionalBackupRegions string
Additional Cloud Regions for Backup Replication.

Deprecated: This property is deprecated.

CustomCode bool
Enable to upload Custom JARs for Flink applications.
FlinkVersion string
Enum: 1.16, 1.19, 1.20, and newer. Flink major version.
IpFilterObjects []GetFlinkFlinkUserConfigIpFilterObject
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
IpFilterStrings []string
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
IpFilters []string
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

NumberOfTaskSlots int
Task slots per node. For a 3 node plan, total number of task slots is 3x this value. Example: 1.
PekkoAskTimeoutS int
Timeout in seconds used for all futures and blocking Pekko requests. Example: 10.
PekkoFramesizeB int
Maximum size in bytes for messages exchanged between the JobManager and the TaskManagers. Example: 10485760.
PrivatelinkAccess GetFlinkFlinkUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
PublicAccess GetFlinkFlinkUserConfigPublicAccess
Allow access to selected service ports from the public Internet
ServiceLog bool
Store logs for the service so that they are available in the HTTP API and console.
StaticIps bool
Use static public IP addresses.
additionalBackupRegions String
Additional Cloud Regions for Backup Replication.

Deprecated: This property is deprecated.

customCode Boolean
Enable to upload Custom JARs for Flink applications.
flinkVersion String
Enum: 1.16, 1.19, 1.20, and newer. Flink major version.
ipFilterObjects List<GetFlinkFlinkUserConfigIpFilterObject>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

numberOfTaskSlots Integer
Task slots per node. For a 3 node plan, total number of task slots is 3x this value. Example: 1.
pekkoAskTimeoutS Integer
Timeout in seconds used for all futures and blocking Pekko requests. Example: 10.
pekkoFramesizeB Integer
Maximum size in bytes for messages exchanged between the JobManager and the TaskManagers. Example: 10485760.
privatelinkAccess GetFlinkFlinkUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
publicAccess GetFlinkFlinkUserConfigPublicAccess
Allow access to selected service ports from the public Internet
serviceLog Boolean
Store logs for the service so that they are available in the HTTP API and console.
staticIps Boolean
Use static public IP addresses.
additionalBackupRegions string
Additional Cloud Regions for Backup Replication.

Deprecated: This property is deprecated.

customCode boolean
Enable to upload Custom JARs for Flink applications.
flinkVersion string
Enum: 1.16, 1.19, 1.20, and newer. Flink major version.
ipFilterObjects GetFlinkFlinkUserConfigIpFilterObject[]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings string[]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters string[]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

numberOfTaskSlots number
Task slots per node. For a 3 node plan, total number of task slots is 3x this value. Example: 1.
pekkoAskTimeoutS number
Timeout in seconds used for all futures and blocking Pekko requests. Example: 10.
pekkoFramesizeB number
Maximum size in bytes for messages exchanged between the JobManager and the TaskManagers. Example: 10485760.
privatelinkAccess GetFlinkFlinkUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
publicAccess GetFlinkFlinkUserConfigPublicAccess
Allow access to selected service ports from the public Internet
serviceLog boolean
Store logs for the service so that they are available in the HTTP API and console.
staticIps boolean
Use static public IP addresses.
additional_backup_regions str
Additional Cloud Regions for Backup Replication.

Deprecated: This property is deprecated.

custom_code bool
Enable to upload Custom JARs for Flink applications.
flink_version str
Enum: 1.16, 1.19, 1.20, and newer. Flink major version.
ip_filter_objects Sequence[GetFlinkFlinkUserConfigIpFilterObject]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ip_filter_strings Sequence[str]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ip_filters Sequence[str]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

number_of_task_slots int
Task slots per node. For a 3 node plan, total number of task slots is 3x this value. Example: 1.
pekko_ask_timeout_s int
Timeout in seconds used for all futures and blocking Pekko requests. Example: 10.
pekko_framesize_b int
Maximum size in bytes for messages exchanged between the JobManager and the TaskManagers. Example: 10485760.
privatelink_access GetFlinkFlinkUserConfigPrivatelinkAccess
Allow access to selected service components through Privatelink
public_access GetFlinkFlinkUserConfigPublicAccess
Allow access to selected service ports from the public Internet
service_log bool
Store logs for the service so that they are available in the HTTP API and console.
static_ips bool
Use static public IP addresses.
additionalBackupRegions String
Additional Cloud Regions for Backup Replication.

Deprecated: This property is deprecated.

customCode Boolean
Enable to upload Custom JARs for Flink applications.
flinkVersion String
Enum: 1.16, 1.19, 1.20, and newer. Flink major version.
ipFilterObjects List<Property Map>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

numberOfTaskSlots Number
Task slots per node. For a 3 node plan, total number of task slots is 3x this value. Example: 1.
pekkoAskTimeoutS Number
Timeout in seconds used for all futures and blocking Pekko requests. Example: 10.
pekkoFramesizeB Number
Maximum size in bytes for messages exchanged between the JobManager and the TaskManagers. Example: 10485760.
privatelinkAccess Property Map
Allow access to selected service components through Privatelink
publicAccess Property Map
Allow access to selected service ports from the public Internet
serviceLog Boolean
Store logs for the service so that they are available in the HTTP API and console.
staticIps Boolean
Use static public IP addresses.

GetFlinkFlinkUserConfigIpFilterObject

Network This property is required. string
CIDR address block. Example: 10.20.0.0/16.
Description string
Description for IP filter list entry. Example: Production service IP range.
Network This property is required. string
CIDR address block. Example: 10.20.0.0/16.
Description string
Description for IP filter list entry. Example: Production service IP range.
network This property is required. String
CIDR address block. Example: 10.20.0.0/16.
description String
Description for IP filter list entry. Example: Production service IP range.
network This property is required. string
CIDR address block. Example: 10.20.0.0/16.
description string
Description for IP filter list entry. Example: Production service IP range.
network This property is required. str
CIDR address block. Example: 10.20.0.0/16.
description str
Description for IP filter list entry. Example: Production service IP range.
network This property is required. String
CIDR address block. Example: 10.20.0.0/16.
description String
Description for IP filter list entry. Example: Production service IP range.

GetFlinkFlinkUserConfigPrivatelinkAccess

Flink bool
Enable flink.
Prometheus bool
Enable prometheus.
Flink bool
Enable flink.
Prometheus bool
Enable prometheus.
flink Boolean
Enable flink.
prometheus Boolean
Enable prometheus.
flink boolean
Enable flink.
prometheus boolean
Enable prometheus.
flink bool
Enable flink.
prometheus bool
Enable prometheus.
flink Boolean
Enable flink.
prometheus Boolean
Enable prometheus.

GetFlinkFlinkUserConfigPublicAccess

Flink bool
Allow clients to connect to flink from the public internet for service nodes that are in a project VPC or another type of private network.
Flink bool
Allow clients to connect to flink from the public internet for service nodes that are in a project VPC or another type of private network.
flink Boolean
Allow clients to connect to flink from the public internet for service nodes that are in a project VPC or another type of private network.
flink boolean
Allow clients to connect to flink from the public internet for service nodes that are in a project VPC or another type of private network.
flink bool
Allow clients to connect to flink from the public internet for service nodes that are in a project VPC or another type of private network.
flink Boolean
Allow clients to connect to flink from the public internet for service nodes that are in a project VPC or another type of private network.

GetFlinkServiceIntegration

IntegrationType This property is required. string
Type of the service integration
SourceServiceName This property is required. string
Name of the source service
IntegrationType This property is required. string
Type of the service integration
SourceServiceName This property is required. string
Name of the source service
integrationType This property is required. String
Type of the service integration
sourceServiceName This property is required. String
Name of the source service
integrationType This property is required. string
Type of the service integration
sourceServiceName This property is required. string
Name of the source service
integration_type This property is required. str
Type of the service integration
source_service_name This property is required. str
Name of the source service
integrationType This property is required. String
Type of the service integration
sourceServiceName This property is required. String
Name of the source service

GetFlinkTag

Key This property is required. string
Service tag key
Value This property is required. string
Service tag value
Key This property is required. string
Service tag key
Value This property is required. string
Service tag value
key This property is required. String
Service tag key
value This property is required. String
Service tag value
key This property is required. string
Service tag key
value This property is required. string
Service tag value
key This property is required. str
Service tag key
value This property is required. str
Service tag value
key This property is required. String
Service tag key
value This property is required. String
Service tag value

GetFlinkTechEmail

Email This property is required. string
An email address to contact for technical issues
Email This property is required. string
An email address to contact for technical issues
email This property is required. String
An email address to contact for technical issues
email This property is required. string
An email address to contact for technical issues
email This property is required. str
An email address to contact for technical issues
email This property is required. String
An email address to contact for technical issues

Package Details

Repository
Aiven pulumi/pulumi-aiven
License
Apache-2.0
Notes
This Pulumi package is based on the aiven Terraform Provider.
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi