1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayMtlsAuth
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

konnect.GatewayMtlsAuth

Explore with Pulumi AI

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

    GatewayMTLSAuth Resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as konnect from "@pulumi/konnect";
    
    const myGatewaymtlsauth = new konnect.GatewayMtlsAuth("myGatewaymtlsauth", {
        caCertificate: {
            id: "...my_id...",
        },
        consumer: {
            id: "...my_id...",
        },
        consumerId: "f28acbfa-c866-4587-b688-0208ac24df21",
        controlPlaneId: "9524ec7d-36d9-465d-a8c5-83a3c9390458",
        gatewayMtlsAuthId: "...my_id...",
        subjectName: "...my_subject_name...",
        tags: ["..."],
    });
    
    import pulumi
    import pulumi_konnect as konnect
    
    my_gatewaymtlsauth = konnect.GatewayMtlsAuth("myGatewaymtlsauth",
        ca_certificate={
            "id": "...my_id...",
        },
        consumer={
            "id": "...my_id...",
        },
        consumer_id="f28acbfa-c866-4587-b688-0208ac24df21",
        control_plane_id="9524ec7d-36d9-465d-a8c5-83a3c9390458",
        gateway_mtls_auth_id="...my_id...",
        subject_name="...my_subject_name...",
        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.NewGatewayMtlsAuth(ctx, "myGatewaymtlsauth", &konnect.GatewayMtlsAuthArgs{
    			CaCertificate: &konnect.GatewayMtlsAuthCaCertificateArgs{
    				Id: pulumi.String("...my_id..."),
    			},
    			Consumer: &konnect.GatewayMtlsAuthConsumerArgs{
    				Id: pulumi.String("...my_id..."),
    			},
    			ConsumerId:        pulumi.String("f28acbfa-c866-4587-b688-0208ac24df21"),
    			ControlPlaneId:    pulumi.String("9524ec7d-36d9-465d-a8c5-83a3c9390458"),
    			GatewayMtlsAuthId: pulumi.String("...my_id..."),
    			SubjectName:       pulumi.String("...my_subject_name..."),
    			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 myGatewaymtlsauth = new Konnect.GatewayMtlsAuth("myGatewaymtlsauth", new()
        {
            CaCertificate = new Konnect.Inputs.GatewayMtlsAuthCaCertificateArgs
            {
                Id = "...my_id...",
            },
            Consumer = new Konnect.Inputs.GatewayMtlsAuthConsumerArgs
            {
                Id = "...my_id...",
            },
            ConsumerId = "f28acbfa-c866-4587-b688-0208ac24df21",
            ControlPlaneId = "9524ec7d-36d9-465d-a8c5-83a3c9390458",
            GatewayMtlsAuthId = "...my_id...",
            SubjectName = "...my_subject_name...",
            Tags = new[]
            {
                "...",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.konnect.GatewayMtlsAuth;
    import com.pulumi.konnect.GatewayMtlsAuthArgs;
    import com.pulumi.konnect.inputs.GatewayMtlsAuthCaCertificateArgs;
    import com.pulumi.konnect.inputs.GatewayMtlsAuthConsumerArgs;
    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 myGatewaymtlsauth = new GatewayMtlsAuth("myGatewaymtlsauth", GatewayMtlsAuthArgs.builder()
                .caCertificate(GatewayMtlsAuthCaCertificateArgs.builder()
                    .id("...my_id...")
                    .build())
                .consumer(GatewayMtlsAuthConsumerArgs.builder()
                    .id("...my_id...")
                    .build())
                .consumerId("f28acbfa-c866-4587-b688-0208ac24df21")
                .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
                .gatewayMtlsAuthId("...my_id...")
                .subjectName("...my_subject_name...")
                .tags("...")
                .build());
    
        }
    }
    
    resources:
      myGatewaymtlsauth:
        type: konnect:GatewayMtlsAuth
        properties:
          caCertificate:
            id: '...my_id...'
          consumer:
            id: '...my_id...'
          consumerId: f28acbfa-c866-4587-b688-0208ac24df21
          controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
          gatewayMtlsAuthId: '...my_id...'
          subjectName: '...my_subject_name...'
          tags:
            - '...'
    

    Create GatewayMtlsAuth Resource

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

    Constructor syntax

    new GatewayMtlsAuth(name: string, args: GatewayMtlsAuthArgs, opts?: CustomResourceOptions);
    @overload
    def GatewayMtlsAuth(resource_name: str,
                        args: GatewayMtlsAuthArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def GatewayMtlsAuth(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        consumer_id: Optional[str] = None,
                        control_plane_id: Optional[str] = None,
                        subject_name: Optional[str] = None,
                        ca_certificate: Optional[GatewayMtlsAuthCaCertificateArgs] = None,
                        consumer: Optional[GatewayMtlsAuthConsumerArgs] = None,
                        gateway_mtls_auth_id: Optional[str] = None,
                        tags: Optional[Sequence[str]] = None)
    func NewGatewayMtlsAuth(ctx *Context, name string, args GatewayMtlsAuthArgs, opts ...ResourceOption) (*GatewayMtlsAuth, error)
    public GatewayMtlsAuth(string name, GatewayMtlsAuthArgs args, CustomResourceOptions? opts = null)
    public GatewayMtlsAuth(String name, GatewayMtlsAuthArgs args)
    public GatewayMtlsAuth(String name, GatewayMtlsAuthArgs args, CustomResourceOptions options)
    
    type: konnect:GatewayMtlsAuth
    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 GatewayMtlsAuthArgs
    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 GatewayMtlsAuthArgs
    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 GatewayMtlsAuthArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayMtlsAuthArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayMtlsAuthArgs
    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 gatewayMtlsAuthResource = new Konnect.GatewayMtlsAuth("gatewayMtlsAuthResource", new()
    {
        ConsumerId = "string",
        ControlPlaneId = "string",
        SubjectName = "string",
        CaCertificate = new Konnect.Inputs.GatewayMtlsAuthCaCertificateArgs
        {
            Id = "string",
        },
        Consumer = new Konnect.Inputs.GatewayMtlsAuthConsumerArgs
        {
            Id = "string",
        },
        GatewayMtlsAuthId = "string",
        Tags = new[]
        {
            "string",
        },
    });
    
    example, err := konnect.NewGatewayMtlsAuth(ctx, "gatewayMtlsAuthResource", &konnect.GatewayMtlsAuthArgs{
    ConsumerId: pulumi.String("string"),
    ControlPlaneId: pulumi.String("string"),
    SubjectName: pulumi.String("string"),
    CaCertificate: &.GatewayMtlsAuthCaCertificateArgs{
    Id: pulumi.String("string"),
    },
    Consumer: &.GatewayMtlsAuthConsumerArgs{
    Id: pulumi.String("string"),
    },
    GatewayMtlsAuthId: pulumi.String("string"),
    Tags: pulumi.StringArray{
    pulumi.String("string"),
    },
    })
    
    var gatewayMtlsAuthResource = new GatewayMtlsAuth("gatewayMtlsAuthResource", GatewayMtlsAuthArgs.builder()
        .consumerId("string")
        .controlPlaneId("string")
        .subjectName("string")
        .caCertificate(GatewayMtlsAuthCaCertificateArgs.builder()
            .id("string")
            .build())
        .consumer(GatewayMtlsAuthConsumerArgs.builder()
            .id("string")
            .build())
        .gatewayMtlsAuthId("string")
        .tags("string")
        .build());
    
    gateway_mtls_auth_resource = konnect.GatewayMtlsAuth("gatewayMtlsAuthResource",
        consumer_id="string",
        control_plane_id="string",
        subject_name="string",
        ca_certificate={
            "id": "string",
        },
        consumer={
            "id": "string",
        },
        gateway_mtls_auth_id="string",
        tags=["string"])
    
    const gatewayMtlsAuthResource = new konnect.GatewayMtlsAuth("gatewayMtlsAuthResource", {
        consumerId: "string",
        controlPlaneId: "string",
        subjectName: "string",
        caCertificate: {
            id: "string",
        },
        consumer: {
            id: "string",
        },
        gatewayMtlsAuthId: "string",
        tags: ["string"],
    });
    
    type: konnect:GatewayMtlsAuth
    properties:
        caCertificate:
            id: string
        consumer:
            id: string
        consumerId: string
        controlPlaneId: string
        gatewayMtlsAuthId: string
        subjectName: string
        tags:
            - string
    

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

    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.
    SubjectName string
    Requires replacement if changed.
    CaCertificate GatewayMtlsAuthCaCertificate
    Requires replacement if changed.
    Consumer GatewayMtlsAuthConsumer
    Requires replacement if changed.
    GatewayMtlsAuthId string
    Requires replacement if changed.
    Tags List<string>
    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.
    SubjectName string
    Requires replacement if changed.
    CaCertificate GatewayMtlsAuthCaCertificateArgs
    Requires replacement if changed.
    Consumer GatewayMtlsAuthConsumerArgs
    Requires replacement if changed.
    GatewayMtlsAuthId string
    Requires replacement if changed.
    Tags []string
    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.
    subjectName String
    Requires replacement if changed.
    caCertificate GatewayMtlsAuthCaCertificate
    Requires replacement if changed.
    consumer GatewayMtlsAuthConsumer
    Requires replacement if changed.
    gatewayMtlsAuthId String
    Requires replacement if changed.
    tags List<String>
    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.
    subjectName string
    Requires replacement if changed.
    caCertificate GatewayMtlsAuthCaCertificate
    Requires replacement if changed.
    consumer GatewayMtlsAuthConsumer
    Requires replacement if changed.
    gatewayMtlsAuthId string
    Requires replacement if changed.
    tags string[]
    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.
    subject_name str
    Requires replacement if changed.
    ca_certificate GatewayMtlsAuthCaCertificateArgs
    Requires replacement if changed.
    consumer GatewayMtlsAuthConsumerArgs
    Requires replacement if changed.
    gateway_mtls_auth_id str
    Requires replacement if changed.
    tags Sequence[str]
    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.
    subjectName String
    Requires replacement if changed.
    caCertificate Property Map
    Requires replacement if changed.
    consumer Property Map
    Requires replacement if changed.
    gatewayMtlsAuthId String
    Requires replacement if changed.
    tags List<String>
    Requires replacement if changed.

    Outputs

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

    Get an existing GatewayMtlsAuth 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?: GatewayMtlsAuthState, opts?: CustomResourceOptions): GatewayMtlsAuth
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ca_certificate: Optional[GatewayMtlsAuthCaCertificateArgs] = None,
            consumer: Optional[GatewayMtlsAuthConsumerArgs] = None,
            consumer_id: Optional[str] = None,
            control_plane_id: Optional[str] = None,
            created_at: Optional[float] = None,
            gateway_mtls_auth_id: Optional[str] = None,
            subject_name: Optional[str] = None,
            tags: Optional[Sequence[str]] = None) -> GatewayMtlsAuth
    func GetGatewayMtlsAuth(ctx *Context, name string, id IDInput, state *GatewayMtlsAuthState, opts ...ResourceOption) (*GatewayMtlsAuth, error)
    public static GatewayMtlsAuth Get(string name, Input<string> id, GatewayMtlsAuthState? state, CustomResourceOptions? opts = null)
    public static GatewayMtlsAuth get(String name, Output<String> id, GatewayMtlsAuthState state, CustomResourceOptions options)
    resources:  _:    type: konnect:GatewayMtlsAuth    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:
    CaCertificate GatewayMtlsAuthCaCertificate
    Requires replacement if changed.
    Consumer GatewayMtlsAuthConsumer
    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.
    GatewayMtlsAuthId string
    Requires replacement if changed.
    SubjectName string
    Requires replacement if changed.
    Tags List<string>
    Requires replacement if changed.
    CaCertificate GatewayMtlsAuthCaCertificateArgs
    Requires replacement if changed.
    Consumer GatewayMtlsAuthConsumerArgs
    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.
    GatewayMtlsAuthId string
    Requires replacement if changed.
    SubjectName string
    Requires replacement if changed.
    Tags []string
    Requires replacement if changed.
    caCertificate GatewayMtlsAuthCaCertificate
    Requires replacement if changed.
    consumer GatewayMtlsAuthConsumer
    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.
    gatewayMtlsAuthId String
    Requires replacement if changed.
    subjectName String
    Requires replacement if changed.
    tags List<String>
    Requires replacement if changed.
    caCertificate GatewayMtlsAuthCaCertificate
    Requires replacement if changed.
    consumer GatewayMtlsAuthConsumer
    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.
    gatewayMtlsAuthId string
    Requires replacement if changed.
    subjectName string
    Requires replacement if changed.
    tags string[]
    Requires replacement if changed.
    ca_certificate GatewayMtlsAuthCaCertificateArgs
    Requires replacement if changed.
    consumer GatewayMtlsAuthConsumerArgs
    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_mtls_auth_id str
    Requires replacement if changed.
    subject_name str
    Requires replacement if changed.
    tags Sequence[str]
    Requires replacement if changed.
    caCertificate Property Map
    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.
    gatewayMtlsAuthId String
    Requires replacement if changed.
    subjectName String
    Requires replacement if changed.
    tags List<String>
    Requires replacement if changed.

    Supporting Types

    GatewayMtlsAuthCaCertificate, GatewayMtlsAuthCaCertificateArgs

    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.

    GatewayMtlsAuthConsumer, GatewayMtlsAuthConsumerArgs

    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/gatewayMtlsAuth:GatewayMtlsAuth my_konnect_gateway_mtls_auth "{ \"consumer_id\": \"f28acbfa-c866-4587-b688-0208ac24df21\", \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"mtls_auth_id\": \"\"}"
    

    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