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

konnect.GatewayConsumerGroup

Explore with Pulumi AI

konnect 2.5.0 published on Tuesday, Apr 15, 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",
    createdAt: 1,
    gatewayConsumerGroupId: "...my_id...",
    tags: ["..."],
    updatedAt: 9,
});
Copy
import pulumi
import pulumi_konnect as konnect

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

});
Copy
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")
            .createdAt(1)
            .gatewayConsumerGroupId("...my_id...")
            .tags("...")
            .updatedAt(9)
            .build());

    }
}
Copy
resources:
  myGatewayconsumergroup:
    type: konnect:GatewayConsumerGroup
    properties:
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      createdAt: 1
      gatewayConsumerGroupId: '...my_id...'
      tags:
        - '...'
      updatedAt: 9
Copy

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,
                         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)
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 This property is required. string
The unique name of the resource.
args This property is required. GatewayConsumerGroupArgs
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. 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 This property is required. string
The unique name of the resource.
args This property is required. GatewayConsumerGroupArgs
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. GatewayConsumerGroupArgs
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. 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",
    CreatedAt = 0,
    GatewayConsumerGroupId = "string",
    Name = "string",
    Tags = new[]
    {
        "string",
    },
    UpdatedAt = 0,
});
Copy
example, err := konnect.NewGatewayConsumerGroup(ctx, "gatewayConsumerGroupResource", &konnect.GatewayConsumerGroupArgs{
ControlPlaneId: pulumi.String("string"),
CreatedAt: pulumi.Float64(0),
GatewayConsumerGroupId: pulumi.String("string"),
Name: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
UpdatedAt: pulumi.Float64(0),
})
Copy
var gatewayConsumerGroupResource = new GatewayConsumerGroup("gatewayConsumerGroupResource", GatewayConsumerGroupArgs.builder()
    .controlPlaneId("string")
    .createdAt(0)
    .gatewayConsumerGroupId("string")
    .name("string")
    .tags("string")
    .updatedAt(0)
    .build());
Copy
gateway_consumer_group_resource = konnect.GatewayConsumerGroup("gatewayConsumerGroupResource",
    control_plane_id="string",
    created_at=0,
    gateway_consumer_group_id="string",
    name="string",
    tags=["string"],
    updated_at=0)
Copy
const gatewayConsumerGroupResource = new konnect.GatewayConsumerGroup("gatewayConsumerGroupResource", {
    controlPlaneId: "string",
    createdAt: 0,
    gatewayConsumerGroupId: "string",
    name: "string",
    tags: ["string"],
    updatedAt: 0,
});
Copy
type: konnect:GatewayConsumerGroup
properties:
    controlPlaneId: string
    createdAt: 0
    gatewayConsumerGroupId: string
    name: string
    tags:
        - string
    updatedAt: 0
Copy

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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.

Outputs

All input properties are implicitly available as output properties. Additionally, the GatewayConsumerGroup 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 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 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.
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 "{ \"id\": \"\", \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\"}"
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