Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. getFlinkConnection
Confluent v2.31.0 published on Friday, Jun 13, 2025 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.getFlinkConnection

Explore with Pulumi AI

confluentcloud logo
Confluent v2.31.0 published on Friday, Jun 13, 2025 by Pulumi
pulumi/pulumi-confluentcloud

    General Availability

    confluentcloud.FlinkConnection describes a Flink Connection data source.

    Example Usage

    Using getFlinkConnection

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFlinkConnection(args: GetFlinkConnectionArgs, opts?: InvokeOptions): Promise<GetFlinkConnectionResult>
function getFlinkConnectionOutput(args: GetFlinkConnectionOutputArgs, opts?: InvokeOptions): Output<GetFlinkConnectionResult>
    def get_flink_connection(compute_pool: Optional[GetFlinkConnectionComputePool] = None,
                         credentials: Optional[GetFlinkConnectionCredentials] = None,
                         display_name: Optional[str] = None,
                         environment: Optional[GetFlinkConnectionEnvironment] = None,
                         organization: Optional[GetFlinkConnectionOrganization] = None,
                         principal: Optional[GetFlinkConnectionPrincipal] = None,
                         rest_endpoint: Optional[str] = None,
                         type: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetFlinkConnectionResult
def get_flink_connection_output(compute_pool: Optional[pulumi.Input[GetFlinkConnectionComputePoolArgs]] = None,
                         credentials: Optional[pulumi.Input[GetFlinkConnectionCredentialsArgs]] = None,
                         display_name: Optional[pulumi.Input[str]] = None,
                         environment: Optional[pulumi.Input[GetFlinkConnectionEnvironmentArgs]] = None,
                         organization: Optional[pulumi.Input[GetFlinkConnectionOrganizationArgs]] = None,
                         principal: Optional[pulumi.Input[GetFlinkConnectionPrincipalArgs]] = None,
                         rest_endpoint: Optional[pulumi.Input[str]] = None,
                         type: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetFlinkConnectionResult]
    func LookupFlinkConnection(ctx *Context, args *LookupFlinkConnectionArgs, opts ...InvokeOption) (*LookupFlinkConnectionResult, error)
func LookupFlinkConnectionOutput(ctx *Context, args *LookupFlinkConnectionOutputArgs, opts ...InvokeOption) LookupFlinkConnectionResultOutput

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

    public static class GetFlinkConnection 
{
    public static Task<GetFlinkConnectionResult> InvokeAsync(GetFlinkConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetFlinkConnectionResult> Invoke(GetFlinkConnectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFlinkConnectionResult> getFlinkConnection(GetFlinkConnectionArgs args, InvokeOptions options)
public static Output<GetFlinkConnectionResult> getFlinkConnection(GetFlinkConnectionArgs args, InvokeOptions options)

    fn::invoke:
  function: confluentcloud:index/getFlinkConnection:getFlinkConnection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DisplayName string
    The name of the Flink Connection.
    ComputePool Pulumi.ConfluentCloud.Inputs.GetFlinkConnectionComputePool
    Credentials Pulumi.ConfluentCloud.Inputs.GetFlinkConnectionCredentials
    Environment Pulumi.ConfluentCloud.Inputs.GetFlinkConnectionEnvironment
    Organization Pulumi.ConfluentCloud.Inputs.GetFlinkConnectionOrganization
    Principal Pulumi.ConfluentCloud.Inputs.GetFlinkConnectionPrincipal
    RestEndpoint string
    The REST endpoint of the Flink region, for example, https://flink.us-east-1.aws.confluent.cloud).
    Type string
    The type of the Flink Connection. The accepted values are: OPENAI, AZUREML, AZUREOPENAI, BEDROCK, SAGEMAKER, GOOGLEAI, VERTEXAI, MONGODB, PINECONE, ELASTIC and COUCHBASE.
    DisplayName string
    The name of the Flink Connection.
    ComputePool GetFlinkConnectionComputePool
    Credentials GetFlinkConnectionCredentials
    Environment GetFlinkConnectionEnvironment
    Organization GetFlinkConnectionOrganization
    Principal GetFlinkConnectionPrincipal
    RestEndpoint string
    The REST endpoint of the Flink region, for example, https://flink.us-east-1.aws.confluent.cloud).
    Type string
    The type of the Flink Connection. The accepted values are: OPENAI, AZUREML, AZUREOPENAI, BEDROCK, SAGEMAKER, GOOGLEAI, VERTEXAI, MONGODB, PINECONE, ELASTIC and COUCHBASE.
    displayName String
    The name of the Flink Connection.
    computePool GetFlinkConnectionComputePool
    credentials GetFlinkConnectionCredentials
    environment GetFlinkConnectionEnvironment
    organization GetFlinkConnectionOrganization
    principal GetFlinkConnectionPrincipal
    restEndpoint String
    The REST endpoint of the Flink region, for example, https://flink.us-east-1.aws.confluent.cloud).
    type String
    The type of the Flink Connection. The accepted values are: OPENAI, AZUREML, AZUREOPENAI, BEDROCK, SAGEMAKER, GOOGLEAI, VERTEXAI, MONGODB, PINECONE, ELASTIC and COUCHBASE.
    displayName string
    The name of the Flink Connection.
    computePool GetFlinkConnectionComputePool
    credentials GetFlinkConnectionCredentials
    environment GetFlinkConnectionEnvironment
    organization GetFlinkConnectionOrganization
    principal GetFlinkConnectionPrincipal
    restEndpoint string
    The REST endpoint of the Flink region, for example, https://flink.us-east-1.aws.confluent.cloud).
    type string
    The type of the Flink Connection. The accepted values are: OPENAI, AZUREML, AZUREOPENAI, BEDROCK, SAGEMAKER, GOOGLEAI, VERTEXAI, MONGODB, PINECONE, ELASTIC and COUCHBASE.
    display_name str
    The name of the Flink Connection.
    compute_pool GetFlinkConnectionComputePool
    credentials GetFlinkConnectionCredentials
    environment GetFlinkConnectionEnvironment
    organization GetFlinkConnectionOrganization
    principal GetFlinkConnectionPrincipal
    rest_endpoint str
    The REST endpoint of the Flink region, for example, https://flink.us-east-1.aws.confluent.cloud).
    type str
    The type of the Flink Connection. The accepted values are: OPENAI, AZUREML, AZUREOPENAI, BEDROCK, SAGEMAKER, GOOGLEAI, VERTEXAI, MONGODB, PINECONE, ELASTIC and COUCHBASE.
    displayName String
    The name of the Flink Connection.
    computePool Property Map
    credentials Property Map
    environment Property Map
    organization Property Map
    principal Property Map
    restEndpoint String
    The REST endpoint of the Flink region, for example, https://flink.us-east-1.aws.confluent.cloud).
    type String
    The type of the Flink Connection. The accepted values are: OPENAI, AZUREML, AZUREOPENAI, BEDROCK, SAGEMAKER, GOOGLEAI, VERTEXAI, MONGODB, PINECONE, ELASTIC and COUCHBASE.

    getFlinkConnection Result

    The following output properties are available:

    ComputePool Pulumi.ConfluentCloud.Outputs.GetFlinkConnectionComputePool
    Data string
    (Required String) The authentication data of the Flink Connection.
    DisplayName string
    Endpoint string
    (Required String) The endpoint of the Flink Connection, for example, https://api.openai.com/v1/chat/completions
    Environment Pulumi.ConfluentCloud.Outputs.GetFlinkConnectionEnvironment
    Id string
    The provider-assigned unique ID for this managed resource.
    Organization Pulumi.ConfluentCloud.Outputs.GetFlinkConnectionOrganization
    Principal Pulumi.ConfluentCloud.Outputs.GetFlinkConnectionPrincipal
    Status string
    (Required String) The status of the Flink Connection.
    StatusDetail string

    (Required String) The status details of the Flink Connection.

    Credentials Pulumi.ConfluentCloud.Outputs.GetFlinkConnectionCredentials
    RestEndpoint string
    Type string
    ComputePool GetFlinkConnectionComputePool
    Data string
    (Required String) The authentication data of the Flink Connection.
    DisplayName string
    Endpoint string
    (Required String) The endpoint of the Flink Connection, for example, https://api.openai.com/v1/chat/completions
    Environment GetFlinkConnectionEnvironment
    Id string
    The provider-assigned unique ID for this managed resource.
    Organization GetFlinkConnectionOrganization
    Principal GetFlinkConnectionPrincipal
    Status string
    (Required String) The status of the Flink Connection.
    StatusDetail string

    (Required String) The status details of the Flink Connection.

    Credentials GetFlinkConnectionCredentials
    RestEndpoint string
    Type string
    computePool GetFlinkConnectionComputePool
    data String
    (Required String) The authentication data of the Flink Connection.
    displayName String
    endpoint String
    (Required String) The endpoint of the Flink Connection, for example, https://api.openai.com/v1/chat/completions
    environment GetFlinkConnectionEnvironment
    id String
    The provider-assigned unique ID for this managed resource.
    organization GetFlinkConnectionOrganization
    principal GetFlinkConnectionPrincipal
    status String
    (Required String) The status of the Flink Connection.
    statusDetail String

    (Required String) The status details of the Flink Connection.

    credentials GetFlinkConnectionCredentials
    restEndpoint String
    type String
    computePool GetFlinkConnectionComputePool
    data string
    (Required String) The authentication data of the Flink Connection.
    displayName string
    endpoint string
    (Required String) The endpoint of the Flink Connection, for example, https://api.openai.com/v1/chat/completions
    environment GetFlinkConnectionEnvironment
    id string
    The provider-assigned unique ID for this managed resource.
    organization GetFlinkConnectionOrganization
    principal GetFlinkConnectionPrincipal
    status string
    (Required String) The status of the Flink Connection.
    statusDetail string

    (Required String) The status details of the Flink Connection.

    credentials GetFlinkConnectionCredentials
    restEndpoint string
    type string
    compute_pool GetFlinkConnectionComputePool
    data str
    (Required String) The authentication data of the Flink Connection.
    display_name str
    endpoint str
    (Required String) The endpoint of the Flink Connection, for example, https://api.openai.com/v1/chat/completions
    environment GetFlinkConnectionEnvironment
    id str
    The provider-assigned unique ID for this managed resource.
    organization GetFlinkConnectionOrganization
    principal GetFlinkConnectionPrincipal
    status str
    (Required String) The status of the Flink Connection.
    status_detail str

    (Required String) The status details of the Flink Connection.

    credentials GetFlinkConnectionCredentials
    rest_endpoint str
    type str
    computePool Property Map
    data String
    (Required String) The authentication data of the Flink Connection.
    displayName String
    endpoint String
    (Required String) The endpoint of the Flink Connection, for example, https://api.openai.com/v1/chat/completions
    environment Property Map
    id String
    The provider-assigned unique ID for this managed resource.
    organization Property Map
    principal Property Map
    status String
    (Required String) The status of the Flink Connection.
    statusDetail String

    (Required String) The status details of the Flink Connection.

    credentials Property Map
    restEndpoint String
    type String

    Supporting Types

    GetFlinkConnectionComputePool

    Id string
    The ID of the Flink Compute Pool, for example, lfcp-abc123.
    Id string
    The ID of the Flink Compute Pool, for example, lfcp-abc123.
    id String
    The ID of the Flink Compute Pool, for example, lfcp-abc123.
    id string
    The ID of the Flink Compute Pool, for example, lfcp-abc123.
    id str
    The ID of the Flink Compute Pool, for example, lfcp-abc123.
    id String
    The ID of the Flink Compute Pool, for example, lfcp-abc123.

    GetFlinkConnectionCredentials

    Key string
    The Flink API Key.
    Secret string

    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.

    Key string
    The Flink API Key.
    Secret string

    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.

    key String
    The Flink API Key.
    secret String

    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.

    key string
    The Flink API Key.
    secret string

    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.

    key str
    The Flink API Key.
    secret str

    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.

    key String
    The Flink API Key.
    secret String

    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.

    GetFlinkConnectionEnvironment

    Id string
    The ID of the Environment, for example, env-abc123.
    Id string
    The ID of the Environment, for example, env-abc123.
    id String
    The ID of the Environment, for example, env-abc123.
    id string
    The ID of the Environment, for example, env-abc123.
    id str
    The ID of the Environment, for example, env-abc123.
    id String
    The ID of the Environment, for example, env-abc123.

    GetFlinkConnectionOrganization

    Id string
    The ID of the Organization, for example, 1111aaaa-11aa-11aa-11aa-111111aaaaaa.
    Id string
    The ID of the Organization, for example, 1111aaaa-11aa-11aa-11aa-111111aaaaaa.
    id String
    The ID of the Organization, for example, 1111aaaa-11aa-11aa-11aa-111111aaaaaa.
    id string
    The ID of the Organization, for example, 1111aaaa-11aa-11aa-11aa-111111aaaaaa.
    id str
    The ID of the Organization, for example, 1111aaaa-11aa-11aa-11aa-111111aaaaaa.
    id String
    The ID of the Organization, for example, 1111aaaa-11aa-11aa-11aa-111111aaaaaa.

    GetFlinkConnectionPrincipal

    Id string
    The ID of the Principal the Flink Connection runs as, for example, sa-abc123.
    Id string
    The ID of the Principal the Flink Connection runs as, for example, sa-abc123.
    id String
    The ID of the Principal the Flink Connection runs as, for example, sa-abc123.
    id string
    The ID of the Principal the Flink Connection runs as, for example, sa-abc123.
    id str
    The ID of the Principal the Flink Connection runs as, for example, sa-abc123.
    id String
    The ID of the Principal the Flink Connection runs as, for example, sa-abc123.

    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
    Confluent v2.31.0 published on Friday, Jun 13, 2025 by Pulumi
    pulumi/pulumi-confluentcloud