Skip to content
v2.277.0

Experimental

@aws-cdk/aws-elasticache-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

UserBaseProps Struct ​

Properties for defining an ElastiCache base user.

Example ​

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

declare const accessControl: elasticache_alpha.AccessControl;
declare const userEngine: elasticache_alpha.UserEngine;
const userBaseProps: elasticache_alpha.UserBaseProps = {
  accessControl: accessControl,
  userId: 'userId',

  // the properties below are optional
  engine: userEngine,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_elasticache_alpha as elasticache_alpha

# access_control: elasticache_alpha.AccessControl
# user_engine: elasticache_alpha.UserEngine

user_base_props = elasticache_alpha.UserBaseProps(
    access_control=access_control,
    user_id="userId",

    # the properties below are optional
    engine=user_engine
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.elasticache.alpha.*;

AccessControl accessControl;
UserEngine userEngine;

UserBaseProps userBaseProps = UserBaseProps.builder()
        .accessControl(accessControl)
        .userId("userId")

        // the properties below are optional
        .engine(userEngine)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.ElastiCache.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ElastiCache.Alpha;

AccessControl accessControl;
UserEngine userEngine;

var userBaseProps = new UserBaseProps {
    AccessControl = accessControl,
    UserId = "userId",

    // the properties below are optional
    Engine = userEngine
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdkelasticachealpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import elasticache_alpha "github.com/aws/aws-cdk-go/awscdkelasticachealpha"

var accessControl AccessControl
var userEngine UserEngine

userBaseProps := &UserBaseProps{
	AccessControl: accessControl,
	UserId: jsii.String("userId"),

	// the properties below are optional
	Engine: userEngine,
}

Properties ​

accessControlAccessControlaccess_controlAccessControlaccessControlAccessControlAccessControlAccessControlAccessControlAccessControlrequired#
Access control configuration for the user.
engineoptionalUserEngineengineoptionalUserEngineengineoptionalUserEngineEngineoptionalUserEngineEngineoptionalUserEngine#
The engine type for the user.

Default: UserEngine.REDIS for NoPasswordUser, UserEngine.VALKEY for all other user types.

Enum options: UserEngine.VALKEY, UserEngine.REDIS.

userIdstringuser_idstruserIdStringUserIdstringUserId*stringrequired#
The ID of the user.