import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { ElastiCacheClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ElastiCacheClient"; import type { CreateUserGroupMessage, UserGroup } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link CreateUserGroupCommand}. */ export interface CreateUserGroupCommandInput extends CreateUserGroupMessage { } /** * @public * * The output of {@link CreateUserGroupCommand}. */ export interface CreateUserGroupCommandOutput extends UserGroup, __MetadataBearer { } declare const CreateUserGroupCommand_base: { new (input: CreateUserGroupCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: CreateUserGroupCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

For Valkey engine version 7.2 onwards and Redis OSS 6.0 to 7.1: Creates a user group. For more * information, see Using Role Based Access Control (RBAC) *

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ElastiCacheClient, CreateUserGroupCommand } from "@aws-sdk/client-elasticache"; // ES Modules import * // const { ElastiCacheClient, CreateUserGroupCommand } = require("@aws-sdk/client-elasticache"); // CommonJS import * // import type { ElastiCacheClientConfig } from "@aws-sdk/client-elasticache"; * const config = {}; // type is ElastiCacheClientConfig * const client = new ElastiCacheClient(config); * const input = { // CreateUserGroupMessage * UserGroupId: "STRING_VALUE", // required * Engine: "STRING_VALUE", // required * UserIds: [ // UserIdListInput * "STRING_VALUE", * ], * Tags: [ // TagList * { // Tag * Key: "STRING_VALUE", * Value: "STRING_VALUE", * }, * ], * }; * const command = new CreateUserGroupCommand(input); * const response = await client.send(command); * // { // UserGroup * // UserGroupId: "STRING_VALUE", * // Status: "STRING_VALUE", * // Engine: "STRING_VALUE", * // UserIds: [ // UserIdList * // "STRING_VALUE", * // ], * // MinimumEngineVersion: "STRING_VALUE", * // PendingChanges: { // UserGroupPendingChanges * // UserIdsToRemove: [ * // "STRING_VALUE", * // ], * // UserIdsToAdd: [ * // "STRING_VALUE", * // ], * // }, * // ReplicationGroups: [ // UGReplicationGroupIdList * // "STRING_VALUE", * // ], * // ServerlessCaches: [ // UGServerlessCacheIdList * // "STRING_VALUE", * // ], * // ARN: "STRING_VALUE", * // }; * * ``` * * @param CreateUserGroupCommandInput - {@link CreateUserGroupCommandInput} * @returns {@link CreateUserGroupCommandOutput} * @see {@link CreateUserGroupCommandInput} for command's `input` shape. * @see {@link CreateUserGroupCommandOutput} for command's `response` shape. * @see {@link ElastiCacheClientResolvedConfig | config} for ElastiCacheClient's `config` shape. * * @throws {@link DefaultUserRequired} (client fault) *

You must add default user to a user group.

* * @throws {@link DuplicateUserNameFault} (client fault) *

A user with this username already exists.

* * @throws {@link InvalidParameterValueException} (client fault) *

The value for a parameter is invalid.

* * @throws {@link ServiceLinkedRoleNotFoundFault} (client fault) *

The specified service linked role (SLR) was not found.

* * @throws {@link TagQuotaPerResourceExceeded} (client fault) *

The request cannot be processed because it would cause the resource to have more than * the allowed number of tags. The maximum number of tags permitted on a resource is * 50.

* * @throws {@link UserGroupAlreadyExistsFault} (client fault) *

The user group with this ID already exists.

* * @throws {@link UserGroupQuotaExceededFault} (client fault) *

The number of users exceeds the user group limit.

* * @throws {@link UserNotFoundFault} (client fault) *

The user does not exist or could not be found.

* * @throws {@link ElastiCacheServiceException} *

Base exception class for all service exceptions from ElastiCache service.

* * * @public */ export declare class CreateUserGroupCommand extends CreateUserGroupCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateUserGroupMessage; output: UserGroup; }; sdk: { input: CreateUserGroupCommandInput; output: CreateUserGroupCommandOutput; }; }; }