1. Packages
  2. Confluent Provider
  3. API Docs
  4. FlinkConnection
Viewing docs for Confluent v2.59.0
published on Friday, Mar 6, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-confluentcloud

confluentcloud.FlinkConnection

confluentcloud logo
Viewing docs for Confluent v2.59.0
published on Friday, Mar 6, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-confluentcloud

    General Availability

    confluentcloud.FlinkConnection provides a Flink Connection resource that enables creating, editing, and deleting Flink Connection on Confluent Cloud.

    Note: It is recommended to set lifecycle {<span pulumi-lang-nodejs=" preventDestroy " pulumi-lang-dotnet=" PreventDestroy " pulumi-lang-go=" preventDestroy " pulumi-lang-python=" prevent_destroy " pulumi-lang-yaml=" preventDestroy " pulumi-lang-java=" preventDestroy "> prevent_destroy </span>= true } on production instances to prevent accidental Flink Connection deletion. This setting rejects plans that would destroy or recreate the Flink Connection, such as attempting to change uneditable attributes. Read more about it in the Terraform docs.

    Example Usage

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

const connection1 = new confluentcloud.FlinkConnection("connection1", {
    organization: {
        id: main.id,
    },
    environment: {
        id: staging.id,
    },
    computePool: {
        id: example.id,
    },
    principal: {
        id: app_manager_flink.id,
    },
    restEndpoint: mainConfluentFlinkRegion.restEndpoint,
    credentials: {
        key: env_admin_flink_api_key.id,
        secret: env_admin_flink_api_key.secret,
    },
    displayName: "connection1",
    type: "OPENAI",
    endpoint: "https://api.openai.com/v1/chat/completions",
    apiKey: "API_Key_value",
});

    import pulumi
import pulumi_confluentcloud as confluentcloud

connection1 = confluentcloud.FlinkConnection("connection1",
    organization={
        "id": main["id"],
    },
    environment={
        "id": staging["id"],
    },
    compute_pool={
        "id": example["id"],
    },
    principal={
        "id": app_manager_flink["id"],
    },
    rest_endpoint=main_confluent_flink_region["restEndpoint"],
    credentials={
        "key": env_admin_flink_api_key["id"],
        "secret": env_admin_flink_api_key["secret"],
    },
    display_name="connection1",
    type="OPENAI",
    endpoint="https://api.openai.com/v1/chat/completions",
    api_key="API_Key_value")

    package main

import (
	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := confluentcloud.NewFlinkConnection(ctx, "connection1", &confluentcloud.FlinkConnectionArgs{
			Organization: &confluentcloud.FlinkConnectionOrganizationArgs{
				Id: pulumi.Any(main.Id),
			},
			Environment: &confluentcloud.FlinkConnectionEnvironmentArgs{
				Id: pulumi.Any(staging.Id),
			},
			ComputePool: &confluentcloud.FlinkConnectionComputePoolArgs{
				Id: pulumi.Any(example.Id),
			},
			Principal: &confluentcloud.FlinkConnectionPrincipalArgs{
				Id: pulumi.Any(app_manager_flink.Id),
			},
			RestEndpoint: pulumi.Any(mainConfluentFlinkRegion.RestEndpoint),
			Credentials: &confluentcloud.FlinkConnectionCredentialsArgs{
				Key:    pulumi.Any(env_admin_flink_api_key.Id),
				Secret: pulumi.Any(env_admin_flink_api_key.Secret),
			},
			DisplayName: pulumi.String("connection1"),
			Type:        pulumi.String("OPENAI"),
			Endpoint:    pulumi.String("https://api.openai.com/v1/chat/completions"),
			ApiKey:      pulumi.String("API_Key_value"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var connection1 = new ConfluentCloud.FlinkConnection("connection1", new()
    {
        Organization = new ConfluentCloud.Inputs.FlinkConnectionOrganizationArgs
        {
            Id = main.Id,
        },
        Environment = new ConfluentCloud.Inputs.FlinkConnectionEnvironmentArgs
        {
            Id = staging.Id,
        },
        ComputePool = new ConfluentCloud.Inputs.FlinkConnectionComputePoolArgs
        {
            Id = example.Id,
        },
        Principal = new ConfluentCloud.Inputs.FlinkConnectionPrincipalArgs
        {
            Id = app_manager_flink.Id,
        },
        RestEndpoint = mainConfluentFlinkRegion.RestEndpoint,
        Credentials = new ConfluentCloud.Inputs.FlinkConnectionCredentialsArgs
        {
            Key = env_admin_flink_api_key.Id,
            Secret = env_admin_flink_api_key.Secret,
        },
        DisplayName = "connection1",
        Type = "OPENAI",
        Endpoint = "https://api.openai.com/v1/chat/completions",
        ApiKey = "API_Key_value",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.FlinkConnection;
import com.pulumi.confluentcloud.FlinkConnectionArgs;
import com.pulumi.confluentcloud.inputs.FlinkConnectionOrganizationArgs;
import com.pulumi.confluentcloud.inputs.FlinkConnectionEnvironmentArgs;
import com.pulumi.confluentcloud.inputs.FlinkConnectionComputePoolArgs;
import com.pulumi.confluentcloud.inputs.FlinkConnectionPrincipalArgs;
import com.pulumi.confluentcloud.inputs.FlinkConnectionCredentialsArgs;
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) {
        var connection1 = new FlinkConnection("connection1", FlinkConnectionArgs.builder()
            .organization(FlinkConnectionOrganizationArgs.builder()
                .id(main.id())
                .build())
            .environment(FlinkConnectionEnvironmentArgs.builder()
                .id(staging.id())
                .build())
            .computePool(FlinkConnectionComputePoolArgs.builder()
                .id(example.id())
                .build())
            .principal(FlinkConnectionPrincipalArgs.builder()
                .id(app_manager_flink.id())
                .build())
            .restEndpoint(mainConfluentFlinkRegion.restEndpoint())
            .credentials(FlinkConnectionCredentialsArgs.builder()
                .key(env_admin_flink_api_key.id())
                .secret(env_admin_flink_api_key.secret())
                .build())
            .displayName("connection1")
            .type("OPENAI")
            .endpoint("https://api.openai.com/v1/chat/completions")
            .apiKey("API_Key_value")
            .build());

    }
}

    resources:
  connection1:
    type: confluentcloud:FlinkConnection
    properties:
      organization:
        id: ${main.id}
      environment:
        id: ${staging.id}
      computePool:
        id: ${example.id}
      principal:
        id: ${["app-manager-flink"].id}
      restEndpoint: ${mainConfluentFlinkRegion.restEndpoint}
      credentials:
        key: ${["env-admin-flink-api-key"].id}
        secret: ${["env-admin-flink-api-key"].secret}
      displayName: connection1
      type: OPENAI
      endpoint: https://api.openai.com/v1/chat/completions
      apiKey: API_Key_value

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

const example = new confluentcloud.FlinkConnection("example", {
    displayName: "connection1",
    type: "OPENAI",
    endpoint: "https://api.openai.com/v1/chat/completions",
    apiKey: "API_Key_value",
});

    import pulumi
import pulumi_confluentcloud as confluentcloud

example = confluentcloud.FlinkConnection("example",
    display_name="connection1",
    type="OPENAI",
    endpoint="https://api.openai.com/v1/chat/completions",
    api_key="API_Key_value")

    package main

import (
	"github.com/pulumi/pulumi-confluentcloud/sdk/v2/go/confluentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := confluentcloud.NewFlinkConnection(ctx, "example", &confluentcloud.FlinkConnectionArgs{
			DisplayName: pulumi.String("connection1"),
			Type:        pulumi.String("OPENAI"),
			Endpoint:    pulumi.String("https://api.openai.com/v1/chat/completions"),
			ApiKey:      pulumi.String("API_Key_value"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var example = new ConfluentCloud.FlinkConnection("example", new()
    {
        DisplayName = "connection1",
        Type = "OPENAI",
        Endpoint = "https://api.openai.com/v1/chat/completions",
        ApiKey = "API_Key_value",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.FlinkConnection;
import com.pulumi.confluentcloud.FlinkConnectionArgs;
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) {
        var example = new FlinkConnection("example", FlinkConnectionArgs.builder()
            .displayName("connection1")
            .type("OPENAI")
            .endpoint("https://api.openai.com/v1/chat/completions")
            .apiKey("API_Key_value")
            .build());

    }
}

    resources:
  example:
    type: confluentcloud:FlinkConnection
    properties:
      displayName: connection1
      type: OPENAI
      endpoint: https://api.openai.com/v1/chat/completions
      apiKey: API_Key_value

    The following arguments are supported:

    • organization (Optional Configuration Block) supports the following:
      • id - (Required String) The ID of the Organization, for example, 1111aaaa-11aa-11aa-11aa-111111aaaaaa.
    • environment (Optional Configuration Block) supports the following:
      • id - (Required String) The ID of the Environment, for example, env-abc123.
    • compute_pool - (Optional Configuration Block) supports the following:
      • id - (Required String) The ID of the Flink Compute Pool, for example, lfcp-abc123.
    • principal - (Optional Configuration Block) supports the following:
      • id - (Required String) The ID of the Principal the Flink Connection runs as, for example, sa-abc123.
    • rest_endpoint - (Optional String) The REST endpoint of the Flink region, for example, https://flink.us-east-1.aws.confluent.cloud.
    • credentials (Optional Configuration Block) supports the following:
      • key - (Required String) The Flink API Key.
      • secret - (Required String, Sensitive) The Flink API Secret.

    Note: A Flink API key consists of a key and a secret. Flink API keys are required to interact with Flink Connections in Confluent Cloud. Each Flink API key is valid for one specific Flink Region.

    Note: Use Option #2 to simplify the key rotation process. When using Option #1, to rotate a Flink API key, create a new Flink API key, update the credentials block in all configuration files to use the new Flink API key, run pulumi up -target="confluent_flink_connection.example", and remove the old Flink API key. Alternatively, in case the old Flink API Key was deleted already, you might need to run pulumi preview -refresh=false -target="confluent_flink_connection.example" -out=rotate-flink-api-key and pulumi up rotate-flink-api-key instead.

    • display_name - (Required String) The name of the Flink Connection.
    • type - (Required String) The type of the Flink Connection. The accepted values are: OPENAI, AZUREML, AZUREOPENAI, BEDROCK, SAGEMAKER, GOOGLEAI, VERTEXAI, MONGODB, PINECONE, ELASTIC and COUCHBASE.
    • endpoint - (Required String) The endpoint of the Flink Connection, for example, https://api.openai.com/v1/chat/completions
    • api_key - (Optional String) The api key for the connection type. This is valid and required for types OPENAI, AZUREML, AZUREOPENAI, GOOGLEAI, ELASTIC and PINECONE.
    • aws_access_key - (Optional String) The AWS access key for the connection type. This is valid and required for types BEDROCK and SAGEMAKER.
    • aws_secret_key - (Optional String) The AWS secret key for the connection type. This is valid and required for types BEDROCK and SAGEMAKER.
    • aws_session_token - (Optional String) The AWS session key for the connection type. This is valid and required for types BEDROCK and SAGEMAKER.
    • service_key - (Optional String) The service key for the connection type. This is valid and required for type VERTEXAI.
    • username - (Optional String) The username for the connection type. This is valid and required for types MONGODB and COUCHBASE.
    • password - (Optional String) The password for the connection type. This is valid and required for types MONGODB and COUCHBASE.

    !> Warning: Use Option #2 to avoid exposing sensitive credentials value in a state file. When using Option #1, Terraform doesn’t encrypt the sensitive credentials value of the confluentcloud.FlinkConnection resource, so you must keep your state file secure to avoid exposing it. Refer to the Terraform documentation to learn more about securing your state file.

    Attributes Reference

    In addition to the preceding arguments, the following attributes are exported:

    • id - (Required String) The ID of the Flink connection, in the format <Organization ID>/<Environment ID>/<Flink Connection name>, for example, org-xyz123/env-abc123/connection1.
    • api_version - (Required String) The API Version of the schema version of the Flink Connection, for example, sql/v1.
    • kind - (Required String) The kind of the Flink Connection, for example, Connection.

    Create FlinkConnection Resource

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

    Constructor syntax

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

@overload
def FlinkConnection(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    display_name: Optional[str] = None,
                    type: Optional[str] = None,
                    endpoint: Optional[str] = None,
                    environment: Optional[FlinkConnectionEnvironmentArgs] = None,
                    compute_pool: Optional[FlinkConnectionComputePoolArgs] = None,
                    credentials: Optional[FlinkConnectionCredentialsArgs] = None,
                    aws_session_token: Optional[str] = None,
                    aws_secret_key: Optional[str] = None,
                    api_key: Optional[str] = None,
                    organization: Optional[FlinkConnectionOrganizationArgs] = None,
                    password: Optional[str] = None,
                    principal: Optional[FlinkConnectionPrincipalArgs] = None,
                    rest_endpoint: Optional[str] = None,
                    service_key: Optional[str] = None,
                    aws_access_key: Optional[str] = None,
                    username: Optional[str] = None)
    func NewFlinkConnection(ctx *Context, name string, args FlinkConnectionArgs, opts ...ResourceOption) (*FlinkConnection, error)
    public FlinkConnection(string name, FlinkConnectionArgs args, CustomResourceOptions? opts = null)
    public FlinkConnection(String name, FlinkConnectionArgs args)
public FlinkConnection(String name, FlinkConnectionArgs args, CustomResourceOptions options)

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

    Parameters

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

    Constructor example

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

    var flinkConnectionResource = new ConfluentCloud.FlinkConnection("flinkConnectionResource", new()
{
    DisplayName = "string",
    Type = "string",
    Endpoint = "string",
    Environment = new ConfluentCloud.Inputs.FlinkConnectionEnvironmentArgs
    {
        Id = "string",
    },
    ComputePool = new ConfluentCloud.Inputs.FlinkConnectionComputePoolArgs
    {
        Id = "string",
    },
    Credentials = new ConfluentCloud.Inputs.FlinkConnectionCredentialsArgs
    {
        Key = "string",
        Secret = "string",
    },
    AwsSessionToken = "string",
    AwsSecretKey = "string",
    ApiKey = "string",
    Organization = new ConfluentCloud.Inputs.FlinkConnectionOrganizationArgs
    {
        Id = "string",
    },
    Password = "string",
    Principal = new ConfluentCloud.Inputs.FlinkConnectionPrincipalArgs
    {
        Id = "string",
    },
    RestEndpoint = "string",
    ServiceKey = "string",
    AwsAccessKey = "string",
    Username = "string",
});

    example, err := confluentcloud.NewFlinkConnection(ctx, "flinkConnectionResource", &confluentcloud.FlinkConnectionArgs{
	DisplayName: pulumi.String("string"),
	Type:        pulumi.String("string"),
	Endpoint:    pulumi.String("string"),
	Environment: &confluentcloud.FlinkConnectionEnvironmentArgs{
		Id: pulumi.String("string"),
	},
	ComputePool: &confluentcloud.FlinkConnectionComputePoolArgs{
		Id: pulumi.String("string"),
	},
	Credentials: &confluentcloud.FlinkConnectionCredentialsArgs{
		Key:    pulumi.String("string"),
		Secret: pulumi.String("string"),
	},
	AwsSessionToken: pulumi.String("string"),
	AwsSecretKey:    pulumi.String("string"),
	ApiKey:          pulumi.String("string"),
	Organization: &confluentcloud.FlinkConnectionOrganizationArgs{
		Id: pulumi.String("string"),
	},
	Password: pulumi.String("string"),
	Principal: &confluentcloud.FlinkConnectionPrincipalArgs{
		Id: pulumi.String("string"),
	},
	RestEndpoint: pulumi.String("string"),
	ServiceKey:   pulumi.String("string"),
	AwsAccessKey: pulumi.String("string"),
	Username:     pulumi.String("string"),
})

    var flinkConnectionResource = new FlinkConnection("flinkConnectionResource", FlinkConnectionArgs.builder()
    .displayName("string")
    .type("string")
    .endpoint("string")
    .environment(FlinkConnectionEnvironmentArgs.builder()
        .id("string")
        .build())
    .computePool(FlinkConnectionComputePoolArgs.builder()
        .id("string")
        .build())
    .credentials(FlinkConnectionCredentialsArgs.builder()
        .key("string")
        .secret("string")
        .build())
    .awsSessionToken("string")
    .awsSecretKey("string")
    .apiKey("string")
    .organization(FlinkConnectionOrganizationArgs.builder()
        .id("string")
        .build())
    .password("string")
    .principal(FlinkConnectionPrincipalArgs.builder()
        .id("string")
        .build())
    .restEndpoint("string")
    .serviceKey("string")
    .awsAccessKey("string")
    .username("string")
    .build());

    flink_connection_resource = confluentcloud.FlinkConnection("flinkConnectionResource",
    display_name="string",
    type="string",
    endpoint="string",
    environment={
        "id": "string",
    },
    compute_pool={
        "id": "string",
    },
    credentials={
        "key": "string",
        "secret": "string",
    },
    aws_session_token="string",
    aws_secret_key="string",
    api_key="string",
    organization={
        "id": "string",
    },
    password="string",
    principal={
        "id": "string",
    },
    rest_endpoint="string",
    service_key="string",
    aws_access_key="string",
    username="string")

    const flinkConnectionResource = new confluentcloud.FlinkConnection("flinkConnectionResource", {
    displayName: "string",
    type: "string",
    endpoint: "string",
    environment: {
        id: "string",
    },
    computePool: {
        id: "string",
    },
    credentials: {
        key: "string",
        secret: "string",
    },
    awsSessionToken: "string",
    awsSecretKey: "string",
    apiKey: "string",
    organization: {
        id: "string",
    },
    password: "string",
    principal: {
        id: "string",
    },
    restEndpoint: "string",
    serviceKey: "string",
    awsAccessKey: "string",
    username: "string",
});

    type: confluentcloud:FlinkConnection
properties:
    apiKey: string
    awsAccessKey: string
    awsSecretKey: string
    awsSessionToken: string
    computePool:
        id: string
    credentials:
        key: string
        secret: string
    displayName: string
    endpoint: string
    environment:
        id: string
    organization:
        id: string
    password: string
    principal:
        id: string
    restEndpoint: string
    serviceKey: string
    type: string
    username: string

    FlinkConnection Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The FlinkConnection resource accepts the following input properties:

    DisplayName string
    The unique name of the Flink Connection per organization, environment scope.
    Endpoint string
    The endpoint of the flink connection.
    Type string
    The type of the flink connection.
    ApiKey string
    API key for the type.
    AwsAccessKey string
    Access key for the type.
    AwsSecretKey string
    Secret key for the type.
    AwsSessionToken string
    Session token for the type.
    ComputePool Pulumi.ConfluentCloud.Inputs.FlinkConnectionComputePool
    Credentials Pulumi.ConfluentCloud.Inputs.FlinkConnectionCredentials
    The Cluster API Credentials.
    Environment Pulumi.ConfluentCloud.Inputs.FlinkConnectionEnvironment
    Organization Pulumi.ConfluentCloud.Inputs.FlinkConnectionOrganization
    Password string
    Password for the type.
    Principal Pulumi.ConfluentCloud.Inputs.FlinkConnectionPrincipal
    RestEndpoint string
    The REST endpoint of the Flink Connection cluster, for example, https://flink.us-east-1.aws.confluent.cloud/sql/v1/organizations/1111aaaa-11aa-11aa-11aa-111111aaaaaa/environments/env-abc123).
    ServiceKey string
    Service Key for the type.
    Username string
    Username for the type.
    DisplayName string
    The unique name of the Flink Connection per organization, environment scope.
    Endpoint string
    The endpoint of the flink connection.
    Type string
    The type of the flink connection.
    ApiKey string
    API key for the type.
    AwsAccessKey string
    Access key for the type.
    AwsSecretKey string
    Secret key for the type.
    AwsSessionToken string
    Session token for the type.
    ComputePool FlinkConnectionComputePoolArgs
    Credentials FlinkConnectionCredentialsArgs
    The Cluster API Credentials.
    Environment FlinkConnectionEnvironmentArgs
    Organization FlinkConnectionOrganizationArgs
    Password string
    Password for the type.
    Principal FlinkConnectionPrincipalArgs
    RestEndpoint string
    The REST endpoint of the Flink Connection cluster, for example, https://flink.us-east-1.aws.confluent.cloud/sql/v1/organizations/1111aaaa-11aa-11aa-11aa-111111aaaaaa/environments/env-abc123).
    ServiceKey string
    Service Key for the type.
    Username string
    Username for the type.
    displayName String
    The unique name of the Flink Connection per organization, environment scope.
    endpoint String
    The endpoint of the flink connection.
    type String
    The type of the flink connection.
    apiKey String
    API key for the type.
    awsAccessKey String
    Access key for the type.
    awsSecretKey String
    Secret key for the type.
    awsSessionToken String
    Session token for the type.
    computePool FlinkConnectionComputePool
    credentials FlinkConnectionCredentials
    The Cluster API Credentials.
    environment FlinkConnectionEnvironment
    organization FlinkConnectionOrganization
    password String
    Password for the type.
    principal FlinkConnectionPrincipal
    restEndpoint String
    The REST endpoint of the Flink Connection cluster, for example, https://flink.us-east-1.aws.confluent.cloud/sql/v1/organizations/1111aaaa-11aa-11aa-11aa-111111aaaaaa/environments/env-abc123).
    serviceKey String
    Service Key for the type.
    username String
    Username for the type.
    displayName string
    The unique name of the Flink Connection per organization, environment scope.
    endpoint string
    The endpoint of the flink connection.
    type string
    The type of the flink connection.
    apiKey string
    API key for the type.
    awsAccessKey string
    Access key for the type.
    awsSecretKey string
    Secret key for the type.
    awsSessionToken string
    Session token for the type.
    computePool FlinkConnectionComputePool
    credentials FlinkConnectionCredentials
    The Cluster API Credentials.
    environment FlinkConnectionEnvironment
    organization FlinkConnectionOrganization
    password string
    Password for the type.
    principal FlinkConnectionPrincipal
    restEndpoint string
    The REST endpoint of the Flink Connection cluster, for example, https://flink.us-east-1.aws.confluent.cloud/sql/v1/organizations/1111aaaa-11aa-11aa-11aa-111111aaaaaa/environments/env-abc123).
    serviceKey string
    Service Key for the type.
    username string
    Username for the type.
    display_name str
    The unique name of the Flink Connection per organization, environment scope.
    endpoint str
    The endpoint of the flink connection.
    type str
    The type of the flink connection.
    api_key str
    API key for the type.
    aws_access_key str
    Access key for the type.
    aws_secret_key str
    Secret key for the type.
    aws_session_token str
    Session token for the type.
    compute_pool FlinkConnectionComputePoolArgs
    credentials FlinkConnectionCredentialsArgs
    The Cluster API Credentials.
    environment FlinkConnectionEnvironmentArgs
    organization FlinkConnectionOrganizationArgs
    password str
    Password for the type.
    principal FlinkConnectionPrincipalArgs
    rest_endpoint str
    The REST endpoint of the Flink Connection cluster, for example, https://flink.us-east-1.aws.confluent.cloud/sql/v1/organizations/1111aaaa-11aa-11aa-11aa-111111aaaaaa/environments/env-abc123).
    service_key str
    Service Key for the type.
    username str
    Username for the type.
    displayName String
    The unique name of the Flink Connection per organization, environment scope.
    endpoint String
    The endpoint of the flink connection.
    type String
    The type of the flink connection.
    apiKey String
    API key for the type.
    awsAccessKey String
    Access key for the type.
    awsSecretKey String
    Secret key for the type.
    awsSessionToken String
    Session token for the type.
    computePool Property Map
    credentials Property Map
    The Cluster API Credentials.
    environment Property Map
    organization Property Map
    password String
    Password for the type.
    principal Property Map
    restEndpoint String
    The REST endpoint of the Flink Connection cluster, for example, https://flink.us-east-1.aws.confluent.cloud/sql/v1/organizations/1111aaaa-11aa-11aa-11aa-111111aaaaaa/environments/env-abc123).
    serviceKey String
    Service Key for the type.
    username String
    Username for the type.

    Outputs

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

    ApiVersion string
    The schema version of this representation of a resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    The object this REST resource represents.
    ApiVersion string
    The schema version of this representation of a resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    The object this REST resource represents.
    apiVersion String
    The schema version of this representation of a resource.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    The object this REST resource represents.
    apiVersion string
    The schema version of this representation of a resource.
    id string
    The provider-assigned unique ID for this managed resource.
    kind string
    The object this REST resource represents.
    api_version str
    The schema version of this representation of a resource.
    id str
    The provider-assigned unique ID for this managed resource.
    kind str
    The object this REST resource represents.
    apiVersion String
    The schema version of this representation of a resource.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    The object this REST resource represents.

    Look up Existing FlinkConnection Resource

    Get an existing FlinkConnection resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: FlinkConnectionState, opts?: CustomResourceOptions): FlinkConnection
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_key: Optional[str] = None,
        api_version: Optional[str] = None,
        aws_access_key: Optional[str] = None,
        aws_secret_key: Optional[str] = None,
        aws_session_token: Optional[str] = None,
        compute_pool: Optional[FlinkConnectionComputePoolArgs] = None,
        credentials: Optional[FlinkConnectionCredentialsArgs] = None,
        display_name: Optional[str] = None,
        endpoint: Optional[str] = None,
        environment: Optional[FlinkConnectionEnvironmentArgs] = None,
        kind: Optional[str] = None,
        organization: Optional[FlinkConnectionOrganizationArgs] = None,
        password: Optional[str] = None,
        principal: Optional[FlinkConnectionPrincipalArgs] = None,
        rest_endpoint: Optional[str] = None,
        service_key: Optional[str] = None,
        type: Optional[str] = None,
        username: Optional[str] = None) -> FlinkConnection
    func GetFlinkConnection(ctx *Context, name string, id IDInput, state *FlinkConnectionState, opts ...ResourceOption) (*FlinkConnection, error)
    public static FlinkConnection Get(string name, Input<string> id, FlinkConnectionState? state, CustomResourceOptions? opts = null)
    public static FlinkConnection get(String name, Output<String> id, FlinkConnectionState state, CustomResourceOptions options)
    resources:  _:    type: confluentcloud:FlinkConnection    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiKey string
    API key for the type.
    ApiVersion string
    The schema version of this representation of a resource.
    AwsAccessKey string
    Access key for the type.
    AwsSecretKey string
    Secret key for the type.
    AwsSessionToken string
    Session token for the type.
    ComputePool Pulumi.ConfluentCloud.Inputs.FlinkConnectionComputePool
    Credentials Pulumi.ConfluentCloud.Inputs.FlinkConnectionCredentials
    The Cluster API Credentials.
    DisplayName string
    The unique name of the Flink Connection per organization, environment scope.
    Endpoint string
    The endpoint of the flink connection.
    Environment Pulumi.ConfluentCloud.Inputs.FlinkConnectionEnvironment
    Kind string
    The object this REST resource represents.
    Organization Pulumi.ConfluentCloud.Inputs.FlinkConnectionOrganization
    Password string
    Password for the type.
    Principal Pulumi.ConfluentCloud.Inputs.FlinkConnectionPrincipal
    RestEndpoint string
    The REST endpoint of the Flink Connection cluster, for example, https://flink.us-east-1.aws.confluent.cloud/sql/v1/organizations/1111aaaa-11aa-11aa-11aa-111111aaaaaa/environments/env-abc123).
    ServiceKey string
    Service Key for the type.
    Type string
    The type of the flink connection.
    Username string
    Username for the type.
    ApiKey string
    API key for the type.
    ApiVersion string
    The schema version of this representation of a resource.
    AwsAccessKey string
    Access key for the type.
    AwsSecretKey string
    Secret key for the type.
    AwsSessionToken string
    Session token for the type.
    ComputePool FlinkConnectionComputePoolArgs
    Credentials FlinkConnectionCredentialsArgs
    The Cluster API Credentials.
    DisplayName string
    The unique name of the Flink Connection per organization, environment scope.
    Endpoint string
    The endpoint of the flink connection.
    Environment FlinkConnectionEnvironmentArgs
    Kind string
    The object this REST resource represents.
    Organization FlinkConnectionOrganizationArgs
    Password string
    Password for the type.
    Principal FlinkConnectionPrincipalArgs
    RestEndpoint string
    The REST endpoint of the Flink Connection cluster, for example, https://flink.us-east-1.aws.confluent.cloud/sql/v1/organizations/1111aaaa-11aa-11aa-11aa-111111aaaaaa/environments/env-abc123).
    ServiceKey string
    Service Key for the type.
    Type string
    The type of the flink connection.
    Username string
    Username for the type.
    apiKey String
    API key for the type.
    apiVersion String
    The schema version of this representation of a resource.
    awsAccessKey String
    Access key for the type.
    awsSecretKey String
    Secret key for the type.
    awsSessionToken String
    Session token for the type.
    computePool FlinkConnectionComputePool
    credentials FlinkConnectionCredentials
    The Cluster API Credentials.
    displayName String
    The unique name of the Flink Connection per organization, environment scope.
    endpoint String
    The endpoint of the flink connection.
    environment FlinkConnectionEnvironment
    kind String
    The object this REST resource represents.
    organization FlinkConnectionOrganization
    password String
    Password for the type.
    principal FlinkConnectionPrincipal
    restEndpoint String
    The REST endpoint of the Flink Connection cluster, for example, https://flink.us-east-1.aws.confluent.cloud/sql/v1/organizations/1111aaaa-11aa-11aa-11aa-111111aaaaaa/environments/env-abc123).
    serviceKey String
    Service Key for the type.
    type String
    The type of the flink connection.
    username String
    Username for the type.
    apiKey string
    API key for the type.
    apiVersion string
    The schema version of this representation of a resource.
    awsAccessKey string
    Access key for the type.
    awsSecretKey string
    Secret key for the type.
    awsSessionToken string
    Session token for the type.
    computePool FlinkConnectionComputePool
    credentials FlinkConnectionCredentials
    The Cluster API Credentials.
    displayName string
    The unique name of the Flink Connection per organization, environment scope.
    endpoint string
    The endpoint of the flink connection.
    environment FlinkConnectionEnvironment
    kind string
    The object this REST resource represents.
    organization FlinkConnectionOrganization
    password string
    Password for the type.
    principal FlinkConnectionPrincipal
    restEndpoint string
    The REST endpoint of the Flink Connection cluster, for example, https://flink.us-east-1.aws.confluent.cloud/sql/v1/organizations/1111aaaa-11aa-11aa-11aa-111111aaaaaa/environments/env-abc123).
    serviceKey string
    Service Key for the type.
    type string
    The type of the flink connection.
    username string
    Username for the type.
    api_key str
    API key for the type.
    api_version str
    The schema version of this representation of a resource.
    aws_access_key str
    Access key for the type.
    aws_secret_key str
    Secret key for the type.
    aws_session_token str
    Session token for the type.
    compute_pool FlinkConnectionComputePoolArgs
    credentials FlinkConnectionCredentialsArgs
    The Cluster API Credentials.
    display_name str
    The unique name of the Flink Connection per organization, environment scope.
    endpoint str
    The endpoint of the flink connection.
    environment FlinkConnectionEnvironmentArgs
    kind str
    The object this REST resource represents.
    organization FlinkConnectionOrganizationArgs
    password str
    Password for the type.
    principal FlinkConnectionPrincipalArgs
    rest_endpoint str
    The REST endpoint of the Flink Connection cluster, for example, https://flink.us-east-1.aws.confluent.cloud/sql/v1/organizations/1111aaaa-11aa-11aa-11aa-111111aaaaaa/environments/env-abc123).
    service_key str
    Service Key for the type.
    type str
    The type of the flink connection.
    username str
    Username for the type.
    apiKey String
    API key for the type.
    apiVersion String
    The schema version of this representation of a resource.
    awsAccessKey String
    Access key for the type.
    awsSecretKey String
    Secret key for the type.
    awsSessionToken String
    Session token for the type.
    computePool Property Map
    credentials Property Map
    The Cluster API Credentials.
    displayName String
    The unique name of the Flink Connection per organization, environment scope.
    endpoint String
    The endpoint of the flink connection.
    environment Property Map
    kind String
    The object this REST resource represents.
    organization Property Map
    password String
    Password for the type.
    principal Property Map
    restEndpoint String
    The REST endpoint of the Flink Connection cluster, for example, https://flink.us-east-1.aws.confluent.cloud/sql/v1/organizations/1111aaaa-11aa-11aa-11aa-111111aaaaaa/environments/env-abc123).
    serviceKey String
    Service Key for the type.
    type String
    The type of the flink connection.
    username String
    Username for the type.

    Supporting Types

    FlinkConnectionComputePool, FlinkConnectionComputePoolArgs

    Id string
    Id string
    id String
    id string
    id str
    id String

    FlinkConnectionCredentials, FlinkConnectionCredentialsArgs

    Key string
    The Cluster API Key for your Confluent Cloud cluster.
    Secret string
    The Cluster API Secret for your Confluent Cloud cluster.
    Key string
    The Cluster API Key for your Confluent Cloud cluster.
    Secret string
    The Cluster API Secret for your Confluent Cloud cluster.
    key String
    The Cluster API Key for your Confluent Cloud cluster.
    secret String
    The Cluster API Secret for your Confluent Cloud cluster.
    key string
    The Cluster API Key for your Confluent Cloud cluster.
    secret string
    The Cluster API Secret for your Confluent Cloud cluster.
    key str
    The Cluster API Key for your Confluent Cloud cluster.
    secret str
    The Cluster API Secret for your Confluent Cloud cluster.
    key String
    The Cluster API Key for your Confluent Cloud cluster.
    secret String
    The Cluster API Secret for your Confluent Cloud cluster.

    FlinkConnectionEnvironment, FlinkConnectionEnvironmentArgs

    Id string
    Id string
    id String
    id string
    id str
    id String

    FlinkConnectionOrganization, FlinkConnectionOrganizationArgs

    Id string
    Id string
    id String
    id string
    id str
    id String

    FlinkConnectionPrincipal, FlinkConnectionPrincipalArgs

    Id string
    Id string
    id String
    id string
    id str
    id String

    Import

    You can import a Flink connection by using the Flink Connection name, for example:

    Option #1: Manage multiple Flink Compute Pools in the same Pulumi Stack

    $ export IMPORT_CONFLUENT_ORGANIZATION_ID="<organization_id>"
$ export IMPORT_CONFLUENT_ENVIRONMENT_ID="<environment_id>"
$ export IMPORT_FLINK_COMPUTE_POOL_ID="<flink_compute_pool_id>"
$ export IMPORT_FLINK_API_KEY="<flink_api_key>"
$ export IMPORT_FLINK_API_SECRET="<flink_api_secret>"
$ export IMPORT_FLINK_REST_ENDPOINT="<flink_rest_endpoint>"
$ export IMPORT_FLINK_PRINCIPAL_ID="<flink_principal>"
$ export API_KEY="<API_KEY>"
$ pulumi import confluentcloud:index/flinkConnection:FlinkConnection example org-xyz123/env-abc123/connection1

    Option #2: Manage a single Flink Compute Pool in the same Pulumi Stack

    $ export API_KEY="<API_KEY>"
$ pulumi import confluentcloud:index/flinkConnection:FlinkConnection example org-xyz123/env-abc123/connection1

    Note: The example above is for type = OPENAI, so we exported API_KEY. Export the required field for each type as mentioned above. The fields that can be exported are: API_KEY, AWS_SECRET_ACCESS_KEY_CONNECTION, AWS_ACCESS_KEY_ID_CONNECTION, AWS_SESSION_TOKEN_CONNECTION, SERVICE_KEY, USERNAME, PASSWORD.

    !> Warning: Do not forget to delete terminal command history afterwards for security purposes.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Confluent Cloud pulumi/pulumi-confluentcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the confluent Terraform Provider.
    confluentcloud logo
    Viewing docs for Confluent v2.59.0
    published on Friday, Mar 6, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-confluentcloud
      Try Pulumi Cloud free. Your team will thank you.