1. Packages
  2. Confluent Cloud
  3. API Docs
  4. getFlinkComputePool
Confluent v1.46.0 published on Friday, May 10, 2024 by Pulumi

confluentcloud.getFlinkComputePool

Explore with Pulumi AI

confluentcloud logo
Confluent v1.46.0 published on Friday, May 10, 2024 by Pulumi

    General Availability

    confluentcloud.FlinkComputePool describes a Flink Compute Pool data source.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as confluentcloud from "@pulumi/confluentcloud";
    
    export = async () => {
        const exampleUsingId = await confluentcloud.getFlinkComputePool({
            id: "lfcp-abc123",
            environment: {
                id: "env-xyz456",
            },
        });
        const exampleUsingName = await confluentcloud.getFlinkComputePool({
            displayName: "my_compute_pool",
            environment: {
                id: "env-xyz456",
            },
        });
        return {
            exampleUsingId: exampleUsingId,
            exampleUsingName: exampleUsingName,
        };
    }
    
    import pulumi
    import pulumi_confluentcloud as confluentcloud
    
    example_using_id = confluentcloud.get_flink_compute_pool(id="lfcp-abc123",
        environment=confluentcloud.GetFlinkComputePoolEnvironmentArgs(
            id="env-xyz456",
        ))
    pulumi.export("exampleUsingId", example_using_id)
    example_using_name = confluentcloud.get_flink_compute_pool(display_name="my_compute_pool",
        environment=confluentcloud.GetFlinkComputePoolEnvironmentArgs(
            id="env-xyz456",
        ))
    pulumi.export("exampleUsingName", example_using_name)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-confluentcloud/sdk/go/confluentcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleUsingId, err := confluentcloud.LookupFlinkComputePool(ctx, &confluentcloud.LookupFlinkComputePoolArgs{
    			Id: pulumi.StringRef("lfcp-abc123"),
    			Environment: confluentcloud.GetFlinkComputePoolEnvironment{
    				Id: "env-xyz456",
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("exampleUsingId", exampleUsingId)
    		exampleUsingName, err := confluentcloud.LookupFlinkComputePool(ctx, &confluentcloud.LookupFlinkComputePoolArgs{
    			DisplayName: pulumi.StringRef("my_compute_pool"),
    			Environment: confluentcloud.GetFlinkComputePoolEnvironment{
    				Id: "env-xyz456",
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("exampleUsingName", exampleUsingName)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using ConfluentCloud = Pulumi.ConfluentCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleUsingId = ConfluentCloud.GetFlinkComputePool.Invoke(new()
        {
            Id = "lfcp-abc123",
            Environment = new ConfluentCloud.Inputs.GetFlinkComputePoolEnvironmentInputArgs
            {
                Id = "env-xyz456",
            },
        });
    
        var exampleUsingName = ConfluentCloud.GetFlinkComputePool.Invoke(new()
        {
            DisplayName = "my_compute_pool",
            Environment = new ConfluentCloud.Inputs.GetFlinkComputePoolEnvironmentInputArgs
            {
                Id = "env-xyz456",
            },
        });
    
        return new Dictionary<string, object?>
        {
            ["exampleUsingId"] = exampleUsingId,
            ["exampleUsingName"] = exampleUsingName,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.confluentcloud.ConfluentcloudFunctions;
    import com.pulumi.confluentcloud.inputs.GetFlinkComputePoolArgs;
    import com.pulumi.confluentcloud.inputs.GetFlinkComputePoolEnvironmentArgs;
    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 exampleUsingId = ConfluentcloudFunctions.getFlinkComputePool(GetFlinkComputePoolArgs.builder()
                .id("lfcp-abc123")
                .environment(GetFlinkComputePoolEnvironmentArgs.builder()
                    .id("env-xyz456")
                    .build())
                .build());
    
            ctx.export("exampleUsingId", exampleUsingId.applyValue(getFlinkComputePoolResult -> getFlinkComputePoolResult));
            final var exampleUsingName = ConfluentcloudFunctions.getFlinkComputePool(GetFlinkComputePoolArgs.builder()
                .displayName("my_compute_pool")
                .environment(GetFlinkComputePoolEnvironmentArgs.builder()
                    .id("env-xyz456")
                    .build())
                .build());
    
            ctx.export("exampleUsingName", exampleUsingName.applyValue(getFlinkComputePoolResult -> getFlinkComputePoolResult));
        }
    }
    
    variables:
      exampleUsingId:
        fn::invoke:
          Function: confluentcloud:getFlinkComputePool
          Arguments:
            id: lfcp-abc123
            environment:
              id: env-xyz456
      exampleUsingName:
        fn::invoke:
          Function: confluentcloud:getFlinkComputePool
          Arguments:
            displayName: my_compute_pool
            environment:
              id: env-xyz456
    outputs:
      exampleUsingId: ${exampleUsingId}
      exampleUsingName: ${exampleUsingName}
    

    Using getFlinkComputePool

    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 getFlinkComputePool(args: GetFlinkComputePoolArgs, opts?: InvokeOptions): Promise<GetFlinkComputePoolResult>
    function getFlinkComputePoolOutput(args: GetFlinkComputePoolOutputArgs, opts?: InvokeOptions): Output<GetFlinkComputePoolResult>
    def get_flink_compute_pool(display_name: Optional[str] = None,
                               environment: Optional[GetFlinkComputePoolEnvironment] = None,
                               id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetFlinkComputePoolResult
    def get_flink_compute_pool_output(display_name: Optional[pulumi.Input[str]] = None,
                               environment: Optional[pulumi.Input[GetFlinkComputePoolEnvironmentArgs]] = None,
                               id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetFlinkComputePoolResult]
    func LookupFlinkComputePool(ctx *Context, args *LookupFlinkComputePoolArgs, opts ...InvokeOption) (*LookupFlinkComputePoolResult, error)
    func LookupFlinkComputePoolOutput(ctx *Context, args *LookupFlinkComputePoolOutputArgs, opts ...InvokeOption) LookupFlinkComputePoolResultOutput

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

    public static class GetFlinkComputePool 
    {
        public static Task<GetFlinkComputePoolResult> InvokeAsync(GetFlinkComputePoolArgs args, InvokeOptions? opts = null)
        public static Output<GetFlinkComputePoolResult> Invoke(GetFlinkComputePoolInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFlinkComputePoolResult> getFlinkComputePool(GetFlinkComputePoolArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: confluentcloud:index/getFlinkComputePool:getFlinkComputePool
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Environment Pulumi.ConfluentCloud.Inputs.GetFlinkComputePoolEnvironment
    (Required Configuration Block) supports the following:
    DisplayName string
    A human-readable name for the Flink Compute Pool.
    Id string
    The ID of the Flink Compute Pool, for example, lfcp-abc123.
    Environment GetFlinkComputePoolEnvironment
    (Required Configuration Block) supports the following:
    DisplayName string
    A human-readable name for the Flink Compute Pool.
    Id string
    The ID of the Flink Compute Pool, for example, lfcp-abc123.
    environment GetFlinkComputePoolEnvironment
    (Required Configuration Block) supports the following:
    displayName String
    A human-readable name for the Flink Compute Pool.
    id String
    The ID of the Flink Compute Pool, for example, lfcp-abc123.
    environment GetFlinkComputePoolEnvironment
    (Required Configuration Block) supports the following:
    displayName string
    A human-readable name for the Flink Compute Pool.
    id string
    The ID of the Flink Compute Pool, for example, lfcp-abc123.
    environment GetFlinkComputePoolEnvironment
    (Required Configuration Block) supports the following:
    display_name str
    A human-readable name for the Flink Compute Pool.
    id str
    The ID of the Flink Compute Pool, for example, lfcp-abc123.
    environment Property Map
    (Required Configuration Block) supports the following:
    displayName String
    A human-readable name for the Flink Compute Pool.
    id String
    The ID of the Flink Compute Pool, for example, lfcp-abc123.

    getFlinkComputePool Result

    The following output properties are available:

    ApiVersion string
    (Required String) The API Version of the schema version of the Flink Compute Pool, for example, fcpm/v2.
    Cloud string
    (Required String) The cloud service provider that runs the Flink Compute Pool.
    DisplayName string
    (Required String) The name of the Flink Compute Pool.
    Environment Pulumi.ConfluentCloud.Outputs.GetFlinkComputePoolEnvironment
    (Required Configuration Block) supports the following:
    Id string
    (Required String) The ID of the Environment that the Flink Compute Pool belongs to, for example, env-abc123.
    Kind string
    (Required String) The kind of the Flink Compute Pool, for example, ComputePool.
    MaxCfu int
    (Required Integer) Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to.
    Region string
    (Required String) The cloud service provider region that hosts the Flink Compute Pool.
    ResourceName string
    (Required String) The Confluent Resource Name of the Flink Compute Pool.
    ApiVersion string
    (Required String) The API Version of the schema version of the Flink Compute Pool, for example, fcpm/v2.
    Cloud string
    (Required String) The cloud service provider that runs the Flink Compute Pool.
    DisplayName string
    (Required String) The name of the Flink Compute Pool.
    Environment GetFlinkComputePoolEnvironment
    (Required Configuration Block) supports the following:
    Id string
    (Required String) The ID of the Environment that the Flink Compute Pool belongs to, for example, env-abc123.
    Kind string
    (Required String) The kind of the Flink Compute Pool, for example, ComputePool.
    MaxCfu int
    (Required Integer) Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to.
    Region string
    (Required String) The cloud service provider region that hosts the Flink Compute Pool.
    ResourceName string
    (Required String) The Confluent Resource Name of the Flink Compute Pool.
    apiVersion String
    (Required String) The API Version of the schema version of the Flink Compute Pool, for example, fcpm/v2.
    cloud String
    (Required String) The cloud service provider that runs the Flink Compute Pool.
    displayName String
    (Required String) The name of the Flink Compute Pool.
    environment GetFlinkComputePoolEnvironment
    (Required Configuration Block) supports the following:
    id String
    (Required String) The ID of the Environment that the Flink Compute Pool belongs to, for example, env-abc123.
    kind String
    (Required String) The kind of the Flink Compute Pool, for example, ComputePool.
    maxCfu Integer
    (Required Integer) Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to.
    region String
    (Required String) The cloud service provider region that hosts the Flink Compute Pool.
    resourceName String
    (Required String) The Confluent Resource Name of the Flink Compute Pool.
    apiVersion string
    (Required String) The API Version of the schema version of the Flink Compute Pool, for example, fcpm/v2.
    cloud string
    (Required String) The cloud service provider that runs the Flink Compute Pool.
    displayName string
    (Required String) The name of the Flink Compute Pool.
    environment GetFlinkComputePoolEnvironment
    (Required Configuration Block) supports the following:
    id string
    (Required String) The ID of the Environment that the Flink Compute Pool belongs to, for example, env-abc123.
    kind string
    (Required String) The kind of the Flink Compute Pool, for example, ComputePool.
    maxCfu number
    (Required Integer) Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to.
    region string
    (Required String) The cloud service provider region that hosts the Flink Compute Pool.
    resourceName string
    (Required String) The Confluent Resource Name of the Flink Compute Pool.
    api_version str
    (Required String) The API Version of the schema version of the Flink Compute Pool, for example, fcpm/v2.
    cloud str
    (Required String) The cloud service provider that runs the Flink Compute Pool.
    display_name str
    (Required String) The name of the Flink Compute Pool.
    environment GetFlinkComputePoolEnvironment
    (Required Configuration Block) supports the following:
    id str
    (Required String) The ID of the Environment that the Flink Compute Pool belongs to, for example, env-abc123.
    kind str
    (Required String) The kind of the Flink Compute Pool, for example, ComputePool.
    max_cfu int
    (Required Integer) Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to.
    region str
    (Required String) The cloud service provider region that hosts the Flink Compute Pool.
    resource_name str
    (Required String) The Confluent Resource Name of the Flink Compute Pool.
    apiVersion String
    (Required String) The API Version of the schema version of the Flink Compute Pool, for example, fcpm/v2.
    cloud String
    (Required String) The cloud service provider that runs the Flink Compute Pool.
    displayName String
    (Required String) The name of the Flink Compute Pool.
    environment Property Map
    (Required Configuration Block) supports the following:
    id String
    (Required String) The ID of the Environment that the Flink Compute Pool belongs to, for example, env-abc123.
    kind String
    (Required String) The kind of the Flink Compute Pool, for example, ComputePool.
    maxCfu Number
    (Required Integer) Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to.
    region String
    (Required String) The cloud service provider region that hosts the Flink Compute Pool.
    resourceName String
    (Required String) The Confluent Resource Name of the Flink Compute Pool.

    Supporting Types

    GetFlinkComputePoolEnvironment

    Id string

    The ID of the Environment that the Flink Compute Pool belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    Id string

    The ID of the Environment that the Flink Compute Pool belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    id String

    The ID of the Environment that the Flink Compute Pool belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    id string

    The ID of the Environment that the Flink Compute Pool belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    id str

    The ID of the Environment that the Flink Compute Pool belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    id String

    The ID of the Environment that the Flink Compute Pool belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    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 v1.46.0 published on Friday, May 10, 2024 by Pulumi