konnect 2.4.1, Mar 13 25

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

konnect.GatewayPluginHmacAuth

Explore with Pulumi AI

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayPluginHmacAuth;
import com.pulumi.konnect.GatewayPluginHmacAuthArgs;
import com.pulumi.konnect.inputs.GatewayPluginHmacAuthConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginHmacAuthOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginHmacAuthOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginHmacAuthOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginHmacAuthRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginHmacAuthServiceArgs;
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 myGatewaypluginhmacauth = new GatewayPluginHmacAuth("myGatewaypluginhmacauth", GatewayPluginHmacAuthArgs.builder()
            .config(GatewayPluginHmacAuthConfigArgs.builder()
                .algorithms("hmac-sha256")
                .anonymous("...my_anonymous...")
                .clock_skew(5.59)
                .enforce_headers("...")
                .hide_credentials(true)
                .realm("...my_realm...")
                .validate_request_body(true)
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(true)
            .gatewayPluginHmacAuthId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginHmacAuthOrderingArgs.builder()
                .after(GatewayPluginHmacAuthOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginHmacAuthOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("https")
            .route(GatewayPluginHmacAuthRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginHmacAuthServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());

    }
}

resources:
  myGatewaypluginhmacauth:
    type: konnect:GatewayPluginHmacAuth
    properties:
      config:
        algorithms:
          - hmac-sha256
        anonymous: '...my_anonymous...'
        clock_skew: 5.59
        enforce_headers:
          - '...'
        hide_credentials: true
        realm: '...my_realm...'
        validate_request_body: true
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: true
      gatewayPluginHmacAuthId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - https
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'

Create GatewayPluginHmacAuth Resource

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

Constructor syntax

new GatewayPluginHmacAuth(name: string, args: GatewayPluginHmacAuthArgs, opts?: CustomResourceOptions);

@overload
def GatewayPluginHmacAuth(resource_name: str,
                          args: GatewayPluginHmacAuthArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def GatewayPluginHmacAuth(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          config: Optional[GatewayPluginHmacAuthConfigArgs] = None,
                          control_plane_id: Optional[str] = None,
                          enabled: Optional[bool] = None,
                          gateway_plugin_hmac_auth_id: Optional[str] = None,
                          instance_name: Optional[str] = None,
                          ordering: Optional[GatewayPluginHmacAuthOrderingArgs] = None,
                          protocols: Optional[Sequence[str]] = None,
                          route: Optional[GatewayPluginHmacAuthRouteArgs] = None,
                          service: Optional[GatewayPluginHmacAuthServiceArgs] = None,
                          tags: Optional[Sequence[str]] = None)

func NewGatewayPluginHmacAuth(ctx *Context, name string, args GatewayPluginHmacAuthArgs, opts ...ResourceOption) (*GatewayPluginHmacAuth, error)

public GatewayPluginHmacAuth(string name, GatewayPluginHmacAuthArgs args, CustomResourceOptions? opts = null)

public GatewayPluginHmacAuth(String name, GatewayPluginHmacAuthArgs args)
public GatewayPluginHmacAuth(String name, GatewayPluginHmacAuthArgs args, CustomResourceOptions options)

type: konnect:GatewayPluginHmacAuth
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 GatewayPluginHmacAuthArgs: 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 GatewayPluginHmacAuthArgs: 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 GatewayPluginHmacAuthArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GatewayPluginHmacAuthArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args GatewayPluginHmacAuthArgs: 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 gatewayPluginHmacAuthResource = new Konnect.GatewayPluginHmacAuth("gatewayPluginHmacAuthResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginHmacAuthConfigArgs
    {
        Algorithms = new[]
        {
            "string",
        },
        Anonymous = "string",
        ClockSkew = 0,
        EnforceHeaders = new[]
        {
            "string",
        },
        HideCredentials = false,
        Realm = "string",
        ValidateRequestBody = false,
    },
    ControlPlaneId = "string",
    Enabled = false,
    GatewayPluginHmacAuthId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginHmacAuthOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginHmacAuthOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginHmacAuthOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginHmacAuthRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginHmacAuthServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});

example, err := konnect.NewGatewayPluginHmacAuth(ctx, "gatewayPluginHmacAuthResource", &konnect.GatewayPluginHmacAuthArgs{
Config: &.GatewayPluginHmacAuthConfigArgs{
Algorithms: pulumi.StringArray{
pulumi.String("string"),
},
Anonymous: pulumi.String("string"),
ClockSkew: pulumi.Float64(0),
EnforceHeaders: pulumi.StringArray{
pulumi.String("string"),
},
HideCredentials: pulumi.Bool(false),
Realm: pulumi.String("string"),
ValidateRequestBody: pulumi.Bool(false),
},
ControlPlaneId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
GatewayPluginHmacAuthId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginHmacAuthOrderingArgs{
After: &.GatewayPluginHmacAuthOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginHmacAuthOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginHmacAuthRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginHmacAuthServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})

var gatewayPluginHmacAuthResource = new GatewayPluginHmacAuth("gatewayPluginHmacAuthResource", GatewayPluginHmacAuthArgs.builder()
    .config(GatewayPluginHmacAuthConfigArgs.builder()
        .algorithms("string")
        .anonymous("string")
        .clockSkew(0)
        .enforceHeaders("string")
        .hideCredentials(false)
        .realm("string")
        .validateRequestBody(false)
        .build())
    .controlPlaneId("string")
    .enabled(false)
    .gatewayPluginHmacAuthId("string")
    .instanceName("string")
    .ordering(GatewayPluginHmacAuthOrderingArgs.builder()
        .after(GatewayPluginHmacAuthOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginHmacAuthOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginHmacAuthRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginHmacAuthServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());

gateway_plugin_hmac_auth_resource = konnect.GatewayPluginHmacAuth("gatewayPluginHmacAuthResource",
    config={
        "algorithms": ["string"],
        "anonymous": "string",
        "clock_skew": 0,
        "enforce_headers": ["string"],
        "hide_credentials": False,
        "realm": "string",
        "validate_request_body": False,
    },
    control_plane_id="string",
    enabled=False,
    gateway_plugin_hmac_auth_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])

const gatewayPluginHmacAuthResource = new konnect.GatewayPluginHmacAuth("gatewayPluginHmacAuthResource", {
    config: {
        algorithms: ["string"],
        anonymous: "string",
        clockSkew: 0,
        enforceHeaders: ["string"],
        hideCredentials: false,
        realm: "string",
        validateRequestBody: false,
    },
    controlPlaneId: "string",
    enabled: false,
    gatewayPluginHmacAuthId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});

type: konnect:GatewayPluginHmacAuth
properties:
    config:
        algorithms:
            - string
        anonymous: string
        clockSkew: 0
        enforceHeaders:
            - string
        hideCredentials: false
        realm: string
        validateRequestBody: false
    controlPlaneId: string
    enabled: false
    gatewayPluginHmacAuthId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string

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

Config GatewayPluginHmacAuthConfig
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Enabled bool: Whether the plugin is applied.
GatewayPluginHmacAuthId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginHmacAuthOrdering
Protocols List<string>: A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
Route GatewayPluginHmacAuthRoute: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
Service GatewayPluginHmacAuthService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags List<string>: An optional set of strings associated with the Plugin for grouping and filtering.

Config GatewayPluginHmacAuthConfigArgs
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Enabled bool: Whether the plugin is applied.
GatewayPluginHmacAuthId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginHmacAuthOrderingArgs
Protocols []string: A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
Route GatewayPluginHmacAuthRouteArgs: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
Service GatewayPluginHmacAuthServiceArgs: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags []string: An optional set of strings associated with the Plugin for grouping and filtering.

config GatewayPluginHmacAuthConfig
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
enabled Boolean: Whether the plugin is applied.
gatewayPluginHmacAuthId String: The ID of this resource.
instanceName String
ordering GatewayPluginHmacAuthOrdering
protocols List<String>: A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
route GatewayPluginHmacAuthRoute: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginHmacAuthService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>: An optional set of strings associated with the Plugin for grouping and filtering.

config GatewayPluginHmacAuthConfig
controlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
enabled boolean: Whether the plugin is applied.
gatewayPluginHmacAuthId string: The ID of this resource.
instanceName string
ordering GatewayPluginHmacAuthOrdering
protocols string[]: A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
route GatewayPluginHmacAuthRoute: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginHmacAuthService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags string[]: An optional set of strings associated with the Plugin for grouping and filtering.

config GatewayPluginHmacAuthConfigArgs
control_plane_id str: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
enabled bool: Whether the plugin is applied.
gateway_plugin_hmac_auth_id str: The ID of this resource.
instance_name str
ordering GatewayPluginHmacAuthOrderingArgs
protocols Sequence[str]: A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
route GatewayPluginHmacAuthRouteArgs: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginHmacAuthServiceArgs: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags Sequence[str]: An optional set of strings associated with the Plugin for grouping and filtering.

config Property Map
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
enabled Boolean: Whether the plugin is applied.
gatewayPluginHmacAuthId String: The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>: A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
route Property Map: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service Property Map: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>: An optional set of strings associated with the Plugin for grouping and filtering.

Outputs

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

CreatedAt double: Unix epoch when the resource was created.
Id string: The provider-assigned unique ID for this managed resource.
UpdatedAt double: Unix epoch when the resource was last updated.

CreatedAt float64: Unix epoch when the resource was created.
Id string: The provider-assigned unique ID for this managed resource.
UpdatedAt float64: Unix epoch when the resource was last updated.

createdAt Double: Unix epoch when the resource was created.
id String: The provider-assigned unique ID for this managed resource.
updatedAt Double: Unix epoch when the resource was last updated.

createdAt number: Unix epoch when the resource was created.
id string: The provider-assigned unique ID for this managed resource.
updatedAt number: Unix epoch when the resource was last updated.

created_at float: Unix epoch when the resource was created.
id str: The provider-assigned unique ID for this managed resource.
updated_at float: Unix epoch when the resource was last updated.

createdAt Number: Unix epoch when the resource was created.
id String: The provider-assigned unique ID for this managed resource.
updatedAt Number: Unix epoch when the resource was last updated.

Look up Existing GatewayPluginHmacAuth Resource

Get an existing GatewayPluginHmacAuth 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?: GatewayPluginHmacAuthState, opts?: CustomResourceOptions): GatewayPluginHmacAuth

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginHmacAuthConfigArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_hmac_auth_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginHmacAuthOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginHmacAuthRouteArgs] = None,
        service: Optional[GatewayPluginHmacAuthServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginHmacAuth

func GetGatewayPluginHmacAuth(ctx *Context, name string, id IDInput, state *GatewayPluginHmacAuthState, opts ...ResourceOption) (*GatewayPluginHmacAuth, error)

public static GatewayPluginHmacAuth Get(string name, Input<string> id, GatewayPluginHmacAuthState? state, CustomResourceOptions? opts = null)

public static GatewayPluginHmacAuth get(String name, Output<String> id, GatewayPluginHmacAuthState state, CustomResourceOptions options)

resources:  _:    type: konnect:GatewayPluginHmacAuth    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:

Config GatewayPluginHmacAuthConfig
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt double: Unix epoch when the resource was created.
Enabled bool: Whether the plugin is applied.
GatewayPluginHmacAuthId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginHmacAuthOrdering
Protocols List<string>: A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
Route GatewayPluginHmacAuthRoute: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
Service GatewayPluginHmacAuthService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags List<string>: An optional set of strings associated with the Plugin for grouping and filtering.
UpdatedAt double: Unix epoch when the resource was last updated.

Config GatewayPluginHmacAuthConfigArgs
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt float64: Unix epoch when the resource was created.
Enabled bool: Whether the plugin is applied.
GatewayPluginHmacAuthId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginHmacAuthOrderingArgs
Protocols []string: A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
Route GatewayPluginHmacAuthRouteArgs: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
Service GatewayPluginHmacAuthServiceArgs: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags []string: An optional set of strings associated with the Plugin for grouping and filtering.
UpdatedAt float64: Unix epoch when the resource was last updated.

config GatewayPluginHmacAuthConfig
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Double: Unix epoch when the resource was created.
enabled Boolean: Whether the plugin is applied.
gatewayPluginHmacAuthId String: The ID of this resource.
instanceName String
ordering GatewayPluginHmacAuthOrdering
protocols List<String>: A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
route GatewayPluginHmacAuthRoute: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginHmacAuthService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>: An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt Double: Unix epoch when the resource was last updated.

config GatewayPluginHmacAuthConfig
controlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt number: Unix epoch when the resource was created.
enabled boolean: Whether the plugin is applied.
gatewayPluginHmacAuthId string: The ID of this resource.
instanceName string
ordering GatewayPluginHmacAuthOrdering
protocols string[]: A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
route GatewayPluginHmacAuthRoute: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginHmacAuthService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags string[]: An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt number: Unix epoch when the resource was last updated.

config GatewayPluginHmacAuthConfigArgs
control_plane_id str: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
created_at float: Unix epoch when the resource was created.
enabled bool: Whether the plugin is applied.
gateway_plugin_hmac_auth_id str: The ID of this resource.
instance_name str
ordering GatewayPluginHmacAuthOrderingArgs
protocols Sequence[str]: A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
route GatewayPluginHmacAuthRouteArgs: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginHmacAuthServiceArgs: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags Sequence[str]: An optional set of strings associated with the Plugin for grouping and filtering.
updated_at float: Unix epoch when the resource was last updated.

config Property Map
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Number: Unix epoch when the resource was created.
enabled Boolean: Whether the plugin is applied.
gatewayPluginHmacAuthId String: The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>: A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.
route Property Map: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service Property Map: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>: An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt Number: Unix epoch when the resource was last updated.

Supporting Types

GatewayPluginHmacAuthConfig, GatewayPluginHmacAuthConfigArgs

Algorithms List<string>: A list of HMAC digest algorithms that the user wants to support. Allowed values are hmac-sha1, hmac-sha256, hmac-sha384, and hmac-sha512
Anonymous string: An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
ClockSkew double: Clock skew in seconds to prevent replay attacks.
EnforceHeaders List<string>: A list of headers that the client should at least use for HTTP signature creation.
HideCredentials bool: An optional boolean value telling the plugin to show or hide the credential from the upstream service.
Realm string: When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
ValidateRequestBody bool: A boolean value telling the plugin to enable body validation.

Algorithms []string: A list of HMAC digest algorithms that the user wants to support. Allowed values are hmac-sha1, hmac-sha256, hmac-sha384, and hmac-sha512
Anonymous string: An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
ClockSkew float64: Clock skew in seconds to prevent replay attacks.
EnforceHeaders []string: A list of headers that the client should at least use for HTTP signature creation.
HideCredentials bool: An optional boolean value telling the plugin to show or hide the credential from the upstream service.
Realm string: When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
ValidateRequestBody bool: A boolean value telling the plugin to enable body validation.

algorithms List<String>: A list of HMAC digest algorithms that the user wants to support. Allowed values are hmac-sha1, hmac-sha256, hmac-sha384, and hmac-sha512
anonymous String: An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
clockSkew Double: Clock skew in seconds to prevent replay attacks.
enforceHeaders List<String>: A list of headers that the client should at least use for HTTP signature creation.
hideCredentials Boolean: An optional boolean value telling the plugin to show or hide the credential from the upstream service.
realm String: When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
validateRequestBody Boolean: A boolean value telling the plugin to enable body validation.

algorithms string[]: A list of HMAC digest algorithms that the user wants to support. Allowed values are hmac-sha1, hmac-sha256, hmac-sha384, and hmac-sha512
anonymous string: An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
clockSkew number: Clock skew in seconds to prevent replay attacks.
enforceHeaders string[]: A list of headers that the client should at least use for HTTP signature creation.
hideCredentials boolean: An optional boolean value telling the plugin to show or hide the credential from the upstream service.
realm string: When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
validateRequestBody boolean: A boolean value telling the plugin to enable body validation.

algorithms Sequence[str]: A list of HMAC digest algorithms that the user wants to support. Allowed values are hmac-sha1, hmac-sha256, hmac-sha384, and hmac-sha512
anonymous str: An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
clock_skew float: Clock skew in seconds to prevent replay attacks.
enforce_headers Sequence[str]: A list of headers that the client should at least use for HTTP signature creation.
hide_credentials bool: An optional boolean value telling the plugin to show or hide the credential from the upstream service.
realm str: When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
validate_request_body bool: A boolean value telling the plugin to enable body validation.

algorithms List<String>: A list of HMAC digest algorithms that the user wants to support. Allowed values are hmac-sha1, hmac-sha256, hmac-sha384, and hmac-sha512
anonymous String: An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.
clockSkew Number: Clock skew in seconds to prevent replay attacks.
enforceHeaders List<String>: A list of headers that the client should at least use for HTTP signature creation.
hideCredentials Boolean: An optional boolean value telling the plugin to show or hide the credential from the upstream service.
realm String: When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
validateRequestBody Boolean: A boolean value telling the plugin to enable body validation.

GatewayPluginHmacAuthOrdering, GatewayPluginHmacAuthOrderingArgs

After GatewayPluginHmacAuthOrderingAfter
Before GatewayPluginHmacAuthOrderingBefore

After GatewayPluginHmacAuthOrderingAfter
Before GatewayPluginHmacAuthOrderingBefore

after GatewayPluginHmacAuthOrderingAfter
before GatewayPluginHmacAuthOrderingBefore

after GatewayPluginHmacAuthOrderingAfter
before GatewayPluginHmacAuthOrderingBefore

after GatewayPluginHmacAuthOrderingAfter
before GatewayPluginHmacAuthOrderingBefore

after Property Map
before Property Map

GatewayPluginHmacAuthOrderingAfter, GatewayPluginHmacAuthOrderingAfterArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginHmacAuthOrderingBefore, GatewayPluginHmacAuthOrderingBeforeArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginHmacAuthRoute, GatewayPluginHmacAuthRouteArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginHmacAuthService, GatewayPluginHmacAuthServiceArgs

Id string

Id string

id String

id string

id str

id String

Import

$ pulumi import konnect:index/gatewayPluginHmacAuth:GatewayPluginHmacAuth my_konnect_gateway_plugin_hmac_auth "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"plugin_id\": \"3473c251-5b6c-4f45-b1ff-7ede735a366d\"}"

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 2.4.1 published on Thursday, Mar 13, 2025 by kong

kong/terraform-provider-konnect

konnect.GatewayPluginHmacAuth

On this page

On this page

Example Usage

Create GatewayPluginHmacAuth Resource

Constructor syntax

Parameters

Constructor example

GatewayPluginHmacAuth Resource Properties

Inputs

Outputs

Look up Existing GatewayPluginHmacAuth Resource

Supporting Types

GatewayPluginHmacAuthConfig, GatewayPluginHmacAuthConfigArgs

GatewayPluginHmacAuthOrdering, GatewayPluginHmacAuthOrderingArgs

GatewayPluginHmacAuthOrderingAfter, GatewayPluginHmacAuthOrderingAfterArgs

GatewayPluginHmacAuthOrderingBefore, GatewayPluginHmacAuthOrderingBeforeArgs

GatewayPluginHmacAuthRoute, GatewayPluginHmacAuthRouteArgs

GatewayPluginHmacAuthService, GatewayPluginHmacAuthServiceArgs

Import

Package Details

On this page

On this page