Class: Aws::QLDB::Types::UpdateLedgerPermissionsModeRequest

Inherits:

Struct

Object
Struct
Aws::QLDB::Types::UpdateLedgerPermissionsModeRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-qldb/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#name ⇒ String

The name of the ledger.
#permissions_mode ⇒ String

The permissions mode to assign to the ledger.

Instance Attribute Details

#name ⇒ `String`

The name of the ledger.

Returns:

(String)

# File 'lib/aws-sdk-qldb/types.rb', line 1490

class UpdateLedgerPermissionsModeRequest < Struct.new(
  :name,
  :permissions_mode)
  SENSITIVE = []
  include Aws::Structure
end

#permissions_mode ⇒ `String`

The permissions mode to assign to the ledger. This parameter can have one of the following values:

‘ALLOW_ALL`: A legacy permissions mode that enables access control with API-level granularity for ledgers.

This mode allows users who have the ‘SendCommand` API permission for this ledger to run all PartiQL commands (hence, `ALLOW_ALL`) on any tables in the specified ledger. This mode disregards any table-level or command-level IAM permissions policies that you create for the ledger.
‘STANDARD`: (Recommended) A permissions mode that enables access control with finer granularity for ledgers, tables, and PartiQL commands.

By default, this mode denies all user requests to run any PartiQL commands on any tables in this ledger. To allow PartiQL commands to run, you must create IAM permissions policies for specific table resources and PartiQL actions, in addition to the ‘SendCommand` API permission for the ledger. For information, see

Getting started with the standard permissions mode][1

in the

*Amazon QLDB Developer Guide*.

<note markdown=“1”> We strongly recommend using the ‘STANDARD` permissions mode to maximize the security of your ledger data.

</note>

[1]: docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html