aws.identitystore.Group
Explore with Pulumi AI
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"])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/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
})
}
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 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.List;
import java.util.ArrayList;
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]}
Create Group Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);
@overload
def Group(resource_name: str,
args: GroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Group(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
identity_store_id: Optional[str] = None,
description: Optional[str] = None)
func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
type: aws:identitystore:Group
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 GroupArgs
- 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 GroupArgs
- 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 GroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GroupArgs
- 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 examplegroupResourceResourceFromIdentitystoregroup = new Aws.IdentityStore.Group("examplegroupResourceResourceFromIdentitystoregroup", new()
{
DisplayName = "string",
IdentityStoreId = "string",
Description = "string",
});
example, err := identitystore.NewGroup(ctx, "examplegroupResourceResourceFromIdentitystoregroup", &identitystore.GroupArgs{
DisplayName: pulumi.String("string"),
IdentityStoreId: pulumi.String("string"),
Description: pulumi.String("string"),
})
var examplegroupResourceResourceFromIdentitystoregroup = new Group("examplegroupResourceResourceFromIdentitystoregroup", GroupArgs.builder()
.displayName("string")
.identityStoreId("string")
.description("string")
.build());
examplegroup_resource_resource_from_identitystoregroup = aws.identitystore.Group("examplegroupResourceResourceFromIdentitystoregroup",
display_name="string",
identity_store_id="string",
description="string")
const examplegroupResourceResourceFromIdentitystoregroup = new aws.identitystore.Group("examplegroupResourceResourceFromIdentitystoregroup", {
displayName: "string",
identityStoreId: "string",
description: "string",
});
type: aws:identitystore:Group
properties:
description: string
displayName: string
identityStoreId: string
Group Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Group resource accepts the following input properties:
- Display
Name string - A string containing the name of the group. This value is commonly displayed when the group is referenced.
- Identity
Store stringId The globally unique identifier for the identity store.
The following arguments are optional:
- Description string
- A string containing the description of the group.
- Display
Name string - A string containing the name of the group. This value is commonly displayed when the group is referenced.
- Identity
Store stringId The globally unique identifier for the identity store.
The following arguments are optional:
- Description string
- A string containing the description of the group.
- display
Name String - A string containing the name of the group. This value is commonly displayed when the group is referenced.
- identity
Store StringId The globally unique identifier for the identity store.
The following arguments are optional:
- description String
- A string containing the description of the group.
- display
Name string - A string containing the name of the group. This value is commonly displayed when the group is referenced.
- identity
Store stringId The globally unique identifier for the identity store.
The following arguments are optional:
- description string
- A string containing the description of the group.
- display_
name str - A string containing the name of the group. This value is commonly displayed when the group is referenced.
- identity_
store_ strid The globally unique identifier for the identity store.
The following arguments are optional:
- description str
- A string containing the description of the group.
- display
Name String - A string containing the name of the group. This value is commonly displayed when the group is referenced.
- identity
Store StringId The globally unique identifier for the identity store.
The following arguments are optional:
- description String
- A string containing the description of the group.
Outputs
All input properties are implicitly available as output properties. Additionally, the Group resource produces the following output properties:
- External
Ids List<GroupExternal Id> - A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
- Group
Id string - The identifier of the newly created group in the identity store.
- Id string
- The provider-assigned unique ID for this managed resource.
- External
Ids []GroupExternal Id - A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
- Group
Id string - The identifier of the newly created group in the identity store.
- Id string
- The provider-assigned unique ID for this managed resource.
- external
Ids List<GroupExternal Id> - A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
- group
Id String - The identifier of the newly created group in the identity store.
- id String
- The provider-assigned unique ID for this managed resource.
- external
Ids GroupExternal Id[] - A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
- group
Id string - The identifier of the newly created group in the identity store.
- id string
- The provider-assigned unique ID for this managed resource.
- external_
ids Sequence[GroupExternal Id] - A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
- group_
id str - The identifier of the newly created group in the identity store.
- id str
- The provider-assigned unique ID for this managed resource.
- external
Ids List<Property Map> - A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
- group
Id String - The identifier of the newly created group in the identity store.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Group Resource
Get an existing Group 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?: GroupState, opts?: CustomResourceOptions): Group
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
external_ids: Optional[Sequence[GroupExternalIdArgs]] = None,
group_id: Optional[str] = None,
identity_store_id: Optional[str] = None) -> Group
func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Description string
- A string containing the description of the group.
- Display
Name string - A string containing the name of the group. This value is commonly displayed when the group is referenced.
- External
Ids List<GroupExternal Id> - A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
- Group
Id string - The identifier of the newly created group in the identity store.
- Identity
Store stringId The globally unique identifier for the identity store.
The following arguments are optional:
- Description string
- A string containing the description of the group.
- Display
Name string - A string containing the name of the group. This value is commonly displayed when the group is referenced.
- External
Ids []GroupExternal Id Args - A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
- Group
Id string - The identifier of the newly created group in the identity store.
- Identity
Store stringId The globally unique identifier for the identity store.
The following arguments are optional:
- description String
- A string containing the description of the group.
- display
Name String - A string containing the name of the group. This value is commonly displayed when the group is referenced.
- external
Ids List<GroupExternal Id> - A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
- group
Id String - The identifier of the newly created group in the identity store.
- identity
Store StringId The globally unique identifier for the identity store.
The following arguments are optional:
- description string
- A string containing the description of the group.
- display
Name string - A string containing the name of the group. This value is commonly displayed when the group is referenced.
- external
Ids GroupExternal Id[] - A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
- group
Id string - The identifier of the newly created group in the identity store.
- identity
Store stringId The globally unique identifier for the identity store.
The following arguments are optional:
- description str
- A string containing the description of the group.
- display_
name str - A string containing the name of the group. This value is commonly displayed when the group is referenced.
- external_
ids Sequence[GroupExternal Id Args] - A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
- group_
id str - The identifier of the newly created group in the identity store.
- identity_
store_ strid The globally unique identifier for the identity store.
The following arguments are optional:
- description String
- A string containing the description of the group.
- display
Name String - A string containing the name of the group. This value is commonly displayed when the group is referenced.
- external
Ids List<Property Map> - A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
- group
Id String - The identifier of the newly created group in the identity store.
- identity
Store StringId The globally unique identifier for the identity store.
The following arguments are optional:
Supporting Types
GroupExternalId, GroupExternalIdArgs
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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.