1. Packages
  2. Konnect Provider
  3. API Docs
  4. IntegrationInstance
konnect 3.1.0 published on Tuesday, Sep 2, 2025 by kong

konnect.IntegrationInstance

Explore with Pulumi AI

konnect logo
konnect 3.1.0 published on Tuesday, Sep 2, 2025 by kong

    IntegrationInstance Resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as konnect from "@pulumi/konnect";
    
    const myIntegrationinstance = new konnect.IntegrationInstance("myIntegrationinstance", {
        config: "{ \"see\": \"documentation\" }",
        description: "...my_description...",
        displayName: "AWS (prod)",
        integrationName: "aws-lambda",
    });
    
    import pulumi
    import pulumi_konnect as konnect
    
    my_integrationinstance = konnect.IntegrationInstance("myIntegrationinstance",
        config="{ \"see\": \"documentation\" }",
        description="...my_description...",
        display_name="AWS (prod)",
        integration_name="aws-lambda")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/konnect/v3/konnect"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := konnect.NewIntegrationInstance(ctx, "myIntegrationinstance", &konnect.IntegrationInstanceArgs{
    			Config:          pulumi.String("{ \"see\": \"documentation\" }"),
    			Description:     pulumi.String("...my_description..."),
    			DisplayName:     pulumi.String("AWS (prod)"),
    			IntegrationName: pulumi.String("aws-lambda"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Konnect = Pulumi.Konnect;
    
    return await Deployment.RunAsync(() => 
    {
        var myIntegrationinstance = new Konnect.IntegrationInstance("myIntegrationinstance", new()
        {
            Config = "{ \"see\": \"documentation\" }",
            Description = "...my_description...",
            DisplayName = "AWS (prod)",
            IntegrationName = "aws-lambda",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.konnect.IntegrationInstance;
    import com.pulumi.konnect.IntegrationInstanceArgs;
    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 myIntegrationinstance = new IntegrationInstance("myIntegrationinstance", IntegrationInstanceArgs.builder()
                .config("{ \"see\": \"documentation\" }")
                .description("...my_description...")
                .displayName("AWS (prod)")
                .integrationName("aws-lambda")
                .build());
    
        }
    }
    
    resources:
      myIntegrationinstance:
        type: konnect:IntegrationInstance
        properties:
          config: '{ "see": "documentation" }'
          description: '...my_description...'
          displayName: AWS (prod)
          integrationName: aws-lambda
    

    Create IntegrationInstance Resource

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

    Constructor syntax

    new IntegrationInstance(name: string, args: IntegrationInstanceArgs, opts?: CustomResourceOptions);
    @overload
    def IntegrationInstance(resource_name: str,
                            args: IntegrationInstanceArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def IntegrationInstance(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            config: Optional[str] = None,
                            display_name: Optional[str] = None,
                            integration_name: Optional[str] = None,
                            description: Optional[str] = None,
                            name: Optional[str] = None)
    func NewIntegrationInstance(ctx *Context, name string, args IntegrationInstanceArgs, opts ...ResourceOption) (*IntegrationInstance, error)
    public IntegrationInstance(string name, IntegrationInstanceArgs args, CustomResourceOptions? opts = null)
    public IntegrationInstance(String name, IntegrationInstanceArgs args)
    public IntegrationInstance(String name, IntegrationInstanceArgs args, CustomResourceOptions options)
    
    type: konnect:IntegrationInstance
    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 IntegrationInstanceArgs
    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 IntegrationInstanceArgs
    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 IntegrationInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IntegrationInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IntegrationInstanceArgs
    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 integrationInstanceResource = new Konnect.IntegrationInstance("integrationInstanceResource", new()
    {
        Config = "string",
        DisplayName = "string",
        IntegrationName = "string",
        Description = "string",
        Name = "string",
    });
    
    example, err := konnect.NewIntegrationInstance(ctx, "integrationInstanceResource", &konnect.IntegrationInstanceArgs{
    	Config:          pulumi.String("string"),
    	DisplayName:     pulumi.String("string"),
    	IntegrationName: pulumi.String("string"),
    	Description:     pulumi.String("string"),
    	Name:            pulumi.String("string"),
    })
    
    var integrationInstanceResource = new IntegrationInstance("integrationInstanceResource", IntegrationInstanceArgs.builder()
        .config("string")
        .displayName("string")
        .integrationName("string")
        .description("string")
        .name("string")
        .build());
    
    integration_instance_resource = konnect.IntegrationInstance("integrationInstanceResource",
        config="string",
        display_name="string",
        integration_name="string",
        description="string",
        name="string")
    
    const integrationInstanceResource = new konnect.IntegrationInstance("integrationInstanceResource", {
        config: "string",
        displayName: "string",
        integrationName: "string",
        description: "string",
        name: "string",
    });
    
    type: konnect:IntegrationInstance
    properties:
        config: string
        description: string
        displayName: string
        integrationName: string
        name: string
    

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

    Config string
    JSON object representing configuration specific to the integration instance. The expected schema depends on the integration type and is dynamically registered at runtime. Parsed as JSON.
    DisplayName string
    The display name of the integration instance.
    IntegrationName string
    The type of integration instance to create. Requires replacement if changed.
    Description string
    Optionally provide a description of the integration instance.
    Name string
    The machine name of the integration instance that uniquely identifies it within the catalog.
    Config string
    JSON object representing configuration specific to the integration instance. The expected schema depends on the integration type and is dynamically registered at runtime. Parsed as JSON.
    DisplayName string
    The display name of the integration instance.
    IntegrationName string
    The type of integration instance to create. Requires replacement if changed.
    Description string
    Optionally provide a description of the integration instance.
    Name string
    The machine name of the integration instance that uniquely identifies it within the catalog.
    config String
    JSON object representing configuration specific to the integration instance. The expected schema depends on the integration type and is dynamically registered at runtime. Parsed as JSON.
    displayName String
    The display name of the integration instance.
    integrationName String
    The type of integration instance to create. Requires replacement if changed.
    description String
    Optionally provide a description of the integration instance.
    name String
    The machine name of the integration instance that uniquely identifies it within the catalog.
    config string
    JSON object representing configuration specific to the integration instance. The expected schema depends on the integration type and is dynamically registered at runtime. Parsed as JSON.
    displayName string
    The display name of the integration instance.
    integrationName string
    The type of integration instance to create. Requires replacement if changed.
    description string
    Optionally provide a description of the integration instance.
    name string
    The machine name of the integration instance that uniquely identifies it within the catalog.
    config str
    JSON object representing configuration specific to the integration instance. The expected schema depends on the integration type and is dynamically registered at runtime. Parsed as JSON.
    display_name str
    The display name of the integration instance.
    integration_name str
    The type of integration instance to create. Requires replacement if changed.
    description str
    Optionally provide a description of the integration instance.
    name str
    The machine name of the integration instance that uniquely identifies it within the catalog.
    config String
    JSON object representing configuration specific to the integration instance. The expected schema depends on the integration type and is dynamically registered at runtime. Parsed as JSON.
    displayName String
    The display name of the integration instance.
    integrationName String
    The type of integration instance to create. Requires replacement if changed.
    description String
    Optionally provide a description of the integration instance.
    name String
    The machine name of the integration instance that uniquely identifies it within the catalog.

    Outputs

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

    Authorized bool
    Denotes whether the integration instance has been authorized within the catalog.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    Integration IntegrationInstanceIntegration
    Short-hand descriptor of an integration that omits instance metadata.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    Authorized bool
    Denotes whether the integration instance has been authorized within the catalog.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    Integration IntegrationInstanceIntegration
    Short-hand descriptor of an integration that omits instance metadata.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    authorized Boolean
    Denotes whether the integration instance has been authorized within the catalog.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    integration IntegrationInstanceIntegration
    Short-hand descriptor of an integration that omits instance metadata.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    authorized boolean
    Denotes whether the integration instance has been authorized within the catalog.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    The provider-assigned unique ID for this managed resource.
    integration IntegrationInstanceIntegration
    Short-hand descriptor of an integration that omits instance metadata.
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    authorized bool
    Denotes whether the integration instance has been authorized within the catalog.
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    id str
    The provider-assigned unique ID for this managed resource.
    integration IntegrationInstanceIntegration
    Short-hand descriptor of an integration that omits instance metadata.
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    authorized Boolean
    Denotes whether the integration instance has been authorized within the catalog.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    integration Property Map
    Short-hand descriptor of an integration that omits instance metadata.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Look up Existing IntegrationInstance Resource

    Get an existing IntegrationInstance 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?: IntegrationInstanceState, opts?: CustomResourceOptions): IntegrationInstance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            authorized: Optional[bool] = None,
            config: Optional[str] = None,
            created_at: Optional[str] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            integration: Optional[IntegrationInstanceIntegrationArgs] = None,
            integration_name: Optional[str] = None,
            name: Optional[str] = None,
            updated_at: Optional[str] = None) -> IntegrationInstance
    func GetIntegrationInstance(ctx *Context, name string, id IDInput, state *IntegrationInstanceState, opts ...ResourceOption) (*IntegrationInstance, error)
    public static IntegrationInstance Get(string name, Input<string> id, IntegrationInstanceState? state, CustomResourceOptions? opts = null)
    public static IntegrationInstance get(String name, Output<String> id, IntegrationInstanceState state, CustomResourceOptions options)
    resources:  _:    type: konnect:IntegrationInstance    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:
    Authorized bool
    Denotes whether the integration instance has been authorized within the catalog.
    Config string
    JSON object representing configuration specific to the integration instance. The expected schema depends on the integration type and is dynamically registered at runtime. Parsed as JSON.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Description string
    Optionally provide a description of the integration instance.
    DisplayName string
    The display name of the integration instance.
    Integration IntegrationInstanceIntegration
    Short-hand descriptor of an integration that omits instance metadata.
    IntegrationName string
    The type of integration instance to create. Requires replacement if changed.
    Name string
    The machine name of the integration instance that uniquely identifies it within the catalog.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    Authorized bool
    Denotes whether the integration instance has been authorized within the catalog.
    Config string
    JSON object representing configuration specific to the integration instance. The expected schema depends on the integration type and is dynamically registered at runtime. Parsed as JSON.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Description string
    Optionally provide a description of the integration instance.
    DisplayName string
    The display name of the integration instance.
    Integration IntegrationInstanceIntegrationArgs
    Short-hand descriptor of an integration that omits instance metadata.
    IntegrationName string
    The type of integration instance to create. Requires replacement if changed.
    Name string
    The machine name of the integration instance that uniquely identifies it within the catalog.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    authorized Boolean
    Denotes whether the integration instance has been authorized within the catalog.
    config String
    JSON object representing configuration specific to the integration instance. The expected schema depends on the integration type and is dynamically registered at runtime. Parsed as JSON.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    description String
    Optionally provide a description of the integration instance.
    displayName String
    The display name of the integration instance.
    integration IntegrationInstanceIntegration
    Short-hand descriptor of an integration that omits instance metadata.
    integrationName String
    The type of integration instance to create. Requires replacement if changed.
    name String
    The machine name of the integration instance that uniquely identifies it within the catalog.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    authorized boolean
    Denotes whether the integration instance has been authorized within the catalog.
    config string
    JSON object representing configuration specific to the integration instance. The expected schema depends on the integration type and is dynamically registered at runtime. Parsed as JSON.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    description string
    Optionally provide a description of the integration instance.
    displayName string
    The display name of the integration instance.
    integration IntegrationInstanceIntegration
    Short-hand descriptor of an integration that omits instance metadata.
    integrationName string
    The type of integration instance to create. Requires replacement if changed.
    name string
    The machine name of the integration instance that uniquely identifies it within the catalog.
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    authorized bool
    Denotes whether the integration instance has been authorized within the catalog.
    config str
    JSON object representing configuration specific to the integration instance. The expected schema depends on the integration type and is dynamically registered at runtime. Parsed as JSON.
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    description str
    Optionally provide a description of the integration instance.
    display_name str
    The display name of the integration instance.
    integration IntegrationInstanceIntegrationArgs
    Short-hand descriptor of an integration that omits instance metadata.
    integration_name str
    The type of integration instance to create. Requires replacement if changed.
    name str
    The machine name of the integration instance that uniquely identifies it within the catalog.
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    authorized Boolean
    Denotes whether the integration instance has been authorized within the catalog.
    config String
    JSON object representing configuration specific to the integration instance. The expected schema depends on the integration type and is dynamically registered at runtime. Parsed as JSON.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    description String
    Optionally provide a description of the integration instance.
    displayName String
    The display name of the integration instance.
    integration Property Map
    Short-hand descriptor of an integration that omits instance metadata.
    integrationName String
    The type of integration instance to create. Requires replacement if changed.
    name String
    The machine name of the integration instance that uniquely identifies it within the catalog.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Supporting Types

    IntegrationInstanceIntegration, IntegrationInstanceIntegrationArgs

    DisplayName string
    Name string
    DisplayName string
    Name string
    displayName String
    name String
    displayName string
    name string
    displayName String
    name String

    Import

    $ pulumi import konnect:index/integrationInstance:IntegrationInstance my_konnect_integration_instance "3f51fa25-310a-421d-bd1a-007f859021a3"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    konnect kong/terraform-provider-konnect
    License
    Notes
    This Pulumi package is based on the konnect Terraform Provider.
    konnect logo
    konnect 3.1.0 published on Tuesday, Sep 2, 2025 by kong