« blib/lib/Paws/QLDB/UpdateLedger.pm
↑ Summary
blib/lib/Paws/QLDB/UpdateLedgerPermissionsModeResponse.pm »
| 1 | |||
| 2 | package Paws::QLDB::UpdateLedgerPermissionsMode; | ||
| 3 | use Moose; | ||
| 4 | has Name => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'name', required => 1); | ||
| 5 | has PermissionsMode => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateLedgerPermissionsMode'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/ledgers/{name}/permissions-mode'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PATCH'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::QLDB::UpdateLedgerPermissionsModeResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::QLDB::UpdateLedgerPermissionsMode - Arguments for method UpdateLedgerPermissionsMode on L<Paws::QLDB> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method UpdateLedgerPermissionsMode on the | ||
| 24 | L<Amazon QLDB|Paws::QLDB> service. Use the attributes of this class | ||
| 25 | as arguments to method UpdateLedgerPermissionsMode. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateLedgerPermissionsMode. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $qldb = Paws->service('QLDB'); | ||
| 32 | my $UpdateLedgerPermissionsModeResponse = | ||
| 33 | $qldb->UpdateLedgerPermissionsMode( | ||
| 34 | Name => 'MyLedgerName', | ||
| 35 | PermissionsMode => 'ALLOW_ALL', | ||
| 36 | |||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $Arn = $UpdateLedgerPermissionsModeResponse->Arn; | ||
| 41 | my $Name = $UpdateLedgerPermissionsModeResponse->Name; | ||
| 42 | my $PermissionsMode = $UpdateLedgerPermissionsModeResponse->PermissionsMode; | ||
| 43 | |||
| 44 | # Returns a L<Paws::QLDB::UpdateLedgerPermissionsModeResponse> object. | ||
| 45 | |||
| 46 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 47 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/qldb/UpdateLedgerPermissionsMode> | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> Name => Str | ||
| 53 | |||
| 54 | The name of the ledger. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> PermissionsMode => Str | ||
| 59 | |||
| 60 | The permissions mode to assign to the ledger. This parameter can have | ||
| 61 | one of the following values: | ||
| 62 | |||
| 63 | =over | ||
| 64 | |||
| 65 | =item * | ||
| 66 | |||
| 67 | C<ALLOW_ALL>: A legacy permissions mode that enables access control | ||
| 68 | with API-level granularity for ledgers. | ||
| 69 | |||
| 70 | This mode allows users who have the C<SendCommand> API permission for | ||
| 71 | this ledger to run all PartiQL commands (hence, C<ALLOW_ALL>) on any | ||
| 72 | tables in the specified ledger. This mode disregards any table-level or | ||
| 73 | command-level IAM permissions policies that you create for the ledger. | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | C<STANDARD>: (I<Recommended>) A permissions mode that enables access | ||
| 78 | control with finer granularity for ledgers, tables, and PartiQL | ||
| 79 | commands. | ||
| 80 | |||
| 81 | By default, this mode denies all user requests to run any PartiQL | ||
| 82 | commands on any tables in this ledger. To allow PartiQL commands to | ||
| 83 | run, you must create IAM permissions policies for specific table | ||
| 84 | resources and PartiQL actions, in addition to the C<SendCommand> API | ||
| 85 | permission for the ledger. For information, see Getting started with | ||
| 86 | the standard permissions mode | ||
| 87 | (https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html) | ||
| 88 | in the I<Amazon QLDB Developer Guide>. | ||
| 89 | |||
| 90 | =back | ||
| 91 | |||
| 92 | We strongly recommend using the C<STANDARD> permissions mode to | ||
| 93 | maximize the security of your ledger data. | ||
| 94 | |||
| 95 | Valid values are: C<"ALLOW_ALL">, C<"STANDARD"> | ||
| 96 | |||
| 97 | |||
| 98 | =head1 SEE ALSO | ||
| 99 | |||
| 100 | This class forms part of L<Paws>, documenting arguments for method UpdateLedgerPermissionsMode in L<Paws::QLDB> | ||
| 101 | |||
| 102 | =head1 BUGS and CONTRIBUTIONS | ||
| 103 | |||
| 104 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 105 | |||
| 106 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 107 | |||
| 108 | =cut | ||
| 109 |