temporalcloud.GroupMembers
Explore with Pulumi AI
Sets Group Membership for the provided Group ID. Only use one per group.
Example Usage
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
resources:
adminGroup:
type: temporalcloud:Group
reader:
type: temporalcloud:User
properties:
email: reader@yourdomain.com
accountAccess: reader
adminGroupAccess:
type: temporalcloud:GroupAccess
properties:
groupId: ${adminGroup.id}
accountAccess: admin
adminGroupMembers:
type: temporalcloud:GroupMembers
properties:
groupId: ${adminGroup.id}
users:
- ${reader.id}
Create GroupMembers Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GroupMembers(name: string, args: GroupMembersArgs, opts?: CustomResourceOptions);
@overload
def GroupMembers(resource_name: str,
args: GroupMembersArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GroupMembers(resource_name: str,
opts: Optional[ResourceOptions] = None,
group_id: Optional[str] = None,
users: Optional[Sequence[str]] = None,
timeouts: Optional[GroupMembersTimeoutsArgs] = None)
func NewGroupMembers(ctx *Context, name string, args GroupMembersArgs, opts ...ResourceOption) (*GroupMembers, error)
public GroupMembers(string name, GroupMembersArgs args, CustomResourceOptions? opts = null)
public GroupMembers(String name, GroupMembersArgs args)
public GroupMembers(String name, GroupMembersArgs args, CustomResourceOptions options)
type: temporalcloud:GroupMembers
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 GroupMembersArgs
- 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 GroupMembersArgs
- 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 GroupMembersArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GroupMembersArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GroupMembersArgs
- 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 groupMembersResource = new Temporalcloud.GroupMembers("groupMembersResource", new()
{
GroupId = "string",
Users = new[]
{
"string",
},
Timeouts = new Temporalcloud.Inputs.GroupMembersTimeoutsArgs
{
Create = "string",
Delete = "string",
},
});
example, err := temporalcloud.NewGroupMembers(ctx, "groupMembersResource", &temporalcloud.GroupMembersArgs{
GroupId: pulumi.String("string"),
Users: pulumi.StringArray{
pulumi.String("string"),
},
Timeouts: &temporalcloud.GroupMembersTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
},
})
var groupMembersResource = new GroupMembers("groupMembersResource", GroupMembersArgs.builder()
.groupId("string")
.users("string")
.timeouts(GroupMembersTimeoutsArgs.builder()
.create("string")
.delete("string")
.build())
.build());
group_members_resource = temporalcloud.GroupMembers("groupMembersResource",
group_id="string",
users=["string"],
timeouts={
"create": "string",
"delete": "string",
})
const groupMembersResource = new temporalcloud.GroupMembers("groupMembersResource", {
groupId: "string",
users: ["string"],
timeouts: {
create: "string",
"delete": "string",
},
});
type: temporalcloud:GroupMembers
properties:
groupId: string
timeouts:
create: string
delete: string
users:
- string
GroupMembers 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 GroupMembers resource accepts the following input properties:
- Group
Id string - The Group ID to set the members for.
- Users List<string>
- The users to add to the group.
- Timeouts
Group
Members Timeouts
- Group
Id string - The Group ID to set the members for.
- Users []string
- The users to add to the group.
- Timeouts
Group
Members Timeouts Args
- group
Id String - The Group ID to set the members for.
- users List<String>
- The users to add to the group.
- timeouts
Group
Members Timeouts
- group
Id string - The Group ID to set the members for.
- users string[]
- The users to add to the group.
- timeouts
Group
Members Timeouts
- group_
id str - The Group ID to set the members for.
- users Sequence[str]
- The users to add to the group.
- timeouts
Group
Members Timeouts Args
- group
Id String - The Group ID to set the members for.
- users List<String>
- The users to add to the group.
- timeouts Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the GroupMembers 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 GroupMembers Resource
Get an existing GroupMembers 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?: GroupMembersState, opts?: CustomResourceOptions): GroupMembers
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
group_id: Optional[str] = None,
timeouts: Optional[GroupMembersTimeoutsArgs] = None,
users: Optional[Sequence[str]] = None) -> GroupMembers
func GetGroupMembers(ctx *Context, name string, id IDInput, state *GroupMembersState, opts ...ResourceOption) (*GroupMembers, error)
public static GroupMembers Get(string name, Input<string> id, GroupMembersState? state, CustomResourceOptions? opts = null)
public static GroupMembers get(String name, Output<String> id, GroupMembersState state, CustomResourceOptions options)
resources: _: type: temporalcloud:GroupMembers 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 Group ID to set the members for.
- Timeouts
Group
Members Timeouts - Users List<string>
- The users to add to the group.
- Group
Id string - The Group ID to set the members for.
- Timeouts
Group
Members Timeouts Args - Users []string
- The users to add to the group.
- group
Id String - The Group ID to set the members for.
- timeouts
Group
Members Timeouts - users List<String>
- The users to add to the group.
- group
Id string - The Group ID to set the members for.
- timeouts
Group
Members Timeouts - users string[]
- The users to add to the group.
- group_
id str - The Group ID to set the members for.
- timeouts
Group
Members Timeouts Args - users Sequence[str]
- The users to add to the group.
- group
Id String - The Group ID to set the members for.
- timeouts Property Map
- users List<String>
- The users to add to the group.
Supporting Types
GroupMembersTimeouts, GroupMembersTimeoutsArgs
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- Create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- Delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- create string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete string
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- create str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete str
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
- create String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
- delete String
- A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
Import
The pulumi import
command can be used, for example:
Group Members can be imported to incorporate existing Group Memberships into your Terraform pipeline.
To import Group Members, you need
a resource configuration in your Terraform configuration file/module to accept the imported Group Members. In the example below, the placeholder is “temporalcloud_group_members” “group”
the Group’s ID, which is found using the Temporal Cloud CLI tcld g l. In the example below, this is 72360058153949edb2f1d47019c1e85f
$ pulumi import temporalcloud:index/groupMembers:GroupMembers group 72360058153949edb2f1d47019c1e85f
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- temporalcloud temporalio/terraform-provider-temporalcloud
- License
- Notes
- This Pulumi package is based on the
temporalcloud
Terraform Provider.