Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayKey
konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

konnect.GatewayKey

Explore with Pulumi AI

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

GatewayKey Resource

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.GatewayKey;
import com.pulumi.konnect.GatewayKeyArgs;
import com.pulumi.konnect.inputs.GatewayKeyPemArgs;
import com.pulumi.konnect.inputs.GatewayKeySetArgs;
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 myGatewaykey = new GatewayKey("myGatewaykey", GatewayKeyArgs.builder()
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .createdAt(3)
            .gatewayKeyId("...my_id...")
            .jwk("...my_jwk...")
            .kid("...my_kid...")
            .pem(GatewayKeyPemArgs.builder()
                .private_key("...my_private_key...")
                .public_key("...my_public_key...")
                .build())
            .set(GatewayKeySetArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .updatedAt(2)
            .x5t("...my_x5t...")
            .build());

    }
}
Copy
resources:
  myGatewaykey:
    type: konnect:GatewayKey
    properties:
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      createdAt: 3
      gatewayKeyId: '...my_id...'
      jwk: '...my_jwk...'
      kid: '...my_kid...'
      pem:
        private_key: '...my_private_key...'
        public_key: '...my_public_key...'
      set:
        id: '...my_id...'
      tags:
        - '...'
      updatedAt: 2
      x5t: '...my_x5t...'
Copy

Create GatewayKey Resource

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

Constructor syntax

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

@overload
def GatewayKey(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               control_plane_id: Optional[str] = None,
               kid: Optional[str] = None,
               created_at: Optional[float] = None,
               gateway_key_id: Optional[str] = None,
               jwk: Optional[str] = None,
               name: Optional[str] = None,
               pem: Optional[GatewayKeyPemArgs] = None,
               set: Optional[GatewayKeySetArgs] = None,
               tags: Optional[Sequence[str]] = None,
               updated_at: Optional[float] = None,
               x5t: Optional[str] = None)
func NewGatewayKey(ctx *Context, name string, args GatewayKeyArgs, opts ...ResourceOption) (*GatewayKey, error)
public GatewayKey(string name, GatewayKeyArgs args, CustomResourceOptions? opts = null)
public GatewayKey(String name, GatewayKeyArgs args)
public GatewayKey(String name, GatewayKeyArgs args, CustomResourceOptions options)

type: konnect:GatewayKey
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. GatewayKeyArgs
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. GatewayKeyArgs
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. GatewayKeyArgs
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. GatewayKeyArgs
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. GatewayKeyArgs
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 gatewayKeyResource = new Konnect.GatewayKey("gatewayKeyResource", new()
{
    ControlPlaneId = "string",
    Kid = "string",
    CreatedAt = 0,
    GatewayKeyId = "string",
    Jwk = "string",
    Name = "string",
    Pem = new Konnect.Inputs.GatewayKeyPemArgs
    {
        PrivateKey = "string",
        PublicKey = "string",
    },
    Set = new Konnect.Inputs.GatewayKeySetArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
    UpdatedAt = 0,
    X5t = "string",
});
Copy
example, err := konnect.NewGatewayKey(ctx, "gatewayKeyResource", &konnect.GatewayKeyArgs{
ControlPlaneId: pulumi.String("string"),
Kid: pulumi.String("string"),
CreatedAt: pulumi.Float64(0),
GatewayKeyId: pulumi.String("string"),
Jwk: pulumi.String("string"),
Name: pulumi.String("string"),
Pem: &.GatewayKeyPemArgs{
PrivateKey: pulumi.String("string"),
PublicKey: pulumi.String("string"),
},
Set: &.GatewayKeySetTypeArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
UpdatedAt: pulumi.Float64(0),
X5t: pulumi.String("string"),
})
Copy
var gatewayKeyResource = new GatewayKey("gatewayKeyResource", GatewayKeyArgs.builder()
    .controlPlaneId("string")
    .kid("string")
    .createdAt(0)
    .gatewayKeyId("string")
    .jwk("string")
    .name("string")
    .pem(GatewayKeyPemArgs.builder()
        .privateKey("string")
        .publicKey("string")
        .build())
    .set(GatewayKeySetArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .updatedAt(0)
    .x5t("string")
    .build());
Copy
gateway_key_resource = konnect.GatewayKey("gatewayKeyResource",
    control_plane_id="string",
    kid="string",
    created_at=0,
    gateway_key_id="string",
    jwk="string",
    name="string",
    pem={
        "private_key": "string",
        "public_key": "string",
    },
    set={
        "id": "string",
    },
    tags=["string"],
    updated_at=0,
    x5t="string")
Copy
const gatewayKeyResource = new konnect.GatewayKey("gatewayKeyResource", {
    controlPlaneId: "string",
    kid: "string",
    createdAt: 0,
    gatewayKeyId: "string",
    jwk: "string",
    name: "string",
    pem: {
        privateKey: "string",
        publicKey: "string",
    },
    set: {
        id: "string",
    },
    tags: ["string"],
    updatedAt: 0,
    x5t: "string",
});
Copy
type: konnect:GatewayKey
properties:
    controlPlaneId: string
    createdAt: 0
    gatewayKeyId: string
    jwk: string
    kid: string
    name: string
    pem:
        privateKey: string
        publicKey: string
    set:
        id: string
    tags:
        - string
    updatedAt: 0
    x5t: string
Copy

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

ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Kid This property is required. string
A unique identifier for a key.
CreatedAt double
Unix epoch when the resource was created.
GatewayKeyId string
The ID of this resource.
Jwk string
A JSON Web Key represented as a string.
Name string
The name to associate with the given keys.
Pem GatewayKeyPem
A keypair in PEM format.
Set GatewayKeySet
The id (an UUID) of the key-set with which to associate the key.
Tags List<string>
An optional set of strings associated with the Key for grouping and filtering.
UpdatedAt double
Unix epoch when the resource was last updated.
X5t string
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Kid This property is required. string
A unique identifier for a key.
CreatedAt float64
Unix epoch when the resource was created.
GatewayKeyId string
The ID of this resource.
Jwk string
A JSON Web Key represented as a string.
Name string
The name to associate with the given keys.
Pem GatewayKeyPemArgs
A keypair in PEM format.
Set GatewayKeySetTypeArgs
The id (an UUID) of the key-set with which to associate the key.
Tags []string
An optional set of strings associated with the Key for grouping and filtering.
UpdatedAt float64
Unix epoch when the resource was last updated.
X5t string
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
kid This property is required. String
A unique identifier for a key.
createdAt Double
Unix epoch when the resource was created.
gatewayKeyId String
The ID of this resource.
jwk String
A JSON Web Key represented as a string.
name String
The name to associate with the given keys.
pem GatewayKeyPem
A keypair in PEM format.
set GatewayKeySet
The id (an UUID) of the key-set with which to associate the key.
tags List<String>
An optional set of strings associated with the Key for grouping and filtering.
updatedAt Double
Unix epoch when the resource was last updated.
x5t String
controlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
kid This property is required. string
A unique identifier for a key.
createdAt number
Unix epoch when the resource was created.
gatewayKeyId string
The ID of this resource.
jwk string
A JSON Web Key represented as a string.
name string
The name to associate with the given keys.
pem GatewayKeyPem
A keypair in PEM format.
set GatewayKeySet
The id (an UUID) of the key-set with which to associate the key.
tags string[]
An optional set of strings associated with the Key for grouping and filtering.
updatedAt number
Unix epoch when the resource was last updated.
x5t string
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.
kid This property is required. str
A unique identifier for a key.
created_at float
Unix epoch when the resource was created.
gateway_key_id str
The ID of this resource.
jwk str
A JSON Web Key represented as a string.
name str
The name to associate with the given keys.
pem GatewayKeyPemArgs
A keypair in PEM format.
set GatewayKeySetArgs
The id (an UUID) of the key-set with which to associate the key.
tags Sequence[str]
An optional set of strings associated with the Key for grouping and filtering.
updated_at float
Unix epoch when the resource was last updated.
x5t str
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
kid This property is required. String
A unique identifier for a key.
createdAt Number
Unix epoch when the resource was created.
gatewayKeyId String
The ID of this resource.
jwk String
A JSON Web Key represented as a string.
name String
The name to associate with the given keys.
pem Property Map
A keypair in PEM format.
set Property Map
The id (an UUID) of the key-set with which to associate the key.
tags List<String>
An optional set of strings associated with the Key for grouping and filtering.
updatedAt Number
Unix epoch when the resource was last updated.
x5t String

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing GatewayKey Resource

Get an existing GatewayKey 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?: GatewayKeyState, opts?: CustomResourceOptions): GatewayKey
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        gateway_key_id: Optional[str] = None,
        jwk: Optional[str] = None,
        kid: Optional[str] = None,
        name: Optional[str] = None,
        pem: Optional[GatewayKeyPemArgs] = None,
        set: Optional[GatewayKeySetArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None,
        x5t: Optional[str] = None) -> GatewayKey
func GetGatewayKey(ctx *Context, name string, id IDInput, state *GatewayKeyState, opts ...ResourceOption) (*GatewayKey, error)
public static GatewayKey Get(string name, Input<string> id, GatewayKeyState? state, CustomResourceOptions? opts = null)
public static GatewayKey get(String name, Output<String> id, GatewayKeyState state, CustomResourceOptions options)
resources:  _:    type: konnect:GatewayKey    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:
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.
GatewayKeyId string
The ID of this resource.
Jwk string
A JSON Web Key represented as a string.
Kid string
A unique identifier for a key.
Name string
The name to associate with the given keys.
Pem GatewayKeyPem
A keypair in PEM format.
Set GatewayKeySet
The id (an UUID) of the key-set with which to associate the key.
Tags List<string>
An optional set of strings associated with the Key for grouping and filtering.
UpdatedAt double
Unix epoch when the resource was last updated.
X5t string
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.
GatewayKeyId string
The ID of this resource.
Jwk string
A JSON Web Key represented as a string.
Kid string
A unique identifier for a key.
Name string
The name to associate with the given keys.
Pem GatewayKeyPemArgs
A keypair in PEM format.
Set GatewayKeySetTypeArgs
The id (an UUID) of the key-set with which to associate the key.
Tags []string
An optional set of strings associated with the Key for grouping and filtering.
UpdatedAt float64
Unix epoch when the resource was last updated.
X5t string
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.
gatewayKeyId String
The ID of this resource.
jwk String
A JSON Web Key represented as a string.
kid String
A unique identifier for a key.
name String
The name to associate with the given keys.
pem GatewayKeyPem
A keypair in PEM format.
set GatewayKeySet
The id (an UUID) of the key-set with which to associate the key.
tags List<String>
An optional set of strings associated with the Key for grouping and filtering.
updatedAt Double
Unix epoch when the resource was last updated.
x5t String
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.
gatewayKeyId string
The ID of this resource.
jwk string
A JSON Web Key represented as a string.
kid string
A unique identifier for a key.
name string
The name to associate with the given keys.
pem GatewayKeyPem
A keypair in PEM format.
set GatewayKeySet
The id (an UUID) of the key-set with which to associate the key.
tags string[]
An optional set of strings associated with the Key for grouping and filtering.
updatedAt number
Unix epoch when the resource was last updated.
x5t string
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_key_id str
The ID of this resource.
jwk str
A JSON Web Key represented as a string.
kid str
A unique identifier for a key.
name str
The name to associate with the given keys.
pem GatewayKeyPemArgs
A keypair in PEM format.
set GatewayKeySetArgs
The id (an UUID) of the key-set with which to associate the key.
tags Sequence[str]
An optional set of strings associated with the Key for grouping and filtering.
updated_at float
Unix epoch when the resource was last updated.
x5t str
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.
gatewayKeyId String
The ID of this resource.
jwk String
A JSON Web Key represented as a string.
kid String
A unique identifier for a key.
name String
The name to associate with the given keys.
pem Property Map
A keypair in PEM format.
set Property Map
The id (an UUID) of the key-set with which to associate the key.
tags List<String>
An optional set of strings associated with the Key for grouping and filtering.
updatedAt Number
Unix epoch when the resource was last updated.
x5t String

Supporting Types

GatewayKeyPem
, GatewayKeyPemArgs

PrivateKey string
PublicKey string
PrivateKey string
PublicKey string
privateKey String
publicKey String
privateKey string
publicKey string
privateKey String
publicKey String

GatewayKeySet
, GatewayKeySetArgs

Id string
Id string
id String
id string
id str
id String

Import

$ pulumi import konnect:index/gatewayKey:GatewayKey my_konnect_gateway_key "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"id\": \"bba22c06-a632-42be-a018-1b9ff357b5b9\"}"
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.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect