Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. identitystore
  5. Group

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.identitystore.Group

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS IdentityStore Group.

    Example Usage

    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)
    public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

    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.

    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:

    DisplayName string
    A string containing the name of the group. This value is commonly displayed when the group is referenced.
    IdentityStoreId string

    The globally unique identifier for the identity store.

    The following arguments are optional:

    Description string
    A string containing the description of the group.
    DisplayName string
    A string containing the name of the group. This value is commonly displayed when the group is referenced.
    IdentityStoreId string

    The globally unique identifier for the identity store.

    The following arguments are optional:

    Description string
    A string containing the description of the group.
    displayName String
    A string containing the name of the group. This value is commonly displayed when the group is referenced.
    identityStoreId String

    The globally unique identifier for the identity store.

    The following arguments are optional:

    description String
    A string containing the description of the group.
    displayName string
    A string containing the name of the group. This value is commonly displayed when the group is referenced.
    identityStoreId string

    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_id str

    The globally unique identifier for the identity store.

    The following arguments are optional:

    description str
    A string containing the description of the group.
    displayName String
    A string containing the name of the group. This value is commonly displayed when the group is referenced.
    identityStoreId String

    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:

    ExternalIds List<GroupExternalId>
    A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
    GroupId string
    The identifier of the newly created group in the identity store.
    Id string
    The provider-assigned unique ID for this managed resource.
    ExternalIds []GroupExternalId
    A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
    GroupId string
    The identifier of the newly created group in the identity store.
    Id string
    The provider-assigned unique ID for this managed resource.
    externalIds List<GroupExternalId>
    A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
    groupId String
    The identifier of the newly created group in the identity store.
    id String
    The provider-assigned unique ID for this managed resource.
    externalIds GroupExternalId[]
    A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
    groupId 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[GroupExternalId]
    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.
    externalIds 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.
    groupId 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.
    The following state arguments are supported:
    Description string
    A string containing the description of the group.
    DisplayName string
    A string containing the name of the group. This value is commonly displayed when the group is referenced.
    ExternalIds List<GroupExternalId>
    A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
    GroupId string
    The identifier of the newly created group in the identity store.
    IdentityStoreId string

    The globally unique identifier for the identity store.

    The following arguments are optional:

    Description string
    A string containing the description of the group.
    DisplayName string
    A string containing the name of the group. This value is commonly displayed when the group is referenced.
    ExternalIds []GroupExternalIdArgs
    A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
    GroupId string
    The identifier of the newly created group in the identity store.
    IdentityStoreId string

    The globally unique identifier for the identity store.

    The following arguments are optional:

    description String
    A string containing the description of the group.
    displayName String
    A string containing the name of the group. This value is commonly displayed when the group is referenced.
    externalIds List<GroupExternalId>
    A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
    groupId String
    The identifier of the newly created group in the identity store.
    identityStoreId String

    The globally unique identifier for the identity store.

    The following arguments are optional:

    description string
    A string containing the description of the group.
    displayName string
    A string containing the name of the group. This value is commonly displayed when the group is referenced.
    externalIds GroupExternalId[]
    A list of external IDs that contains the identifiers issued to this resource by an external identity provider. See External IDs below.
    groupId string
    The identifier of the newly created group in the identity store.
    identityStoreId string

    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[GroupExternalIdArgs]
    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_id str

    The globally unique identifier for the identity store.

    The following arguments are optional:

    description String
    A string containing the description of the group.
    displayName String
    A string containing the name of the group. This value is commonly displayed when the group is referenced.
    externalIds 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.
    groupId String
    The identifier of the newly created group in the identity store.
    identityStoreId String

    The globally unique identifier for the identity store.

    The following arguments are optional:

    Supporting Types

    GroupExternalId, GroupExternalIdArgs

    Id string
    The identifier issued to this resource by an external identity provider.
    Issuer string
    The issuer for an external identifier.
    Id string
    The identifier issued to this resource by an external identity provider.
    Issuer string
    The issuer for an external identifier.
    id String
    The identifier issued to this resource by an external identity provider.
    issuer String
    The issuer for an external identifier.
    id string
    The identifier issued to this resource by an external identity provider.
    issuer string
    The issuer for an external identifier.
    id str
    The identifier issued to this resource by an external identity provider.
    issuer str
    The issuer for an external identifier.
    id String
    The identifier issued to this resource by an external identity provider.
    issuer String
    The issuer for an external identifier.

    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.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.32.0 published on Friday, Apr 19, 2024 by Pulumi
    pulumi/pulumi-aws