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

konnect.GatewayConsumerGroupMember

Explore with Pulumi AI

GatewayConsumerGroupMember Resource

Example Usage

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

const myGatewayconsumergroupmember = new konnect.GatewayConsumerGroupMember("myGatewayconsumergroupmember", {
    consumerGroupId: "...my_consumer_group_id...",
    consumerId: "cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b",
    controlPlaneId: "9524ec7d-36d9-465d-a8c5-83a3c9390458",
});
Copy
import pulumi
import pulumi_konnect as konnect

my_gatewayconsumergroupmember = konnect.GatewayConsumerGroupMember("myGatewayconsumergroupmember",
    consumer_group_id="...my_consumer_group_id...",
    consumer_id="cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b",
    control_plane_id="9524ec7d-36d9-465d-a8c5-83a3c9390458")
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.NewGatewayConsumerGroupMember(ctx, "myGatewayconsumergroupmember", &konnect.GatewayConsumerGroupMemberArgs{
			ConsumerGroupId: pulumi.String("...my_consumer_group_id..."),
			ConsumerId:      pulumi.String("cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b"),
			ControlPlaneId:  pulumi.String("9524ec7d-36d9-465d-a8c5-83a3c9390458"),
		})
		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 myGatewayconsumergroupmember = new Konnect.GatewayConsumerGroupMember("myGatewayconsumergroupmember", new()
    {
        ConsumerGroupId = "...my_consumer_group_id...",
        ConsumerId = "cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b",
        ControlPlaneId = "9524ec7d-36d9-465d-a8c5-83a3c9390458",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayConsumerGroupMember;
import com.pulumi.konnect.GatewayConsumerGroupMemberArgs;
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 myGatewayconsumergroupmember = new GatewayConsumerGroupMember("myGatewayconsumergroupmember", GatewayConsumerGroupMemberArgs.builder()
            .consumerGroupId("...my_consumer_group_id...")
            .consumerId("cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b")
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .build());

    }
}
Copy
resources:
  myGatewayconsumergroupmember:
    type: konnect:GatewayConsumerGroupMember
    properties:
      consumerGroupId: '...my_consumer_group_id...'
      consumerId: cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
Copy

Create GatewayConsumerGroupMember Resource

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

Constructor syntax

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

@overload
def GatewayConsumerGroupMember(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               consumer_group_id: Optional[str] = None,
                               control_plane_id: Optional[str] = None,
                               consumer_id: Optional[str] = None)
func NewGatewayConsumerGroupMember(ctx *Context, name string, args GatewayConsumerGroupMemberArgs, opts ...ResourceOption) (*GatewayConsumerGroupMember, error)
public GatewayConsumerGroupMember(string name, GatewayConsumerGroupMemberArgs args, CustomResourceOptions? opts = null)
public GatewayConsumerGroupMember(String name, GatewayConsumerGroupMemberArgs args)
public GatewayConsumerGroupMember(String name, GatewayConsumerGroupMemberArgs args, CustomResourceOptions options)
type: konnect:GatewayConsumerGroupMember
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. GatewayConsumerGroupMemberArgs
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. GatewayConsumerGroupMemberArgs
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. GatewayConsumerGroupMemberArgs
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. GatewayConsumerGroupMemberArgs
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. GatewayConsumerGroupMemberArgs
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 gatewayConsumerGroupMemberResource = new Konnect.GatewayConsumerGroupMember("gatewayConsumerGroupMemberResource", new()
{
    ConsumerGroupId = "string",
    ControlPlaneId = "string",
    ConsumerId = "string",
});
Copy
example, err := konnect.NewGatewayConsumerGroupMember(ctx, "gatewayConsumerGroupMemberResource", &konnect.GatewayConsumerGroupMemberArgs{
ConsumerGroupId: pulumi.String("string"),
ControlPlaneId: pulumi.String("string"),
ConsumerId: pulumi.String("string"),
})
Copy
var gatewayConsumerGroupMemberResource = new GatewayConsumerGroupMember("gatewayConsumerGroupMemberResource", GatewayConsumerGroupMemberArgs.builder()
    .consumerGroupId("string")
    .controlPlaneId("string")
    .consumerId("string")
    .build());
Copy
gateway_consumer_group_member_resource = konnect.GatewayConsumerGroupMember("gatewayConsumerGroupMemberResource",
    consumer_group_id="string",
    control_plane_id="string",
    consumer_id="string")
Copy
const gatewayConsumerGroupMemberResource = new konnect.GatewayConsumerGroupMember("gatewayConsumerGroupMemberResource", {
    consumerGroupId: "string",
    controlPlaneId: "string",
    consumerId: "string",
});
Copy
type: konnect:GatewayConsumerGroupMember
properties:
    consumerGroupId: string
    consumerId: string
    controlPlaneId: string
Copy

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

ConsumerGroupId This property is required. string
Requires replacement if changed.
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
ConsumerId string
Requires replacement if changed.
ConsumerGroupId This property is required. string
Requires replacement if changed.
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
ConsumerId string
Requires replacement if changed.
consumerGroupId This property is required. String
Requires replacement if changed.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumerId String
Requires replacement if changed.
consumerGroupId This property is required. string
Requires replacement if changed.
controlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumerId string
Requires replacement if changed.
consumer_group_id This property is required. str
Requires replacement if changed.
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.
consumer_id str
Requires replacement if changed.
consumerGroupId This property is required. String
Requires replacement if changed.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumerId String
Requires replacement if changed.

Outputs

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

Get an existing GatewayConsumerGroupMember 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?: GatewayConsumerGroupMemberState, opts?: CustomResourceOptions): GatewayConsumerGroupMember
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        consumer_group_id: Optional[str] = None,
        consumer_id: Optional[str] = None,
        control_plane_id: Optional[str] = None) -> GatewayConsumerGroupMember
func GetGatewayConsumerGroupMember(ctx *Context, name string, id IDInput, state *GatewayConsumerGroupMemberState, opts ...ResourceOption) (*GatewayConsumerGroupMember, error)
public static GatewayConsumerGroupMember Get(string name, Input<string> id, GatewayConsumerGroupMemberState? state, CustomResourceOptions? opts = null)
public static GatewayConsumerGroupMember get(String name, Output<String> id, GatewayConsumerGroupMemberState state, CustomResourceOptions options)
resources:  _:    type: konnect:GatewayConsumerGroupMember    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:
ConsumerGroupId string
Requires replacement if changed.
ConsumerId string
Requires replacement if changed.
ControlPlaneId string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
ConsumerGroupId string
Requires replacement if changed.
ConsumerId string
Requires replacement if changed.
ControlPlaneId string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumerGroupId String
Requires replacement if changed.
consumerId String
Requires replacement if changed.
controlPlaneId String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumerGroupId string
Requires replacement if changed.
consumerId string
Requires replacement if changed.
controlPlaneId string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer_group_id str
Requires replacement if changed.
consumer_id str
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.
consumerGroupId String
Requires replacement if changed.
consumerId String
Requires replacement if changed.
controlPlaneId String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

Package Details

Repository
konnect kong/terraform-provider-konnect
License
Notes
This Pulumi package is based on the konnect Terraform Provider.