UpdateACLCommand

Suggest an Edit

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

Example Syntax

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

import { MemoryDBClient, UpdateACLCommand } from "@aws-sdk/client-memorydb"; // ES Modules import
// const { MemoryDBClient, UpdateACLCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import
const client = new MemoryDBClient(config);
const input = { // UpdateACLRequest
  ACLName: "STRING_VALUE", // required
  UserNamesToAdd: [ // UserNameListInput
    "STRING_VALUE",
  ],
  UserNamesToRemove: [
    "STRING_VALUE",
  ],
};
const command = new UpdateACLCommand(input);
const response = await client.send(command);
// { // UpdateACLResponse
//   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",
//   },
// };

UpdateACLCommand Input

See UpdateACLCommandInput for more details

Parameter
Type
Description
ACLName
Required
string | undefined

The name of the Access Control List.

UserNamesToAdd
string[] | undefined

The list of users to add to the Access Control List.

UserNamesToRemove
string[] | undefined

The list of users to remove from the Access Control List.

UpdateACLCommand Output

See UpdateACLCommandOutput for details

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

The updated Access Control List.

Throws

Name
Fault
Details
ACLNotFoundFault
client

DefaultUserRequired
client

DuplicateUserNameFault
client

InvalidACLStateFault
client

InvalidParameterCombinationException
client

InvalidParameterValueException
client

UserNotFoundFault
client

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