Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayHmacAuth
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

konnect.GatewayHmacAuth

Explore with Pulumi AI

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

GatewayHMACAuth Resource

Example Usage

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

const myGatewayhmacauth = new konnect.GatewayHmacAuth("myGatewayhmacauth", {
    consumer: {
        id: "...my_id...",
    },
    consumerId: "f28acbfa-c866-4587-b688-0208ac24df21",
    controlPlaneId: "9524ec7d-36d9-465d-a8c5-83a3c9390458",
    gatewayHmacAuthId: "...my_id...",
    secret: "...my_secret...",
    tags: ["..."],
    username: "...my_username...",
});
Copy
import pulumi
import pulumi_konnect as konnect

my_gatewayhmacauth = konnect.GatewayHmacAuth("myGatewayhmacauth",
    consumer={
        "id": "...my_id...",
    },
    consumer_id="f28acbfa-c866-4587-b688-0208ac24df21",
    control_plane_id="9524ec7d-36d9-465d-a8c5-83a3c9390458",
    gateway_hmac_auth_id="...my_id...",
    secret="...my_secret...",
    tags=["..."],
    username="...my_username...")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := konnect.NewGatewayHmacAuth(ctx, "myGatewayhmacauth", &konnect.GatewayHmacAuthArgs{
			Consumer: &konnect.GatewayHmacAuthConsumerArgs{
				Id: pulumi.String("...my_id..."),
			},
			ConsumerId:        pulumi.String("f28acbfa-c866-4587-b688-0208ac24df21"),
			ControlPlaneId:    pulumi.String("9524ec7d-36d9-465d-a8c5-83a3c9390458"),
			GatewayHmacAuthId: pulumi.String("...my_id..."),
			Secret:            pulumi.String("...my_secret..."),
			Tags: pulumi.StringArray{
				pulumi.String("..."),
			},
			Username: pulumi.String("...my_username..."),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Konnect = Pulumi.Konnect;

return await Deployment.RunAsync(() => 
{
    var myGatewayhmacauth = new Konnect.GatewayHmacAuth("myGatewayhmacauth", new()
    {
        Consumer = new Konnect.Inputs.GatewayHmacAuthConsumerArgs
        {
            Id = "...my_id...",
        },
        ConsumerId = "f28acbfa-c866-4587-b688-0208ac24df21",
        ControlPlaneId = "9524ec7d-36d9-465d-a8c5-83a3c9390458",
        GatewayHmacAuthId = "...my_id...",
        Secret = "...my_secret...",
        Tags = new[]
        {
            "...",
        },
        Username = "...my_username...",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayHmacAuth;
import com.pulumi.konnect.GatewayHmacAuthArgs;
import com.pulumi.konnect.inputs.GatewayHmacAuthConsumerArgs;
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 myGatewayhmacauth = new GatewayHmacAuth("myGatewayhmacauth", GatewayHmacAuthArgs.builder()
            .consumer(GatewayHmacAuthConsumerArgs.builder()
                .id("...my_id...")
                .build())
            .consumerId("f28acbfa-c866-4587-b688-0208ac24df21")
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .gatewayHmacAuthId("...my_id...")
            .secret("...my_secret...")
            .tags("...")
            .username("...my_username...")
            .build());

    }
}
Copy
resources:
  myGatewayhmacauth:
    type: konnect:GatewayHmacAuth
    properties:
      consumer:
        id: '...my_id...'
      consumerId: f28acbfa-c866-4587-b688-0208ac24df21
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      gatewayHmacAuthId: '...my_id...'
      secret: '...my_secret...'
      tags:
        - '...'
      username: '...my_username...'
Copy

Create GatewayHmacAuth Resource

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

Constructor syntax

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

@overload
def GatewayHmacAuth(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    consumer_id: Optional[str] = None,
                    control_plane_id: Optional[str] = None,
                    username: Optional[str] = None,
                    consumer: Optional[GatewayHmacAuthConsumerArgs] = None,
                    gateway_hmac_auth_id: Optional[str] = None,
                    secret: Optional[str] = None,
                    tags: Optional[Sequence[str]] = None)
func NewGatewayHmacAuth(ctx *Context, name string, args GatewayHmacAuthArgs, opts ...ResourceOption) (*GatewayHmacAuth, error)
public GatewayHmacAuth(string name, GatewayHmacAuthArgs args, CustomResourceOptions? opts = null)
public GatewayHmacAuth(String name, GatewayHmacAuthArgs args)
public GatewayHmacAuth(String name, GatewayHmacAuthArgs args, CustomResourceOptions options)

type: konnect:GatewayHmacAuth
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GatewayHmacAuthArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GatewayHmacAuthArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayHmacAuthArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayHmacAuthArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GatewayHmacAuthArgs
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 gatewayHmacAuthResource = new Konnect.GatewayHmacAuth("gatewayHmacAuthResource", new()
{
    ConsumerId = "string",
    ControlPlaneId = "string",
    Username = "string",
    Consumer = new Konnect.Inputs.GatewayHmacAuthConsumerArgs
    {
        Id = "string",
    },
    GatewayHmacAuthId = "string",
    Secret = "string",
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := konnect.NewGatewayHmacAuth(ctx, "gatewayHmacAuthResource", &konnect.GatewayHmacAuthArgs{
ConsumerId: pulumi.String("string"),
ControlPlaneId: pulumi.String("string"),
Username: pulumi.String("string"),
Consumer: &.GatewayHmacAuthConsumerArgs{
Id: pulumi.String("string"),
},
GatewayHmacAuthId: pulumi.String("string"),
Secret: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})
Copy
var gatewayHmacAuthResource = new GatewayHmacAuth("gatewayHmacAuthResource", GatewayHmacAuthArgs.builder()
    .consumerId("string")
    .controlPlaneId("string")
    .username("string")
    .consumer(GatewayHmacAuthConsumerArgs.builder()
        .id("string")
        .build())
    .gatewayHmacAuthId("string")
    .secret("string")
    .tags("string")
    .build());
Copy
gateway_hmac_auth_resource = konnect.GatewayHmacAuth("gatewayHmacAuthResource",
    consumer_id="string",
    control_plane_id="string",
    username="string",
    consumer={
        "id": "string",
    },
    gateway_hmac_auth_id="string",
    secret="string",
    tags=["string"])
Copy
const gatewayHmacAuthResource = new konnect.GatewayHmacAuth("gatewayHmacAuthResource", {
    consumerId: "string",
    controlPlaneId: "string",
    username: "string",
    consumer: {
        id: "string",
    },
    gatewayHmacAuthId: "string",
    secret: "string",
    tags: ["string"],
});
Copy
type: konnect:GatewayHmacAuth
properties:
    consumer:
        id: string
    consumerId: string
    controlPlaneId: string
    gatewayHmacAuthId: string
    secret: string
    tags:
        - string
    username: string
Copy

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

ConsumerId This property is required. string
Consumer ID for nested entities. Requires replacement if changed.
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Username This property is required. string
Requires replacement if changed.
Consumer GatewayHmacAuthConsumer
Requires replacement if changed.
GatewayHmacAuthId string
Requires replacement if changed.
Secret string
Requires replacement if changed.
Tags List<string>
Requires replacement if changed.
ConsumerId This property is required. string
Consumer ID for nested entities. Requires replacement if changed.
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Username This property is required. string
Requires replacement if changed.
Consumer GatewayHmacAuthConsumerArgs
Requires replacement if changed.
GatewayHmacAuthId string
Requires replacement if changed.
Secret string
Requires replacement if changed.
Tags []string
Requires replacement if changed.
consumerId This property is required. String
Consumer ID for nested entities. Requires replacement if changed.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
username This property is required. String
Requires replacement if changed.
consumer GatewayHmacAuthConsumer
Requires replacement if changed.
gatewayHmacAuthId String
Requires replacement if changed.
secret String
Requires replacement if changed.
tags List<String>
Requires replacement if changed.
consumerId This property is required. string
Consumer ID for nested entities. Requires replacement if changed.
controlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
username This property is required. string
Requires replacement if changed.
consumer GatewayHmacAuthConsumer
Requires replacement if changed.
gatewayHmacAuthId string
Requires replacement if changed.
secret string
Requires replacement if changed.
tags string[]
Requires replacement if changed.
consumer_id This property is required. str
Consumer ID for nested entities. Requires replacement if changed.
control_plane_id This property is required. str
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
username This property is required. str
Requires replacement if changed.
consumer GatewayHmacAuthConsumerArgs
Requires replacement if changed.
gateway_hmac_auth_id str
Requires replacement if changed.
secret str
Requires replacement if changed.
tags Sequence[str]
Requires replacement if changed.
consumerId This property is required. String
Consumer ID for nested entities. Requires replacement if changed.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
username This property is required. String
Requires replacement if changed.
consumer Property Map
Requires replacement if changed.
gatewayHmacAuthId String
Requires replacement if changed.
secret String
Requires replacement if changed.
tags List<String>
Requires replacement if changed.

Outputs

All input properties are implicitly available as output properties. Additionally, the GatewayHmacAuth 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.
CreatedAt float64
Unix epoch when the resource was created.
Id string
The provider-assigned unique ID for this managed resource.
createdAt Double
Unix epoch when the resource was created.
id String
The provider-assigned unique ID for this managed resource.
createdAt number
Unix epoch when the resource was created.
id string
The provider-assigned unique ID for this managed resource.
created_at float
Unix epoch when the resource was created.
id str
The provider-assigned unique ID for this managed resource.
createdAt Number
Unix epoch when the resource was created.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing GatewayHmacAuth Resource

Get an existing GatewayHmacAuth 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?: GatewayHmacAuthState, opts?: CustomResourceOptions): GatewayHmacAuth
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        consumer: Optional[GatewayHmacAuthConsumerArgs] = None,
        consumer_id: Optional[str] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        gateway_hmac_auth_id: Optional[str] = None,
        secret: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        username: Optional[str] = None) -> GatewayHmacAuth
func GetGatewayHmacAuth(ctx *Context, name string, id IDInput, state *GatewayHmacAuthState, opts ...ResourceOption) (*GatewayHmacAuth, error)
public static GatewayHmacAuth Get(string name, Input<string> id, GatewayHmacAuthState? state, CustomResourceOptions? opts = null)
public static GatewayHmacAuth get(String name, Output<String> id, GatewayHmacAuthState state, CustomResourceOptions options)
resources:  _:    type: konnect:GatewayHmacAuth    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Consumer GatewayHmacAuthConsumer
Requires replacement if changed.
ConsumerId string
Consumer ID for nested entities. Requires replacement if changed.
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.
GatewayHmacAuthId string
Requires replacement if changed.
Secret string
Requires replacement if changed.
Tags List<string>
Requires replacement if changed.
Username string
Requires replacement if changed.
Consumer GatewayHmacAuthConsumerArgs
Requires replacement if changed.
ConsumerId string
Consumer ID for nested entities. Requires replacement if changed.
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.
GatewayHmacAuthId string
Requires replacement if changed.
Secret string
Requires replacement if changed.
Tags []string
Requires replacement if changed.
Username string
Requires replacement if changed.
consumer GatewayHmacAuthConsumer
Requires replacement if changed.
consumerId String
Consumer ID for nested entities. Requires replacement if changed.
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.
gatewayHmacAuthId String
Requires replacement if changed.
secret String
Requires replacement if changed.
tags List<String>
Requires replacement if changed.
username String
Requires replacement if changed.
consumer GatewayHmacAuthConsumer
Requires replacement if changed.
consumerId string
Consumer ID for nested entities. Requires replacement if changed.
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.
gatewayHmacAuthId string
Requires replacement if changed.
secret string
Requires replacement if changed.
tags string[]
Requires replacement if changed.
username string
Requires replacement if changed.
consumer GatewayHmacAuthConsumerArgs
Requires replacement if changed.
consumer_id str
Consumer ID for nested entities. Requires replacement if changed.
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.
gateway_hmac_auth_id str
Requires replacement if changed.
secret str
Requires replacement if changed.
tags Sequence[str]
Requires replacement if changed.
username str
Requires replacement if changed.
consumer Property Map
Requires replacement if changed.
consumerId String
Consumer ID for nested entities. Requires replacement if changed.
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.
gatewayHmacAuthId String
Requires replacement if changed.
secret String
Requires replacement if changed.
tags List<String>
Requires replacement if changed.
username String
Requires replacement if changed.

Supporting Types

GatewayHmacAuthConsumer
, GatewayHmacAuthConsumerArgs

Id string
Requires replacement if changed.
Id string
Requires replacement if changed.
id String
Requires replacement if changed.
id string
Requires replacement if changed.
id str
Requires replacement if changed.
id String
Requires replacement if changed.

Import

$ pulumi import konnect:index/gatewayHmacAuth:GatewayHmacAuth my_konnect_gateway_hmac_auth "{ \"consumer_id\": \"f28acbfa-c866-4587-b688-0208ac24df21\", \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"hmac_auth_id\": \"70e7b00b-72f2-471b-a5ce-9c4171775360\"}"
Copy

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