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

konnect.GatewayConsumerGroup

Explore with Pulumi AI

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

    GatewayConsumerGroup Resource

    Example Usage

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

const myGatewayconsumergroup = new konnect.GatewayConsumerGroup("myGatewayconsumergroup", {
    controlPlaneId: "9524ec7d-36d9-465d-a8c5-83a3c9390458",
    gatewayConsumerGroupId: "...my_id...",
    tags: ["..."],
});

    import pulumi
import pulumi_konnect as konnect

my_gatewayconsumergroup = konnect.GatewayConsumerGroup("myGatewayconsumergroup",
    control_plane_id="9524ec7d-36d9-465d-a8c5-83a3c9390458",
    gateway_consumer_group_id="...my_id...",
    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.NewGatewayConsumerGroup(ctx, "myGatewayconsumergroup", &konnect.GatewayConsumerGroupArgs{
			ControlPlaneId:         pulumi.String("9524ec7d-36d9-465d-a8c5-83a3c9390458"),
			GatewayConsumerGroupId: pulumi.String("...my_id..."),
			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 myGatewayconsumergroup = new Konnect.GatewayConsumerGroup("myGatewayconsumergroup", new()
    {
        ControlPlaneId = "9524ec7d-36d9-465d-a8c5-83a3c9390458",
        GatewayConsumerGroupId = "...my_id...",
        Tags = new[]
        {
            "...",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayConsumerGroup;
import com.pulumi.konnect.GatewayConsumerGroupArgs;
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 myGatewayconsumergroup = new GatewayConsumerGroup("myGatewayconsumergroup", GatewayConsumerGroupArgs.builder()
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .gatewayConsumerGroupId("...my_id...")
            .tags("...")
            .build());

    }
}

    resources:
  myGatewayconsumergroup:
    type: konnect:GatewayConsumerGroup
    properties:
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      gatewayConsumerGroupId: '...my_id...'
      tags:
        - '...'

    Create GatewayConsumerGroup Resource

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

    Constructor syntax

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

@overload
def GatewayConsumerGroup(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         control_plane_id: Optional[str] = None,
                         gateway_consumer_group_id: Optional[str] = None,
                         name: Optional[str] = None,
                         tags: Optional[Sequence[str]] = None)
    func NewGatewayConsumerGroup(ctx *Context, name string, args GatewayConsumerGroupArgs, opts ...ResourceOption) (*GatewayConsumerGroup, error)
    public GatewayConsumerGroup(string name, GatewayConsumerGroupArgs args, CustomResourceOptions? opts = null)
    public GatewayConsumerGroup(String name, GatewayConsumerGroupArgs args)
public GatewayConsumerGroup(String name, GatewayConsumerGroupArgs args, CustomResourceOptions options)

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

    example, err := konnect.NewGatewayConsumerGroup(ctx, "gatewayConsumerGroupResource", &konnect.GatewayConsumerGroupArgs{
ControlPlaneId: pulumi.String("string"),
GatewayConsumerGroupId: pulumi.String("string"),
Name: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})

    var gatewayConsumerGroupResource = new GatewayConsumerGroup("gatewayConsumerGroupResource", GatewayConsumerGroupArgs.builder()
    .controlPlaneId("string")
    .gatewayConsumerGroupId("string")
    .name("string")
    .tags("string")
    .build());

    gateway_consumer_group_resource = konnect.GatewayConsumerGroup("gatewayConsumerGroupResource",
    control_plane_id="string",
    gateway_consumer_group_id="string",
    name="string",
    tags=["string"])

    const gatewayConsumerGroupResource = new konnect.GatewayConsumerGroup("gatewayConsumerGroupResource", {
    controlPlaneId: "string",
    gatewayConsumerGroupId: "string",
    name: "string",
    tags: ["string"],
});

    type: konnect:GatewayConsumerGroup
properties:
    controlPlaneId: string
    gatewayConsumerGroupId: string
    name: string
    tags:
        - string

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

    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    GatewayConsumerGroupId string
    The ID of this resource.
    Name string
    Tags List<string>
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    GatewayConsumerGroupId string
    The ID of this resource.
    Name string
    Tags []string
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    gatewayConsumerGroupId String
    The ID of this resource.
    name String
    tags List<String>
    controlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    gatewayConsumerGroupId string
    The ID of this resource.
    name string
    tags string[]
    control_plane_id str
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    gateway_consumer_group_id str
    The ID of this resource.
    name str
    tags Sequence[str]
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    gatewayConsumerGroupId String
    The ID of this resource.
    name String
    tags List<String>

    Outputs

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

    Get an existing GatewayConsumerGroup 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?: GatewayConsumerGroupState, opts?: CustomResourceOptions): GatewayConsumerGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        gateway_consumer_group_id: Optional[str] = None,
        name: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayConsumerGroup
    func GetGatewayConsumerGroup(ctx *Context, name string, id IDInput, state *GatewayConsumerGroupState, opts ...ResourceOption) (*GatewayConsumerGroup, error)
    public static GatewayConsumerGroup Get(string name, Input<string> id, GatewayConsumerGroupState? state, CustomResourceOptions? opts = null)
    public static GatewayConsumerGroup get(String name, Output<String> id, GatewayConsumerGroupState state, CustomResourceOptions options)
    resources:  _:    type: konnect:GatewayConsumerGroup    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:
    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.
    GatewayConsumerGroupId string
    The ID of this resource.
    Name string
    Tags List<string>
    UpdatedAt double
    Unix epoch when the resource was last updated.
    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.
    GatewayConsumerGroupId string
    The ID of this resource.
    Name string
    Tags []string
    UpdatedAt float64
    Unix epoch when the resource was last updated.
    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.
    gatewayConsumerGroupId String
    The ID of this resource.
    name String
    tags List<String>
    updatedAt Double
    Unix epoch when the resource was last updated.
    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.
    gatewayConsumerGroupId string
    The ID of this resource.
    name string
    tags string[]
    updatedAt number
    Unix epoch when the resource was last updated.
    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_consumer_group_id str
    The ID of this resource.
    name str
    tags Sequence[str]
    updated_at float
    Unix epoch when the resource was last updated.
    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.
    gatewayConsumerGroupId String
    The ID of this resource.
    name String
    tags List<String>
    updatedAt Number
    Unix epoch when the resource was last updated.

    Import

    $ pulumi import konnect:index/gatewayConsumerGroup:GatewayConsumerGroup my_konnect_gateway_consumer_group "{ \"consumer_group_id\": \"\", \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\"}"

    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