blib/lib/Paws/Transfer/DescribedAccess.pm untested

filter: Statementstmt 0.0% 0 / 10 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 11 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Transfer::DescribedAccess;
3 use Moose;
4 has ExternalId => (is => 'ro', isa => 'Str');
5 has HomeDirectory => (is => 'ro', isa => 'Str');
6 has HomeDirectoryMappings => (is => 'ro', isa => 'ArrayRef[Paws::Transfer::HomeDirectoryMapEntry]');
7 has HomeDirectoryType => (is => 'ro', isa => 'Str');
8 has Policy => (is => 'ro', isa => 'Str');
9 has PosixProfile => (is => 'ro', isa => 'Paws::Transfer::PosixProfile');
10 has Role => (is => 'ro', isa => 'Str');
11  
12 1;
13  
14 ### main pod documentation begin ###
15  
16 =head1 NAME
17  
18 Paws::Transfer::DescribedAccess
19  
20 =head1 USAGE
21  
22 This class represents one of two things:
23  
24 =head3 Arguments in a call to a service
25  
26 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
27 Each attribute should be used as a named argument in the calls that expect this type of object.
28  
29 As an example, if Att1 is expected to be a Paws::Transfer::DescribedAccess object:
30  
31 $service_obj->Method(Att1 => { ExternalId => $value, ..., Role => $value });
32  
33 =head3 Results returned from an API call
34  
35 Use accessors for each attribute. If Att1 is expected to be an Paws::Transfer::DescribedAccess object:
36  
37 $result = $service_obj->Method(...);
38 $result->Att1->ExternalId
39  
40 =head1 DESCRIPTION
41  
42 Describes the properties of the access that was specified.
43  
44 =head1 ATTRIBUTES
45  
46  
47 =head2 ExternalId => Str
48  
49 A unique identifier that is required to identify specific groups within
50 your directory. The users of the group that you associate have access
51 to your Amazon S3 or Amazon EFS resources over the enabled protocols
52 using Amazon Web Services Transfer Family. If you know the group name,
53 you can view the SID values by running the following command using
54 Windows PowerShell.
55  
56 C<Get-ADGroup -Filter {samAccountName -like "I<YourGroupName>*"}
57 -Properties * | Select SamAccountName,ObjectSid>
58  
59 In that command, replace I<YourGroupName> with the name of your Active
60 Directory group.
61  
62 The regex used to validate this parameter is a string of characters
63 consisting of uppercase and lowercase alphanumeric characters with no
64 spaces. You can also include underscores or any of the following
65 characters: =,.@:/-
66  
67  
68 =head2 HomeDirectory => Str
69  
70 The landing directory (folder) for a user when they log in to the
71 server using the client.
72  
73 A C<HomeDirectory> example is C</bucket_name/home/mydirectory>.
74  
75  
76 =head2 HomeDirectoryMappings => ArrayRef[L<Paws::Transfer::HomeDirectoryMapEntry>]
77  
78 Logical directory mappings that specify what Amazon S3 or Amazon EFS
79 paths and keys should be visible to your user and how you want to make
80 them visible. You must specify the C<Entry> and C<Target> pair, where
81 C<Entry> shows how the path is made visible and C<Target> is the actual
82 Amazon S3 or Amazon EFS path. If you only specify a target, it is
83 displayed as is. You also must ensure that your Amazon Web Services
84 Identity and Access Management (IAM) role provides access to paths in
85 C<Target>. This value can only be set when C<HomeDirectoryType> is set
86 to I<LOGICAL>.
87  
88 In most cases, you can use this value instead of the scope-down policy
89 to lock down the associated access to the designated home directory
90 ("C<chroot>"). To do this, you can set C<Entry> to '/' and set
91 C<Target> to the C<HomeDirectory> parameter value.
92  
93  
94 =head2 HomeDirectoryType => Str
95  
96 The type of landing directory (folder) you want your users' home
97 directory to be when they log into the server. If you set it to
98 C<PATH>, the user will see the absolute Amazon S3 bucket or EFS paths
99 as is in their file transfer protocol clients. If you set it
100 C<LOGICAL>, you will need to provide mappings in the
101 C<HomeDirectoryMappings> for how you want to make Amazon S3 or EFS
102 paths visible to your users.
103  
104  
105 =head2 Policy => Str
106  
107 A scope-down policy for your user so that you can use the same IAM role
108 across multiple users. This policy scopes down user access to portions
109 of their Amazon S3 bucket. Variables that you can use inside this
110 policy include C<${Transfer:UserName}>, C<${Transfer:HomeDirectory}>,
111 and C<${Transfer:HomeBucket}>.
112  
113  
114 =head2 PosixProfile => L<Paws::Transfer::PosixProfile>
115  
116  
117  
118  
119 =head2 Role => Str
120  
121 Specifies the Amazon Resource Name (ARN) of the IAM role that controls
122 your users' access to your Amazon S3 bucket or EFS file system. The
123 policies attached to this role determine the level of access that you
124 want to provide your users when transferring files into and out of your
125 Amazon S3 bucket or EFS file system. The IAM role should also contain a
126 trust relationship that allows the server to access your resources when
127 servicing your users' transfer requests.
128  
129  
130  
131 =head1 SEE ALSO
132  
133 This class forms part of L<Paws>, describing an object used in L<Paws::Transfer>
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