aws-cdk-lib.aws_elasticache.CfnUserProps

interface CfnUserProps

LanguageType name
.NETAmazon.CDK.AWS.ElastiCache.CfnUserProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awselasticache#CfnUserProps
Javasoftware.amazon.awscdk.services.elasticache.CfnUserProps
Pythonaws_cdk.aws_elasticache.CfnUserProps
TypeScript aws-cdk-lib » 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 { aws_elasticache as elasticache } from 'aws-cdk-lib';

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

NameTypeDescription
enginestringThe current supported value is redis.
userIdstringThe ID of the user.
userNamestringThe username of the user.
accessString?stringAccess permissions string used for this user.
authenticationMode?anySpecifies the authentication mode to use. Below is an example of the possible JSON values:.
noPasswordRequired?boolean | IResolvableIndicates 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.