1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. elasticache
  5. getUserGroup

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.elasticache.getUserGroup

Get Started
aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::ElastiCache::UserGroup

    Using getUserGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getUserGroup(args: GetUserGroupArgs, opts?: InvokeOptions): Promise<GetUserGroupResult>
function getUserGroupOutput(args: GetUserGroupOutputArgs, opts?: InvokeOptions): Output<GetUserGroupResult>
    def get_user_group(user_group_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetUserGroupResult
def get_user_group_output(user_group_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetUserGroupResult]
    func LookupUserGroup(ctx *Context, args *LookupUserGroupArgs, opts ...InvokeOption) (*LookupUserGroupResult, error)
func LookupUserGroupOutput(ctx *Context, args *LookupUserGroupOutputArgs, opts ...InvokeOption) LookupUserGroupResultOutput

    > Note: This function is named LookupUserGroup in the Go SDK.

    public static class GetUserGroup 
{
    public static Task<GetUserGroupResult> InvokeAsync(GetUserGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetUserGroupResult> Invoke(GetUserGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetUserGroupResult> getUserGroup(GetUserGroupArgs args, InvokeOptions options)
public static Output<GetUserGroupResult> getUserGroup(GetUserGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:elasticache:getUserGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    UserGroupId string
    The ID of the user group.
    UserGroupId string
    The ID of the user group.
    userGroupId String
    The ID of the user group.
    userGroupId string
    The ID of the user group.
    user_group_id str
    The ID of the user group.
    userGroupId String
    The ID of the user group.

    getUserGroup Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the user account.
    Engine Pulumi.AwsNative.ElastiCache.UserGroupEngine
    The target cache engine for the user group.
    Status string
    Indicates user group status. Can be "creating", "active", "modifying", "deleting".
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this user.
    UserIds List<string>
    List of users associated to this user group.
    Arn string
    The Amazon Resource Name (ARN) of the user account.
    Engine UserGroupEngine
    The target cache engine for the user group.
    Status string
    Indicates user group status. Can be "creating", "active", "modifying", "deleting".
    Tags Tag
    An array of key-value pairs to apply to this user.
    UserIds []string
    List of users associated to this user group.
    arn String
    The Amazon Resource Name (ARN) of the user account.
    engine UserGroupEngine
    The target cache engine for the user group.
    status String
    Indicates user group status. Can be "creating", "active", "modifying", "deleting".
    tags List<Tag>
    An array of key-value pairs to apply to this user.
    userIds List<String>
    List of users associated to this user group.
    arn string
    The Amazon Resource Name (ARN) of the user account.
    engine UserGroupEngine
    The target cache engine for the user group.
    status string
    Indicates user group status. Can be "creating", "active", "modifying", "deleting".
    tags Tag[]
    An array of key-value pairs to apply to this user.
    userIds string[]
    List of users associated to this user group.
    arn str
    The Amazon Resource Name (ARN) of the user account.
    engine UserGroupEngine
    The target cache engine for the user group.
    status str
    Indicates user group status. Can be "creating", "active", "modifying", "deleting".
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this user.
    user_ids Sequence[str]
    List of users associated to this user group.
    arn String
    The Amazon Resource Name (ARN) of the user account.
    engine "redis" | "valkey"
    The target cache engine for the user group.
    status String
    Indicates user group status. Can be "creating", "active", "modifying", "deleting".
    tags List<Property Map>
    An array of key-value pairs to apply to this user.
    userIds List<String>
    List of users associated to this user group.

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    UserGroupEngine

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.37.0 published on Wednesday, Oct 15, 2025 by Pulumi
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate