Docs Home
Formal v1.0.3 published on Monday, Aug 18, 2025 by Formal
formal.GroupUserLink
Explore with Pulumi AI
Linking a User to a Group in Formal.
Create GroupUserLink Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GroupUserLink(name: string, args: GroupUserLinkArgs, opts?: CustomResourceOptions);@overload
def GroupUserLink(resource_name: str,
args: GroupUserLinkArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GroupUserLink(resource_name: str,
opts: Optional[ResourceOptions] = None,
group_id: Optional[str] = None,
user_id: Optional[str] = None,
termination_protection: Optional[bool] = None)func NewGroupUserLink(ctx *Context, name string, args GroupUserLinkArgs, opts ...ResourceOption) (*GroupUserLink, error)public GroupUserLink(string name, GroupUserLinkArgs args, CustomResourceOptions? opts = null)
public GroupUserLink(String name, GroupUserLinkArgs args)
public GroupUserLink(String name, GroupUserLinkArgs args, CustomResourceOptions options)
type: formal:GroupUserLink
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 GroupUserLinkArgs
- 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 GroupUserLinkArgs
- 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 GroupUserLinkArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GroupUserLinkArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GroupUserLinkArgs
- 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 groupUserLinkResource = new Pulumi.GroupUserLink("groupUserLinkResource", new()
{
GroupId = "string",
UserId = "string",
TerminationProtection = false,
});
example, err := formal.NewGroupUserLink(ctx, "groupUserLinkResource", &formal.GroupUserLinkArgs{
GroupId: pulumi.String("string"),
UserId: pulumi.String("string"),
TerminationProtection: pulumi.Bool(false),
})
var groupUserLinkResource = new GroupUserLink("groupUserLinkResource", GroupUserLinkArgs.builder()
.groupId("string")
.userId("string")
.terminationProtection(false)
.build());
group_user_link_resource = formal.GroupUserLink("groupUserLinkResource",
group_id="string",
user_id="string",
termination_protection=False)
const groupUserLinkResource = new formal.GroupUserLink("groupUserLinkResource", {
groupId: "string",
userId: "string",
terminationProtection: false,
});
type: formal:GroupUserLink
properties:
groupId: string
terminationProtection: false
userId: string
GroupUserLink 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 GroupUserLink resource accepts the following input properties:
- Group
Id string - The Formal ID for the group to be linked.
- User
Id string - The Formal ID of the user to be linked.
- Termination
Protection bool - If set to true, this Link cannot be deleted.
- Group
Id string - The Formal ID for the group to be linked.
- User
Id string - The Formal ID of the user to be linked.
- Termination
Protection bool - If set to true, this Link cannot be deleted.
- group
Id String - The Formal ID for the group to be linked.
- user
Id String - The Formal ID of the user to be linked.
- termination
Protection Boolean - If set to true, this Link cannot be deleted.
- group
Id string - The Formal ID for the group to be linked.
- user
Id string - The Formal ID of the user to be linked.
- termination
Protection boolean - If set to true, this Link cannot be deleted.
- group_
id str - The Formal ID for the group to be linked.
- user_
id str - The Formal ID of the user to be linked.
- termination_
protection bool - If set to true, this Link cannot be deleted.
- group
Id String - The Formal ID for the group to be linked.
- user
Id String - The Formal ID of the user to be linked.
- termination
Protection Boolean - If set to true, this Link cannot be deleted.
Outputs
All input properties are implicitly available as output properties. Additionally, the GroupUserLink 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 GroupUserLink Resource
Get an existing GroupUserLink 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?: GroupUserLinkState, opts?: CustomResourceOptions): GroupUserLink@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
group_id: Optional[str] = None,
termination_protection: Optional[bool] = None,
user_id: Optional[str] = None) -> GroupUserLinkfunc GetGroupUserLink(ctx *Context, name string, id IDInput, state *GroupUserLinkState, opts ...ResourceOption) (*GroupUserLink, error)public static GroupUserLink Get(string name, Input<string> id, GroupUserLinkState? state, CustomResourceOptions? opts = null)public static GroupUserLink get(String name, Output<String> id, GroupUserLinkState state, CustomResourceOptions options)resources: _: type: formal:GroupUserLink 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.
- Group
Id string - The Formal ID for the group to be linked.
- Termination
Protection bool - If set to true, this Link cannot be deleted.
- User
Id string - The Formal ID of the user to be linked.
- Group
Id string - The Formal ID for the group to be linked.
- Termination
Protection bool - If set to true, this Link cannot be deleted.
- User
Id string - The Formal ID of the user to be linked.
- group
Id String - The Formal ID for the group to be linked.
- termination
Protection Boolean - If set to true, this Link cannot be deleted.
- user
Id String - The Formal ID of the user to be linked.
- group
Id string - The Formal ID for the group to be linked.
- termination
Protection boolean - If set to true, this Link cannot be deleted.
- user
Id string - The Formal ID of the user to be linked.
- group_
id str - The Formal ID for the group to be linked.
- termination_
protection bool - If set to true, this Link cannot be deleted.
- user_
id str - The Formal ID of the user to be linked.
- group
Id String - The Formal ID for the group to be linked.
- termination
Protection Boolean - If set to true, this Link cannot be deleted.
- user
Id String - The Formal ID of the user to be linked.
Package Details
- Repository
- formal formalco/pulumi-formal
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
formalTerraform Provider.
