Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. ApiImplementation
konnect 3.1.0 published on Tuesday, Sep 2, 2025 by kong
kong/terraform-provider-konnect

konnect.ApiImplementation

Explore with Pulumi AI

konnect logo
konnect 3.1.0 published on Tuesday, Sep 2, 2025 by kong
kong/terraform-provider-konnect

    APIImplementation Resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as konnect from "@pulumi/konnect";

const myApiimplementation = new konnect.ApiImplementation("myApiimplementation", {
    apiId: "9f5061ce-78f6-4452-9108-ad7c02821fd5",
    serviceReference: {
        service: {
            controlPlaneId: "9f5061ce-78f6-4452-9108-ad7c02821fd5",
            id: "7710d5c4-d902-410b-992f-18b814155b53",
        },
    },
});

    import pulumi
import pulumi_konnect as konnect

my_apiimplementation = konnect.ApiImplementation("myApiimplementation",
    api_id="9f5061ce-78f6-4452-9108-ad7c02821fd5",
    service_reference={
        "service": {
            "control_plane_id": "9f5061ce-78f6-4452-9108-ad7c02821fd5",
            "id": "7710d5c4-d902-410b-992f-18b814155b53",
        },
    })

    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.NewApiImplementation(ctx, "myApiimplementation", &konnect.ApiImplementationArgs{
			ApiId: pulumi.String("9f5061ce-78f6-4452-9108-ad7c02821fd5"),
			ServiceReference: &konnect.ApiImplementationServiceReferenceArgs{
				Service: &konnect.ApiImplementationServiceReferenceServiceArgs{
					ControlPlaneId: pulumi.String("9f5061ce-78f6-4452-9108-ad7c02821fd5"),
					Id:             pulumi.String("7710d5c4-d902-410b-992f-18b814155b53"),
				},
			},
		})
		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 myApiimplementation = new Konnect.ApiImplementation("myApiimplementation", new()
    {
        ApiId = "9f5061ce-78f6-4452-9108-ad7c02821fd5",
        ServiceReference = new Konnect.Inputs.ApiImplementationServiceReferenceArgs
        {
            Service = new Konnect.Inputs.ApiImplementationServiceReferenceServiceArgs
            {
                ControlPlaneId = "9f5061ce-78f6-4452-9108-ad7c02821fd5",
                Id = "7710d5c4-d902-410b-992f-18b814155b53",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.ApiImplementation;
import com.pulumi.konnect.ApiImplementationArgs;
import com.pulumi.konnect.inputs.ApiImplementationServiceReferenceArgs;
import com.pulumi.konnect.inputs.ApiImplementationServiceReferenceServiceArgs;
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 myApiimplementation = new ApiImplementation("myApiimplementation", ApiImplementationArgs.builder()
            .apiId("9f5061ce-78f6-4452-9108-ad7c02821fd5")
            .serviceReference(ApiImplementationServiceReferenceArgs.builder()
                .service(ApiImplementationServiceReferenceServiceArgs.builder()
                    .controlPlaneId("9f5061ce-78f6-4452-9108-ad7c02821fd5")
                    .id("7710d5c4-d902-410b-992f-18b814155b53")
                    .build())
                .build())
            .build());

    }
}

    resources:
  myApiimplementation:
    type: konnect:ApiImplementation
    properties:
      apiId: 9f5061ce-78f6-4452-9108-ad7c02821fd5
      serviceReference:
        service:
          controlPlaneId: 9f5061ce-78f6-4452-9108-ad7c02821fd5
          id: 7710d5c4-d902-410b-992f-18b814155b53

    Create ApiImplementation Resource

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

    Constructor syntax

    new ApiImplementation(name: string, args: ApiImplementationArgs, opts?: CustomResourceOptions);
    @overload
def ApiImplementation(resource_name: str,
                      args: ApiImplementationArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def ApiImplementation(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      api_id: Optional[str] = None,
                      service_reference: Optional[ApiImplementationServiceReferenceArgs] = None)
    func NewApiImplementation(ctx *Context, name string, args ApiImplementationArgs, opts ...ResourceOption) (*ApiImplementation, error)
    public ApiImplementation(string name, ApiImplementationArgs args, CustomResourceOptions? opts = null)
    public ApiImplementation(String name, ApiImplementationArgs args)
public ApiImplementation(String name, ApiImplementationArgs args, CustomResourceOptions options)

    type: konnect:ApiImplementation
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 ApiImplementationArgs
    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 ApiImplementationArgs
    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 ApiImplementationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiImplementationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiImplementationArgs
    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 apiImplementationResource = new Konnect.ApiImplementation("apiImplementationResource", new()
{
    ApiId = "string",
    ServiceReference = new Konnect.Inputs.ApiImplementationServiceReferenceArgs
    {
        CreatedAt = "string",
        Id = "string",
        Service = new Konnect.Inputs.ApiImplementationServiceReferenceServiceArgs
        {
            ControlPlaneId = "string",
            Id = "string",
        },
        UpdatedAt = "string",
    },
});

    example, err := konnect.NewApiImplementation(ctx, "apiImplementationResource", &konnect.ApiImplementationArgs{
	ApiId: pulumi.String("string"),
	ServiceReference: &konnect.ApiImplementationServiceReferenceArgs{
		CreatedAt: pulumi.String("string"),
		Id:        pulumi.String("string"),
		Service: &konnect.ApiImplementationServiceReferenceServiceArgs{
			ControlPlaneId: pulumi.String("string"),
			Id:             pulumi.String("string"),
		},
		UpdatedAt: pulumi.String("string"),
	},
})

    var apiImplementationResource = new ApiImplementation("apiImplementationResource", ApiImplementationArgs.builder()
    .apiId("string")
    .serviceReference(ApiImplementationServiceReferenceArgs.builder()
        .createdAt("string")
        .id("string")
        .service(ApiImplementationServiceReferenceServiceArgs.builder()
            .controlPlaneId("string")
            .id("string")
            .build())
        .updatedAt("string")
        .build())
    .build());

    api_implementation_resource = konnect.ApiImplementation("apiImplementationResource",
    api_id="string",
    service_reference={
        "created_at": "string",
        "id": "string",
        "service": {
            "control_plane_id": "string",
            "id": "string",
        },
        "updated_at": "string",
    })

    const apiImplementationResource = new konnect.ApiImplementation("apiImplementationResource", {
    apiId: "string",
    serviceReference: {
        createdAt: "string",
        id: "string",
        service: {
            controlPlaneId: "string",
            id: "string",
        },
        updatedAt: "string",
    },
});

    type: konnect:ApiImplementation
properties:
    apiId: string
    serviceReference:
        createdAt: string
        id: string
        service:
            controlPlaneId: string
            id: string
        updatedAt: string

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

    ApiId string
    The UUID API identifier. Requires replacement if changed.
    ServiceReference ApiImplementationServiceReference
    A gateway service that implements an API. Requires replacement if changed.
    ApiId string
    The UUID API identifier. Requires replacement if changed.
    ServiceReference ApiImplementationServiceReferenceArgs
    A gateway service that implements an API. Requires replacement if changed.
    apiId String
    The UUID API identifier. Requires replacement if changed.
    serviceReference ApiImplementationServiceReference
    A gateway service that implements an API. Requires replacement if changed.
    apiId string
    The UUID API identifier. Requires replacement if changed.
    serviceReference ApiImplementationServiceReference
    A gateway service that implements an API. Requires replacement if changed.
    api_id str
    The UUID API identifier. Requires replacement if changed.
    service_reference ApiImplementationServiceReferenceArgs
    A gateway service that implements an API. Requires replacement if changed.
    apiId String
    The UUID API identifier. Requires replacement if changed.
    serviceReference Property Map
    A gateway service that implements an API. Requires replacement if changed.

    Outputs

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

    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    Service ApiImplementationService
    A Gateway service that implements an API
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    The provider-assigned unique ID for this managed resource.
    Service ApiImplementationService
    A Gateway service that implements an API
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    service ApiImplementationService
    A Gateway service that implements an API
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    The provider-assigned unique ID for this managed resource.
    service ApiImplementationService
    A Gateway service that implements an API
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    id str
    The provider-assigned unique ID for this managed resource.
    service ApiImplementationService
    A Gateway service that implements an API
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    The provider-assigned unique ID for this managed resource.
    service Property Map
    A Gateway service that implements an API
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Look up Existing ApiImplementation Resource

    Get an existing ApiImplementation 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?: ApiImplementationState, opts?: CustomResourceOptions): ApiImplementation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_id: Optional[str] = None,
        created_at: Optional[str] = None,
        service: Optional[ApiImplementationServiceArgs] = None,
        service_reference: Optional[ApiImplementationServiceReferenceArgs] = None,
        updated_at: Optional[str] = None) -> ApiImplementation
    func GetApiImplementation(ctx *Context, name string, id IDInput, state *ApiImplementationState, opts ...ResourceOption) (*ApiImplementation, error)
    public static ApiImplementation Get(string name, Input<string> id, ApiImplementationState? state, CustomResourceOptions? opts = null)
    public static ApiImplementation get(String name, Output<String> id, ApiImplementationState state, CustomResourceOptions options)
    resources:  _:    type: konnect:ApiImplementation    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:
    ApiId string
    The UUID API identifier. Requires replacement if changed.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Service ApiImplementationService
    A Gateway service that implements an API
    ServiceReference ApiImplementationServiceReference
    A gateway service that implements an API. Requires replacement if changed.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    ApiId string
    The UUID API identifier. Requires replacement if changed.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Service ApiImplementationServiceArgs
    A Gateway service that implements an API
    ServiceReference ApiImplementationServiceReferenceArgs
    A gateway service that implements an API. Requires replacement if changed.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    apiId String
    The UUID API identifier. Requires replacement if changed.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    service ApiImplementationService
    A Gateway service that implements an API
    serviceReference ApiImplementationServiceReference
    A gateway service that implements an API. Requires replacement if changed.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    apiId string
    The UUID API identifier. Requires replacement if changed.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    service ApiImplementationService
    A Gateway service that implements an API
    serviceReference ApiImplementationServiceReference
    A gateway service that implements an API. Requires replacement if changed.
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    api_id str
    The UUID API identifier. Requires replacement if changed.
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    service ApiImplementationServiceArgs
    A Gateway service that implements an API
    service_reference ApiImplementationServiceReferenceArgs
    A gateway service that implements an API. Requires replacement if changed.
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    apiId String
    The UUID API identifier. Requires replacement if changed.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    service Property Map
    A Gateway service that implements an API
    serviceReference Property Map
    A gateway service that implements an API. Requires replacement if changed.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    Supporting Types

    ApiImplementationService, ApiImplementationServiceArgs

    ControlPlaneId string
    Id string
    ControlPlaneId string
    Id string
    controlPlaneId String
    id String
    controlPlaneId string
    id string
    controlPlaneId String
    id String

    ApiImplementationServiceReference, ApiImplementationServiceReferenceArgs

    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    Contains a unique identifier used for this resource.
    Service ApiImplementationServiceReferenceService
    A Gateway service that implements an API. Requires replacement if changed.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    CreatedAt string
    An ISO-8601 timestamp representation of entity creation date.
    Id string
    Contains a unique identifier used for this resource.
    Service ApiImplementationServiceReferenceService
    A Gateway service that implements an API. Requires replacement if changed.
    UpdatedAt string
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    Contains a unique identifier used for this resource.
    service ApiImplementationServiceReferenceService
    A Gateway service that implements an API. Requires replacement if changed.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.
    createdAt string
    An ISO-8601 timestamp representation of entity creation date.
    id string
    Contains a unique identifier used for this resource.
    service ApiImplementationServiceReferenceService
    A Gateway service that implements an API. Requires replacement if changed.
    updatedAt string
    An ISO-8601 timestamp representation of entity update date.
    created_at str
    An ISO-8601 timestamp representation of entity creation date.
    id str
    Contains a unique identifier used for this resource.
    service ApiImplementationServiceReferenceService
    A Gateway service that implements an API. Requires replacement if changed.
    updated_at str
    An ISO-8601 timestamp representation of entity update date.
    createdAt String
    An ISO-8601 timestamp representation of entity creation date.
    id String
    Contains a unique identifier used for this resource.
    service Property Map
    A Gateway service that implements an API. Requires replacement if changed.
    updatedAt String
    An ISO-8601 timestamp representation of entity update date.

    ApiImplementationServiceReferenceService, ApiImplementationServiceReferenceServiceArgs

    ControlPlaneId string
    Not Null; Requires replacement if changed.
    Id string
    Not Null; Requires replacement if changed.
    ControlPlaneId string
    Not Null; Requires replacement if changed.
    Id string
    Not Null; Requires replacement if changed.
    controlPlaneId String
    Not Null; Requires replacement if changed.
    id String
    Not Null; Requires replacement if changed.
    controlPlaneId string
    Not Null; Requires replacement if changed.
    id string
    Not Null; Requires replacement if changed.
    control_plane_id str
    Not Null; Requires replacement if changed.
    id str
    Not Null; Requires replacement if changed.
    controlPlaneId String
    Not Null; Requires replacement if changed.
    id String
    Not Null; Requires replacement if changed.

    Import

    $ pulumi import konnect:index/apiImplementation:ApiImplementation my_konnect_api_implementation '{"api_id": "9f5061ce-78f6-4452-9108-ad7c02821fd5", "id": "032d905a-ed33-46a3-a093-d8f536af9a8a"}'

    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
    kong/terraform-provider-konnect