Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Commercetools Provider
  3. API Docs
  4. ApiExtension
commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
labd/terraform-provider-commercetools

commercetools.ApiExtension

Explore with Pulumi AI

commercetools logo
commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
labd/terraform-provider-commercetools

    Create a new API extension to extend the behaviour of an API with business logic. Note that API extensions affect the performance of the API it is extending. If it fails, the whole API call fails

    Also see the API Extension API Documentation

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as commercetools from "@pulumi/commercetools";
import * as google from "@pulumi/google";

// HTTP api extension
const my_http_extension = new commercetools.ApiExtension("my-http-extension", {
    key: "my-http-extension-key",
    destination: {
        type: "HTTP",
        url: "https://example.com",
        authorizationHeader: "Basic 12345",
    },
    triggers: [{
        resourceTypeId: "customer",
        actions: [
            "Create",
            "Update",
        ],
    }],
});
// AWS Lambda api extension
const my_awslambda_extension = new commercetools.ApiExtension("my-awslambda-extension", {
    key: "my-awslambda-extension-key",
    destination: {
        type: "awslambda",
        arn: "us-east-1:123456789012:mylambda",
        accessKey: "mykey",
        accessSecret: "mysecret",
    },
    triggers: [{
        resourceTypeId: "customer",
        actions: [
            "Create",
            "Update",
        ],
    }],
});
// Google Cloud Function api extension
const my_googlecloudfunction_extension = new commercetools.ApiExtension("my-googlecloudfunction-extension", {
    key: "my-googlecloudfunction-extension-key",
    destination: {
        type: "googlecloudfunction",
        url: "https://example.com",
    },
    triggers: [{
        resourceTypeId: "customer",
        actions: [
            "Create",
            "Update",
        ],
    }],
});
const myCloudFunction = new google.index.Google_cloudfunctions_function("myCloudFunction", {
    name: "function-test",
    description: "My function",
    runtime: "nodejs16",
});
// See https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/cloudfunctions_function for any
// further settings
const invoker = new google.index.Google_cloudfunctions_function_iam_member("invoker", {
    project: "my-project",
    region: "europe-central2",
    cloudFunction: myCloudFunction.name,
    role: "roles/cloudfunctions.invoker",
    member: "serviceAccount:extensions@commercetools-platform.iam.gserviceaccount.com",
});

    import pulumi
import pulumi_commercetools as commercetools
import pulumi_google as google

# HTTP api extension
my_http_extension = commercetools.ApiExtension("my-http-extension",
    key="my-http-extension-key",
    destination={
        "type": "HTTP",
        "url": "https://example.com",
        "authorization_header": "Basic 12345",
    },
    triggers=[{
        "resource_type_id": "customer",
        "actions": [
            "Create",
            "Update",
        ],
    }])
# AWS Lambda api extension
my_awslambda_extension = commercetools.ApiExtension("my-awslambda-extension",
    key="my-awslambda-extension-key",
    destination={
        "type": "awslambda",
        "arn": "us-east-1:123456789012:mylambda",
        "access_key": "mykey",
        "access_secret": "mysecret",
    },
    triggers=[{
        "resource_type_id": "customer",
        "actions": [
            "Create",
            "Update",
        ],
    }])
# Google Cloud Function api extension
my_googlecloudfunction_extension = commercetools.ApiExtension("my-googlecloudfunction-extension",
    key="my-googlecloudfunction-extension-key",
    destination={
        "type": "googlecloudfunction",
        "url": "https://example.com",
    },
    triggers=[{
        "resource_type_id": "customer",
        "actions": [
            "Create",
            "Update",
        ],
    }])
my_cloud_function = google.index.Google_cloudfunctions_function("myCloudFunction",
    name=function-test,
    description=My function,
    runtime=nodejs16)
# See https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/cloudfunctions_function for any
# further settings
invoker = google.index.Google_cloudfunctions_function_iam_member("invoker",
    project=my-project,
    region=europe-central2,
    cloud_function=my_cloud_function.name,
    role=roles/cloudfunctions.invoker,
    member=serviceAccount:extensions@commercetools-platform.iam.gserviceaccount.com)

    package main

import (
	"github.com/pulumi/pulumi-google/sdk/go/google"
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/commercetools/commercetools"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// HTTP api extension
		_, err := commercetools.NewApiExtension(ctx, "my-http-extension", &commercetools.ApiExtensionArgs{
			Key: pulumi.String("my-http-extension-key"),
			Destination: &commercetools.ApiExtensionDestinationArgs{
				Type:                pulumi.String("HTTP"),
				Url:                 pulumi.String("https://example.com"),
				AuthorizationHeader: pulumi.String("Basic 12345"),
			},
			Triggers: commercetools.ApiExtensionTriggerArray{
				&commercetools.ApiExtensionTriggerArgs{
					ResourceTypeId: pulumi.String("customer"),
					Actions: pulumi.StringArray{
						pulumi.String("Create"),
						pulumi.String("Update"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		// AWS Lambda api extension
		_, err = commercetools.NewApiExtension(ctx, "my-awslambda-extension", &commercetools.ApiExtensionArgs{
			Key: pulumi.String("my-awslambda-extension-key"),
			Destination: &commercetools.ApiExtensionDestinationArgs{
				Type:         pulumi.String("awslambda"),
				Arn:          pulumi.String("us-east-1:123456789012:mylambda"),
				AccessKey:    pulumi.String("mykey"),
				AccessSecret: pulumi.String("mysecret"),
			},
			Triggers: commercetools.ApiExtensionTriggerArray{
				&commercetools.ApiExtensionTriggerArgs{
					ResourceTypeId: pulumi.String("customer"),
					Actions: pulumi.StringArray{
						pulumi.String("Create"),
						pulumi.String("Update"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		// Google Cloud Function api extension
		_, err = commercetools.NewApiExtension(ctx, "my-googlecloudfunction-extension", &commercetools.ApiExtensionArgs{
			Key: pulumi.String("my-googlecloudfunction-extension-key"),
			Destination: &commercetools.ApiExtensionDestinationArgs{
				Type: pulumi.String("googlecloudfunction"),
				Url:  pulumi.String("https://example.com"),
			},
			Triggers: commercetools.ApiExtensionTriggerArray{
				&commercetools.ApiExtensionTriggerArgs{
					ResourceTypeId: pulumi.String("customer"),
					Actions: pulumi.StringArray{
						pulumi.String("Create"),
						pulumi.String("Update"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		myCloudFunction, err := google.NewGoogle_cloudfunctions_function(ctx, "myCloudFunction", &google.Google_cloudfunctions_functionArgs{
			Name:        "function-test",
			Description: "My function",
			Runtime:     "nodejs16",
		})
		if err != nil {
			return err
		}
		_, err = google.NewGoogle_cloudfunctions_function_iam_member(ctx, "invoker", &google.Google_cloudfunctions_function_iam_memberArgs{
			Project:       "my-project",
			Region:        "europe-central2",
			CloudFunction: myCloudFunction.Name,
			Role:          "roles/cloudfunctions.invoker",
			Member:        "serviceAccount:extensions@commercetools-platform.iam.gserviceaccount.com",
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Commercetools = Pulumi.Commercetools;
using Google = Pulumi.Google;

return await Deployment.RunAsync(() => 
{
    // HTTP api extension
    var my_http_extension = new Commercetools.ApiExtension("my-http-extension", new()
    {
        Key = "my-http-extension-key",
        Destination = new Commercetools.Inputs.ApiExtensionDestinationArgs
        {
            Type = "HTTP",
            Url = "https://example.com",
            AuthorizationHeader = "Basic 12345",
        },
        Triggers = new[]
        {
            new Commercetools.Inputs.ApiExtensionTriggerArgs
            {
                ResourceTypeId = "customer",
                Actions = new[]
                {
                    "Create",
                    "Update",
                },
            },
        },
    });

    // AWS Lambda api extension
    var my_awslambda_extension = new Commercetools.ApiExtension("my-awslambda-extension", new()
    {
        Key = "my-awslambda-extension-key",
        Destination = new Commercetools.Inputs.ApiExtensionDestinationArgs
        {
            Type = "awslambda",
            Arn = "us-east-1:123456789012:mylambda",
            AccessKey = "mykey",
            AccessSecret = "mysecret",
        },
        Triggers = new[]
        {
            new Commercetools.Inputs.ApiExtensionTriggerArgs
            {
                ResourceTypeId = "customer",
                Actions = new[]
                {
                    "Create",
                    "Update",
                },
            },
        },
    });

    // Google Cloud Function api extension
    var my_googlecloudfunction_extension = new Commercetools.ApiExtension("my-googlecloudfunction-extension", new()
    {
        Key = "my-googlecloudfunction-extension-key",
        Destination = new Commercetools.Inputs.ApiExtensionDestinationArgs
        {
            Type = "googlecloudfunction",
            Url = "https://example.com",
        },
        Triggers = new[]
        {
            new Commercetools.Inputs.ApiExtensionTriggerArgs
            {
                ResourceTypeId = "customer",
                Actions = new[]
                {
                    "Create",
                    "Update",
                },
            },
        },
    });

    var myCloudFunction = new Google.Index.Google_cloudfunctions_function("myCloudFunction", new()
    {
        Name = "function-test",
        Description = "My function",
        Runtime = "nodejs16",
    });

    // See https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/cloudfunctions_function for any
    // further settings
    var invoker = new Google.Index.Google_cloudfunctions_function_iam_member("invoker", new()
    {
        Project = "my-project",
        Region = "europe-central2",
        CloudFunction = myCloudFunction.Name,
        Role = "roles/cloudfunctions.invoker",
        Member = "serviceAccount:extensions@commercetools-platform.iam.gserviceaccount.com",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.commercetools.ApiExtension;
import com.pulumi.commercetools.ApiExtensionArgs;
import com.pulumi.commercetools.inputs.ApiExtensionDestinationArgs;
import com.pulumi.commercetools.inputs.ApiExtensionTriggerArgs;
import com.pulumi.google.google_cloudfunctions_function;
import com.pulumi.google.Google_cloudfunctions_functionArgs;
import com.pulumi.google.google_cloudfunctions_function_iam_member;
import com.pulumi.google.Google_cloudfunctions_function_iam_memberArgs;
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) {
        // HTTP api extension
        var my_http_extension = new ApiExtension("my-http-extension", ApiExtensionArgs.builder()
            .key("my-http-extension-key")
            .destination(ApiExtensionDestinationArgs.builder()
                .type("HTTP")
                .url("https://example.com")
                .authorizationHeader("Basic 12345")
                .build())
            .triggers(ApiExtensionTriggerArgs.builder()
                .resourceTypeId("customer")
                .actions(                
                    "Create",
                    "Update")
                .build())
            .build());

        // AWS Lambda api extension
        var my_awslambda_extension = new ApiExtension("my-awslambda-extension", ApiExtensionArgs.builder()
            .key("my-awslambda-extension-key")
            .destination(ApiExtensionDestinationArgs.builder()
                .type("awslambda")
                .arn("us-east-1:123456789012:mylambda")
                .accessKey("mykey")
                .accessSecret("mysecret")
                .build())
            .triggers(ApiExtensionTriggerArgs.builder()
                .resourceTypeId("customer")
                .actions(                
                    "Create",
                    "Update")
                .build())
            .build());

        // Google Cloud Function api extension
        var my_googlecloudfunction_extension = new ApiExtension("my-googlecloudfunction-extension", ApiExtensionArgs.builder()
            .key("my-googlecloudfunction-extension-key")
            .destination(ApiExtensionDestinationArgs.builder()
                .type("googlecloudfunction")
                .url("https://example.com")
                .build())
            .triggers(ApiExtensionTriggerArgs.builder()
                .resourceTypeId("customer")
                .actions(                
                    "Create",
                    "Update")
                .build())
            .build());

        var myCloudFunction = new Google_cloudfunctions_function("myCloudFunction", Google_cloudfunctions_functionArgs.builder()
            .name("function-test")
            .description("My function")
            .runtime("nodejs16")
            .build());

        // See https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/cloudfunctions_function for any
        // further settings
        var invoker = new Google_cloudfunctions_function_iam_member("invoker", Google_cloudfunctions_function_iam_memberArgs.builder()
            .project("my-project")
            .region("europe-central2")
            .cloudFunction(myCloudFunction.name())
            .role("roles/cloudfunctions.invoker")
            .member("serviceAccount:extensions@commercetools-platform.iam.gserviceaccount.com")
            .build());

    }
}

    resources:
  # HTTP api extension
  my-http-extension:
    type: commercetools:ApiExtension
    properties:
      key: my-http-extension-key
      destination:
        type: HTTP
        url: https://example.com
        authorizationHeader: Basic 12345
      triggers:
        - resourceTypeId: customer
          actions:
            - Create
            - Update
  # AWS Lambda api extension
  my-awslambda-extension:
    type: commercetools:ApiExtension
    properties:
      key: my-awslambda-extension-key
      destination:
        type: awslambda
        arn: us-east-1:123456789012:mylambda
        accessKey: mykey
        accessSecret: mysecret
      triggers:
        - resourceTypeId: customer
          actions:
            - Create
            - Update
  # Google Cloud Function api extension
  my-googlecloudfunction-extension:
    type: commercetools:ApiExtension
    properties:
      key: my-googlecloudfunction-extension-key
      destination:
        type: googlecloudfunction
        url: https://example.com
      triggers:
        - resourceTypeId: customer
          actions:
            - Create
            - Update
  myCloudFunction:
    type: google:google_cloudfunctions_function
    properties:
      name: function-test
      description: My function
      runtime: nodejs16
  invoker:
    type: google:google_cloudfunctions_function_iam_member
    properties:
      # For GoogleCloudFunction destinations, you need to grant permissions to the
      #   # <extensions@commercetools-platform.iam.gserviceaccount.com> service account to invoke your function.
      project: my-project
      region: europe-central2
      cloudFunction: ${myCloudFunction.name}
      # If your function's version is 1st gen, grant the service account the IAM role Cloud Functions Invoker
      role: roles/cloudfunctions.invoker
      # For version 2nd gen, assign the IAM role Cloud Run Invoker
      #   # role   = "roles/run.invoker"
      member: serviceAccount:extensions@commercetools-platform.iam.gserviceaccount.com

    Create ApiExtension Resource

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

    Constructor syntax

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

@overload
def ApiExtension(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 destination: Optional[ApiExtensionDestinationArgs] = None,
                 triggers: Optional[Sequence[ApiExtensionTriggerArgs]] = None,
                 api_extension_id: Optional[str] = None,
                 key: Optional[str] = None,
                 timeout_in_ms: Optional[float] = None)
    func NewApiExtension(ctx *Context, name string, args ApiExtensionArgs, opts ...ResourceOption) (*ApiExtension, error)
    public ApiExtension(string name, ApiExtensionArgs args, CustomResourceOptions? opts = null)
    public ApiExtension(String name, ApiExtensionArgs args)
public ApiExtension(String name, ApiExtensionArgs args, CustomResourceOptions options)

    type: commercetools:ApiExtension
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 ApiExtensionArgs
    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 ApiExtensionArgs
    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 ApiExtensionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiExtensionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiExtensionArgs
    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 apiExtensionResource = new Commercetools.ApiExtension("apiExtensionResource", new()
{
    Destination = new Commercetools.Inputs.ApiExtensionDestinationArgs
    {
        Type = "string",
        AccessKey = "string",
        AccessSecret = "string",
        Arn = "string",
        AuthorizationHeader = "string",
        AzureAuthentication = "string",
        Url = "string",
    },
    Triggers = new[]
    {
        new Commercetools.Inputs.ApiExtensionTriggerArgs
        {
            Actions = new[]
            {
                "string",
            },
            ResourceTypeId = "string",
            Condition = "string",
        },
    },
    ApiExtensionId = "string",
    Key = "string",
    TimeoutInMs = 0,
});

    example, err := commercetools.NewApiExtension(ctx, "apiExtensionResource", &commercetools.ApiExtensionArgs{
Destination: &.ApiExtensionDestinationArgs{
Type: pulumi.String("string"),
AccessKey: pulumi.String("string"),
AccessSecret: pulumi.String("string"),
Arn: pulumi.String("string"),
AuthorizationHeader: pulumi.String("string"),
AzureAuthentication: pulumi.String("string"),
Url: pulumi.String("string"),
},
Triggers: .ApiExtensionTriggerArray{
&.ApiExtensionTriggerArgs{
Actions: pulumi.StringArray{
pulumi.String("string"),
},
ResourceTypeId: pulumi.String("string"),
Condition: pulumi.String("string"),
},
},
ApiExtensionId: pulumi.String("string"),
Key: pulumi.String("string"),
TimeoutInMs: pulumi.Float64(0),
})

    var apiExtensionResource = new ApiExtension("apiExtensionResource", ApiExtensionArgs.builder()
    .destination(ApiExtensionDestinationArgs.builder()
        .type("string")
        .accessKey("string")
        .accessSecret("string")
        .arn("string")
        .authorizationHeader("string")
        .azureAuthentication("string")
        .url("string")
        .build())
    .triggers(ApiExtensionTriggerArgs.builder()
        .actions("string")
        .resourceTypeId("string")
        .condition("string")
        .build())
    .apiExtensionId("string")
    .key("string")
    .timeoutInMs(0)
    .build());

    api_extension_resource = commercetools.ApiExtension("apiExtensionResource",
    destination={
        "type": "string",
        "access_key": "string",
        "access_secret": "string",
        "arn": "string",
        "authorization_header": "string",
        "azure_authentication": "string",
        "url": "string",
    },
    triggers=[{
        "actions": ["string"],
        "resource_type_id": "string",
        "condition": "string",
    }],
    api_extension_id="string",
    key="string",
    timeout_in_ms=0)

    const apiExtensionResource = new commercetools.ApiExtension("apiExtensionResource", {
    destination: {
        type: "string",
        accessKey: "string",
        accessSecret: "string",
        arn: "string",
        authorizationHeader: "string",
        azureAuthentication: "string",
        url: "string",
    },
    triggers: [{
        actions: ["string"],
        resourceTypeId: "string",
        condition: "string",
    }],
    apiExtensionId: "string",
    key: "string",
    timeoutInMs: 0,
});

    type: commercetools:ApiExtension
properties:
    apiExtensionId: string
    destination:
        accessKey: string
        accessSecret: string
        arn: string
        authorizationHeader: string
        azureAuthentication: string
        type: string
        url: string
    key: string
    timeoutInMs: 0
    triggers:
        - actions:
            - string
          condition: string
          resourceTypeId: string

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

    Destination ApiExtensionDestination
    Destination Details where the extension can be reached
    Triggers List<ApiExtensionTrigger>
    Array of Trigger Describes what triggers the extension
    ApiExtensionId string
    The ID of this resource.
    Key string
    User-specific unique identifier for the extension
    TimeoutInMs double
    Extension timeout in milliseconds
    Destination ApiExtensionDestinationArgs
    Destination Details where the extension can be reached
    Triggers []ApiExtensionTriggerArgs
    Array of Trigger Describes what triggers the extension
    ApiExtensionId string
    The ID of this resource.
    Key string
    User-specific unique identifier for the extension
    TimeoutInMs float64
    Extension timeout in milliseconds
    destination ApiExtensionDestination
    Destination Details where the extension can be reached
    triggers List<ApiExtensionTrigger>
    Array of Trigger Describes what triggers the extension
    apiExtensionId String
    The ID of this resource.
    key String
    User-specific unique identifier for the extension
    timeoutInMs Double
    Extension timeout in milliseconds
    destination ApiExtensionDestination
    Destination Details where the extension can be reached
    triggers ApiExtensionTrigger[]
    Array of Trigger Describes what triggers the extension
    apiExtensionId string
    The ID of this resource.
    key string
    User-specific unique identifier for the extension
    timeoutInMs number
    Extension timeout in milliseconds
    destination ApiExtensionDestinationArgs
    Destination Details where the extension can be reached
    triggers Sequence[ApiExtensionTriggerArgs]
    Array of Trigger Describes what triggers the extension
    api_extension_id str
    The ID of this resource.
    key str
    User-specific unique identifier for the extension
    timeout_in_ms float
    Extension timeout in milliseconds
    destination Property Map
    Destination Details where the extension can be reached
    triggers List<Property Map>
    Array of Trigger Describes what triggers the extension
    apiExtensionId String
    The ID of this resource.
    key String
    User-specific unique identifier for the extension
    timeoutInMs Number
    Extension timeout in milliseconds

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Version double
    Id string
    The provider-assigned unique ID for this managed resource.
    Version float64
    id String
    The provider-assigned unique ID for this managed resource.
    version Double
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    id str
    The provider-assigned unique ID for this managed resource.
    version float
    id String
    The provider-assigned unique ID for this managed resource.
    version Number

    Look up Existing ApiExtension Resource

    Get an existing ApiExtension 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?: ApiExtensionState, opts?: CustomResourceOptions): ApiExtension
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_extension_id: Optional[str] = None,
        destination: Optional[ApiExtensionDestinationArgs] = None,
        key: Optional[str] = None,
        timeout_in_ms: Optional[float] = None,
        triggers: Optional[Sequence[ApiExtensionTriggerArgs]] = None,
        version: Optional[float] = None) -> ApiExtension
    func GetApiExtension(ctx *Context, name string, id IDInput, state *ApiExtensionState, opts ...ResourceOption) (*ApiExtension, error)
    public static ApiExtension Get(string name, Input<string> id, ApiExtensionState? state, CustomResourceOptions? opts = null)
    public static ApiExtension get(String name, Output<String> id, ApiExtensionState state, CustomResourceOptions options)
    resources:  _:    type: commercetools:ApiExtension    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:
    ApiExtensionId string
    The ID of this resource.
    Destination ApiExtensionDestination
    Destination Details where the extension can be reached
    Key string
    User-specific unique identifier for the extension
    TimeoutInMs double
    Extension timeout in milliseconds
    Triggers List<ApiExtensionTrigger>
    Array of Trigger Describes what triggers the extension
    Version double
    ApiExtensionId string
    The ID of this resource.
    Destination ApiExtensionDestinationArgs
    Destination Details where the extension can be reached
    Key string
    User-specific unique identifier for the extension
    TimeoutInMs float64
    Extension timeout in milliseconds
    Triggers []ApiExtensionTriggerArgs
    Array of Trigger Describes what triggers the extension
    Version float64
    apiExtensionId String
    The ID of this resource.
    destination ApiExtensionDestination
    Destination Details where the extension can be reached
    key String
    User-specific unique identifier for the extension
    timeoutInMs Double
    Extension timeout in milliseconds
    triggers List<ApiExtensionTrigger>
    Array of Trigger Describes what triggers the extension
    version Double
    apiExtensionId string
    The ID of this resource.
    destination ApiExtensionDestination
    Destination Details where the extension can be reached
    key string
    User-specific unique identifier for the extension
    timeoutInMs number
    Extension timeout in milliseconds
    triggers ApiExtensionTrigger[]
    Array of Trigger Describes what triggers the extension
    version number
    api_extension_id str
    The ID of this resource.
    destination ApiExtensionDestinationArgs
    Destination Details where the extension can be reached
    key str
    User-specific unique identifier for the extension
    timeout_in_ms float
    Extension timeout in milliseconds
    triggers Sequence[ApiExtensionTriggerArgs]
    Array of Trigger Describes what triggers the extension
    version float
    apiExtensionId String
    The ID of this resource.
    destination Property Map
    Destination Details where the extension can be reached
    key String
    User-specific unique identifier for the extension
    timeoutInMs Number
    Extension timeout in milliseconds
    triggers List<Property Map>
    Array of Trigger Describes what triggers the extension
    version Number

    Supporting Types

    ApiExtensionDestination, ApiExtensionDestinationArgs

    Type string
    AccessKey string
    AccessSecret string
    Arn string
    AuthorizationHeader string
    AzureAuthentication string
    Url string
    Type string
    AccessKey string
    AccessSecret string
    Arn string
    AuthorizationHeader string
    AzureAuthentication string
    Url string
    type String
    accessKey String
    accessSecret String
    arn String
    authorizationHeader String
    azureAuthentication String
    url String
    type string
    accessKey string
    accessSecret string
    arn string
    authorizationHeader string
    azureAuthentication string
    url string
    type String
    accessKey String
    accessSecret String
    arn String
    authorizationHeader String
    azureAuthentication String
    url String

    ApiExtensionTrigger, ApiExtensionTriggerArgs

    Actions List<string>
    Currently, Create and Update are supported
    ResourceTypeId string
    Currently, cart, order, payment, and customer are supported
    Condition string
    Valid predicate that controls the conditions under which the API Extension is called.
    Actions []string
    Currently, Create and Update are supported
    ResourceTypeId string
    Currently, cart, order, payment, and customer are supported
    Condition string
    Valid predicate that controls the conditions under which the API Extension is called.
    actions List<String>
    Currently, Create and Update are supported
    resourceTypeId String
    Currently, cart, order, payment, and customer are supported
    condition String
    Valid predicate that controls the conditions under which the API Extension is called.
    actions string[]
    Currently, Create and Update are supported
    resourceTypeId string
    Currently, cart, order, payment, and customer are supported
    condition string
    Valid predicate that controls the conditions under which the API Extension is called.
    actions Sequence[str]
    Currently, Create and Update are supported
    resource_type_id str
    Currently, cart, order, payment, and customer are supported
    condition str
    Valid predicate that controls the conditions under which the API Extension is called.
    actions List<String>
    Currently, Create and Update are supported
    resourceTypeId String
    Currently, cart, order, payment, and customer are supported
    condition String
    Valid predicate that controls the conditions under which the API Extension is called.

    Package Details

    Repository
    commercetools labd/terraform-provider-commercetools
    License
    Notes
    This Pulumi package is based on the commercetools Terraform Provider.
    commercetools logo
    commercetools 1.19.2 published on Friday, Mar 7, 2025 by labd
    labd/terraform-provider-commercetools