1. Packages
  2. Confluent Provider
  3. API Docs
  4. ConnectArtifact
Confluent v2.31.0 published on Friday, Jun 13, 2025 by Pulumi

confluentcloud.ConnectArtifact

Explore with Pulumi AI

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as confluentcloud from "@pulumi/confluentcloud";
    
    const example = new confluentcloud.ConnectArtifact("example", {
        displayName: "example-connect-artifact",
        cloud: "AWS",
        environment: {
            id: "env-123456",
        },
        contentFormat: "JAR",
        artifactFile: "path/to/your/artifact.jar",
        description: "Example Connect Artifact",
    });
    
    import pulumi
    import pulumi_confluentcloud as confluentcloud
    
    example = confluentcloud.ConnectArtifact("example",
        display_name="example-connect-artifact",
        cloud="AWS",
        environment={
            "id": "env-123456",
        },
        content_format="JAR",
        artifact_file="path/to/your/artifact.jar",
        description="Example Connect Artifact")
    
    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.NewConnectArtifact(ctx, "example", &confluentcloud.ConnectArtifactArgs{
    			DisplayName: pulumi.String("example-connect-artifact"),
    			Cloud:       pulumi.String("AWS"),
    			Environment: &confluentcloud.ConnectArtifactEnvironmentArgs{
    				Id: pulumi.String("env-123456"),
    			},
    			ContentFormat: pulumi.String("JAR"),
    			ArtifactFile:  pulumi.String("path/to/your/artifact.jar"),
    			Description:   pulumi.String("Example Connect Artifact"),
    		})
    		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.ConnectArtifact("example", new()
        {
            DisplayName = "example-connect-artifact",
            Cloud = "AWS",
            Environment = new ConfluentCloud.Inputs.ConnectArtifactEnvironmentArgs
            {
                Id = "env-123456",
            },
            ContentFormat = "JAR",
            ArtifactFile = "path/to/your/artifact.jar",
            Description = "Example Connect Artifact",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.confluentcloud.ConnectArtifact;
    import com.pulumi.confluentcloud.ConnectArtifactArgs;
    import com.pulumi.confluentcloud.inputs.ConnectArtifactEnvironmentArgs;
    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 ConnectArtifact("example", ConnectArtifactArgs.builder()
                .displayName("example-connect-artifact")
                .cloud("AWS")
                .environment(ConnectArtifactEnvironmentArgs.builder()
                    .id("env-123456")
                    .build())
                .contentFormat("JAR")
                .artifactFile("path/to/your/artifact.jar")
                .description("Example Connect Artifact")
                .build());
    
        }
    }
    
    resources:
      example:
        type: confluentcloud:ConnectArtifact
        properties:
          displayName: example-connect-artifact
          cloud: AWS
          environment:
            id: env-123456
          contentFormat: JAR
          artifactFile: path/to/your/artifact.jar
          description: Example Connect Artifact
    

    Create ConnectArtifact Resource

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

    Constructor syntax

    new ConnectArtifact(name: string, args: ConnectArtifactArgs, opts?: CustomResourceOptions);
    @overload
    def ConnectArtifact(resource_name: str,
                        args: ConnectArtifactArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def ConnectArtifact(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        cloud: Optional[str] = None,
                        content_format: Optional[str] = None,
                        display_name: Optional[str] = None,
                        environment: Optional[ConnectArtifactEnvironmentArgs] = None,
                        artifact_file: Optional[str] = None,
                        description: Optional[str] = None)
    func NewConnectArtifact(ctx *Context, name string, args ConnectArtifactArgs, opts ...ResourceOption) (*ConnectArtifact, error)
    public ConnectArtifact(string name, ConnectArtifactArgs args, CustomResourceOptions? opts = null)
    public ConnectArtifact(String name, ConnectArtifactArgs args)
    public ConnectArtifact(String name, ConnectArtifactArgs args, CustomResourceOptions options)
    
    type: confluentcloud:ConnectArtifact
    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 ConnectArtifactArgs
    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 ConnectArtifactArgs
    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 ConnectArtifactArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectArtifactArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectArtifactArgs
    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 connectArtifactResource = new ConfluentCloud.ConnectArtifact("connectArtifactResource", new()
    {
        Cloud = "string",
        ContentFormat = "string",
        DisplayName = "string",
        Environment = new ConfluentCloud.Inputs.ConnectArtifactEnvironmentArgs
        {
            Id = "string",
        },
        ArtifactFile = "string",
        Description = "string",
    });
    
    example, err := confluentcloud.NewConnectArtifact(ctx, "connectArtifactResource", &confluentcloud.ConnectArtifactArgs{
    	Cloud:         pulumi.String("string"),
    	ContentFormat: pulumi.String("string"),
    	DisplayName:   pulumi.String("string"),
    	Environment: &confluentcloud.ConnectArtifactEnvironmentArgs{
    		Id: pulumi.String("string"),
    	},
    	ArtifactFile: pulumi.String("string"),
    	Description:  pulumi.String("string"),
    })
    
    var connectArtifactResource = new ConnectArtifact("connectArtifactResource", ConnectArtifactArgs.builder()
        .cloud("string")
        .contentFormat("string")
        .displayName("string")
        .environment(ConnectArtifactEnvironmentArgs.builder()
            .id("string")
            .build())
        .artifactFile("string")
        .description("string")
        .build());
    
    connect_artifact_resource = confluentcloud.ConnectArtifact("connectArtifactResource",
        cloud="string",
        content_format="string",
        display_name="string",
        environment={
            "id": "string",
        },
        artifact_file="string",
        description="string")
    
    const connectArtifactResource = new confluentcloud.ConnectArtifact("connectArtifactResource", {
        cloud: "string",
        contentFormat: "string",
        displayName: "string",
        environment: {
            id: "string",
        },
        artifactFile: "string",
        description: "string",
    });
    
    type: confluentcloud:ConnectArtifact
    properties:
        artifactFile: string
        cloud: string
        contentFormat: string
        description: string
        displayName: string
        environment:
            id: string
    

    ConnectArtifact 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 ConnectArtifact resource accepts the following input properties:

    Cloud string
    Cloud provider where the Connect Artifact archive is uploaded.
    ContentFormat string
    Archive format of the Connect Artifact. Supported formats are JAR and ZIP.
    DisplayName string
    The unique name of the Connect Artifact per cloud, environment scope.
    Environment Pulumi.ConfluentCloud.Inputs.ConnectArtifactEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    ArtifactFile string
    The artifact file for Connect Artifact in JAR or ZIP format. This can be relative or absolute path
    Description string
    Description of the Connect Artifact.
    Cloud string
    Cloud provider where the Connect Artifact archive is uploaded.
    ContentFormat string
    Archive format of the Connect Artifact. Supported formats are JAR and ZIP.
    DisplayName string
    The unique name of the Connect Artifact per cloud, environment scope.
    Environment ConnectArtifactEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    ArtifactFile string
    The artifact file for Connect Artifact in JAR or ZIP format. This can be relative or absolute path
    Description string
    Description of the Connect Artifact.
    cloud String
    Cloud provider where the Connect Artifact archive is uploaded.
    contentFormat String
    Archive format of the Connect Artifact. Supported formats are JAR and ZIP.
    displayName String
    The unique name of the Connect Artifact per cloud, environment scope.
    environment ConnectArtifactEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    artifactFile String
    The artifact file for Connect Artifact in JAR or ZIP format. This can be relative or absolute path
    description String
    Description of the Connect Artifact.
    cloud string
    Cloud provider where the Connect Artifact archive is uploaded.
    contentFormat string
    Archive format of the Connect Artifact. Supported formats are JAR and ZIP.
    displayName string
    The unique name of the Connect Artifact per cloud, environment scope.
    environment ConnectArtifactEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    artifactFile string
    The artifact file for Connect Artifact in JAR or ZIP format. This can be relative or absolute path
    description string
    Description of the Connect Artifact.
    cloud str
    Cloud provider where the Connect Artifact archive is uploaded.
    content_format str
    Archive format of the Connect Artifact. Supported formats are JAR and ZIP.
    display_name str
    The unique name of the Connect Artifact per cloud, environment scope.
    environment ConnectArtifactEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    artifact_file str
    The artifact file for Connect Artifact in JAR or ZIP format. This can be relative or absolute path
    description str
    Description of the Connect Artifact.
    cloud String
    Cloud provider where the Connect Artifact archive is uploaded.
    contentFormat String
    Archive format of the Connect Artifact. Supported formats are JAR and ZIP.
    displayName String
    The unique name of the Connect Artifact per cloud, environment scope.
    environment Property Map
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    artifactFile String
    The artifact file for Connect Artifact in JAR or ZIP format. This can be relative or absolute path
    description String
    Description of the Connect Artifact.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the Connect Artifact.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the Connect Artifact.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the Connect Artifact.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Status of the Connect Artifact.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Status of the Connect Artifact.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the Connect Artifact.

    Look up Existing ConnectArtifact Resource

    Get an existing ConnectArtifact 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?: ConnectArtifactState, opts?: CustomResourceOptions): ConnectArtifact
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            artifact_file: Optional[str] = None,
            cloud: Optional[str] = None,
            content_format: Optional[str] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            environment: Optional[ConnectArtifactEnvironmentArgs] = None,
            status: Optional[str] = None) -> ConnectArtifact
    func GetConnectArtifact(ctx *Context, name string, id IDInput, state *ConnectArtifactState, opts ...ResourceOption) (*ConnectArtifact, error)
    public static ConnectArtifact Get(string name, Input<string> id, ConnectArtifactState? state, CustomResourceOptions? opts = null)
    public static ConnectArtifact get(String name, Output<String> id, ConnectArtifactState state, CustomResourceOptions options)
    resources:  _:    type: confluentcloud:ConnectArtifact    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:
    ArtifactFile string
    The artifact file for Connect Artifact in JAR or ZIP format. This can be relative or absolute path
    Cloud string
    Cloud provider where the Connect Artifact archive is uploaded.
    ContentFormat string
    Archive format of the Connect Artifact. Supported formats are JAR and ZIP.
    Description string
    Description of the Connect Artifact.
    DisplayName string
    The unique name of the Connect Artifact per cloud, environment scope.
    Environment Pulumi.ConfluentCloud.Inputs.ConnectArtifactEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Status string
    Status of the Connect Artifact.
    ArtifactFile string
    The artifact file for Connect Artifact in JAR or ZIP format. This can be relative or absolute path
    Cloud string
    Cloud provider where the Connect Artifact archive is uploaded.
    ContentFormat string
    Archive format of the Connect Artifact. Supported formats are JAR and ZIP.
    Description string
    Description of the Connect Artifact.
    DisplayName string
    The unique name of the Connect Artifact per cloud, environment scope.
    Environment ConnectArtifactEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Status string
    Status of the Connect Artifact.
    artifactFile String
    The artifact file for Connect Artifact in JAR or ZIP format. This can be relative or absolute path
    cloud String
    Cloud provider where the Connect Artifact archive is uploaded.
    contentFormat String
    Archive format of the Connect Artifact. Supported formats are JAR and ZIP.
    description String
    Description of the Connect Artifact.
    displayName String
    The unique name of the Connect Artifact per cloud, environment scope.
    environment ConnectArtifactEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    status String
    Status of the Connect Artifact.
    artifactFile string
    The artifact file for Connect Artifact in JAR or ZIP format. This can be relative or absolute path
    cloud string
    Cloud provider where the Connect Artifact archive is uploaded.
    contentFormat string
    Archive format of the Connect Artifact. Supported formats are JAR and ZIP.
    description string
    Description of the Connect Artifact.
    displayName string
    The unique name of the Connect Artifact per cloud, environment scope.
    environment ConnectArtifactEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    status string
    Status of the Connect Artifact.
    artifact_file str
    The artifact file for Connect Artifact in JAR or ZIP format. This can be relative or absolute path
    cloud str
    Cloud provider where the Connect Artifact archive is uploaded.
    content_format str
    Archive format of the Connect Artifact. Supported formats are JAR and ZIP.
    description str
    Description of the Connect Artifact.
    display_name str
    The unique name of the Connect Artifact per cloud, environment scope.
    environment ConnectArtifactEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    status str
    Status of the Connect Artifact.
    artifactFile String
    The artifact file for Connect Artifact in JAR or ZIP format. This can be relative or absolute path
    cloud String
    Cloud provider where the Connect Artifact archive is uploaded.
    contentFormat String
    Archive format of the Connect Artifact. Supported formats are JAR and ZIP.
    description String
    Description of the Connect Artifact.
    displayName String
    The unique name of the Connect Artifact per cloud, environment scope.
    environment Property Map
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    status String
    Status of the Connect Artifact.

    Supporting Types

    ConnectArtifactEnvironment, ConnectArtifactEnvironmentArgs

    Id string
    The ID of the Environment that the Connect Artifact belongs to.
    Id string
    The ID of the Environment that the Connect Artifact belongs to.
    id String
    The ID of the Environment that the Connect Artifact belongs to.
    id string
    The ID of the Environment that the Connect Artifact belongs to.
    id str
    The ID of the Environment that the Connect Artifact belongs to.
    id String
    The ID of the Environment that the Connect Artifact belongs to.

    Import

    You can import a Connect Artifact by using Environment ID, Cloud, and Connect Artifact ID in the format <Environment ID>/<cloud>/<Connect Artifact ID>, for example:

    $ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"

    $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

    $ pulumi import confluentcloud:index/connectArtifact:ConnectArtifact example env-123456/AWS/ca-123456
    

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