1. Packages
  2. Confluent Provider
  3. API Docs
  4. getFlinkArtifact
Confluent v2.10.0 published on Wednesday, Nov 20, 2024 by Pulumi

confluentcloud.getFlinkArtifact

Explore with Pulumi AI

confluentcloud logo
Confluent v2.10.0 published on Wednesday, Nov 20, 2024 by Pulumi

    General Availability

    confluentcloud.FlinkArtifact describes a Flink Artifact data source.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as confluentcloud from "@pulumi/confluentcloud";
    
    export = async () => {
        const exampleUsingId = await confluentcloud.getFlinkArtifact({
            id: "lfa-abc123",
            environment: {
                id: "env-xyz456",
            },
        });
        const exampleUsingName = await confluentcloud.getFlinkArtifact({
            displayName: "my_artifact",
            environment: {
                id: "env-xyz456",
            },
        });
        return {
            exampleUsingId: exampleUsingId,
            exampleUsingName: exampleUsingName,
        };
    }
    
    import pulumi
    import pulumi_confluentcloud as confluentcloud
    
    example_using_id = confluentcloud.get_flink_artifact(id="lfa-abc123",
        environment={
            "id": "env-xyz456",
        })
    pulumi.export("exampleUsingId", example_using_id)
    example_using_name = confluentcloud.get_flink_artifact(display_name="my_artifact",
        environment={
            "id": "env-xyz456",
        })
    pulumi.export("exampleUsingName", example_using_name)
    
    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 {
    		exampleUsingId, err := confluentcloud.LookupFlinkArtifact(ctx, &confluentcloud.LookupFlinkArtifactArgs{
    			Id: pulumi.StringRef("lfa-abc123"),
    			Environment: confluentcloud.GetFlinkArtifactEnvironment{
    				Id: "env-xyz456",
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("exampleUsingId", exampleUsingId)
    		exampleUsingName, err := confluentcloud.LookupFlinkArtifact(ctx, &confluentcloud.LookupFlinkArtifactArgs{
    			DisplayName: pulumi.StringRef("my_artifact"),
    			Environment: confluentcloud.GetFlinkArtifactEnvironment{
    				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.GetFlinkArtifact.Invoke(new()
        {
            Id = "lfa-abc123",
            Environment = new ConfluentCloud.Inputs.GetFlinkArtifactEnvironmentInputArgs
            {
                Id = "env-xyz456",
            },
        });
    
        var exampleUsingName = ConfluentCloud.GetFlinkArtifact.Invoke(new()
        {
            DisplayName = "my_artifact",
            Environment = new ConfluentCloud.Inputs.GetFlinkArtifactEnvironmentInputArgs
            {
                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.GetFlinkArtifactArgs;
    import com.pulumi.confluentcloud.inputs.GetFlinkArtifactEnvironmentArgs;
    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.getFlinkArtifact(GetFlinkArtifactArgs.builder()
                .id("lfa-abc123")
                .environment(GetFlinkArtifactEnvironmentArgs.builder()
                    .id("env-xyz456")
                    .build())
                .build());
    
            ctx.export("exampleUsingId", exampleUsingId.applyValue(getFlinkArtifactResult -> getFlinkArtifactResult));
            final var exampleUsingName = ConfluentcloudFunctions.getFlinkArtifact(GetFlinkArtifactArgs.builder()
                .displayName("my_artifact")
                .environment(GetFlinkArtifactEnvironmentArgs.builder()
                    .id("env-xyz456")
                    .build())
                .build());
    
            ctx.export("exampleUsingName", exampleUsingName.applyValue(getFlinkArtifactResult -> getFlinkArtifactResult));
        }
    }
    
    variables:
      exampleUsingId:
        fn::invoke:
          Function: confluentcloud:getFlinkArtifact
          Arguments:
            id: lfa-abc123
            environment:
              id: env-xyz456
      exampleUsingName:
        fn::invoke:
          Function: confluentcloud:getFlinkArtifact
          Arguments:
            displayName: my_artifact
            environment:
              id: env-xyz456
    outputs:
      exampleUsingId: ${exampleUsingId}
      exampleUsingName: ${exampleUsingName}
    

    Using getFlinkArtifact

    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 getFlinkArtifact(args: GetFlinkArtifactArgs, opts?: InvokeOptions): Promise<GetFlinkArtifactResult>
    function getFlinkArtifactOutput(args: GetFlinkArtifactOutputArgs, opts?: InvokeOptions): Output<GetFlinkArtifactResult>
    def get_flink_artifact(cloud: Optional[str] = None,
                           display_name: Optional[str] = None,
                           environment: Optional[GetFlinkArtifactEnvironment] = None,
                           id: Optional[str] = None,
                           region: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetFlinkArtifactResult
    def get_flink_artifact_output(cloud: Optional[pulumi.Input[str]] = None,
                           display_name: Optional[pulumi.Input[str]] = None,
                           environment: Optional[pulumi.Input[GetFlinkArtifactEnvironmentArgs]] = None,
                           id: Optional[pulumi.Input[str]] = None,
                           region: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetFlinkArtifactResult]
    func LookupFlinkArtifact(ctx *Context, args *LookupFlinkArtifactArgs, opts ...InvokeOption) (*LookupFlinkArtifactResult, error)
    func LookupFlinkArtifactOutput(ctx *Context, args *LookupFlinkArtifactOutputArgs, opts ...InvokeOption) LookupFlinkArtifactResultOutput

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

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

    The following arguments are supported:

    Cloud string
    The cloud service provider that hosts the region. Accepted values are: AWS, AZURE, and GCP.
    Environment Pulumi.ConfluentCloud.Inputs.GetFlinkArtifactEnvironment
    Region string

    The cloud service provider region, for example, us-east-1.

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

    DisplayName string
    A human-readable name for the Flink Artifact.
    Id string
    The ID of the Flink Artifact, for example, lfa-abc123.
    Cloud string
    The cloud service provider that hosts the region. Accepted values are: AWS, AZURE, and GCP.
    Environment GetFlinkArtifactEnvironment
    Region string

    The cloud service provider region, for example, us-east-1.

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

    DisplayName string
    A human-readable name for the Flink Artifact.
    Id string
    The ID of the Flink Artifact, for example, lfa-abc123.
    cloud String
    The cloud service provider that hosts the region. Accepted values are: AWS, AZURE, and GCP.
    environment GetFlinkArtifactEnvironment
    region String

    The cloud service provider region, for example, us-east-1.

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

    displayName String
    A human-readable name for the Flink Artifact.
    id String
    The ID of the Flink Artifact, for example, lfa-abc123.
    cloud string
    The cloud service provider that hosts the region. Accepted values are: AWS, AZURE, and GCP.
    environment GetFlinkArtifactEnvironment
    region string

    The cloud service provider region, for example, us-east-1.

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

    displayName string
    A human-readable name for the Flink Artifact.
    id string
    The ID of the Flink Artifact, for example, lfa-abc123.
    cloud str
    The cloud service provider that hosts the region. Accepted values are: AWS, AZURE, and GCP.
    environment GetFlinkArtifactEnvironment
    region str

    The cloud service provider region, for example, us-east-1.

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

    display_name str
    A human-readable name for the Flink Artifact.
    id str
    The ID of the Flink Artifact, for example, lfa-abc123.
    cloud String
    The cloud service provider that hosts the region. Accepted values are: AWS, AZURE, and GCP.
    environment Property Map
    region String

    The cloud service provider region, for example, us-east-1.

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

    displayName String
    A human-readable name for the Flink Artifact.
    id String
    The ID of the Flink Artifact, for example, lfa-abc123.

    getFlinkArtifact Result

    The following output properties are available:

    ApiVersion string
    (Required String) The API Version of the schema version of the Flink Artifact, for example, fa/v2.
    Class string
    (Required String) Java class or alias for the Flink Artifact as provided by developer.
    Cloud string
    ContentFormat string
    (Required String) Archive format of the Flink Artifact.
    Description string
    (Required String) Description of the Flink Artifact.
    DisplayName string
    Environment Pulumi.ConfluentCloud.Outputs.GetFlinkArtifactEnvironment
    Id string
    Kind string
    (Required String) The kind of the Flink Artifact, for example, FlinkArtifact.
    Region string
    RuntimeLanguage string
    (Required String) Runtime language of the Flink Artifact. The default runtime language is JAVA.
    Versions List<Pulumi.ConfluentCloud.Outputs.GetFlinkArtifactVersion>
    ApiVersion string
    (Required String) The API Version of the schema version of the Flink Artifact, for example, fa/v2.
    Class string
    (Required String) Java class or alias for the Flink Artifact as provided by developer.
    Cloud string
    ContentFormat string
    (Required String) Archive format of the Flink Artifact.
    Description string
    (Required String) Description of the Flink Artifact.
    DisplayName string
    Environment GetFlinkArtifactEnvironment
    Id string
    Kind string
    (Required String) The kind of the Flink Artifact, for example, FlinkArtifact.
    Region string
    RuntimeLanguage string
    (Required String) Runtime language of the Flink Artifact. The default runtime language is JAVA.
    Versions []GetFlinkArtifactVersion
    apiVersion String
    (Required String) The API Version of the schema version of the Flink Artifact, for example, fa/v2.
    class_ String
    (Required String) Java class or alias for the Flink Artifact as provided by developer.
    cloud String
    contentFormat String
    (Required String) Archive format of the Flink Artifact.
    description String
    (Required String) Description of the Flink Artifact.
    displayName String
    environment GetFlinkArtifactEnvironment
    id String
    kind String
    (Required String) The kind of the Flink Artifact, for example, FlinkArtifact.
    region String
    runtimeLanguage String
    (Required String) Runtime language of the Flink Artifact. The default runtime language is JAVA.
    versions List<GetFlinkArtifactVersion>
    apiVersion string
    (Required String) The API Version of the schema version of the Flink Artifact, for example, fa/v2.
    class string
    (Required String) Java class or alias for the Flink Artifact as provided by developer.
    cloud string
    contentFormat string
    (Required String) Archive format of the Flink Artifact.
    description string
    (Required String) Description of the Flink Artifact.
    displayName string
    environment GetFlinkArtifactEnvironment
    id string
    kind string
    (Required String) The kind of the Flink Artifact, for example, FlinkArtifact.
    region string
    runtimeLanguage string
    (Required String) Runtime language of the Flink Artifact. The default runtime language is JAVA.
    versions GetFlinkArtifactVersion[]
    api_version str
    (Required String) The API Version of the schema version of the Flink Artifact, for example, fa/v2.
    class_ str
    (Required String) Java class or alias for the Flink Artifact as provided by developer.
    cloud str
    content_format str
    (Required String) Archive format of the Flink Artifact.
    description str
    (Required String) Description of the Flink Artifact.
    display_name str
    environment GetFlinkArtifactEnvironment
    id str
    kind str
    (Required String) The kind of the Flink Artifact, for example, FlinkArtifact.
    region str
    runtime_language str
    (Required String) Runtime language of the Flink Artifact. The default runtime language is JAVA.
    versions Sequence[GetFlinkArtifactVersion]
    apiVersion String
    (Required String) The API Version of the schema version of the Flink Artifact, for example, fa/v2.
    class String
    (Required String) Java class or alias for the Flink Artifact as provided by developer.
    cloud String
    contentFormat String
    (Required String) Archive format of the Flink Artifact.
    description String
    (Required String) Description of the Flink Artifact.
    displayName String
    environment Property Map
    id String
    kind String
    (Required String) The kind of the Flink Artifact, for example, FlinkArtifact.
    region String
    runtimeLanguage String
    (Required String) Runtime language of the Flink Artifact. The default runtime language is JAVA.
    versions List<Property Map>

    Supporting Types

    GetFlinkArtifactEnvironment

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

    GetFlinkArtifactVersion

    Version string
    The version of this Flink Artifact.
    Version string
    The version of this Flink Artifact.
    version String
    The version of this Flink Artifact.
    version string
    The version of this Flink Artifact.
    version str
    The version of this Flink Artifact.
    version String
    The version of this Flink Artifact.

    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.10.0 published on Wednesday, Nov 20, 2024 by Pulumi