Package software.amazon.awssdk.services.qldb.model

Interface UpdateLedgerPermissionsModeRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateLedgerPermissionsModeRequest.Builder,UpdateLedgerPermissionsModeRequest>, QldbRequest.Builder, SdkBuilder<UpdateLedgerPermissionsModeRequest.Builder,UpdateLedgerPermissionsModeRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateLedgerPermissionsModeRequest

public static interface UpdateLedgerPermissionsModeRequest.Builder
extends QldbRequest.Builder, SdkPojo, CopyableBuilder<UpdateLedgerPermissionsModeRequest.Builder,UpdateLedgerPermissionsModeRequest>

Method Summary

Modifier and Type	Method	Description
UpdateLedgerPermissionsModeRequest.Builder	name(String name)	The name of the ledger.
UpdateLedgerPermissionsModeRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateLedgerPermissionsModeRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateLedgerPermissionsModeRequest.Builder	permissionsMode(String permissionsMode)	The permissions mode to assign to the ledger.
UpdateLedgerPermissionsModeRequest.Builder	permissionsMode(PermissionsMode permissionsMode)	The permissions mode to assign to the ledger.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.qldb.model.QldbRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

name

UpdateLedgerPermissionsModeRequest.Builder name(String name)

The name of the ledger.

Parameters:

name - The name of the ledger.

Returns:

Returns a reference to this object so that method calls can be chained together.

permissionsMode

UpdateLedgerPermissionsModeRequest.Builder permissionsMode(String permissionsMode)

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.

Parameters:

permissionsMode - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PermissionsMode, PermissionsMode

permissionsMode

UpdateLedgerPermissionsModeRequest.Builder permissionsMode(PermissionsMode permissionsMode)

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.

Parameters:

permissionsMode - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PermissionsMode, PermissionsMode

overrideConfiguration

UpdateLedgerPermissionsModeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateLedgerPermissionsModeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder