interface CfnUserProps

Language	Type name
.NET	Amazon.CDK.AWS.ElastiCache.CfnUserProps
Java	software.amazon.awscdk.services.elasticache.CfnUserProps
Python	aws_cdk.aws_elasticache.CfnUserProps
TypeScript	@aws-cdk/aws-elasticache » CfnUserProps

Properties for defining a CfnUser.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as elasticache from '@aws-cdk/aws-elasticache';

declare const authenticationMode: any;
const cfnUserProps: elasticache.CfnUserProps = {
  engine: 'engine',
  userId: 'userId',
  userName: 'userName',

  // the properties below are optional
  accessString: 'accessString',
  authenticationMode: authenticationMode,
  noPasswordRequired: false,
  passwords: ['passwords'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
engine	string	The current supported value is redis.
userId	string	The ID of the user.
userName	string	The username of the user.
accessString?	string	Access permissions string used for this user.
authenticationMode?	any	Specifies the authentication mode to use. Below is an example of the possible JSON values:.
noPasswordRequired?	boolean | IResolvable	Indicates a password is not required for this user.
passwords?	string[]	Passwords used for this user.
tags?	CfnTag[]	AWS::ElastiCache::User.Tags.

---

engine

Type: string

The current supported value is redis.

---

userId

Type: string

The ID of the user.

---

userName

Type: string

The username of the user.

---

accessString?

Type: string (optional)

Access permissions string used for this user.

---

authenticationMode?

Type: any (optional)

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

{ Type: <iam | no-password-required | password> Passwords: ["*****", "******"] // If Type is password.
}

---

noPasswordRequired?

Type: boolean | IResolvable (optional)

Indicates a password is not required for this user.

---

passwords?

Type: string[] (optional)

Passwords used for this user.

You can create up to two passwords for each user.

---

tags?

Type: CfnTag[] (optional)

AWS::ElastiCache::User.Tags.