Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. ApigCustomAuthorizer
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

flexibleengine.ApigCustomAuthorizer

Explore with Pulumi AI

flexibleengine logo
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

    Manages an APIG custom authorizer resource within FlexibleEngine.

    Example Usage

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

const config = new pulumi.Config();
const instanceId = config.requireObject("instanceId");
const authorizerName = config.requireObject("authorizerName");
const functionUrn = config.requireObject("functionUrn");
const test = new flexibleengine.ApigCustomAuthorizer("test", {
    instanceId: instanceId,
    functionUrn: functionUrn,
    type: "FRONTEND",
    cacheAge: 60,
    identities: [{
        name: "user_name",
        location: "QUERY",
    }],
});

    import pulumi
import pulumi_flexibleengine as flexibleengine

config = pulumi.Config()
instance_id = config.require_object("instanceId")
authorizer_name = config.require_object("authorizerName")
function_urn = config.require_object("functionUrn")
test = flexibleengine.ApigCustomAuthorizer("test",
    instance_id=instance_id,
    function_urn=function_urn,
    type="FRONTEND",
    cache_age=60,
    identities=[{
        "name": "user_name",
        "location": "QUERY",
    }])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		authorizerName := cfg.RequireObject("authorizerName")
		functionUrn := cfg.RequireObject("functionUrn")
		_, err := flexibleengine.NewApigCustomAuthorizer(ctx, "test", &flexibleengine.ApigCustomAuthorizerArgs{
			InstanceId:  pulumi.Any(instanceId),
			FunctionUrn: pulumi.Any(functionUrn),
			Type:        pulumi.String("FRONTEND"),
			CacheAge:    pulumi.Float64(60),
			Identities: flexibleengine.ApigCustomAuthorizerIdentityArray{
				&flexibleengine.ApigCustomAuthorizerIdentityArgs{
					Name:     pulumi.String("user_name"),
					Location: pulumi.String("QUERY"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Flexibleengine = Pulumi.Flexibleengine;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var instanceId = config.RequireObject<dynamic>("instanceId");
    var authorizerName = config.RequireObject<dynamic>("authorizerName");
    var functionUrn = config.RequireObject<dynamic>("functionUrn");
    var test = new Flexibleengine.ApigCustomAuthorizer("test", new()
    {
        InstanceId = instanceId,
        FunctionUrn = functionUrn,
        Type = "FRONTEND",
        CacheAge = 60,
        Identities = new[]
        {
            new Flexibleengine.Inputs.ApigCustomAuthorizerIdentityArgs
            {
                Name = "user_name",
                Location = "QUERY",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.ApigCustomAuthorizer;
import com.pulumi.flexibleengine.ApigCustomAuthorizerArgs;
import com.pulumi.flexibleengine.inputs.ApigCustomAuthorizerIdentityArgs;
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) {
        final var config = ctx.config();
        final var instanceId = config.get("instanceId");
        final var authorizerName = config.get("authorizerName");
        final var functionUrn = config.get("functionUrn");
        var test = new ApigCustomAuthorizer("test", ApigCustomAuthorizerArgs.builder()
            .instanceId(instanceId)
            .functionUrn(functionUrn)
            .type("FRONTEND")
            .cacheAge(60)
            .identities(ApigCustomAuthorizerIdentityArgs.builder()
                .name("user_name")
                .location("QUERY")
                .build())
            .build());

    }
}

    configuration:
  instanceId:
    type: dynamic
  authorizerName:
    type: dynamic
  functionUrn:
    type: dynamic
resources:
  test:
    type: flexibleengine:ApigCustomAuthorizer
    properties:
      instanceId: ${instanceId}
      functionUrn: ${functionUrn}
      type: FRONTEND
      cacheAge: 60
      identities:
        - name: user_name
          location: QUERY

    Create ApigCustomAuthorizer Resource

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

    Constructor syntax

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

@overload
def ApigCustomAuthorizer(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         function_urn: Optional[str] = None,
                         instance_id: Optional[str] = None,
                         apig_custom_authorizer_id: Optional[str] = None,
                         cache_age: Optional[float] = None,
                         identities: Optional[Sequence[ApigCustomAuthorizerIdentityArgs]] = None,
                         is_body_send: Optional[bool] = None,
                         name: Optional[str] = None,
                         region: Optional[str] = None,
                         type: Optional[str] = None,
                         user_data: Optional[str] = None)
    func NewApigCustomAuthorizer(ctx *Context, name string, args ApigCustomAuthorizerArgs, opts ...ResourceOption) (*ApigCustomAuthorizer, error)
    public ApigCustomAuthorizer(string name, ApigCustomAuthorizerArgs args, CustomResourceOptions? opts = null)
    public ApigCustomAuthorizer(String name, ApigCustomAuthorizerArgs args)
public ApigCustomAuthorizer(String name, ApigCustomAuthorizerArgs args, CustomResourceOptions options)

    type: flexibleengine:ApigCustomAuthorizer
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 ApigCustomAuthorizerArgs
    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 ApigCustomAuthorizerArgs
    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 ApigCustomAuthorizerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApigCustomAuthorizerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApigCustomAuthorizerArgs
    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 apigCustomAuthorizerResource = new Flexibleengine.ApigCustomAuthorizer("apigCustomAuthorizerResource", new()
{
    FunctionUrn = "string",
    InstanceId = "string",
    ApigCustomAuthorizerId = "string",
    CacheAge = 0,
    Identities = new[]
    {
        new Flexibleengine.Inputs.ApigCustomAuthorizerIdentityArgs
        {
            Location = "string",
            Name = "string",
            Validation = "string",
        },
    },
    IsBodySend = false,
    Name = "string",
    Region = "string",
    Type = "string",
    UserData = "string",
});

    example, err := flexibleengine.NewApigCustomAuthorizer(ctx, "apigCustomAuthorizerResource", &flexibleengine.ApigCustomAuthorizerArgs{
	FunctionUrn:            pulumi.String("string"),
	InstanceId:             pulumi.String("string"),
	ApigCustomAuthorizerId: pulumi.String("string"),
	CacheAge:               pulumi.Float64(0),
	Identities: flexibleengine.ApigCustomAuthorizerIdentityArray{
		&flexibleengine.ApigCustomAuthorizerIdentityArgs{
			Location:   pulumi.String("string"),
			Name:       pulumi.String("string"),
			Validation: pulumi.String("string"),
		},
	},
	IsBodySend: pulumi.Bool(false),
	Name:       pulumi.String("string"),
	Region:     pulumi.String("string"),
	Type:       pulumi.String("string"),
	UserData:   pulumi.String("string"),
})

    var apigCustomAuthorizerResource = new ApigCustomAuthorizer("apigCustomAuthorizerResource", ApigCustomAuthorizerArgs.builder()
    .functionUrn("string")
    .instanceId("string")
    .apigCustomAuthorizerId("string")
    .cacheAge(0)
    .identities(ApigCustomAuthorizerIdentityArgs.builder()
        .location("string")
        .name("string")
        .validation("string")
        .build())
    .isBodySend(false)
    .name("string")
    .region("string")
    .type("string")
    .userData("string")
    .build());

    apig_custom_authorizer_resource = flexibleengine.ApigCustomAuthorizer("apigCustomAuthorizerResource",
    function_urn="string",
    instance_id="string",
    apig_custom_authorizer_id="string",
    cache_age=0,
    identities=[{
        "location": "string",
        "name": "string",
        "validation": "string",
    }],
    is_body_send=False,
    name="string",
    region="string",
    type="string",
    user_data="string")

    const apigCustomAuthorizerResource = new flexibleengine.ApigCustomAuthorizer("apigCustomAuthorizerResource", {
    functionUrn: "string",
    instanceId: "string",
    apigCustomAuthorizerId: "string",
    cacheAge: 0,
    identities: [{
        location: "string",
        name: "string",
        validation: "string",
    }],
    isBodySend: false,
    name: "string",
    region: "string",
    type: "string",
    userData: "string",
});

    type: flexibleengine:ApigCustomAuthorizer
properties:
    apigCustomAuthorizerId: string
    cacheAge: 0
    functionUrn: string
    identities:
        - location: string
          name: string
          validation: string
    instanceId: string
    isBodySend: false
    name: string
    region: string
    type: string
    userData: string

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

    FunctionUrn string
    Specifies the uniform function URN of the function graph resource.
    InstanceId string
    Specifies an ID of the APIG dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
    ApigCustomAuthorizerId string
    ID of the custom authorizer.
    CacheAge double
    Specifies the maximum cache age.
    Identities List<ApigCustomAuthorizerIdentity>
    Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
    IsBodySend bool
    Specifies whether to send the body.
    Name string
    Specifies the name of the custom authorizer. The custom authorizer name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    Region string
    Specifies the region in which to create the custom authorizer resource. If omitted, the provider-level region will be used. Changing this will create a new custom authorizer resource.
    Type string
    Specifies the custom authoriz type. The valid values are FRONTEND and BACKEND. Changing this will create a new custom authorizer resource.
    UserData string

    Specifies the user data, which can contain a maximum of 2,048 characters. The user data is used by APIG to invoke the specified authentication function when accessing the backend service.

    NOTE: The user data will be displayed in plain text on the console.

    FunctionUrn string
    Specifies the uniform function URN of the function graph resource.
    InstanceId string
    Specifies an ID of the APIG dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
    ApigCustomAuthorizerId string
    ID of the custom authorizer.
    CacheAge float64
    Specifies the maximum cache age.
    Identities []ApigCustomAuthorizerIdentityArgs
    Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
    IsBodySend bool
    Specifies whether to send the body.
    Name string
    Specifies the name of the custom authorizer. The custom authorizer name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    Region string
    Specifies the region in which to create the custom authorizer resource. If omitted, the provider-level region will be used. Changing this will create a new custom authorizer resource.
    Type string
    Specifies the custom authoriz type. The valid values are FRONTEND and BACKEND. Changing this will create a new custom authorizer resource.
    UserData string

    Specifies the user data, which can contain a maximum of 2,048 characters. The user data is used by APIG to invoke the specified authentication function when accessing the backend service.

    NOTE: The user data will be displayed in plain text on the console.

    functionUrn String
    Specifies the uniform function URN of the function graph resource.
    instanceId String
    Specifies an ID of the APIG dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
    apigCustomAuthorizerId String
    ID of the custom authorizer.
    cacheAge Double
    Specifies the maximum cache age.
    identities List<ApigCustomAuthorizerIdentity>
    Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
    isBodySend Boolean
    Specifies whether to send the body.
    name String
    Specifies the name of the custom authorizer. The custom authorizer name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    region String
    Specifies the region in which to create the custom authorizer resource. If omitted, the provider-level region will be used. Changing this will create a new custom authorizer resource.
    type String
    Specifies the custom authoriz type. The valid values are FRONTEND and BACKEND. Changing this will create a new custom authorizer resource.
    userData String

    Specifies the user data, which can contain a maximum of 2,048 characters. The user data is used by APIG to invoke the specified authentication function when accessing the backend service.

    NOTE: The user data will be displayed in plain text on the console.

    functionUrn string
    Specifies the uniform function URN of the function graph resource.
    instanceId string
    Specifies an ID of the APIG dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
    apigCustomAuthorizerId string
    ID of the custom authorizer.
    cacheAge number
    Specifies the maximum cache age.
    identities ApigCustomAuthorizerIdentity[]
    Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
    isBodySend boolean
    Specifies whether to send the body.
    name string
    Specifies the name of the custom authorizer. The custom authorizer name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    region string
    Specifies the region in which to create the custom authorizer resource. If omitted, the provider-level region will be used. Changing this will create a new custom authorizer resource.
    type string
    Specifies the custom authoriz type. The valid values are FRONTEND and BACKEND. Changing this will create a new custom authorizer resource.
    userData string

    Specifies the user data, which can contain a maximum of 2,048 characters. The user data is used by APIG to invoke the specified authentication function when accessing the backend service.

    NOTE: The user data will be displayed in plain text on the console.

    function_urn str
    Specifies the uniform function URN of the function graph resource.
    instance_id str
    Specifies an ID of the APIG dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
    apig_custom_authorizer_id str
    ID of the custom authorizer.
    cache_age float
    Specifies the maximum cache age.
    identities Sequence[ApigCustomAuthorizerIdentityArgs]
    Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
    is_body_send bool
    Specifies whether to send the body.
    name str
    Specifies the name of the custom authorizer. The custom authorizer name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    region str
    Specifies the region in which to create the custom authorizer resource. If omitted, the provider-level region will be used. Changing this will create a new custom authorizer resource.
    type str
    Specifies the custom authoriz type. The valid values are FRONTEND and BACKEND. Changing this will create a new custom authorizer resource.
    user_data str

    Specifies the user data, which can contain a maximum of 2,048 characters. The user data is used by APIG to invoke the specified authentication function when accessing the backend service.

    NOTE: The user data will be displayed in plain text on the console.

    functionUrn String
    Specifies the uniform function URN of the function graph resource.
    instanceId String
    Specifies an ID of the APIG dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
    apigCustomAuthorizerId String
    ID of the custom authorizer.
    cacheAge Number
    Specifies the maximum cache age.
    identities List<Property Map>
    Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
    isBodySend Boolean
    Specifies whether to send the body.
    name String
    Specifies the name of the custom authorizer. The custom authorizer name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    region String
    Specifies the region in which to create the custom authorizer resource. If omitted, the provider-level region will be used. Changing this will create a new custom authorizer resource.
    type String
    Specifies the custom authoriz type. The valid values are FRONTEND and BACKEND. Changing this will create a new custom authorizer resource.
    userData String

    Specifies the user data, which can contain a maximum of 2,048 characters. The user data is used by APIG to invoke the specified authentication function when accessing the backend service.

    NOTE: The user data will be displayed in plain text on the console.

    Outputs

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

    CreatedAt string
    The creation time of the custom authorizer.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreatedAt string
    The creation time of the custom authorizer.
    Id string
    The provider-assigned unique ID for this managed resource.
    createdAt String
    The creation time of the custom authorizer.
    id String
    The provider-assigned unique ID for this managed resource.
    createdAt string
    The creation time of the custom authorizer.
    id string
    The provider-assigned unique ID for this managed resource.
    created_at str
    The creation time of the custom authorizer.
    id str
    The provider-assigned unique ID for this managed resource.
    createdAt String
    The creation time of the custom authorizer.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ApigCustomAuthorizer Resource

    Get an existing ApigCustomAuthorizer 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?: ApigCustomAuthorizerState, opts?: CustomResourceOptions): ApigCustomAuthorizer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apig_custom_authorizer_id: Optional[str] = None,
        cache_age: Optional[float] = None,
        created_at: Optional[str] = None,
        function_urn: Optional[str] = None,
        identities: Optional[Sequence[ApigCustomAuthorizerIdentityArgs]] = None,
        instance_id: Optional[str] = None,
        is_body_send: Optional[bool] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        type: Optional[str] = None,
        user_data: Optional[str] = None) -> ApigCustomAuthorizer
    func GetApigCustomAuthorizer(ctx *Context, name string, id IDInput, state *ApigCustomAuthorizerState, opts ...ResourceOption) (*ApigCustomAuthorizer, error)
    public static ApigCustomAuthorizer Get(string name, Input<string> id, ApigCustomAuthorizerState? state, CustomResourceOptions? opts = null)
    public static ApigCustomAuthorizer get(String name, Output<String> id, ApigCustomAuthorizerState state, CustomResourceOptions options)
    resources:  _:    type: flexibleengine:ApigCustomAuthorizer    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:
    ApigCustomAuthorizerId string
    ID of the custom authorizer.
    CacheAge double
    Specifies the maximum cache age.
    CreatedAt string
    The creation time of the custom authorizer.
    FunctionUrn string
    Specifies the uniform function URN of the function graph resource.
    Identities List<ApigCustomAuthorizerIdentity>
    Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
    InstanceId string
    Specifies an ID of the APIG dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
    IsBodySend bool
    Specifies whether to send the body.
    Name string
    Specifies the name of the custom authorizer. The custom authorizer name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    Region string
    Specifies the region in which to create the custom authorizer resource. If omitted, the provider-level region will be used. Changing this will create a new custom authorizer resource.
    Type string
    Specifies the custom authoriz type. The valid values are FRONTEND and BACKEND. Changing this will create a new custom authorizer resource.
    UserData string

    Specifies the user data, which can contain a maximum of 2,048 characters. The user data is used by APIG to invoke the specified authentication function when accessing the backend service.

    NOTE: The user data will be displayed in plain text on the console.

    ApigCustomAuthorizerId string
    ID of the custom authorizer.
    CacheAge float64
    Specifies the maximum cache age.
    CreatedAt string
    The creation time of the custom authorizer.
    FunctionUrn string
    Specifies the uniform function URN of the function graph resource.
    Identities []ApigCustomAuthorizerIdentityArgs
    Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
    InstanceId string
    Specifies an ID of the APIG dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
    IsBodySend bool
    Specifies whether to send the body.
    Name string
    Specifies the name of the custom authorizer. The custom authorizer name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    Region string
    Specifies the region in which to create the custom authorizer resource. If omitted, the provider-level region will be used. Changing this will create a new custom authorizer resource.
    Type string
    Specifies the custom authoriz type. The valid values are FRONTEND and BACKEND. Changing this will create a new custom authorizer resource.
    UserData string

    Specifies the user data, which can contain a maximum of 2,048 characters. The user data is used by APIG to invoke the specified authentication function when accessing the backend service.

    NOTE: The user data will be displayed in plain text on the console.

    apigCustomAuthorizerId String
    ID of the custom authorizer.
    cacheAge Double
    Specifies the maximum cache age.
    createdAt String
    The creation time of the custom authorizer.
    functionUrn String
    Specifies the uniform function URN of the function graph resource.
    identities List<ApigCustomAuthorizerIdentity>
    Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
    instanceId String
    Specifies an ID of the APIG dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
    isBodySend Boolean
    Specifies whether to send the body.
    name String
    Specifies the name of the custom authorizer. The custom authorizer name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    region String
    Specifies the region in which to create the custom authorizer resource. If omitted, the provider-level region will be used. Changing this will create a new custom authorizer resource.
    type String
    Specifies the custom authoriz type. The valid values are FRONTEND and BACKEND. Changing this will create a new custom authorizer resource.
    userData String

    Specifies the user data, which can contain a maximum of 2,048 characters. The user data is used by APIG to invoke the specified authentication function when accessing the backend service.

    NOTE: The user data will be displayed in plain text on the console.

    apigCustomAuthorizerId string
    ID of the custom authorizer.
    cacheAge number
    Specifies the maximum cache age.
    createdAt string
    The creation time of the custom authorizer.
    functionUrn string
    Specifies the uniform function URN of the function graph resource.
    identities ApigCustomAuthorizerIdentity[]
    Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
    instanceId string
    Specifies an ID of the APIG dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
    isBodySend boolean
    Specifies whether to send the body.
    name string
    Specifies the name of the custom authorizer. The custom authorizer name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    region string
    Specifies the region in which to create the custom authorizer resource. If omitted, the provider-level region will be used. Changing this will create a new custom authorizer resource.
    type string
    Specifies the custom authoriz type. The valid values are FRONTEND and BACKEND. Changing this will create a new custom authorizer resource.
    userData string

    Specifies the user data, which can contain a maximum of 2,048 characters. The user data is used by APIG to invoke the specified authentication function when accessing the backend service.

    NOTE: The user data will be displayed in plain text on the console.

    apig_custom_authorizer_id str
    ID of the custom authorizer.
    cache_age float
    Specifies the maximum cache age.
    created_at str
    The creation time of the custom authorizer.
    function_urn str
    Specifies the uniform function URN of the function graph resource.
    identities Sequence[ApigCustomAuthorizerIdentityArgs]
    Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
    instance_id str
    Specifies an ID of the APIG dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
    is_body_send bool
    Specifies whether to send the body.
    name str
    Specifies the name of the custom authorizer. The custom authorizer name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    region str
    Specifies the region in which to create the custom authorizer resource. If omitted, the provider-level region will be used. Changing this will create a new custom authorizer resource.
    type str
    Specifies the custom authoriz type. The valid values are FRONTEND and BACKEND. Changing this will create a new custom authorizer resource.
    user_data str

    Specifies the user data, which can contain a maximum of 2,048 characters. The user data is used by APIG to invoke the specified authentication function when accessing the backend service.

    NOTE: The user data will be displayed in plain text on the console.

    apigCustomAuthorizerId String
    ID of the custom authorizer.
    cacheAge Number
    Specifies the maximum cache age.
    createdAt String
    The creation time of the custom authorizer.
    functionUrn String
    Specifies the uniform function URN of the function graph resource.
    identities List<Property Map>
    Specifies an array of one or more parameter identities of the custom authorizer. The object structure is documented below.
    instanceId String
    Specifies an ID of the APIG dedicated instance to which the custom authorizer belongs to. Changing this will create a new custom authorizer resource.
    isBodySend Boolean
    Specifies whether to send the body.
    name String
    Specifies the name of the custom authorizer. The custom authorizer name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed.
    region String
    Specifies the region in which to create the custom authorizer resource. If omitted, the provider-level region will be used. Changing this will create a new custom authorizer resource.
    type String
    Specifies the custom authoriz type. The valid values are FRONTEND and BACKEND. Changing this will create a new custom authorizer resource.
    userData String

    Specifies the user data, which can contain a maximum of 2,048 characters. The user data is used by APIG to invoke the specified authentication function when accessing the backend service.

    NOTE: The user data will be displayed in plain text on the console.

    Supporting Types

    ApigCustomAuthorizerIdentity, ApigCustomAuthorizerIdentityArgs

    Location string
    Specifies the parameter location, which support 'HEADER' and 'QUERY'.
    Name string
    Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
    Validation string
    Specifies the parameter verification expression. If omitted, the custom authorizer will not perform verification. The valid value is range form 1 to 2,048.
    Location string
    Specifies the parameter location, which support 'HEADER' and 'QUERY'.
    Name string
    Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
    Validation string
    Specifies the parameter verification expression. If omitted, the custom authorizer will not perform verification. The valid value is range form 1 to 2,048.
    location String
    Specifies the parameter location, which support 'HEADER' and 'QUERY'.
    name String
    Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
    validation String
    Specifies the parameter verification expression. If omitted, the custom authorizer will not perform verification. The valid value is range form 1 to 2,048.
    location string
    Specifies the parameter location, which support 'HEADER' and 'QUERY'.
    name string
    Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
    validation string
    Specifies the parameter verification expression. If omitted, the custom authorizer will not perform verification. The valid value is range form 1 to 2,048.
    location str
    Specifies the parameter location, which support 'HEADER' and 'QUERY'.
    name str
    Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
    validation str
    Specifies the parameter verification expression. If omitted, the custom authorizer will not perform verification. The valid value is range form 1 to 2,048.
    location String
    Specifies the parameter location, which support 'HEADER' and 'QUERY'.
    name String
    Specifies the name of the parameter to be verified. The parameter includes front-end and back-end parameters.
    validation String
    Specifies the parameter verification expression. If omitted, the custom authorizer will not perform verification. The valid value is range form 1 to 2,048.

    Import

    Custom Authorizers of the APIG can be imported using the ID of the APIG instance to which the group belongs and

    Custom Authorizer name, separated by a slash, e.g.

    $ pulumi import flexibleengine:index/apigCustomAuthorizer:ApigCustomAuthorizer test <instance_id>/<name>

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

    Package Details

    Repository
    flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
    License
    Notes
    This Pulumi package is based on the flexibleengine Terraform Provider.
    flexibleengine logo
    flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
    flexibleenginecloud/terraform-provider-flexibleengine