interface CfnUserProps

Language	Type name
.NET	`Amazon.CDK.AWS.ElastiCache.CfnUserProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awselasticache#CfnUserProps`
Java	`software.amazon.awscdk.services.elasticache.CfnUserProps`
Python	`aws_cdk.aws_elasticache.CfnUserProps`
TypeScript	`aws-cdk-lib` » `aws_elasticache` » `CfnUserProps`

Properties for defining a CfnUser.

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

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

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[]`	The list of tags.

engine

Type: string

The current supported value is redis.

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

userId

Type: string

The ID of the user.

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

userName

Type: string

The username of the user.

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

accessString?

Type: string (optional)

Access permissions string used for this user.

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

authenticationMode?

Type: any (optional)

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

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

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

noPasswordRequired?

Type: boolean | IResolvable (optional)

Indicates a password is not required for this user.

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

passwords?

Type: string[] (optional)

Passwords used for this user.

You can create up to two passwords for each user.

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

tags?

Type: CfnTag[] (optional)

The list of tags.

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