Aiven v6.37.0, Apr 10 25

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

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

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

import pulumi
import pulumi_aiven as aiven

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

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
	})
}

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",
    });

});

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());

    }
}

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

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.

TypeScript
Python
Go
C#
Java
YAML

function getFlink(args: GetFlinkArgs, opts?: InvokeOptions): Promise<GetFlinkResult>
function getFlinkOutput(args: GetFlinkOutputArgs, opts?: InvokeOptions): Output<GetFlinkResult>

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]

func LookupFlink(ctx *Context, args *LookupFlinkArgs, opts ...InvokeOption) (*LookupFlinkResult, error)
func LookupFlinkOutput(ctx *Context, args *LookupFlinkOutputArgs, opts ...InvokeOption) LookupFlinkResultOutput

> 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)
}

public static CompletableFuture<GetFlinkResult> getFlink(GetFlinkArgs args, InvokeOptions options)
public static Output<GetFlinkResult> getFlink(GetFlinkArgs args, InvokeOptions options)

fn::invoke:
  function: aiven:index/getFlink:getFlink
  arguments:
    # arguments dictionary

The following arguments are supported:

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.
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.

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.
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.

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.
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.

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.
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.

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.
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.

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.
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.

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 string: Service component name
ConnectionUri string: Connection info for connecting to the service component. This is a combination of host and port.
Host string: Host name for connecting to the service component
KafkaAuthenticationMethod string: Kafka authentication method. This is a value specific to the 'kafka' service component
KafkaSslCa string: Kafka certificate used. The possible values are letsencrypt and project_ca.
Port int: Port number for connecting to the service component
Route string: Network access route
Ssl 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 string: DNS usage name

Component string: Service component name
ConnectionUri string: Connection info for connecting to the service component. This is a combination of host and port.
Host string: Host name for connecting to the service component
KafkaAuthenticationMethod string: Kafka authentication method. This is a value specific to the 'kafka' service component
KafkaSslCa string: Kafka certificate used. The possible values are letsencrypt and project_ca.
Port int: Port number for connecting to the service component
Route string: Network access route
Ssl 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 string: DNS usage name

component String: Service component name
connectionUri String: Connection info for connecting to the service component. This is a combination of host and port.
host String: Host name for connecting to the service component
kafkaAuthenticationMethod String: Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa String: Kafka certificate used. The possible values are letsencrypt and project_ca.
port Integer: Port number for connecting to the service component
route String: Network access route
ssl 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 String: DNS usage name

component string: Service component name
connectionUri string: Connection info for connecting to the service component. This is a combination of host and port.
host string: Host name for connecting to the service component
kafkaAuthenticationMethod string: Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa string: Kafka certificate used. The possible values are letsencrypt and project_ca.
port number: Port number for connecting to the service component
route string: Network access route
ssl 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 string: DNS usage name

component str: Service component name
connection_uri str: Connection info for connecting to the service component. This is a combination of host and port.
host str: Host name for connecting to the service component
kafka_authentication_method str: Kafka authentication method. This is a value specific to the 'kafka' service component
kafka_ssl_ca str: Kafka certificate used. The possible values are letsencrypt and project_ca.
port int: Port number for connecting to the service component
route str: Network access route
ssl 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 str: DNS usage name

component String: Service component name
connectionUri String: Connection info for connecting to the service component. This is a combination of host and port.
host String: Host name for connecting to the service component
kafkaAuthenticationMethod String: Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa String: Kafka certificate used. The possible values are letsencrypt and project_ca.
port Number: Port number for connecting to the service component
route String: Network access route
ssl 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 String: DNS usage name

GetFlinkFlink

HostPorts List<string>: The host and port of a Flink server.

HostPorts []string: The host and port of a Flink server.

hostPorts List<String>: The host and port of a Flink server.

hostPorts string[]: The host and port of a Flink server.

host_ports Sequence[str]: The host and port of a Flink server.

hostPorts 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 string: CIDR address block. Example: 10.20.0.0/16.
Description string: Description for IP filter list entry. Example: Production service IP range.

Network string: CIDR address block. Example: 10.20.0.0/16.
Description string: Description for IP filter list entry. Example: Production service IP range.

network String: CIDR address block. Example: 10.20.0.0/16.
description String: Description for IP filter list entry. Example: Production service IP range.

network string: CIDR address block. Example: 10.20.0.0/16.
description string: Description for IP filter list entry. Example: Production service IP range.

network str: CIDR address block. Example: 10.20.0.0/16.
description str: Description for IP filter list entry. Example: Production service IP range.

network 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 string: Type of the service integration
SourceServiceName string: Name of the source service

IntegrationType string: Type of the service integration
SourceServiceName string: Name of the source service

integrationType String: Type of the service integration
sourceServiceName String: Name of the source service

integrationType string: Type of the service integration
sourceServiceName string: Name of the source service

integration_type str: Type of the service integration
source_service_name str: Name of the source service

integrationType String: Type of the service integration
sourceServiceName String: Name of the source service

GetFlinkTag

Key string: Service tag key
Value string: Service tag value

Key string: Service tag key
Value string: Service tag value

key String: Service tag key
value String: Service tag value

key string: Service tag key
value string: Service tag value

key str: Service tag key
value str: Service tag value

key String: Service tag key
value String: Service tag value

GetFlinkTechEmail

Email string: An email address to contact for technical issues

Email string: An email address to contact for technical issues

email String: An email address to contact for technical issues

email string: An email address to contact for technical issues

email str: An email address to contact for technical issues

email 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

pulumi/pulumi-aiven

aiven.getFlink

On this page

On this page

Example Usage

Using getFlink

getFlink Result

Supporting Types

GetFlinkComponent

GetFlinkFlink

GetFlinkFlinkUserConfig

GetFlinkFlinkUserConfigIpFilterObject

GetFlinkFlinkUserConfigPrivatelinkAccess

GetFlinkFlinkUserConfigPublicAccess

GetFlinkServiceIntegration

GetFlinkTag

GetFlinkTechEmail

Package Details

On this page

On this page