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

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.elasticache.User

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::ElastiCache::User

    Create User Resource

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

    Constructor syntax

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

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         engine: Optional[UserEngine] = None,
         user_id: Optional[str] = None,
         access_string: Optional[str] = None,
         authentication_mode: Optional[AuthenticationModePropertiesArgs] = None,
         no_password_required: Optional[bool] = None,
         passwords: Optional[Sequence[str]] = None,
         tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
         user_name: Optional[str] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

    type: aws-native:elasticache:User
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 UserArgs
    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 UserArgs
    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 UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    User 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 User resource accepts the following input properties:

    Engine Pulumi.AwsNative.ElastiCache.UserEngine
    The target cache engine for the user.
    UserId string
    The ID of the user.
    AccessString string
    Access permissions string used for this user account.
    AuthenticationMode Pulumi.AwsNative.ElastiCache.Inputs.AuthenticationModeProperties
    Specifies the authentication mode to use. Below is an example of the possible JSON values:

    { Passwords: ["*****", "******"] // If Type is password.
}
    NoPasswordRequired bool
    Indicates a password is not required for this user account.
    Passwords List<string>
    Passwords used for this user account. You can create up to two passwords for each user.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this user.
    UserName string
    The username of the user.
    Engine UserEngine
    The target cache engine for the user.
    UserId string
    The ID of the user.
    AccessString string
    Access permissions string used for this user account.
    AuthenticationMode AuthenticationModePropertiesArgs
    Specifies the authentication mode to use. Below is an example of the possible JSON values:

    { Passwords: ["*****", "******"] // If Type is password.
}
    NoPasswordRequired bool
    Indicates a password is not required for this user account.
    Passwords []string
    Passwords used for this user account. You can create up to two passwords for each user.
    Tags TagArgs
    An array of key-value pairs to apply to this user.
    UserName string
    The username of the user.
    engine UserEngine
    The target cache engine for the user.
    userId String
    The ID of the user.
    accessString String
    Access permissions string used for this user account.
    authenticationMode AuthenticationModeProperties
    Specifies the authentication mode to use. Below is an example of the possible JSON values:

    { Passwords: ["*****", "******"] // If Type is password.
}
    noPasswordRequired Boolean
    Indicates a password is not required for this user account.
    passwords List<String>
    Passwords used for this user account. You can create up to two passwords for each user.
    tags List<Tag>
    An array of key-value pairs to apply to this user.
    userName String
    The username of the user.
    engine UserEngine
    The target cache engine for the user.
    userId string
    The ID of the user.
    accessString string
    Access permissions string used for this user account.
    authenticationMode AuthenticationModeProperties
    Specifies the authentication mode to use. Below is an example of the possible JSON values:

    { Passwords: ["*****", "******"] // If Type is password.
}
    noPasswordRequired boolean
    Indicates a password is not required for this user account.
    passwords string[]
    Passwords used for this user account. You can create up to two passwords for each user.
    tags Tag[]
    An array of key-value pairs to apply to this user.
    userName string
    The username of the user.
    engine UserEngine
    The target cache engine for the user.
    user_id str
    The ID of the user.
    access_string str
    Access permissions string used for this user account.
    authentication_mode AuthenticationModePropertiesArgs
    Specifies the authentication mode to use. Below is an example of the possible JSON values:

    { Passwords: ["*****", "******"] // If Type is password.
}
    no_password_required bool
    Indicates a password is not required for this user account.
    passwords Sequence[str]
    Passwords used for this user account. You can create up to two passwords for each user.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this user.
    user_name str
    The username of the user.
    engine "redis" | "valkey"
    The target cache engine for the user.
    userId String
    The ID of the user.
    accessString String
    Access permissions string used for this user account.
    authenticationMode Property Map
    Specifies the authentication mode to use. Below is an example of the possible JSON values:

    { Passwords: ["*****", "******"] // If Type is password.
}
    noPasswordRequired Boolean
    Indicates a password is not required for this user account.
    passwords List<String>
    Passwords used for this user account. You can create up to two passwords for each user.
    tags List<Property Map>
    An array of key-value pairs to apply to this user.
    userName String
    The username of the user.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the User 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 the user status. Can be "active", "modifying" or "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 the user status. Can be "active", "modifying" or "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 the user status. Can be "active", "modifying" or "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 the user status. Can be "active", "modifying" or "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 the user status. Can be "active", "modifying" or "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 the user status. Can be "active", "modifying" or "deleting".

    Supporting Types

    AuthenticationModeProperties, AuthenticationModePropertiesArgs

    Type Pulumi.AwsNative.ElastiCache.UserAuthenticationModePropertiesType
    Authentication Type
    Passwords List<string>
    Passwords used for this user account. You can create up to two passwords for each user.
    Type UserAuthenticationModePropertiesType
    Authentication Type
    Passwords []string
    Passwords used for this user account. You can create up to two passwords for each user.
    type UserAuthenticationModePropertiesType
    Authentication Type
    passwords List<String>
    Passwords used for this user account. You can create up to two passwords for each user.
    type UserAuthenticationModePropertiesType
    Authentication Type
    passwords string[]
    Passwords used for this user account. You can create up to two passwords for each user.
    type UserAuthenticationModePropertiesType
    Authentication Type
    passwords Sequence[str]
    Passwords used for this user account. You can create up to two passwords for each user.
    type "password" | "no-password-required" | "iam"
    Authentication Type
    passwords List<String>
    Passwords used for this user account. You can create up to two passwords for each user.

    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

    UserAuthenticationModePropertiesType, UserAuthenticationModePropertiesTypeArgs

    Password
    password
    NoPasswordRequired
    no-password-required
    Iam
    iam
    UserAuthenticationModePropertiesTypePassword
    password
    UserAuthenticationModePropertiesTypeNoPasswordRequired
    no-password-required
    UserAuthenticationModePropertiesTypeIam
    iam
    Password
    password
    NoPasswordRequired
    no-password-required
    Iam
    iam
    Password
    password
    NoPasswordRequired
    no-password-required
    Iam
    iam
    PASSWORD
    password
    NO_PASSWORD_REQUIRED
    no-password-required
    IAM
    iam
    "password"
    password
    "no-password-required"
    no-password-required
    "iam"
    iam

    UserEngine, UserEngineArgs

    Redis
    redis
    Valkey
    valkey
    UserEngineRedis
    redis
    UserEngineValkey
    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
    aws-native logo

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

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native