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

konnect.GatewayControlPlaneMembership

Explore with Pulumi AI

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

GatewayControlPlaneMembership Resource

Example Usage

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

const myGatewaycontrolplanemembership = new konnect.GatewayControlPlaneMembership("myGatewaycontrolplanemembership", {
    gatewayControlPlaneMembershipId: "...my_id...",
    members: [{
        id: "...my_id...",
    }],
});
Copy
import pulumi
import pulumi_konnect as konnect

my_gatewaycontrolplanemembership = konnect.GatewayControlPlaneMembership("myGatewaycontrolplanemembership",
    gateway_control_plane_membership_id="...my_id...",
    members=[{
        "id": "...my_id...",
    }])
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.NewGatewayControlPlaneMembership(ctx, "myGatewaycontrolplanemembership", &konnect.GatewayControlPlaneMembershipArgs{
			GatewayControlPlaneMembershipId: pulumi.String("...my_id..."),
			Members: konnect.GatewayControlPlaneMembershipMemberArray{
				&konnect.GatewayControlPlaneMembershipMemberArgs{
					Id: pulumi.String("...my_id..."),
				},
			},
		})
		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 myGatewaycontrolplanemembership = new Konnect.GatewayControlPlaneMembership("myGatewaycontrolplanemembership", new()
    {
        GatewayControlPlaneMembershipId = "...my_id...",
        Members = new[]
        {
            new Konnect.Inputs.GatewayControlPlaneMembershipMemberArgs
            {
                Id = "...my_id...",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayControlPlaneMembership;
import com.pulumi.konnect.GatewayControlPlaneMembershipArgs;
import com.pulumi.konnect.inputs.GatewayControlPlaneMembershipMemberArgs;
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 myGatewaycontrolplanemembership = new GatewayControlPlaneMembership("myGatewaycontrolplanemembership", GatewayControlPlaneMembershipArgs.builder()
            .gatewayControlPlaneMembershipId("...my_id...")
            .members(GatewayControlPlaneMembershipMemberArgs.builder()
                .id("...my_id...")
                .build())
            .build());

    }
}
Copy
resources:
  myGatewaycontrolplanemembership:
    type: konnect:GatewayControlPlaneMembership
    properties:
      gatewayControlPlaneMembershipId: '...my_id...'
      members:
        - id: '...my_id...'
Copy

Create GatewayControlPlaneMembership Resource

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

Constructor syntax

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

@overload
def GatewayControlPlaneMembership(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  gateway_control_plane_membership_id: Optional[str] = None,
                                  members: Optional[Sequence[GatewayControlPlaneMembershipMemberArgs]] = None)
func NewGatewayControlPlaneMembership(ctx *Context, name string, args GatewayControlPlaneMembershipArgs, opts ...ResourceOption) (*GatewayControlPlaneMembership, error)
public GatewayControlPlaneMembership(string name, GatewayControlPlaneMembershipArgs args, CustomResourceOptions? opts = null)
public GatewayControlPlaneMembership(String name, GatewayControlPlaneMembershipArgs args)
public GatewayControlPlaneMembership(String name, GatewayControlPlaneMembershipArgs args, CustomResourceOptions options)

type: konnect:GatewayControlPlaneMembership
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. GatewayControlPlaneMembershipArgs
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. GatewayControlPlaneMembershipArgs
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. GatewayControlPlaneMembershipArgs
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. GatewayControlPlaneMembershipArgs
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. GatewayControlPlaneMembershipArgs
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 gatewayControlPlaneMembershipResource = new Konnect.GatewayControlPlaneMembership("gatewayControlPlaneMembershipResource", new()
{
    GatewayControlPlaneMembershipId = "string",
    Members = new[]
    {
        new Konnect.Inputs.GatewayControlPlaneMembershipMemberArgs
        {
            Id = "string",
        },
    },
});
Copy
example, err := konnect.NewGatewayControlPlaneMembership(ctx, "gatewayControlPlaneMembershipResource", &konnect.GatewayControlPlaneMembershipArgs{
GatewayControlPlaneMembershipId: pulumi.String("string"),
Members: .GatewayControlPlaneMembershipMemberArray{
&.GatewayControlPlaneMembershipMemberArgs{
Id: pulumi.String("string"),
},
},
})
Copy
var gatewayControlPlaneMembershipResource = new GatewayControlPlaneMembership("gatewayControlPlaneMembershipResource", GatewayControlPlaneMembershipArgs.builder()
    .gatewayControlPlaneMembershipId("string")
    .members(GatewayControlPlaneMembershipMemberArgs.builder()
        .id("string")
        .build())
    .build());
Copy
gateway_control_plane_membership_resource = konnect.GatewayControlPlaneMembership("gatewayControlPlaneMembershipResource",
    gateway_control_plane_membership_id="string",
    members=[{
        "id": "string",
    }])
Copy
const gatewayControlPlaneMembershipResource = new konnect.GatewayControlPlaneMembership("gatewayControlPlaneMembershipResource", {
    gatewayControlPlaneMembershipId: "string",
    members: [{
        id: "string",
    }],
});
Copy
type: konnect:GatewayControlPlaneMembership
properties:
    gatewayControlPlaneMembershipId: string
    members:
        - id: string
Copy

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

GatewayControlPlaneMembershipId This property is required. string
ID of a control plane group. Requires replacement if changed.
Members This property is required. List<GatewayControlPlaneMembershipMember>
Requires replacement if changed.
GatewayControlPlaneMembershipId This property is required. string
ID of a control plane group. Requires replacement if changed.
Members This property is required. []GatewayControlPlaneMembershipMemberArgs
Requires replacement if changed.
gatewayControlPlaneMembershipId This property is required. String
ID of a control plane group. Requires replacement if changed.
members This property is required. List<GatewayControlPlaneMembershipMember>
Requires replacement if changed.
gatewayControlPlaneMembershipId This property is required. string
ID of a control plane group. Requires replacement if changed.
members This property is required. GatewayControlPlaneMembershipMember[]
Requires replacement if changed.
gateway_control_plane_membership_id This property is required. str
ID of a control plane group. Requires replacement if changed.
members This property is required. Sequence[GatewayControlPlaneMembershipMemberArgs]
Requires replacement if changed.
gatewayControlPlaneMembershipId This property is required. String
ID of a control plane group. Requires replacement if changed.
members This property is required. List<Property Map>
Requires replacement if changed.

Outputs

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

Get an existing GatewayControlPlaneMembership 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?: GatewayControlPlaneMembershipState, opts?: CustomResourceOptions): GatewayControlPlaneMembership
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        gateway_control_plane_membership_id: Optional[str] = None,
        members: Optional[Sequence[GatewayControlPlaneMembershipMemberArgs]] = None) -> GatewayControlPlaneMembership
func GetGatewayControlPlaneMembership(ctx *Context, name string, id IDInput, state *GatewayControlPlaneMembershipState, opts ...ResourceOption) (*GatewayControlPlaneMembership, error)
public static GatewayControlPlaneMembership Get(string name, Input<string> id, GatewayControlPlaneMembershipState? state, CustomResourceOptions? opts = null)
public static GatewayControlPlaneMembership get(String name, Output<String> id, GatewayControlPlaneMembershipState state, CustomResourceOptions options)
resources:  _:    type: konnect:GatewayControlPlaneMembership    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:
GatewayControlPlaneMembershipId string
ID of a control plane group. Requires replacement if changed.
Members List<GatewayControlPlaneMembershipMember>
Requires replacement if changed.
GatewayControlPlaneMembershipId string
ID of a control plane group. Requires replacement if changed.
Members []GatewayControlPlaneMembershipMemberArgs
Requires replacement if changed.
gatewayControlPlaneMembershipId String
ID of a control plane group. Requires replacement if changed.
members List<GatewayControlPlaneMembershipMember>
Requires replacement if changed.
gatewayControlPlaneMembershipId string
ID of a control plane group. Requires replacement if changed.
members GatewayControlPlaneMembershipMember[]
Requires replacement if changed.
gateway_control_plane_membership_id str
ID of a control plane group. Requires replacement if changed.
members Sequence[GatewayControlPlaneMembershipMemberArgs]
Requires replacement if changed.
gatewayControlPlaneMembershipId String
ID of a control plane group. Requires replacement if changed.
members List<Property Map>
Requires replacement if changed.

Supporting Types

GatewayControlPlaneMembershipMember
, GatewayControlPlaneMembershipMemberArgs

Id This property is required. string
Requires replacement if changed.
Id This property is required. string
Requires replacement if changed.
id This property is required. String
Requires replacement if changed.
id This property is required. string
Requires replacement if changed.
id This property is required. str
Requires replacement if changed.
id This property is required. String
Requires replacement if changed.

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