Experimental
@aws-cdk/aws-elasticache-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
PasswordUser L2 construct
Define an ElastiCache user with password authentication.
Example
const user = new elasticache.PasswordUser(this, 'User', {
// set user engine
engine: elasticache.UserEngine.VALKEY,
// set user id
userId: 'my-user-id',
// set access string
accessControl: elasticache.AccessControl.fromAccessString("on ~* +@all"),
// set username
userName: 'my-user-name',
// set up to two passwords
passwords: [
// "SecretIdForPassword" is the secret id for the password
SecretValue.secretsManager('SecretIdForPassword'),
// "AnotherSecretIdForPassword" is the secret id for the password
SecretValue.secretsManager('AnotherSecretIdForPassword'),
],
});
user = elasticache.PasswordUser(self, "User",
# set user engine
engine=elasticache.UserEngine.VALKEY,
# set user id
user_id="my-user-id",
# set access string
access_control=elasticache.AccessControl.from_access_string("on ~* +@all"),
# set username
user_name="my-user-name",
# set up to two passwords
passwords=[
# "SecretIdForPassword" is the secret id for the password
SecretValue.secrets_manager("SecretIdForPassword"),
# "AnotherSecretIdForPassword" is the secret id for the password
SecretValue.secrets_manager("AnotherSecretIdForPassword")
]
)
PasswordUser user = PasswordUser.Builder.create(this, "User")
// set user engine
.engine(UserEngine.VALKEY)
// set user id
.userId("my-user-id")
// set access string
.accessControl(AccessControl.fromAccessString("on ~* +@all"))
// set username
.userName("my-user-name")
// set up to two passwords
.passwords(List.of(SecretValue.secretsManager("SecretIdForPassword"), SecretValue.secretsManager("AnotherSecretIdForPassword")))
.build();
// Install: dotnet add package Amazon.CDK.AWS.ElastiCache.Alpha
var user = new PasswordUser(this, "User", new PasswordUserProps {
// set user engine
Engine = UserEngine.VALKEY,
// set user id
UserId = "my-user-id",
// set access string
AccessControl = AccessControl.FromAccessString("on ~* +@all"),
// set username
UserName = "my-user-name",
// set up to two passwords
Passwords = new [] { SecretValue.SecretsManager("SecretIdForPassword"), SecretValue.SecretsManager("AnotherSecretIdForPassword") }
});
// Install: go get github.com/aws/aws-cdk-go/awscdkelasticachealpha/v2
user := elasticache.NewPasswordUser(this, jsii.String("User"), &PasswordUserProps{
// set user engine
Engine: elasticache.UserEngine_VALKEY(),
// set user id
UserId: jsii.String("my-user-id"),
// set access string
AccessControl: elasticache.AccessControl_FromAccessString(jsii.String("on ~* +@all")),
// set username
UserName: jsii.String("my-user-name"),
// set up to two passwords
Passwords: []SecretValue{
awscdk.SecretValue_SecretsManager(jsii.String("SecretIdForPassword")),
awscdk.SecretValue_*SecretsManager(jsii.String("AnotherSecretIdForPassword")),
},
})
Initializer
new PasswordUser(scope: Construct, id: string, props: PasswordUserProps)
PasswordUser(scope: Construct, id: str, props: PasswordUserProps)
new PasswordUser(Construct scope, String id, PasswordUserProps props)
new PasswordUser(Construct scope, string id, PasswordUserProps props)
NewPasswordUser(Scope Construct, Id *string, Props PasswordUserProps)
Construct Props
accessControlAccessControlaccess_controlAccessControlaccessControlAccessControlAccessControlAccessControlAccessControlAccessControlrequired#engineoptionalUserEngineengineoptionalUserEngineengineoptionalUserEngineEngineoptionalUserEngineEngineoptionalUserEngine#Default: UserEngine.REDIS for NoPasswordUser, UserEngine.VALKEY for all other user types.
Enum options: UserEngine.VALKEY, UserEngine.REDIS.
passwordsSecretValue[]passwordstyping.List[SecretValue]passwordsList<SecretValue>PasswordsSecretValue[]Passwords*[]SecretValuerequired#Password authentication requires using 1-2 passwords.
userNameoptionalstringuser_nameoptionalstruserNameoptionalStringUserNameoptionalstringUserNameoptional*string#Default: Same as userId.
Properties
enginemay be undefinedUserEngineenginemay be undefinedUserEngineenginemay be undefinedUserEngineEnginemay be undefinedUserEngineEnginemay be undefinedUserEngine#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#userNamemay be undefinedstringuser_namemay be undefinedstruserNamemay be undefinedStringUserNamemay be undefinedstringUserNamemay be undefined*string#Can be 'active', 'modifying', 'deleting'.
Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
fromUserArn(scope: Construct, id: string, userArn: string): IUser@staticmethod def from_user_arn(scope: Construct, id: str, user_arn: str) -> IUserpublic static IUser fromUserArn(Construct scope, String id, String userArn)public static IUser FromUserArn(Construct scope, string id, string userArn)func FromUserArn(Scope Construct, Id *string, UserArn *string) IUserstatic#3 parameters
Parameters
scopescopescopescopeScope— The parent creating construct (usuallythis).ididididId— The construct's name.userArnuser_arnuserArnuserArnUserArn— The ARN of the existing user.
fromUserAttributes(scope: Construct, id: string, attrs: UserBaseAttributes): IUser@staticmethod def from_user_attributes(scope: Construct, id: str, attrs: UserBaseAttributes) -> IUserpublic static IUser fromUserAttributes(Construct scope, String id, UserBaseAttributes attrs)public static IUser FromUserAttributes(Construct scope, string id, UserBaseAttributes attrs)func FromUserAttributes(Scope Construct, Id *string, Attrs UserBaseAttributes) IUserstatic#3 parameters
Parameters
scopescopescopescopeScope— The parent creating construct (usuallythis).ididididId— The construct's name.attrsattrsattrsattrsAttrs— AUserBaseAttributesobject.
fromUserId(scope: Construct, id: string, userId: string): IUser@staticmethod def from_user_id(scope: Construct, id: str, user_id: str) -> IUserpublic static IUser fromUserId(Construct scope, String id, String userId)public static IUser FromUserId(Construct scope, string id, string userId)func FromUserId(Scope Construct, Id *string, UserId *string) IUserstatic#3 parameters
Parameters
scopescopescopescopeScope— The parent creating construct (usuallythis).ididididId— The construct's name.userIduser_iduserIduserIdUserId— The ID of the existing user.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isPasswordUser(x: any): boolean@staticmethod def is_password_user(x: Any) -> boolpublic static Boolean isPasswordUser(Object x)public static bool IsPasswordUser(object x)func IsPasswordUser(X interface{}) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.