Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

GroupMemberships

Import

This resource does not support import. Instead of importing, feel free to create this resource as if it did not already exist on the server.

Create a GroupMemberships Resource

new GroupMemberships(name: string, args: GroupMembershipsArgs, opts?: CustomResourceOptions);
def GroupMemberships(resource_name: str, opts: Optional[ResourceOptions] = None, group_id: Optional[str] = None, members: Optional[Sequence[str]] = None, realm_id: Optional[str] = None)
func NewGroupMemberships(ctx *Context, name string, args GroupMembershipsArgs, opts ...ResourceOption) (*GroupMemberships, error)
public GroupMemberships(string name, GroupMembershipsArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args GroupMembershipsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args GroupMembershipsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args GroupMembershipsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

GroupMemberships Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The GroupMemberships resource accepts the following input properties:

Members List<string>

A list of usernames that belong to this group.

RealmId string

The realm this group exists in.

GroupId string

The ID of the group this resource should manage memberships for.

Members []string

A list of usernames that belong to this group.

RealmId string

The realm this group exists in.

GroupId string

The ID of the group this resource should manage memberships for.

members string[]

A list of usernames that belong to this group.

realmId string

The realm this group exists in.

groupId string

The ID of the group this resource should manage memberships for.

members Sequence[str]

A list of usernames that belong to this group.

realm_id str

The realm this group exists in.

group_id str

The ID of the group this resource should manage memberships for.

Outputs

All input properties are implicitly available as output properties. Additionally, the GroupMemberships 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing GroupMemberships Resource

Get an existing GroupMemberships 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?: GroupMembershipsState, opts?: CustomResourceOptions): GroupMemberships
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, group_id: Optional[str] = None, members: Optional[Sequence[str]] = None, realm_id: Optional[str] = None) -> GroupMemberships
func GetGroupMemberships(ctx *Context, name string, id IDInput, state *GroupMembershipsState, opts ...ResourceOption) (*GroupMemberships, error)
public static GroupMemberships Get(string name, Input<string> id, GroupMembershipsState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

GroupId string

The ID of the group this resource should manage memberships for.

Members List<string>

A list of usernames that belong to this group.

RealmId string

The realm this group exists in.

GroupId string

The ID of the group this resource should manage memberships for.

Members []string

A list of usernames that belong to this group.

RealmId string

The realm this group exists in.

groupId string

The ID of the group this resource should manage memberships for.

members string[]

A list of usernames that belong to this group.

realmId string

The realm this group exists in.

group_id str

The ID of the group this resource should manage memberships for.

members Sequence[str]

A list of usernames that belong to this group.

realm_id str

The realm this group exists in.

Package Details

Repository
https://github.com/pulumi/pulumi-keycloak
License
Apache-2.0
Notes
This Pulumi package is based on the keycloak Terraform Provider.