CreateACLCommand

Suggest an Edit

Creates an Access Control List. For more information, see Authenticating users with Access Contol Lists (ACLs) .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { MemoryDBClient, CreateACLCommand } from "@aws-sdk/client-memorydb"; // ES Modules import
// const { MemoryDBClient, CreateACLCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import
const client = new MemoryDBClient(config);
const input = { // CreateACLRequest
  ACLName: "STRING_VALUE", // required
  UserNames: [ // UserNameListInput
    "STRING_VALUE",
  ],
  Tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE",
      Value: "STRING_VALUE",
    },
  ],
};
const command = new CreateACLCommand(input);
const response = await client.send(command);
// { // CreateACLResponse
//   ACL: { // ACL
//     Name: "STRING_VALUE",
//     Status: "STRING_VALUE",
//     UserNames: [ // UserNameList
//       "STRING_VALUE",
//     ],
//     MinimumEngineVersion: "STRING_VALUE",
//     PendingChanges: { // ACLPendingChanges
//       UserNamesToRemove: [
//         "STRING_VALUE",
//       ],
//       UserNamesToAdd: [
//         "STRING_VALUE",
//       ],
//     },
//     Clusters: [ // ACLClusterNameList
//       "STRING_VALUE",
//     ],
//     ARN: "STRING_VALUE",
//   },
// };

CreateACLCommand Input

See CreateACLCommandInput for more details

Parameter
Type
Description
ACLName
Required
string | undefined

The name of the Access Control List.

Tags
Tag[] | undefined

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

UserNames
string[] | undefined

The list of users that belong to the Access Control List.

CreateACLCommand Output

See CreateACLCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ACL
ACL | undefined

The newly-created Access Control List.

Throws

Name
Fault
Details
ACLAlreadyExistsFault
client

ACLQuotaExceededFault
client

DefaultUserRequired
client

DuplicateUserNameFault
client

InvalidParameterValueException
client

TagQuotaPerResourceExceeded
client

UserNotFoundFault
client

MemoryDBServiceException
Base exception class for all service exceptions from MemoryDB service.