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

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.elasticache.UserGroup

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 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 string
    The unique name of the resource.
    args UserGroupArgs
    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 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 string
    The unique name of the resource.
    args UserGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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

    The UserGroup resource accepts the following input properties:

    Engine Pulumi.AwsNative.ElastiCache.UserGroupEngine
    Must be redis.
    UserGroupId string
    The ID of the user group.
    UserIds 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 UserGroupEngine
    Must be redis.
    UserGroupId string
    The ID of the user group.
    UserIds []string
    List of users associated to this user group.
    Tags TagArgs
    An array of key-value pairs to apply to this user.
    engine UserGroupEngine
    Must be redis.
    userGroupId String
    The ID of the user group.
    userIds 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 UserGroupEngine
    Must be redis.
    userGroupId string
    The ID of the user group.
    userIds string[]
    List of users associated to this user group.
    tags Tag[]
    An array of key-value pairs to apply to this user.
    engine UserGroupEngine
    Must be redis.
    user_group_id str
    The ID of the user group.
    user_ids 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 "redis"
    Must be redis.
    userGroupId String
    The ID of the user group.
    userIds 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 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, UserGroupEngineArgs

    Redis
    redis
    UserGroupEngineRedis
    redis
    Redis
    redis
    Redis
    redis
    REDIS
    redis
    "redis"
    redis

    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 Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native