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

konnect.GatewayVault

Explore with Pulumi AI

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

    GatewayVault Resource

    Example Usage

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

const myGatewayvault = new konnect.GatewayVault("myGatewayvault", {
    config: "{ \"see\": \"documentation\" }",
    controlPlaneId: "9524ec7d-36d9-465d-a8c5-83a3c9390458",
    description: "...my_description...",
    gatewayVaultId: "...my_id...",
    prefix: "...my_prefix...",
    tags: ["..."],
});

    import pulumi
import pulumi_konnect as konnect

my_gatewayvault = konnect.GatewayVault("myGatewayvault",
    config="{ \"see\": \"documentation\" }",
    control_plane_id="9524ec7d-36d9-465d-a8c5-83a3c9390458",
    description="...my_description...",
    gateway_vault_id="...my_id...",
    prefix="...my_prefix...",
    tags=["..."])

    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.NewGatewayVault(ctx, "myGatewayvault", &konnect.GatewayVaultArgs{
			Config:         pulumi.String("{ \"see\": \"documentation\" }"),
			ControlPlaneId: pulumi.String("9524ec7d-36d9-465d-a8c5-83a3c9390458"),
			Description:    pulumi.String("...my_description..."),
			GatewayVaultId: pulumi.String("...my_id..."),
			Prefix:         pulumi.String("...my_prefix..."),
			Tags: pulumi.StringArray{
				pulumi.String("..."),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var myGatewayvault = new Konnect.GatewayVault("myGatewayvault", new()
    {
        Config = "{ \"see\": \"documentation\" }",
        ControlPlaneId = "9524ec7d-36d9-465d-a8c5-83a3c9390458",
        Description = "...my_description...",
        GatewayVaultId = "...my_id...",
        Prefix = "...my_prefix...",
        Tags = new[]
        {
            "...",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayVault;
import com.pulumi.konnect.GatewayVaultArgs;
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 myGatewayvault = new GatewayVault("myGatewayvault", GatewayVaultArgs.builder()
            .config("{ \"see\": \"documentation\" }")
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .description("...my_description...")
            .gatewayVaultId("...my_id...")
            .prefix("...my_prefix...")
            .tags("...")
            .build());

    }
}

    resources:
  myGatewayvault:
    type: konnect:GatewayVault
    properties:
      config: '{ "see": "documentation" }'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      description: '...my_description...'
      gatewayVaultId: '...my_id...'
      prefix: '...my_prefix...'
      tags:
        - '...'

    Create GatewayVault Resource

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

    Constructor syntax

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

@overload
def GatewayVault(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 config: Optional[str] = None,
                 control_plane_id: Optional[str] = None,
                 prefix: Optional[str] = None,
                 description: Optional[str] = None,
                 gateway_vault_id: Optional[str] = None,
                 name: Optional[str] = None,
                 tags: Optional[Sequence[str]] = None)
    func NewGatewayVault(ctx *Context, name string, args GatewayVaultArgs, opts ...ResourceOption) (*GatewayVault, error)
    public GatewayVault(string name, GatewayVaultArgs args, CustomResourceOptions? opts = null)
    public GatewayVault(String name, GatewayVaultArgs args)
public GatewayVault(String name, GatewayVaultArgs args, CustomResourceOptions options)

    type: konnect:GatewayVault
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 GatewayVaultArgs
    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 GatewayVaultArgs
    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 GatewayVaultArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayVaultArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayVaultArgs
    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 gatewayVaultResource = new Konnect.GatewayVault("gatewayVaultResource", new()
{
    Config = "string",
    ControlPlaneId = "string",
    Prefix = "string",
    Description = "string",
    GatewayVaultId = "string",
    Name = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := konnect.NewGatewayVault(ctx, "gatewayVaultResource", &konnect.GatewayVaultArgs{
Config: pulumi.String("string"),
ControlPlaneId: pulumi.String("string"),
Prefix: pulumi.String("string"),
Description: pulumi.String("string"),
GatewayVaultId: pulumi.String("string"),
Name: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})

    var gatewayVaultResource = new GatewayVault("gatewayVaultResource", GatewayVaultArgs.builder()
    .config("string")
    .controlPlaneId("string")
    .prefix("string")
    .description("string")
    .gatewayVaultId("string")
    .name("string")
    .tags("string")
    .build());

    gateway_vault_resource = konnect.GatewayVault("gatewayVaultResource",
    config="string",
    control_plane_id="string",
    prefix="string",
    description="string",
    gateway_vault_id="string",
    name="string",
    tags=["string"])

    const gatewayVaultResource = new konnect.GatewayVault("gatewayVaultResource", {
    config: "string",
    controlPlaneId: "string",
    prefix: "string",
    description: "string",
    gatewayVaultId: "string",
    name: "string",
    tags: ["string"],
});

    type: konnect:GatewayVault
properties:
    config: string
    controlPlaneId: string
    description: string
    gatewayVaultId: string
    name: string
    prefix: string
    tags:
        - string

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

    Config string
    The configuration properties for the Vault which can be found on the vaults' documentation page. Parsed as JSON.
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    Prefix string
    The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.
    Description string
    The description of the Vault entity.
    GatewayVaultId string
    The ID of this resource.
    Name string
    The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.
    Tags List<string>
    An optional set of strings associated with the Vault for grouping and filtering.
    Config string
    The configuration properties for the Vault which can be found on the vaults' documentation page. Parsed as JSON.
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    Prefix string
    The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.
    Description string
    The description of the Vault entity.
    GatewayVaultId string
    The ID of this resource.
    Name string
    The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.
    Tags []string
    An optional set of strings associated with the Vault for grouping and filtering.
    config String
    The configuration properties for the Vault which can be found on the vaults' documentation page. Parsed as JSON.
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    prefix String
    The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.
    description String
    The description of the Vault entity.
    gatewayVaultId String
    The ID of this resource.
    name String
    The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.
    tags List<String>
    An optional set of strings associated with the Vault for grouping and filtering.
    config string
    The configuration properties for the Vault which can be found on the vaults' documentation page. Parsed as JSON.
    controlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    prefix string
    The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.
    description string
    The description of the Vault entity.
    gatewayVaultId string
    The ID of this resource.
    name string
    The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.
    tags string[]
    An optional set of strings associated with the Vault for grouping and filtering.
    config str
    The configuration properties for the Vault which can be found on the vaults' documentation page. Parsed as JSON.
    control_plane_id str
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    prefix str
    The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.
    description str
    The description of the Vault entity.
    gateway_vault_id str
    The ID of this resource.
    name str
    The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.
    tags Sequence[str]
    An optional set of strings associated with the Vault for grouping and filtering.
    config String
    The configuration properties for the Vault which can be found on the vaults' documentation page. Parsed as JSON.
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    prefix String
    The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.
    description String
    The description of the Vault entity.
    gatewayVaultId String
    The ID of this resource.
    name String
    The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.
    tags List<String>
    An optional set of strings associated with the Vault for grouping and filtering.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GatewayVault 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 GatewayVault Resource

    Get an existing GatewayVault 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?: GatewayVaultState, opts?: CustomResourceOptions): GatewayVault
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[str] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        description: Optional[str] = None,
        gateway_vault_id: Optional[str] = None,
        name: Optional[str] = None,
        prefix: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayVault
    func GetGatewayVault(ctx *Context, name string, id IDInput, state *GatewayVaultState, opts ...ResourceOption) (*GatewayVault, error)
    public static GatewayVault Get(string name, Input<string> id, GatewayVaultState? state, CustomResourceOptions? opts = null)
    public static GatewayVault get(String name, Output<String> id, GatewayVaultState state, CustomResourceOptions options)
    resources:  _:    type: konnect:GatewayVault    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 string
    The configuration properties for the Vault which can be found on the vaults' documentation page. Parsed as JSON.
    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.
    Description string
    The description of the Vault entity.
    GatewayVaultId string
    The ID of this resource.
    Name string
    The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.
    Prefix string
    The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.
    Tags List<string>
    An optional set of strings associated with the Vault for grouping and filtering.
    UpdatedAt double
    Unix epoch when the resource was last updated.
    Config string
    The configuration properties for the Vault which can be found on the vaults' documentation page. Parsed as JSON.
    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.
    Description string
    The description of the Vault entity.
    GatewayVaultId string
    The ID of this resource.
    Name string
    The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.
    Prefix string
    The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.
    Tags []string
    An optional set of strings associated with the Vault for grouping and filtering.
    UpdatedAt float64
    Unix epoch when the resource was last updated.
    config String
    The configuration properties for the Vault which can be found on the vaults' documentation page. Parsed as JSON.
    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.
    description String
    The description of the Vault entity.
    gatewayVaultId String
    The ID of this resource.
    name String
    The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.
    prefix String
    The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.
    tags List<String>
    An optional set of strings associated with the Vault for grouping and filtering.
    updatedAt Double
    Unix epoch when the resource was last updated.
    config string
    The configuration properties for the Vault which can be found on the vaults' documentation page. Parsed as JSON.
    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.
    description string
    The description of the Vault entity.
    gatewayVaultId string
    The ID of this resource.
    name string
    The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.
    prefix string
    The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.
    tags string[]
    An optional set of strings associated with the Vault for grouping and filtering.
    updatedAt number
    Unix epoch when the resource was last updated.
    config str
    The configuration properties for the Vault which can be found on the vaults' documentation page. Parsed as JSON.
    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.
    description str
    The description of the Vault entity.
    gateway_vault_id str
    The ID of this resource.
    name str
    The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.
    prefix str
    The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.
    tags Sequence[str]
    An optional set of strings associated with the Vault for grouping and filtering.
    updated_at float
    Unix epoch when the resource was last updated.
    config String
    The configuration properties for the Vault which can be found on the vaults' documentation page. Parsed as JSON.
    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.
    description String
    The description of the Vault entity.
    gatewayVaultId String
    The ID of this resource.
    name String
    The name of the Vault that's going to be added. Currently, the Vault implementation must be installed in every Kong instance.
    prefix String
    The unique prefix (or identifier) for this Vault configuration. The prefix is used to load the right Vault configuration and implementation when referencing secrets with the other entities.
    tags List<String>
    An optional set of strings associated with the Vault for grouping and filtering.
    updatedAt Number
    Unix epoch when the resource was last updated.

    Import

    $ pulumi import konnect:index/gatewayVault:GatewayVault my_konnect_gateway_vault "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"vault_id\": \"9d4d6d19-77c6-428e-a965-9bc9647633e9\"}"

    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 logo
    konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
    kong/terraform-provider-konnect