Struct aws_sdk_qldb::client::fluent_builders::UpdateLedgerPermissionsMode

pub struct UpdateLedgerPermissionsMode { /* private fields */ }

Fluent builder constructing a request to UpdateLedgerPermissionsMode.

Updates the permissions mode of a ledger.

Before you switch to the STANDARD permissions mode, you must first create all required IAM policies and table tags to avoid disruption to your users. To learn more, see Migrating to the standard permissions mode in the Amazon QLDB Developer Guide.

Implementations

impl UpdateLedgerPermissionsMode

pub async fn send(
    self
) -> Result<UpdateLedgerPermissionsModeOutput, SdkError<UpdateLedgerPermissionsModeError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn name(self, input: impl Into<String>) -> Self

The name of the ledger.

pub fn set_name(self, input: Option<String>) -> Self

The name of the ledger.

pub fn permissions_mode(self, input: PermissionsMode) -> Self

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 in the Amazon QLDB Developer Guide.

We strongly recommend using the STANDARD permissions mode to maximize the security of your ledger data.

pub fn set_permissions_mode(self, input: Option<PermissionsMode>) -> Self

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 in the Amazon QLDB Developer Guide.

We strongly recommend using the STANDARD permissions mode to maximize the security of your ledger data.

Trait Implementations

impl Clone for UpdateLedgerPermissionsMode

fn clone(&self) -> UpdateLedgerPermissionsMode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateLedgerPermissionsMode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.