Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. elasticache
  5. UserGroup

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.elasticache.UserGroup

Explore with Pulumi AI

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::ElastiCache::UserGroup

Create UserGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new UserGroup(name: string, args: UserGroupArgs, opts?: CustomResourceOptions);
@overload
def UserGroup(resource_name: str,
              args: UserGroupArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def UserGroup(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              engine: Optional[UserGroupEngine] = None,
              user_group_id: Optional[str] = None,
              user_ids: Optional[Sequence[str]] = None,
              tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewUserGroup(ctx *Context, name string, args UserGroupArgs, opts ...ResourceOption) (*UserGroup, error)
public UserGroup(string name, UserGroupArgs args, CustomResourceOptions? opts = null)
public UserGroup(String name, UserGroupArgs args)
public UserGroup(String name, UserGroupArgs args, CustomResourceOptions options)

type: aws-native:elasticache:UserGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. UserGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. UserGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. UserGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. UserGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. UserGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

UserGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The UserGroup resource accepts the following input properties:

Engine This property is required. Pulumi.AwsNative.ElastiCache.UserGroupEngine
The target cache engine for the user group.
UserGroupId This property is required. string
The ID of the user group.
UserIds This property is required. List<string>
List of users associated to this user group.
Tags List<Pulumi.AwsNative.Inputs.Tag>
An array of key-value pairs to apply to this user.
Engine This property is required. UserGroupEngine
The target cache engine for the user group.
UserGroupId This property is required. string
The ID of the user group.
UserIds This property is required. []string
List of users associated to this user group.
Tags TagArgs
An array of key-value pairs to apply to this user.
engine This property is required. UserGroupEngine
The target cache engine for the user group.
userGroupId This property is required. String
The ID of the user group.
userIds This property is required. List<String>
List of users associated to this user group.
tags List<Tag>
An array of key-value pairs to apply to this user.
engine This property is required. UserGroupEngine
The target cache engine for the user group.
userGroupId This property is required. string
The ID of the user group.
userIds This property is required. string[]
List of users associated to this user group.
tags Tag[]
An array of key-value pairs to apply to this user.
engine This property is required. UserGroupEngine
The target cache engine for the user group.
user_group_id This property is required. str
The ID of the user group.
user_ids This property is required. Sequence[str]
List of users associated to this user group.
tags Sequence[TagArgs]
An array of key-value pairs to apply to this user.
engine This property is required. "redis" | "valkey"
The target cache engine for the user group.
userGroupId This property is required. String
The ID of the user group.
userIds This property is required. List<String>
List of users associated to this user group.
tags List<Property Map>
An array of key-value pairs to apply to this user.

Outputs

All input properties are implicitly available as output properties. Additionally, the UserGroup resource produces the following output properties:

Arn string
The Amazon Resource Name (ARN) of the user account.
Id string
The provider-assigned unique ID for this managed resource.
Status string
Indicates user group status. Can be "creating", "active", "modifying", "deleting".
Arn string
The Amazon Resource Name (ARN) of the user account.
Id string
The provider-assigned unique ID for this managed resource.
Status string
Indicates user group status. Can be "creating", "active", "modifying", "deleting".
arn String
The Amazon Resource Name (ARN) of the user account.
id String
The provider-assigned unique ID for this managed resource.
status String
Indicates user group status. Can be "creating", "active", "modifying", "deleting".
arn string
The Amazon Resource Name (ARN) of the user account.
id string
The provider-assigned unique ID for this managed resource.
status string
Indicates user group status. Can be "creating", "active", "modifying", "deleting".
arn str
The Amazon Resource Name (ARN) of the user account.
id str
The provider-assigned unique ID for this managed resource.
status str
Indicates user group status. Can be "creating", "active", "modifying", "deleting".
arn String
The Amazon Resource Name (ARN) of the user account.
id String
The provider-assigned unique ID for this managed resource.
status String
Indicates user group status. Can be "creating", "active", "modifying", "deleting".

Supporting Types

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

UserGroupEngine
, UserGroupEngineArgs

Redis
redis
Valkey
valkey
UserGroupEngineRedis
redis
UserGroupEngineValkey
valkey
Redis
redis
Valkey
valkey
Redis
redis
Valkey
valkey
REDIS
redis
VALKEY
valkey
"redis"
redis
"valkey"
valkey

Package Details

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

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native