blib/lib/Paws/QLDB/CreateLedger.pm untested

filter: Statementstmt 0.0% 0 / 14 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 16 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::QLDB::CreateLedger;
3 use Moose;
4 has DeletionProtection => (is => 'ro', isa => 'Bool');
5 has Name => (is => 'ro', isa => 'Str', required => 1);
6 has PermissionsMode => (is => 'ro', isa => 'Str', required => 1);
7 has Tags => (is => 'ro', isa => 'Paws::QLDB::Tags');
8  
9 use MooseX::ClassAttribute;
10  
11 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateLedger');
12 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/ledgers');
13 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::QLDB::CreateLedgerResponse');
15 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::QLDB::CreateLedger - Arguments for method CreateLedger on L<Paws::QLDB>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method CreateLedger on the
26 L<Amazon QLDB|Paws::QLDB> service. Use the attributes of this class
27 as arguments to method CreateLedger.
28  
29 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateLedger.
30  
31 =head1 SYNOPSIS
32  
33 my $qldb = Paws->service('QLDB');
34 my $CreateLedgerResponse = $qldb->CreateLedger(
35 Name => 'MyLedgerName',
36 PermissionsMode => 'ALLOW_ALL',
37 DeletionProtection => 1, # OPTIONAL
38 Tags => {
39 'MyTagKey' => 'MyTagValue', # key: min: 1, max: 128, value: max: 256
40 }, # OPTIONAL
41 );
42  
43 # Results:
44 my $Arn = $CreateLedgerResponse->Arn;
45 my $CreationDateTime = $CreateLedgerResponse->CreationDateTime;
46 my $DeletionProtection = $CreateLedgerResponse->DeletionProtection;
47 my $Name = $CreateLedgerResponse->Name;
48 my $PermissionsMode = $CreateLedgerResponse->PermissionsMode;
49 my $State = $CreateLedgerResponse->State;
50  
51 # Returns a L<Paws::QLDB::CreateLedgerResponse> object.
52  
53 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.
54 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/qldb/CreateLedger>
55  
56 =head1 ATTRIBUTES
57  
58  
59 =head2 DeletionProtection => Bool
60  
61 The flag that prevents a ledger from being deleted by any user. If not
62 provided on ledger creation, this feature is enabled (C<true>) by
63 default.
64  
65 If deletion protection is enabled, you must first disable it before you
66 can delete the ledger. You can disable it by calling the
67 C<UpdateLedger> operation to set the flag to C<false>.
68  
69  
70  
71 =head2 B<REQUIRED> Name => Str
72  
73 The name of the ledger that you want to create. The name must be unique
74 among all of your ledgers in the current AWS Region.
75  
76 Naming constraints for ledger names are defined in Quotas in Amazon
77 QLDB
78 (https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming)
79 in the I<Amazon QLDB Developer Guide>.
80  
81  
82  
83 =head2 B<REQUIRED> PermissionsMode => Str
84  
85 The permissions mode to assign to the ledger that you want to create.
86 This parameter can have one of the following values:
87  
88 =over
89  
90 =item *
91  
92 C<ALLOW_ALL>: A legacy permissions mode that enables access control
93 with API-level granularity for ledgers.
94  
95 This mode allows users who have the C<SendCommand> API permission for
96 this ledger to run all PartiQL commands (hence, C<ALLOW_ALL>) on any
97 tables in the specified ledger. This mode disregards any table-level or
98 command-level IAM permissions policies that you create for the ledger.
99  
100 =item *
101  
102 C<STANDARD>: (I<Recommended>) A permissions mode that enables access
103 control with finer granularity for ledgers, tables, and PartiQL
104 commands.
105  
106 By default, this mode denies all user requests to run any PartiQL
107 commands on any tables in this ledger. To allow PartiQL commands to
108 run, you must create IAM permissions policies for specific table
109 resources and PartiQL actions, in addition to the C<SendCommand> API
110 permission for the ledger. For information, see Getting started with
111 the standard permissions mode
112 (https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html)
113 in the I<Amazon QLDB Developer Guide>.
114  
115 =back
116  
117 We strongly recommend using the C<STANDARD> permissions mode to
118 maximize the security of your ledger data.
119  
120 Valid values are: C<"ALLOW_ALL">, C<"STANDARD">
121  
122 =head2 Tags => L<Paws::QLDB::Tags>
123  
124 The key-value pairs to add as tags to the ledger that you want to
125 create. Tag keys are case sensitive. Tag values are case sensitive and
126 can be null.
127  
128  
129  
130  
131 =head1 SEE ALSO
132  
133 This class forms part of L<Paws>, documenting arguments for method CreateLedger in L<Paws::QLDB>
134  
135 =head1 BUGS and CONTRIBUTIONS
136  
137 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
138  
139 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
140  
141 =cut
142