Class UpdateLedgerPermissionsModeRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateLedgerPermissionsModeRequest.Builder,UpdateLedgerPermissionsModeRequest>

@Generated("software.amazon.awssdk:codegen") public final class UpdateLedgerPermissionsModeRequest extends QldbRequest implements ToCopyableBuilder<UpdateLedgerPermissionsModeRequest.Builder,UpdateLedgerPermissionsModeRequest>
  • Method Details

    • name

      public final String name()

      The name of the ledger.

      Returns:
      The name of the ledger.
    • permissionsMode

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, permissionsMode will return PermissionsMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from permissionsModeAsString().

      Returns:
      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.

      See Also:
    • permissionsModeAsString

      public final String permissionsModeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, permissionsMode will return PermissionsMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from permissionsModeAsString().

      Returns:
      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.

      See Also:
    • toBuilder

      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateLedgerPermissionsModeRequest.Builder,UpdateLedgerPermissionsModeRequest>
      Specified by:
      toBuilder in class QldbRequest
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

      public static Class<? extends UpdateLedgerPermissionsModeRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.