blib/lib/Paws/LakeFormation/GrantPermissions.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::LakeFormation::GrantPermissions;
3 use Moose;
4 has CatalogId => (is => 'ro', isa => 'Str');
5 has Permissions => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1);
6 has PermissionsWithGrantOption => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7 has Principal => (is => 'ro', isa => 'Paws::LakeFormation::DataLakePrincipal', required => 1);
8 has Resource => (is => 'ro', isa => 'Paws::LakeFormation::Resource', required => 1);
9  
10 use MooseX::ClassAttribute;
11  
12 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GrantPermissions');
13 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LakeFormation::GrantPermissionsResponse');
14 class_has _result_key => (isa => 'Str', is => 'ro');
15 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::LakeFormation::GrantPermissions - Arguments for method GrantPermissions on L<Paws::LakeFormation>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method GrantPermissions on the
26 L<AWS Lake Formation|Paws::LakeFormation> service. Use the attributes of this class
27 as arguments to method GrantPermissions.
28  
29 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GrantPermissions.
30  
31 =head1 SYNOPSIS
32  
33 my $lakeformation = Paws->service('LakeFormation');
34 my $GrantPermissionsResponse = $lakeformation->GrantPermissions(
35 Permissions => [
36 'ALL',
37 ... # values: ALL, SELECT, ALTER, DROP, DELETE, INSERT, DESCRIBE, CREATE_DATABASE, CREATE_TABLE, DATA_LOCATION_ACCESS, CREATE_TAG, ALTER_TAG, DELETE_TAG, DESCRIBE_TAG, ASSOCIATE_TAG
38 ],
39 Principal => {
40 DataLakePrincipalIdentifier =>
41 'MyDataLakePrincipalString', # min: 1, max: 255; OPTIONAL
42 },
43 Resource => {
44 Catalog => {
45  
46 }, # OPTIONAL
47 DataLocation => {
48 ResourceArn => 'MyResourceArnString',
49 CatalogId => 'MyCatalogIdString', # min: 1, max: 255; OPTIONAL
50 }, # OPTIONAL
51 Database => {
52 Name => 'MyNameString', # min: 1, max: 255
53 CatalogId => 'MyCatalogIdString', # min: 1, max: 255; OPTIONAL
54 }, # OPTIONAL
55 LFTag => {
56 TagKey => 'MyNameString', # min: 1, max: 255
57 TagValues => [
58 'MyLFTagValue', ... # max: 256
59 ], # min: 1, max: 50
60 CatalogId => 'MyCatalogIdString', # min: 1, max: 255; OPTIONAL
61 }, # OPTIONAL
62 LFTagPolicy => {
63 Expression => [
64 {
65 TagKey => 'MyLFTagKey', # min: 1, max: 128
66 TagValues => [
67 'MyLFTagValue', ... # max: 256
68 ], # min: 1, max: 50
69  
70 },
71 ...
72 ], # min: 1, max: 5
73 ResourceType => 'DATABASE', # values: DATABASE, TABLE
74 CatalogId => 'MyCatalogIdString', # min: 1, max: 255; OPTIONAL
75 }, # OPTIONAL
76 Table => {
77 DatabaseName => 'MyNameString', # min: 1, max: 255
78 CatalogId => 'MyCatalogIdString', # min: 1, max: 255; OPTIONAL
79 Name => 'MyNameString', # min: 1, max: 255
80 TableWildcard => {
81  
82 }, # OPTIONAL
83 }, # OPTIONAL
84 TableWithColumns => {
85 DatabaseName => 'MyNameString', # min: 1, max: 255
86 Name => 'MyNameString', # min: 1, max: 255
87 CatalogId => 'MyCatalogIdString', # min: 1, max: 255; OPTIONAL
88 ColumnNames => [
89 'MyNameString', ... # min: 1, max: 255
90 ], # OPTIONAL
91 ColumnWildcard => {
92 ExcludedColumnNames => [
93 'MyNameString', ... # min: 1, max: 255
94 ], # OPTIONAL
95 }, # OPTIONAL
96 }, # OPTIONAL
97 },
98 CatalogId => 'MyCatalogIdString', # OPTIONAL
99 PermissionsWithGrantOption => [
100 'ALL',
101 ... # values: ALL, SELECT, ALTER, DROP, DELETE, INSERT, DESCRIBE, CREATE_DATABASE, CREATE_TABLE, DATA_LOCATION_ACCESS, CREATE_TAG, ALTER_TAG, DELETE_TAG, DESCRIBE_TAG, ASSOCIATE_TAG
102 ], # OPTIONAL
103 );
104  
105 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.
106 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/lakeformation/GrantPermissions>
107  
108 =head1 ATTRIBUTES
109  
110  
111 =head2 CatalogId => Str
112  
113 The identifier for the Data Catalog. By default, the account ID. The
114 Data Catalog is the persistent metadata store. It contains database
115 definitions, table definitions, and other control information to manage
116 your AWS Lake Formation environment.
117  
118  
119  
120 =head2 B<REQUIRED> Permissions => ArrayRef[Str|Undef]
121  
122 The permissions granted to the principal on the resource. AWS Lake
123 Formation defines privileges to grant and revoke access to metadata in
124 the Data Catalog and data organized in underlying data storage such as
125 Amazon S3. AWS Lake Formation requires that each principal be
126 authorized to perform a specific task on AWS Lake Formation resources.
127  
128  
129  
130 =head2 PermissionsWithGrantOption => ArrayRef[Str|Undef]
131  
132 Indicates a list of the granted permissions that the principal may pass
133 to other users. These permissions may only be a subset of the
134 permissions granted in the C<Privileges>.
135  
136  
137  
138 =head2 B<REQUIRED> Principal => L<Paws::LakeFormation::DataLakePrincipal>
139  
140 The principal to be granted the permissions on the resource. Supported
141 principals are IAM users or IAM roles, and they are defined by their
142 principal type and their ARN.
143  
144 Note that if you define a resource with a particular ARN, then later
145 delete, and recreate a resource with that same ARN, the resource
146 maintains the permissions already granted.
147  
148  
149  
150 =head2 B<REQUIRED> Resource => L<Paws::LakeFormation::Resource>
151  
152 The resource to which permissions are to be granted. Resources in AWS
153 Lake Formation are the Data Catalog, databases, and tables.
154  
155  
156  
157  
158 =head1 SEE ALSO
159  
160 This class forms part of L<Paws>, documenting arguments for method GrantPermissions in L<Paws::LakeFormation>
161  
162 =head1 BUGS and CONTRIBUTIONS
163  
164 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
165  
166 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
167  
168 =cut
169