@aws-cdk/aws-elasticache-alpha 2.218.0-alpha.0

package/lib/user-base.d.ts

@@ -0,0 +1,148 @@
+import { Construct } from 'constructs';
+import { UserEngine } from './common';
+import { IResource, Resource } from 'aws-cdk-lib/core';
+/**
+ * Access control configuration for ElastiCache users.
+ */
+export declare abstract class AccessControl {
+    /**
+     * Create access control from an access string.
+     *
+     * @param accessString The access string defining user permissions.
+     */
+    static fromAccessString(accessString: string): AccessControl;
+    /**
+     * The access string that defines user's permissions.
+     */
+    abstract readonly accessString: string;
+}
+/**
+ * Properties for defining an ElastiCache base user.
+ */
+export interface UserBaseProps {
+    /**
+     * The engine type for the user.
+     * Enum options: UserEngine.VALKEY, UserEngine.REDIS.
+     *
+     * @default UserEngine.VALKEY.
+     */
+    readonly engine?: UserEngine;
+    /**
+     * The ID of the user.
+     */
+    readonly userId: string;
+    /**
+     * Access control configuration for the user.
+     */
+    readonly accessControl: AccessControl;
+}
+/**
+ * Represents an ElastiCache base user.
+ */
+export interface IUser extends IResource {
+    /**
+     * The user's ID.
+     *
+     * @attribute
+     */
+    readonly userId: string;
+    /**
+     * The engine for the user.
+     */
+    readonly engine?: UserEngine;
+    /**
+     * The user's name.
+     *
+     * @attribute
+     */
+    readonly userName?: string;
+    /**
+     * The user's ARN.
+     *
+     * @attribute
+     */
+    readonly userArn: string;
+}
+/**
+ * Attributes for importing an existing ElastiCache user.
+ */
+export interface UserBaseAttributes {
+    /**
+     * The ID of the user.
+     * One of `userId` or `userArn` is required.
+     *
+     * @default - derived from userArn.
+     */
+    readonly userId?: string;
+    /**
+     * The engine type for the user.
+     *
+     * @default - engine type is unknown.
+     */
+    readonly engine?: UserEngine;
+    /**
+     * The user's name.
+     *
+     * @default - name is unknown.
+     */
+    readonly userName?: string;
+    /**
+     * The ARN of the user.
+     *
+     * One of `userId` or `userArn` is required.
+     *
+     * @default - derived from userId.
+     */
+    readonly userArn?: string;
+}
+/**
+ * Base class for ElastiCache users.
+ */
+export declare abstract class UserBase extends Resource implements IUser {
+    /**
+     * Import an existing user by ID.
+     *
+     * @param scope The parent creating construct (usually `this`).
+     * @param id The construct's name.
+     * @param userId The ID of the existing user.
+     */
+    static fromUserId(scope: Construct, id: string, userId: string): IUser;
+    /**
+     * Import an existing user by ARN.
+     *
+     * @param scope The parent creating construct (usually `this`).
+     * @param id The construct's name.
+     * @param userArn The ARN of the existing user.
+     */
+    static fromUserArn(scope: Construct, id: string, userArn: string): IUser;
+    /**
+     * Import an existing user using attributes.
+     *
+     * @param scope The parent creating construct (usually `this`).
+     * @param id The construct's name.
+     * @param attrs A `UserBaseAttributes` object.
+     */
+    static fromUserAttributes(scope: Construct, id: string, attrs: UserBaseAttributes): IUser;
+    /**
+     * The user's ID.
+     *
+     * @attribute
+     */
+    abstract readonly userId: string;
+    /**
+     * The engine for the user.
+     */
+    abstract readonly engine?: UserEngine;
+    /**
+     * The user's name.
+     *
+     * @attribute
+     */
+    abstract readonly userName?: string;
+    /**
+     * The user's ARN.
+     *
+     * @attribute
+     */
+    abstract readonly userArn: string;
+}

package/lib/user-base.js

@@ -0,0 +1,114 @@
+"use strict";
+var _a, _b;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserBase = exports.AccessControl = void 0;
+const jsiiDeprecationWarnings = require("../.warnings.jsii.js");
+const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
+const core_1 = require("aws-cdk-lib/core");
+/**
+ * Access control configuration for ElastiCache users.
+ */
+class AccessControl {
+    /**
+     * Create access control from an access string.
+     *
+     * @param accessString The access string defining user permissions.
+     */
+    static fromAccessString(accessString) {
+        return new AccessControlString(accessString);
+    }
+}
+exports.AccessControl = AccessControl;
+_a = JSII_RTTI_SYMBOL_1;
+AccessControl[_a] = { fqn: "@aws-cdk/aws-elasticache-alpha.AccessControl", version: "2.218.0-alpha.0" };
+/**
+ * Access control implementation using a raw access string.
+ */
+class AccessControlString extends AccessControl {
+    constructor(accessString) {
+        super();
+        this.accessString = accessString;
+    }
+}
+/**
+ * Base class for ElastiCache users.
+ */
+class UserBase extends core_1.Resource {
+    /**
+     * Import an existing user by ID.
+     *
+     * @param scope The parent creating construct (usually `this`).
+     * @param id The construct's name.
+     * @param userId The ID of the existing user.
+     */
+    static fromUserId(scope, id, userId) {
+        return UserBase.fromUserAttributes(scope, id, { userId });
+    }
+    /**
+     * Import an existing user by ARN.
+     *
+     * @param scope The parent creating construct (usually `this`).
+     * @param id The construct's name.
+     * @param userArn The ARN of the existing user.
+     */
+    static fromUserArn(scope, id, userArn) {
+        return UserBase.fromUserAttributes(scope, id, { userArn });
+    }
+    /**
+     * Import an existing user using attributes.
+     *
+     * @param scope The parent creating construct (usually `this`).
+     * @param id The construct's name.
+     * @param attrs A `UserBaseAttributes` object.
+     */
+    static fromUserAttributes(scope, id, attrs) {
+        try {
+            jsiiDeprecationWarnings._aws_cdk_aws_elasticache_alpha_UserBaseAttributes(attrs);
+        }
+        catch (error) {
+            if (process.env.JSII_DEBUG !== "1" && error.name === "DeprecationError") {
+                Error.captureStackTrace(error, this.fromUserAttributes);
+            }
+            throw error;
+        }
+        let userId;
+        let userArn;
+        const stack = core_1.Stack.of(scope);
+        if (attrs.userArn && attrs.userId) {
+            throw new core_1.ValidationError('Only one of userArn or userId can be provided.', scope);
+        }
+        if (attrs.userArn) {
+            userArn = attrs.userArn;
+            const extractedUserId = stack.splitArn(attrs.userArn, core_1.ArnFormat.SLASH_RESOURCE_NAME).resourceName;
+            if (!extractedUserId) {
+                throw new core_1.ValidationError('Unable to extract user id from ARN.', scope);
+            }
+            userId = extractedUserId;
+        }
+        else if (attrs.userId) {
+            userId = attrs.userId;
+            userArn = stack.formatArn({
+                service: 'elasticache',
+                resource: 'user',
+                resourceName: attrs.userId,
+            });
+        }
+        else {
+            throw new core_1.ValidationError('One of userId or userArn is required.', scope);
+        }
+        class Import extends core_1.Resource {
+            constructor(_userArn, _userId) {
+                super(scope, id);
+                this.userArn = _userArn;
+                this.userId = _userId;
+                this.engine = attrs.engine;
+                this.userName = attrs.userName;
+            }
+        }
+        return new Import(userArn, userId);
+    }
+}
+exports.UserBase = UserBase;
+_b = JSII_RTTI_SYMBOL_1;
+UserBase[_b] = { fqn: "@aws-cdk/aws-elasticache-alpha.UserBase", version: "2.218.0-alpha.0" };
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"user-base.js","sourceRoot":"","sources":["user-base.ts"],"names":[],"mappings":";;;;;;AAEA,2CAA0F;AAE1F;;GAEG;AACH,MAAsB,aAAa;IACjC;;;;OAIG;IACI,MAAM,CAAC,gBAAgB,CAAC,YAAoB;QACjD,OAAO,IAAI,mBAAmB,CAAC,YAAY,CAAC,CAAC;KAC9C;;AARH,sCAcC;;;AAED;;GAEG;AACH,MAAM,mBAAoB,SAAQ,aAAa;IAM7C,YAAY,YAAoB;QAC9B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;KAClC;CACF;AAoFD;;GAEG;AACH,MAAsB,QAAS,SAAQ,eAAQ;IAC7C;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CAAC,KAAgB,EAAE,EAAU,EAAE,MAAc;QACnE,OAAO,QAAQ,CAAC,kBAAkB,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;KAC3D;IAED;;;;;;OAMG;IACI,MAAM,CAAC,WAAW,CAAC,KAAgB,EAAE,EAAU,EAAE,OAAe;QACrE,OAAO,QAAQ,CAAC,kBAAkB,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;KAC5D;IAED;;;;;;OAMG;IACI,MAAM,CAAC,kBAAkB,CAAC,KAAgB,EAAE,EAAU,EAAE,KAAyB;;;;;;;;;;QACtF,IAAI,MAAc,CAAC;QACnB,IAAI,OAAe,CAAC;QACpB,MAAM,KAAK,GAAG,YAAK,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;QAE9B,IAAI,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YAClC,MAAM,IAAI,sBAAe,CAAC,gDAAgD,EAAE,KAAK,CAAC,CAAC;QACrF,CAAC;QAED,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;YACxB,MAAM,eAAe,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,gBAAS,CAAC,mBAAmB,CAAC,CAAC,YAAY,CAAC;YAClG,IAAI,CAAC,eAAe,EAAE,CAAC;gBACrB,MAAM,IAAI,sBAAe,CAAC,qCAAqC,EAAE,KAAK,CAAC,CAAC;YAC1E,CAAC;YACD,MAAM,GAAG,eAAe,CAAC;QAC3B,CAAC;aAAM,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACxB,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;YACtB,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC;gBACxB,OAAO,EAAE,aAAa;gBACtB,QAAQ,EAAE,MAAM;gBAChB,YAAY,EAAE,KAAK,CAAC,MAAM;aAC3B,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,sBAAe,CAAC,uCAAuC,EAAE,KAAK,CAAC,CAAC;QAC5E,CAAC;QAED,MAAM,MAAO,SAAQ,eAAQ;YAM3B,YAAY,QAAgB,EAAE,OAAe;gBAC3C,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBACjB,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC;gBACxB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;gBACtB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;gBAC3B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;YACjC,CAAC;SACF;QAED,OAAO,IAAI,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;KACpC;;AAzEH,4BAiGC","sourcesContent":["import { Construct } from 'constructs';\nimport { UserEngine } from './common';\nimport { IResource, Resource, ArnFormat, Stack, ValidationError } from 'aws-cdk-lib/core';\n\n/**\n * Access control configuration for ElastiCache users.\n */\nexport abstract class AccessControl {\n  /**\n   * Create access control from an access string.\n   *\n   * @param accessString The access string defining user permissions.\n   */\n  public static fromAccessString(accessString: string): AccessControl {\n    return new AccessControlString(accessString);\n  }\n\n  /**\n   * The access string that defines user's permissions.\n   */\n  public abstract readonly accessString: string;\n}\n\n/**\n * Access control implementation using a raw access string.\n */\nclass AccessControlString extends AccessControl {\n  /**\n   * The access string that defines user's permissions.\n   */\n  public readonly accessString: string;\n\n  constructor(accessString: string) {\n    super();\n    this.accessString = accessString;\n  }\n}\n\n/**\n * Properties for defining an ElastiCache base user.\n */\nexport interface UserBaseProps {\n  /**\n   * The engine type for the user.\n   * Enum options: UserEngine.VALKEY, UserEngine.REDIS.\n   *\n   * @default UserEngine.VALKEY.\n   */\n  readonly engine?: UserEngine;\n  /**\n   * The ID of the user.\n   */\n  readonly userId: string;\n  /**\n   * Access control configuration for the user.\n   */\n  readonly accessControl: AccessControl;\n}\n\n/**\n * Represents an ElastiCache base user.\n */\nexport interface IUser extends IResource {\n  /**\n   * The user's ID.\n   *\n   * @attribute\n   */\n  readonly userId: string;\n  /**\n   * The engine for the user.\n   */\n  readonly engine?: UserEngine;\n  /**\n   * The user's name.\n   *\n   * @attribute\n   */\n  readonly userName?: string;\n  /**\n   * The user's ARN.\n   *\n   * @attribute\n   */\n  readonly userArn: string;\n}\n\n/**\n * Attributes for importing an existing ElastiCache user.\n */\nexport interface UserBaseAttributes {\n  /**\n   * The ID of the user.\n   * One of `userId` or `userArn` is required.\n   *\n   * @default - derived from userArn.\n   */\n  readonly userId?: string;\n  /**\n   * The engine type for the user.\n   *\n   * @default - engine type is unknown.\n   */\n  readonly engine?: UserEngine;\n  /**\n   * The user's name.\n   *\n   * @default - name is unknown.\n   */\n  readonly userName?: string;\n  /**\n   * The ARN of the user.\n   *\n   * One of `userId` or `userArn` is required.\n   *\n   * @default - derived from userId.\n   */\n  readonly userArn?: string;\n}\n\n/**\n * Base class for ElastiCache users.\n */\nexport abstract class UserBase extends Resource implements IUser {\n  /**\n   * Import an existing user by ID.\n   *\n   * @param scope The parent creating construct (usually `this`).\n   * @param id The construct's name.\n   * @param userId The ID of the existing user.\n   */\n  public static fromUserId(scope: Construct, id: string, userId: string): IUser {\n    return UserBase.fromUserAttributes(scope, id, { userId });\n  }\n\n  /**\n   * Import an existing user by ARN.\n   *\n   * @param scope The parent creating construct (usually `this`).\n   * @param id The construct's name.\n   * @param userArn The ARN of the existing user.\n   */\n  public static fromUserArn(scope: Construct, id: string, userArn: string): IUser {\n    return UserBase.fromUserAttributes(scope, id, { userArn });\n  }\n\n  /**\n   * Import an existing user using attributes.\n   *\n   * @param scope The parent creating construct (usually `this`).\n   * @param id The construct's name.\n   * @param attrs A `UserBaseAttributes` object.\n   */\n  public static fromUserAttributes(scope: Construct, id: string, attrs: UserBaseAttributes): IUser {\n    let userId: string;\n    let userArn: string;\n    const stack = Stack.of(scope);\n\n    if (attrs.userArn && attrs.userId) {\n      throw new ValidationError('Only one of userArn or userId can be provided.', scope);\n    }\n\n    if (attrs.userArn) {\n      userArn = attrs.userArn;\n      const extractedUserId = stack.splitArn(attrs.userArn, ArnFormat.SLASH_RESOURCE_NAME).resourceName;\n      if (!extractedUserId) {\n        throw new ValidationError('Unable to extract user id from ARN.', scope);\n      }\n      userId = extractedUserId;\n    } else if (attrs.userId) {\n      userId = attrs.userId;\n      userArn = stack.formatArn({\n        service: 'elasticache',\n        resource: 'user',\n        resourceName: attrs.userId,\n      });\n    } else {\n      throw new ValidationError('One of userId or userArn is required.', scope);\n    }\n\n    class Import extends Resource implements IUser {\n      public readonly engine?: UserEngine;\n      public readonly userId: string;\n      public readonly userArn: string;\n      readonly userName?: string;\n\n      constructor(_userArn: string, _userId: string) {\n        super(scope, id);\n        this.userArn = _userArn;\n        this.userId = _userId;\n        this.engine = attrs.engine;\n        this.userName = attrs.userName;\n      }\n    }\n\n    return new Import(userArn, userId);\n  }\n\n  /**\n   * The user's ID.\n   *\n   * @attribute\n   */\n  public abstract readonly userId: string;\n  /**\n   * The engine for the user.\n   */\n  public abstract readonly engine?: UserEngine;\n  /**\n   * The user's name.\n   *\n   * @attribute\n   */\n  public abstract readonly userName?: string;\n  /**\n   * The user's ARN.\n   *\n   * @attribute\n   */\n  public abstract readonly userArn: string;\n}\n"]}

package/lib/user-group.d.ts

@@ -0,0 +1,199 @@
+import { Construct } from 'constructs';
+import { UserEngine } from './common';
+import { IUser } from './user-base';
+import { IResource, Resource } from 'aws-cdk-lib/core';
+/**
+ * Properties for defining an ElastiCache UserGroup
+ */
+export interface UserGroupProps {
+    /**
+     * Enforces a particular physical user group name.
+     * @default <generated>
+     */
+    readonly userGroupName?: string;
+    /**
+     * The engine type for the user group
+     * Enum options: UserEngine.VALKEY, UserEngine.REDIS
+     *
+     * @default UserEngine.VALKEY
+     */
+    readonly engine?: UserEngine;
+    /**
+     * List of users inside the user group
+     *
+     * @default - no users
+     */
+    readonly users?: IUser[];
+}
+/**
+ * Represents an ElastiCache UserGroup
+ */
+export interface IUserGroup extends IResource {
+    /**
+     * The name of the user group
+     *
+     * @attribute
+     */
+    readonly userGroupName: string;
+    /**
+     * The engine type for the user group
+     */
+    readonly engine?: UserEngine;
+    /**
+     * List of users in the user group
+     */
+    readonly users?: IUser[];
+    /**
+     * The ARN of the user group
+     *
+     * @attribute
+     */
+    readonly userGroupArn: string;
+    /**
+     * Add a user to this user group
+     *
+     * @param user The user to add
+     */
+    addUser(user: IUser): void;
+}
+/**
+ * Base class for UserGroup constructs
+ */
+export declare abstract class UserGroupBase extends Resource implements IUserGroup {
+    /**
+     * The name of the user group
+     *
+     * @attribute
+     */
+    abstract readonly userGroupName: string;
+    /**
+     * The engine type for the user group
+     */
+    abstract readonly engine?: UserEngine;
+    /**
+     * List of users in the user group
+     */
+    abstract readonly users?: IUser[];
+    /**
+     * The ARN of the user group
+     * @attribute
+     */
+    abstract readonly userGroupArn: string;
+    /**
+     * Add a user to this user group
+     *
+     * @param _user The user to add
+     */
+    addUser(_user: IUser): void;
+}
+/**
+ * Attributes that can be specified when importing a UserGroup
+ */
+export interface UserGroupAttributes {
+    /**
+     * The name of the user group
+     *
+     * One of `userGroupName` or `userGroupArn` is required.
+     *
+     * @default - derived from userGroupArn
+     */
+    readonly userGroupName?: string;
+    /**
+     * The engine type for the user group
+     *
+     * @default - engine type is unknown
+     */
+    readonly engine?: UserEngine;
+    /**
+     * List of users in the user group
+     *
+     * @default - users are unknown
+     */
+    readonly users?: IUser[];
+    /**
+     * The ARN of the user group
+     *
+     * One of `userGroupName` or `userGroupArn` is required.
+     *
+     * @default - derived from userGroupName
+     */
+    readonly userGroupArn?: string;
+}
+/**
+ * An ElastiCache UserGroup
+ *
+ * @resource AWS::ElastiCache::UserGroup
+ */
+export declare class UserGroup extends UserGroupBase {
+    /**
+     * Uniquely identifies this class
+     */
+    static readonly PROPERTY_INJECTION_ID: string;
+    /**
+     * Return whether the given object is a `UserGroup`
+     */
+    static isUserGroup(x: any): x is UserGroup;
+    /**
+     * Import an existing user group by name
+     *
+     * @param scope The parent creating construct (usually `this`)
+     * @param id The construct's name
+     * @param userGroupName The name of the existing user group
+     */
+    static fromUserGroupName(scope: Construct, id: string, userGroupName: string): IUserGroup;
+    /**
+     * Import an existing user group by ARN
+     *
+     * @param scope The parent creating construct (usually `this`)
+     * @param id The construct's name
+     * @param userGroupArn The ARN of the existing user group
+     */
+    static fromUserGroupArn(scope: Construct, id: string, userGroupArn: string): IUserGroup;
+    /**
+     * Import an existing user group using attributes
+     *
+     * @param scope The parent creating construct (usually `this`)
+     * @param id The construct's name
+     * @param attrs A `UserGroupAttributes` object
+     */
+    static fromUserGroupAttributes(scope: Construct, id: string, attrs: UserGroupAttributes): IUserGroup;
+    readonly engine?: UserEngine;
+    readonly userGroupName: string;
+    private readonly _users;
+    /**
+     * The ARN of the user group
+     *
+     * @attribute
+     */
+    readonly userGroupArn: string;
+    /**
+     * The status of the user group
+     * Can be 'creating', 'active', 'modifying', 'deleting'
+     *
+     * @attribute
+     */
+    readonly userGroupStatus: string;
+    private readonly resource;
+    constructor(scope: Construct, id: string, props?: UserGroupProps);
+    /**
+     * Add a CloudFormation dependency on the user resource to ensure proper creation order.
+     */
+    private addUserDependency;
+    /**
+     * Array of users in the user group
+     *
+     * Do not push directly to this array.
+     * Use addUser() instead to ensure proper validation and dependency management.
+     */
+    get users(): IUser[] | undefined;
+    /**
+     * Validates users in the user group for duplicate usernames and Redis-specific requirements.
+     */
+    private validateUsers;
+    /**
+     * Add a user to this user group
+     *
+     * @param user The user to add to the group
+     */
+    addUser(user: IUser): void;
+}