Class CfnUserProps

Properties for defining a CfnUser.

Inheritance

object

CfnUserProps

Implements

ICfnUserProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.ElastiCache

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnUserProps : ICfnUserProps

Syntax (vb)

Public Class CfnUserProps Implements ICfnUserProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ElastiCache;

             var authenticationMode;

             var cfnUserProps = new CfnUserProps {
                 Engine = "engine",
                 UserId = "userId",
                 UserName = "userName",

                 // the properties below are optional
                 AccessString = "accessString",
                 AuthenticationMode = authenticationMode,
                 NoPasswordRequired = false,
                 Passwords = new [] { "passwords" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnUserProps()

Properties for defining a CfnUser.

Properties

AccessString	Access permissions string used for this user.
AuthenticationMode	Specifies the authentication mode to use. Below is an example of the possible JSON values:.
Engine	The current supported values are valkey and redis.
NoPasswordRequired	Indicates a password is not required for this user.
Passwords	Passwords used for this user.
Tags	The list of tags.
UserId	The ID of the user.
UserName	The username of the user.

Constructors

CfnUserProps()

Properties for defining a CfnUser.

public CfnUserProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ElastiCache;

             var authenticationMode;

             var cfnUserProps = new CfnUserProps {
                 Engine = "engine",
                 UserId = "userId",
                 UserName = "userName",

                 // the properties below are optional
                 AccessString = "accessString",
                 AuthenticationMode = authenticationMode,
                 NoPasswordRequired = false,
                 Passwords = new [] { "passwords" },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

AccessString

Access permissions string used for this user.

public string? AccessString { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-accessstring

AuthenticationMode

Specifies the authentication mode to use. Below is an example of the possible JSON values:.

public object? AuthenticationMode { get; set; }

Property Value

object

Remarks

{ Passwords: ["*****", "******"] // If Type is password.
}

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-authenticationmode

Engine

The current supported values are valkey and redis.

public string Engine { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-engine

NoPasswordRequired

Indicates a password is not required for this user.

public object? NoPasswordRequired { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-nopasswordrequired

Type union: either bool or IResolvable

Passwords

Passwords used for this user.

public string[]? Passwords { get; set; }

Property Value

string[]

Remarks

You can create up to two passwords for each user.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-passwords

UserId

The ID of the user.

public string UserId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-user.html#cfn-elasticache-user-userid

UserName

The username of the user.

public string UserName { get; set; }