GroupMembership

Create a GroupMembership Resource

new GroupMembership(name: string, args: GroupMembershipArgs, opts?: CustomResourceOptions);

def GroupMembership(resource_name, opts=None, group=None, member_key=None, preferred_member_key=None, roles=None, __props__=None);

func NewGroupMembership(ctx *Context, name string, args GroupMembershipArgs, opts ...ResourceOption) (*GroupMembership, error)

public GroupMembership(string name, GroupMembershipArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args GroupMembershipArgs: 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 GroupMembershipArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GroupMembershipArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

GroupMembership Resource Properties

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

Inputs

The GroupMembership resource accepts the following input properties:

Group string: The name of the Group to create this membership in.
Roles List<GroupMembershipRoleArgs>: The MembershipRoles that apply to the Membership. Must not contain duplicate MembershipRoles with the same name. Structure is documented below.
MemberKey GroupMembershipMemberKeyArgs: EntityKey of the member. Structure is documented below.
PreferredMemberKey GroupMembershipPreferredMemberKeyArgs: EntityKey of the member. Structure is documented below.

Group string: The name of the Group to create this membership in.
Roles []GroupMembershipRole: The MembershipRoles that apply to the Membership. Must not contain duplicate MembershipRoles with the same name. Structure is documented below.
MemberKey GroupMembershipMemberKey: EntityKey of the member. Structure is documented below.
PreferredMemberKey GroupMembershipPreferredMemberKey: EntityKey of the member. Structure is documented below.

group string: The name of the Group to create this membership in.
roles GroupMembershipRole[]: The MembershipRoles that apply to the Membership. Must not contain duplicate MembershipRoles with the same name. Structure is documented below.
memberKey GroupMembershipMemberKey: EntityKey of the member. Structure is documented below.
preferredMemberKey GroupMembershipPreferredMemberKey: EntityKey of the member. Structure is documented below.

group str: The name of the Group to create this membership in.
roles List[GroupMembershipRole]: The MembershipRoles that apply to the Membership. Must not contain duplicate MembershipRoles with the same name. Structure is documented below.
member_key Dict[GroupMembershipMemberKey]: EntityKey of the member. Structure is documented below.
preferred_member_key Dict[GroupMembershipPreferredMemberKey]: EntityKey of the member. Structure is documented below.

Outputs

All input properties are implicitly available as output properties. Additionally, the GroupMembership resource produces the following output properties:

CreateTime string: The time when the Membership was created.
Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the MembershipRole. Must be one of OWNER, MANAGER, MEMBER.
Type string: The type of the membership.
UpdateTime string: The time when the Membership was last updated.

CreateTime string: The time when the Membership was created.
Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the MembershipRole. Must be one of OWNER, MANAGER, MEMBER.
Type string: The type of the membership.
UpdateTime string: The time when the Membership was last updated.

createTime string: The time when the Membership was created.
id string: The provider-assigned unique ID for this managed resource.
name string: The name of the MembershipRole. Must be one of OWNER, MANAGER, MEMBER.
type string: The type of the membership.
updateTime string: The time when the Membership was last updated.

create_time str: The time when the Membership was created.
id str: The provider-assigned unique ID for this managed resource.
name str: The name of the MembershipRole. Must be one of OWNER, MANAGER, MEMBER.
type str: The type of the membership.
update_time str: The time when the Membership was last updated.

Look up an Existing GroupMembership Resource

Get an existing GroupMembership 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?: GroupMembershipState, opts?: CustomResourceOptions): GroupMembership

static get(resource_name, id, opts=None, create_time=None, group=None, member_key=None, name=None, preferred_member_key=None, roles=None, type=None, update_time=None, __props__=None);

func GetGroupMembership(ctx *Context, name string, id IDInput, state *GroupMembershipState, opts ...ResourceOption) (*GroupMembership, error)

public static GroupMembership Get(string name, Input<string> id, GroupMembershipState? 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:

CreateTime string: The time when the Membership was created.
Group string: The name of the Group to create this membership in.
MemberKey GroupMembershipMemberKeyArgs: EntityKey of the member. Structure is documented below.
Name string: The name of the MembershipRole. Must be one of OWNER, MANAGER, MEMBER.
PreferredMemberKey GroupMembershipPreferredMemberKeyArgs: EntityKey of the member. Structure is documented below.
Roles List<GroupMembershipRoleArgs>: The MembershipRoles that apply to the Membership. Must not contain duplicate MembershipRoles with the same name. Structure is documented below.
Type string: The type of the membership.
UpdateTime string: The time when the Membership was last updated.

CreateTime string: The time when the Membership was created.
Group string: The name of the Group to create this membership in.
MemberKey GroupMembershipMemberKey: EntityKey of the member. Structure is documented below.
Name string: The name of the MembershipRole. Must be one of OWNER, MANAGER, MEMBER.
PreferredMemberKey GroupMembershipPreferredMemberKey: EntityKey of the member. Structure is documented below.
Roles []GroupMembershipRole: The MembershipRoles that apply to the Membership. Must not contain duplicate MembershipRoles with the same name. Structure is documented below.
Type string: The type of the membership.
UpdateTime string: The time when the Membership was last updated.

createTime string: The time when the Membership was created.
group string: The name of the Group to create this membership in.
memberKey GroupMembershipMemberKey: EntityKey of the member. Structure is documented below.
name string: The name of the MembershipRole. Must be one of OWNER, MANAGER, MEMBER.
preferredMemberKey GroupMembershipPreferredMemberKey: EntityKey of the member. Structure is documented below.
roles GroupMembershipRole[]: The MembershipRoles that apply to the Membership. Must not contain duplicate MembershipRoles with the same name. Structure is documented below.
type string: The type of the membership.
updateTime string: The time when the Membership was last updated.

create_time str: The time when the Membership was created.
group str: The name of the Group to create this membership in.
member_key Dict[GroupMembershipMemberKey]: EntityKey of the member. Structure is documented below.
name str: The name of the MembershipRole. Must be one of OWNER, MANAGER, MEMBER.
preferred_member_key Dict[GroupMembershipPreferredMemberKey]: EntityKey of the member. Structure is documented below.
roles List[GroupMembershipRole]: The MembershipRoles that apply to the Membership. Must not contain duplicate MembershipRoles with the same name. Structure is documented below.
type str: The type of the membership.
update_time str: The time when the Membership was last updated.

Supporting Types

GroupMembershipMemberKey

See the input and output API doc for this type.

Id string: The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source’s requirements. Must be unique within a namespace.
Namespace string: The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

Id string: The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source’s requirements. Must be unique within a namespace.
Namespace string: The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

id string: The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source’s requirements. Must be unique within a namespace.
namespace string: The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

id str: The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source’s requirements. Must be unique within a namespace.
namespace str: The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

GroupMembershipPreferredMemberKey

See the input and output API doc for this type.

Id string: The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source’s requirements. Must be unique within a namespace.
Namespace string: The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

Id string: The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source’s requirements. Must be unique within a namespace.
Namespace string: The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

id string: The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source’s requirements. Must be unique within a namespace.
namespace string: The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

id str: The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source’s requirements. Must be unique within a namespace.
namespace str: The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source_id}.

GroupMembershipRole

See the input and output API doc for this type.

Name string: The name of the MembershipRole. Must be one of OWNER, MANAGER, MEMBER.

Name string: The name of the MembershipRole. Must be one of OWNER, MANAGER, MEMBER.

name string: The name of the MembershipRole. Must be one of OWNER, MANAGER, MEMBER.

name str: The name of the MembershipRole. Must be one of OWNER, MANAGER, MEMBER.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GroupMembership

Create a GroupMembership Resource

GroupMembership Resource Properties

Inputs

Outputs

Look up an Existing GroupMembership Resource

Supporting Types

GroupMembershipMemberKey

GroupMembershipPreferredMemberKey

GroupMembershipRole

Package Details

On This Page