GroupMembership class
Resource for managing an AWS IdentityStore Group Membership.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.ssoadmin.getInstances({});
const exampleUser = new aws.identitystore.User("example", {
name: {
familyName: "Doe",
givenName: "John",
},
identityStoreId: example.then(example => example.identityStoreIds?.[0]),
displayName: "John Doe",
userName: "john.doe@example.com",
});
const exampleGroup = new aws.identitystore.Group("example", {
identityStoreId: example.then(example => example.identityStoreIds?.[0]),
displayName: "MyGroup",
description: "Some group name",
});
const exampleGroupMembership = new aws.identitystore.GroupMembership("example", {
identityStoreId: example.then(example => example.identityStoreIds?.[0]),
groupId: exampleGroup.groupId,
memberId: exampleUser.userId,
});
import pulumi
import pulumi_aws as aws
example = aws.ssoadmin.get_instances()
example_user = aws.identitystore.User("example",
name={
"family_name": "Doe",
"given_name": "John",
},
identity_store_id=example.identity_store_ids[0],
display_name="John Doe",
user_name="john.doe@example.com")
example_group = aws.identitystore.Group("example",
identity_store_id=example.identity_store_ids[0],
display_name="MyGroup",
description="Some group name")
example_group_membership = aws.identitystore.GroupMembership("example",
identity_store_id=example.identity_store_ids[0],
group_id=example_group.group_id,
member_id=example_user.user_id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.SsoAdmin.GetInstances.Invoke();
var exampleUser = new Aws.IdentityStore.User("example", new()
{
Name = new Aws.IdentityStore.Inputs.UserNameArgs
{
FamilyName = "Doe",
GivenName = "John",
},
IdentityStoreId = example.Apply(getInstancesResult => getInstancesResult.IdentityStoreIds[0]),
DisplayName = "John Doe",
UserName = "john.doe@example.com",
});
var exampleGroup = new Aws.IdentityStore.Group("example", new()
{
IdentityStoreId = example.Apply(getInstancesResult => getInstancesResult.IdentityStoreIds[0]),
DisplayName = "MyGroup",
Description = "Some group name",
});
var exampleGroupMembership = new Aws.IdentityStore.GroupMembership("example", new()
{
IdentityStoreId = example.Apply(getInstancesResult => getInstancesResult.IdentityStoreIds[0]),
GroupId = exampleGroup.GroupId,
MemberId = exampleUser.UserId,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/identitystore"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ssoadmin"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := ssoadmin.GetInstances(ctx, &ssoadmin.GetInstancesArgs{}, nil)
if err != nil {
return err
}
exampleUser, err := identitystore.NewUser(ctx, "example", &identitystore.UserArgs{
Name: &identitystore.UserNameArgs{
FamilyName: pulumi.String("Doe"),
GivenName: pulumi.String("John"),
},
IdentityStoreId: pulumi.String(example.IdentityStoreIds[0]),
DisplayName: pulumi.String("John Doe"),
UserName: pulumi.String("john.doe@example.com"),
})
if err != nil {
return err
}
exampleGroup, err := identitystore.NewGroup(ctx, "example", &identitystore.GroupArgs{
IdentityStoreId: pulumi.String(example.IdentityStoreIds[0]),
DisplayName: pulumi.String("MyGroup"),
Description: pulumi.String("Some group name"),
})
if err != nil {
return err
}
_, err = identitystore.NewGroupMembership(ctx, "example", &identitystore.GroupMembershipArgs{
IdentityStoreId: pulumi.String(example.IdentityStoreIds[0]),
GroupId: exampleGroup.GroupId,
MemberId: exampleUser.UserId,
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_ssoadmin_getinstances" "example" {
}
resource "aws_identitystore_user" "example" {
name = {
family_name = "Doe"
given_name = "John"
}
identity_store_id = data.aws_ssoadmin_getinstances.example.identity_store_ids[0]
display_name = "John Doe"
user_name = "john.doe@example.com"
}
resource "aws_identitystore_group" "example" {
identity_store_id = data.aws_ssoadmin_getinstances.example.identity_store_ids[0]
display_name = "MyGroup"
description = "Some group name"
}
resource "aws_identitystore_groupmembership" "example" {
identity_store_id = data.aws_ssoadmin_getinstances.example.identity_store_ids[0]
group_id = aws_identitystore_group.example.group_id
member_id = aws_identitystore_user.example.user_id
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssoadmin.SsoadminFunctions;
import com.pulumi.aws.ssoadmin.inputs.GetInstancesArgs;
import com.pulumi.aws.identitystore.User;
import com.pulumi.aws.identitystore.UserArgs;
import com.pulumi.aws.identitystore.inputs.UserNameArgs;
import com.pulumi.aws.identitystore.Group;
import com.pulumi.aws.identitystore.GroupArgs;
import com.pulumi.aws.identitystore.GroupMembership;
import com.pulumi.aws.identitystore.GroupMembershipArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
final var example = SsoadminFunctions.getInstances(GetInstancesArgs.builder()
.build());
var exampleUser = new User("exampleUser", UserArgs.builder()
.name(UserNameArgs.builder()
.familyName("Doe")
.givenName("John")
.build())
.identityStoreId(example.identityStoreIds()[0])
.displayName("John Doe")
.userName("john.doe@example.com")
.build());
var exampleGroup = new Group("exampleGroup", GroupArgs.builder()
.identityStoreId(example.identityStoreIds()[0])
.displayName("MyGroup")
.description("Some group name")
.build());
var exampleGroupMembership = new GroupMembership("exampleGroupMembership", GroupMembershipArgs.builder()
.identityStoreId(example.identityStoreIds()[0])
.groupId(exampleGroup.groupId())
.memberId(exampleUser.userId())
.build());
}
}
resources:
exampleUser:
type: aws:identitystore:User
name: example
properties:
name:
familyName: Doe
givenName: John
identityStoreId: ${example.identityStoreIds[0]}
displayName: John Doe
userName: john.doe@example.com
exampleGroup:
type: aws:identitystore:Group
name: example
properties:
identityStoreId: ${example.identityStoreIds[0]}
displayName: MyGroup
description: Some group name
exampleGroupMembership:
type: aws:identitystore:GroupMembership
name: example
properties:
identityStoreId: ${example.identityStoreIds[0]}
groupId: ${exampleGroup.groupId}
memberId: ${exampleUser.userId}
variables:
example:
fn::invoke:
function: aws:ssoadmin:getInstances
arguments: {}
Import
Using pulumi import, import aws.identitystore.GroupMembership using the identity_store_id/membership_id. For example:
$ pulumi import aws:identitystore/groupMembership:GroupMembership example d-0000000000/00000000-0000-0000-0000-000000000000
Constructors
- GroupMembership(String name, {GroupMembershipArgs? args, CustomResourceOptions? options})
-
Creates a new GroupMembership.
nameThe Pulumi resource name.argsArguments used to configure this GroupMembership. The set of arguments for GroupMembership.optionsResource options controlling this resource's behavior. - GroupMembership.reference(String urn)
- Creates a typed reference to an existing GroupMembership resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
groupId
↔ Output<
String> -
The identifier for a group in the Identity Store.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
identityStoreId
↔ Output<
String> -
Identity Store ID associated with the Single Sign-On Instance.
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
memberId
↔ Output<
String> -
The identifier for a user in the Identity Store.
latefinal
-
membershipId
↔ Output<
String> -
The identifier of the newly created group membership in the Identity Store.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {GroupMembershipState? state, CustomResourceOptions? options}) → GroupMembership -
Gets an existing GroupMembership resource's state with the given
nameandid.