Group class
Resource for managing an AWS IdentityStore Group.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const _this = new aws.identitystore.Group("this", {
displayName: "Example group",
description: "Example description",
identityStoreId: example.identityStoreIds[0],
});
import pulumi
import pulumi_aws as aws
this = aws.identitystore.Group("this",
display_name="Example group",
description="Example description",
identity_store_id=example["identityStoreIds"][0])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var @this = new Aws.IdentityStore.Group("this", new()
{
DisplayName = "Example group",
Description = "Example description",
IdentityStoreId = example.IdentityStoreIds[0],
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/identitystore"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := identitystore.NewGroup(ctx, "this", &identitystore.GroupArgs{
DisplayName: pulumi.String("Example group"),
Description: pulumi.String("Example description"),
IdentityStoreId: pulumi.Any(example.IdentityStoreIds[0]),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_identitystore_group" "this" {
display_name = "Example group"
description = "Example description"
identity_store_id = example.identityStoreIds[0]
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.identitystore.Group;
import com.pulumi.aws.identitystore.GroupArgs;
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) {
var this_ = new Group("this", GroupArgs.builder()
.displayName("Example group")
.description("Example description")
.identityStoreId(example.identityStoreIds()[0])
.build());
}
}
resources:
this:
type: aws:identitystore:Group
properties:
displayName: Example group
description: Example description
identityStoreId: ${example.identityStoreIds[0]}
Import
Using pulumi import, import an Identity Store Group using the combination identity_store_id/group_id. For example:
$ pulumi import aws:identitystore/group:Group example d-9c6705e95c/b8a1c340-8031-7071-a2fb-7dc540320c30
Constructors
- Group(String name, {GroupArgs? args, CustomResourceOptions? options})
-
Creates a new Group.
nameThe Pulumi resource name.argsArguments used to configure this Group. The set of arguments for Group.optionsResource options controlling this resource's behavior. - Group.reference(String urn)
- Creates a typed reference to an existing Group resource.
Properties
-
arn
↔ Output<
String> -
ARN of the Group.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String?> -
A string containing the description of the group.
latefinal
-
displayName
↔ Output<
String> -
A string containing the name of the group. This value is commonly displayed when the group is referenced.
latefinal
-
externalIds
↔ Output<
List< GroupExternalId> > -
A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
latefinal
-
groupId
↔ Output<
String> -
The identifier of the newly created 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> -
The globally unique identifier for the identity store.
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
-
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