1. Packages
  2. Confluent Cloud
  3. API Docs
  4. FlinkComputePool
Confluent v1.42.0 published on Friday, Apr 19, 2024 by Pulumi

confluentcloud.FlinkComputePool

Explore with Pulumi AI

confluentcloud logo
Confluent v1.42.0 published on Friday, Apr 19, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as confluentcloud from "@pulumi/confluentcloud";
    
    const development = new confluentcloud.Environment("development", {displayName: "Development"});
    const main = new confluentcloud.FlinkComputePool("main", {
        displayName: "standard_compute_pool",
        cloud: "AWS",
        region: "us-east-1",
        maxCfu: 5,
        environment: {
            id: development.id,
        },
    });
    
    import pulumi
    import pulumi_confluentcloud as confluentcloud
    
    development = confluentcloud.Environment("development", display_name="Development")
    main = confluentcloud.FlinkComputePool("main",
        display_name="standard_compute_pool",
        cloud="AWS",
        region="us-east-1",
        max_cfu=5,
        environment=confluentcloud.FlinkComputePoolEnvironmentArgs(
            id=development.id,
        ))
    
    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 {
    		development, err := confluentcloud.NewEnvironment(ctx, "development", &confluentcloud.EnvironmentArgs{
    			DisplayName: pulumi.String("Development"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = confluentcloud.NewFlinkComputePool(ctx, "main", &confluentcloud.FlinkComputePoolArgs{
    			DisplayName: pulumi.String("standard_compute_pool"),
    			Cloud:       pulumi.String("AWS"),
    			Region:      pulumi.String("us-east-1"),
    			MaxCfu:      pulumi.Int(5),
    			Environment: &confluentcloud.FlinkComputePoolEnvironmentArgs{
    				Id: development.ID(),
    			},
    		})
    		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 development = new ConfluentCloud.Environment("development", new()
        {
            DisplayName = "Development",
        });
    
        var main = new ConfluentCloud.FlinkComputePool("main", new()
        {
            DisplayName = "standard_compute_pool",
            Cloud = "AWS",
            Region = "us-east-1",
            MaxCfu = 5,
            Environment = new ConfluentCloud.Inputs.FlinkComputePoolEnvironmentArgs
            {
                Id = development.Id,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.confluentcloud.Environment;
    import com.pulumi.confluentcloud.EnvironmentArgs;
    import com.pulumi.confluentcloud.FlinkComputePool;
    import com.pulumi.confluentcloud.FlinkComputePoolArgs;
    import com.pulumi.confluentcloud.inputs.FlinkComputePoolEnvironmentArgs;
    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 development = new Environment("development", EnvironmentArgs.builder()        
                .displayName("Development")
                .build());
    
            var main = new FlinkComputePool("main", FlinkComputePoolArgs.builder()        
                .displayName("standard_compute_pool")
                .cloud("AWS")
                .region("us-east-1")
                .maxCfu(5)
                .environment(FlinkComputePoolEnvironmentArgs.builder()
                    .id(development.id())
                    .build())
                .build());
    
        }
    }
    
    resources:
      development:
        type: confluentcloud:Environment
        properties:
          displayName: Development
      main:
        type: confluentcloud:FlinkComputePool
        properties:
          displayName: standard_compute_pool
          cloud: AWS
          region: us-east-1
          maxCfu: 5
          environment:
            id: ${development.id}
    

    Create FlinkComputePool Resource

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

    Constructor syntax

    new FlinkComputePool(name: string, args: FlinkComputePoolArgs, opts?: CustomResourceOptions);
    @overload
    def FlinkComputePool(resource_name: str,
                         args: FlinkComputePoolArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def FlinkComputePool(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         cloud: Optional[str] = None,
                         display_name: Optional[str] = None,
                         environment: Optional[FlinkComputePoolEnvironmentArgs] = None,
                         region: Optional[str] = None,
                         max_cfu: Optional[int] = None)
    func NewFlinkComputePool(ctx *Context, name string, args FlinkComputePoolArgs, opts ...ResourceOption) (*FlinkComputePool, error)
    public FlinkComputePool(string name, FlinkComputePoolArgs args, CustomResourceOptions? opts = null)
    public FlinkComputePool(String name, FlinkComputePoolArgs args)
    public FlinkComputePool(String name, FlinkComputePoolArgs args, CustomResourceOptions options)
    
    type: confluentcloud:FlinkComputePool
    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 FlinkComputePoolArgs
    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 FlinkComputePoolArgs
    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 FlinkComputePoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FlinkComputePoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FlinkComputePoolArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var flinkComputePoolResource = new ConfluentCloud.FlinkComputePool("flinkComputePoolResource", new()
    {
        Cloud = "string",
        DisplayName = "string",
        Environment = new ConfluentCloud.Inputs.FlinkComputePoolEnvironmentArgs
        {
            Id = "string",
        },
        Region = "string",
        MaxCfu = 0,
    });
    
    example, err := confluentcloud.NewFlinkComputePool(ctx, "flinkComputePoolResource", &confluentcloud.FlinkComputePoolArgs{
    	Cloud:       pulumi.String("string"),
    	DisplayName: pulumi.String("string"),
    	Environment: &confluentcloud.FlinkComputePoolEnvironmentArgs{
    		Id: pulumi.String("string"),
    	},
    	Region: pulumi.String("string"),
    	MaxCfu: pulumi.Int(0),
    })
    
    var flinkComputePoolResource = new FlinkComputePool("flinkComputePoolResource", FlinkComputePoolArgs.builder()        
        .cloud("string")
        .displayName("string")
        .environment(FlinkComputePoolEnvironmentArgs.builder()
            .id("string")
            .build())
        .region("string")
        .maxCfu(0)
        .build());
    
    flink_compute_pool_resource = confluentcloud.FlinkComputePool("flinkComputePoolResource",
        cloud="string",
        display_name="string",
        environment=confluentcloud.FlinkComputePoolEnvironmentArgs(
            id="string",
        ),
        region="string",
        max_cfu=0)
    
    const flinkComputePoolResource = new confluentcloud.FlinkComputePool("flinkComputePoolResource", {
        cloud: "string",
        displayName: "string",
        environment: {
            id: "string",
        },
        region: "string",
        maxCfu: 0,
    });
    
    type: confluentcloud:FlinkComputePool
    properties:
        cloud: string
        displayName: string
        environment:
            id: string
        maxCfu: 0
        region: string
    

    FlinkComputePool Resource Properties

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

    Inputs

    The FlinkComputePool resource accepts the following input properties:

    Cloud string
    The cloud service provider that runs the Flink Compute Pool.
    DisplayName string
    The name of the Flink Compute Pool.
    Environment Pulumi.ConfluentCloud.Inputs.FlinkComputePoolEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Region string
    The cloud service provider region that hosts the Flink Compute Pool.
    MaxCfu int
    Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to. The accepted values are: 5, 10, 20, 30, 40 and 50.
    Cloud string
    The cloud service provider that runs the Flink Compute Pool.
    DisplayName string
    The name of the Flink Compute Pool.
    Environment FlinkComputePoolEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Region string
    The cloud service provider region that hosts the Flink Compute Pool.
    MaxCfu int
    Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to. The accepted values are: 5, 10, 20, 30, 40 and 50.
    cloud String
    The cloud service provider that runs the Flink Compute Pool.
    displayName String
    The name of the Flink Compute Pool.
    environment FlinkComputePoolEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    region String
    The cloud service provider region that hosts the Flink Compute Pool.
    maxCfu Integer
    Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to. The accepted values are: 5, 10, 20, 30, 40 and 50.
    cloud string
    The cloud service provider that runs the Flink Compute Pool.
    displayName string
    The name of the Flink Compute Pool.
    environment FlinkComputePoolEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    region string
    The cloud service provider region that hosts the Flink Compute Pool.
    maxCfu number
    Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to. The accepted values are: 5, 10, 20, 30, 40 and 50.
    cloud str
    The cloud service provider that runs the Flink Compute Pool.
    display_name str
    The name of the Flink Compute Pool.
    environment FlinkComputePoolEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    region str
    The cloud service provider region that hosts the Flink Compute Pool.
    max_cfu int
    Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to. The accepted values are: 5, 10, 20, 30, 40 and 50.
    cloud String
    The cloud service provider that runs the Flink Compute Pool.
    displayName String
    The name of the Flink Compute Pool.
    environment Property Map
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    region String
    The cloud service provider region that hosts the Flink Compute Pool.
    maxCfu Number
    Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to. The accepted values are: 5, 10, 20, 30, 40 and 50.

    Outputs

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

    ApiVersion string
    (Required String) The API Version of the schema version of the Flink Compute Pool, for example, fcpm/v2.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    (Required String) The kind of the Flink Compute Pool, for example, ComputePool.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Kind string
    (Required String) The kind of the Flink Compute Pool, for example, ComputePool.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    (Required String) The kind of the Flink Compute Pool, for example, ComputePool.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    kind string
    (Required String) The kind of the Flink Compute Pool, for example, ComputePool.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    kind str
    (Required String) The kind of the Flink Compute Pool, for example, ComputePool.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    kind String
    (Required String) The kind of the Flink Compute Pool, for example, ComputePool.
    resourceName String
    (Required String) The Confluent Resource Name of the Flink Compute Pool.

    Look up Existing FlinkComputePool Resource

    Get an existing FlinkComputePool 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?: FlinkComputePoolState, opts?: CustomResourceOptions): FlinkComputePool
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_version: Optional[str] = None,
            cloud: Optional[str] = None,
            display_name: Optional[str] = None,
            environment: Optional[FlinkComputePoolEnvironmentArgs] = None,
            kind: Optional[str] = None,
            max_cfu: Optional[int] = None,
            region: Optional[str] = None,
            resource_name: Optional[str] = None) -> FlinkComputePool
    func GetFlinkComputePool(ctx *Context, name string, id IDInput, state *FlinkComputePoolState, opts ...ResourceOption) (*FlinkComputePool, error)
    public static FlinkComputePool Get(string name, Input<string> id, FlinkComputePoolState? state, CustomResourceOptions? opts = null)
    public static FlinkComputePool get(String name, Output<String> id, FlinkComputePoolState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    ApiVersion string
    (Required String) The API Version of the schema version of the Flink Compute Pool, for example, fcpm/v2.
    Cloud string
    The cloud service provider that runs the Flink Compute Pool.
    DisplayName string
    The name of the Flink Compute Pool.
    Environment Pulumi.ConfluentCloud.Inputs.FlinkComputePoolEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Kind string
    (Required String) The kind of the Flink Compute Pool, for example, ComputePool.
    MaxCfu int
    Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to. The accepted values are: 5, 10, 20, 30, 40 and 50.
    Region 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
    The cloud service provider that runs the Flink Compute Pool.
    DisplayName string
    The name of the Flink Compute Pool.
    Environment FlinkComputePoolEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Kind string
    (Required String) The kind of the Flink Compute Pool, for example, ComputePool.
    MaxCfu int
    Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to. The accepted values are: 5, 10, 20, 30, 40 and 50.
    Region 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
    The cloud service provider that runs the Flink Compute Pool.
    displayName String
    The name of the Flink Compute Pool.
    environment FlinkComputePoolEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    kind String
    (Required String) The kind of the Flink Compute Pool, for example, ComputePool.
    maxCfu Integer
    Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to. The accepted values are: 5, 10, 20, 30, 40 and 50.
    region 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
    The cloud service provider that runs the Flink Compute Pool.
    displayName string
    The name of the Flink Compute Pool.
    environment FlinkComputePoolEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    kind string
    (Required String) The kind of the Flink Compute Pool, for example, ComputePool.
    maxCfu number
    Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to. The accepted values are: 5, 10, 20, 30, 40 and 50.
    region 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
    The cloud service provider that runs the Flink Compute Pool.
    display_name str
    The name of the Flink Compute Pool.
    environment FlinkComputePoolEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    kind str
    (Required String) The kind of the Flink Compute Pool, for example, ComputePool.
    max_cfu int
    Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to. The accepted values are: 5, 10, 20, 30, 40 and 50.
    region str
    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
    The cloud service provider that runs the Flink Compute Pool.
    displayName String
    The name of the Flink Compute Pool.
    environment Property Map
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    kind String
    (Required String) The kind of the Flink Compute Pool, for example, ComputePool.
    maxCfu Number
    Maximum number of Confluent Flink Units (CFUs) that the Flink compute pool should auto-scale to. The accepted values are: 5, 10, 20, 30, 40 and 50.
    region 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

    FlinkComputePoolEnvironment, FlinkComputePoolEnvironmentArgs

    Id string
    The ID of the Environment that the Flink Compute Pool belongs to, for example, env-abc123.
    Id string
    The ID of the Environment that the Flink Compute Pool belongs to, for example, env-abc123.
    id String
    The ID of the Environment that the Flink Compute Pool belongs to, for example, env-abc123.
    id string
    The ID of the Environment that the Flink Compute Pool belongs to, for example, env-abc123.
    id str
    The ID of the Environment that the Flink Compute Pool belongs to, for example, env-abc123.
    id String
    The ID of the Environment that the Flink Compute Pool belongs to, for example, env-abc123.

    Import

    You can import a Flink Compute Pool by using Environment ID and Flink Compute Pool ID, in the format <Environment ID>/<Flink Compute Pool ID>. The following example shows how to import a Flink Compute Pool:

    $ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"

    $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

    $ pulumi import confluentcloud:index/flinkComputePool:FlinkComputePool main env-abc123/lfcp-abc123
    

    !> 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
    Confluent v1.42.0 published on Friday, Apr 19, 2024 by Pulumi