1. Packages
  2. Confluent Cloud
  3. API Docs
  4. TfImporter
Confluent v1.47.0 published on Wednesday, Jun 12, 2024 by Pulumi

confluentcloud.TfImporter

Explore with Pulumi AI

confluentcloud logo
Confluent v1.47.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as confluentcloud from "@pulumi/confluentcloud";
    
    const example = new confluentcloud.TfImporter("example", {resources: [
        "confluent_service_account",
        "confluent_environment",
    ]});
    
    import pulumi
    import pulumi_confluentcloud as confluentcloud
    
    example = confluentcloud.TfImporter("example", resources=[
        "confluent_service_account",
        "confluent_environment",
    ])
    
    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 {
    		_, err := confluentcloud.NewTfImporter(ctx, "example", &confluentcloud.TfImporterArgs{
    			Resources: pulumi.StringArray{
    				pulumi.String("confluent_service_account"),
    				pulumi.String("confluent_environment"),
    			},
    		})
    		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.TfImporter("example", new()
        {
            Resources = new[]
            {
                "confluent_service_account",
                "confluent_environment",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.confluentcloud.TfImporter;
    import com.pulumi.confluentcloud.TfImporterArgs;
    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 TfImporter("example", TfImporterArgs.builder()
                .resources(            
                    "confluent_service_account",
                    "confluent_environment")
                .build());
    
        }
    }
    
    resources:
      example:
        type: confluentcloud:TfImporter
        properties:
          resources:
            - confluent_service_account
            - confluent_environment
    

    Getting Started

    The following end-to-end examples might help to get started with the confluentcloud.TfImporter resource:

    • cloud-importer: Export Cloud resources (for example, Service Accounts, Environments)
    • kafka-importer: Export Kafka resources (for example, ACLs, Topics)

    Create TfImporter Resource

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

    Constructor syntax

    new TfImporter(name: string, args?: TfImporterArgs, opts?: CustomResourceOptions);
    @overload
    def TfImporter(resource_name: str,
                   args: Optional[TfImporterArgs] = None,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def TfImporter(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   output_path: Optional[str] = None,
                   resources: Optional[Sequence[str]] = None)
    func NewTfImporter(ctx *Context, name string, args *TfImporterArgs, opts ...ResourceOption) (*TfImporter, error)
    public TfImporter(string name, TfImporterArgs? args = null, CustomResourceOptions? opts = null)
    public TfImporter(String name, TfImporterArgs args)
    public TfImporter(String name, TfImporterArgs args, CustomResourceOptions options)
    
    type: confluentcloud:TfImporter
    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 TfImporterArgs
    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 TfImporterArgs
    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 TfImporterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TfImporterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TfImporterArgs
    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 tfImporterResource = new ConfluentCloud.TfImporter("tfImporterResource", new()
    {
        OutputPath = "string",
        Resources = new[]
        {
            "string",
        },
    });
    
    example, err := confluentcloud.NewTfImporter(ctx, "tfImporterResource", &confluentcloud.TfImporterArgs{
    	OutputPath: pulumi.String("string"),
    	Resources: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var tfImporterResource = new TfImporter("tfImporterResource", TfImporterArgs.builder()
        .outputPath("string")
        .resources("string")
        .build());
    
    tf_importer_resource = confluentcloud.TfImporter("tfImporterResource",
        output_path="string",
        resources=["string"])
    
    const tfImporterResource = new confluentcloud.TfImporter("tfImporterResource", {
        outputPath: "string",
        resources: ["string"],
    });
    
    type: confluentcloud:TfImporter
    properties:
        outputPath: string
        resources:
            - string
    

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

    OutputPath string

    An absolute path to a folder for outputting generated TF state and TF configuration files for your infrastructure. The folder is created if it doesn't exist. Defaults to ./imported_confluent_infrastructure.

    These are the exportable resources:

    • Service Accounts
    • Environments
    • Connectors
    • Kafka Clusters
    • Access Control Lists (ACLs)
    • Topics
    • Schemas

    Note: File an issue to request a support for other resources.

    Resources List<string>
    A list of resources names to export. Defaults to all exportable resources.
    OutputPath string

    An absolute path to a folder for outputting generated TF state and TF configuration files for your infrastructure. The folder is created if it doesn't exist. Defaults to ./imported_confluent_infrastructure.

    These are the exportable resources:

    • Service Accounts
    • Environments
    • Connectors
    • Kafka Clusters
    • Access Control Lists (ACLs)
    • Topics
    • Schemas

    Note: File an issue to request a support for other resources.

    Resources []string
    A list of resources names to export. Defaults to all exportable resources.
    outputPath String

    An absolute path to a folder for outputting generated TF state and TF configuration files for your infrastructure. The folder is created if it doesn't exist. Defaults to ./imported_confluent_infrastructure.

    These are the exportable resources:

    • Service Accounts
    • Environments
    • Connectors
    • Kafka Clusters
    • Access Control Lists (ACLs)
    • Topics
    • Schemas

    Note: File an issue to request a support for other resources.

    resources List<String>
    A list of resources names to export. Defaults to all exportable resources.
    outputPath string

    An absolute path to a folder for outputting generated TF state and TF configuration files for your infrastructure. The folder is created if it doesn't exist. Defaults to ./imported_confluent_infrastructure.

    These are the exportable resources:

    • Service Accounts
    • Environments
    • Connectors
    • Kafka Clusters
    • Access Control Lists (ACLs)
    • Topics
    • Schemas

    Note: File an issue to request a support for other resources.

    resources string[]
    A list of resources names to export. Defaults to all exportable resources.
    output_path str

    An absolute path to a folder for outputting generated TF state and TF configuration files for your infrastructure. The folder is created if it doesn't exist. Defaults to ./imported_confluent_infrastructure.

    These are the exportable resources:

    • Service Accounts
    • Environments
    • Connectors
    • Kafka Clusters
    • Access Control Lists (ACLs)
    • Topics
    • Schemas

    Note: File an issue to request a support for other resources.

    resources Sequence[str]
    A list of resources names to export. Defaults to all exportable resources.
    outputPath String

    An absolute path to a folder for outputting generated TF state and TF configuration files for your infrastructure. The folder is created if it doesn't exist. Defaults to ./imported_confluent_infrastructure.

    These are the exportable resources:

    • Service Accounts
    • Environments
    • Connectors
    • Kafka Clusters
    • Access Control Lists (ACLs)
    • Topics
    • Schemas

    Note: File an issue to request a support for other resources.

    resources List<String>
    A list of resources names to export. Defaults to all exportable resources.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing TfImporter Resource

    Get an existing TfImporter 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?: TfImporterState, opts?: CustomResourceOptions): TfImporter
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            output_path: Optional[str] = None,
            resources: Optional[Sequence[str]] = None) -> TfImporter
    func GetTfImporter(ctx *Context, name string, id IDInput, state *TfImporterState, opts ...ResourceOption) (*TfImporter, error)
    public static TfImporter Get(string name, Input<string> id, TfImporterState? state, CustomResourceOptions? opts = null)
    public static TfImporter get(String name, Output<String> id, TfImporterState 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:
    OutputPath string

    An absolute path to a folder for outputting generated TF state and TF configuration files for your infrastructure. The folder is created if it doesn't exist. Defaults to ./imported_confluent_infrastructure.

    These are the exportable resources:

    • Service Accounts
    • Environments
    • Connectors
    • Kafka Clusters
    • Access Control Lists (ACLs)
    • Topics
    • Schemas

    Note: File an issue to request a support for other resources.

    Resources List<string>
    A list of resources names to export. Defaults to all exportable resources.
    OutputPath string

    An absolute path to a folder for outputting generated TF state and TF configuration files for your infrastructure. The folder is created if it doesn't exist. Defaults to ./imported_confluent_infrastructure.

    These are the exportable resources:

    • Service Accounts
    • Environments
    • Connectors
    • Kafka Clusters
    • Access Control Lists (ACLs)
    • Topics
    • Schemas

    Note: File an issue to request a support for other resources.

    Resources []string
    A list of resources names to export. Defaults to all exportable resources.
    outputPath String

    An absolute path to a folder for outputting generated TF state and TF configuration files for your infrastructure. The folder is created if it doesn't exist. Defaults to ./imported_confluent_infrastructure.

    These are the exportable resources:

    • Service Accounts
    • Environments
    • Connectors
    • Kafka Clusters
    • Access Control Lists (ACLs)
    • Topics
    • Schemas

    Note: File an issue to request a support for other resources.

    resources List<String>
    A list of resources names to export. Defaults to all exportable resources.
    outputPath string

    An absolute path to a folder for outputting generated TF state and TF configuration files for your infrastructure. The folder is created if it doesn't exist. Defaults to ./imported_confluent_infrastructure.

    These are the exportable resources:

    • Service Accounts
    • Environments
    • Connectors
    • Kafka Clusters
    • Access Control Lists (ACLs)
    • Topics
    • Schemas

    Note: File an issue to request a support for other resources.

    resources string[]
    A list of resources names to export. Defaults to all exportable resources.
    output_path str

    An absolute path to a folder for outputting generated TF state and TF configuration files for your infrastructure. The folder is created if it doesn't exist. Defaults to ./imported_confluent_infrastructure.

    These are the exportable resources:

    • Service Accounts
    • Environments
    • Connectors
    • Kafka Clusters
    • Access Control Lists (ACLs)
    • Topics
    • Schemas

    Note: File an issue to request a support for other resources.

    resources Sequence[str]
    A list of resources names to export. Defaults to all exportable resources.
    outputPath String

    An absolute path to a folder for outputting generated TF state and TF configuration files for your infrastructure. The folder is created if it doesn't exist. Defaults to ./imported_confluent_infrastructure.

    These are the exportable resources:

    • Service Accounts
    • Environments
    • Connectors
    • Kafka Clusters
    • Access Control Lists (ACLs)
    • Topics
    • Schemas

    Note: File an issue to request a support for other resources.

    resources List<String>
    A list of resources names to export. Defaults to all exportable 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.47.0 published on Wednesday, Jun 12, 2024 by Pulumi