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

filter: Statementstmt 0.0% 0 / 7 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 8 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::ListedAccess;
3 use Moose;
4 has ExternalId => (is => 'ro', isa => 'Str');
5 has HomeDirectory => (is => 'ro', isa => 'Str');
6 has HomeDirectoryType => (is => 'ro', isa => 'Str');
7 has Role => (is => 'ro', isa => 'Str');
8  
9 1;
10  
11 ### main pod documentation begin ###
12  
13 =head1 NAME
14  
15 Paws::Transfer::ListedAccess
16  
17 =head1 USAGE
18  
19 This class represents one of two things:
20  
21 =head3 Arguments in a call to a service
22  
23 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24 Each attribute should be used as a named argument in the calls that expect this type of object.
25  
26 As an example, if Att1 is expected to be a Paws::Transfer::ListedAccess object:
27  
28 $service_obj->Method(Att1 => { ExternalId => $value, ..., Role => $value });
29  
30 =head3 Results returned from an API call
31  
32 Use accessors for each attribute. If Att1 is expected to be an Paws::Transfer::ListedAccess object:
33  
34 $result = $service_obj->Method(...);
35 $result->Att1->ExternalId
36  
37 =head1 DESCRIPTION
38  
39 Lists the properties for one or more specified associated accesses.
40  
41 =head1 ATTRIBUTES
42  
43  
44 =head2 ExternalId => Str
45  
46 A unique identifier that is required to identify specific groups within
47 your directory. The users of the group that you associate have access
48 to your Amazon S3 or Amazon EFS resources over the enabled protocols
49 using Amazon Web Services Transfer Family. If you know the group name,
50 you can view the SID values by running the following command using
51 Windows PowerShell.
52  
53 C<Get-ADGroup -Filter {samAccountName -like "I<YourGroupName>*"}
54 -Properties * | Select SamAccountName,ObjectSid>
55  
56 In that command, replace I<YourGroupName> with the name of your Active
57 Directory group.
58  
59 The regex used to validate this parameter is a string of characters
60 consisting of uppercase and lowercase alphanumeric characters with no
61 spaces. You can also include underscores or any of the following
62 characters: =,.@:/-
63  
64  
65 =head2 HomeDirectory => Str
66  
67 The landing directory (folder) for a user when they log in to the
68 server using the client.
69  
70 A C<HomeDirectory> example is C</bucket_name/home/mydirectory>.
71  
72  
73 =head2 HomeDirectoryType => Str
74  
75 The type of landing directory (folder) you want your users' home
76 directory to be when they log into the server. If you set it to
77 C<PATH>, the user will see the absolute Amazon S3 bucket or EFS paths
78 as is in their file transfer protocol clients. If you set it
79 C<LOGICAL>, you will need to provide mappings in the
80 C<HomeDirectoryMappings> for how you want to make Amazon S3 or EFS
81 paths visible to your users.
82  
83  
84 =head2 Role => Str
85  
86 Specifies the Amazon Resource Name (ARN) of the IAM role that controls
87 your users' access to your Amazon S3 bucket or EFS file system. The
88 policies attached to this role determine the level of access that you
89 want to provide your users when transferring files into and out of your
90 Amazon S3 bucket or EFS file system. The IAM role should also contain a
91 trust relationship that allows the server to access your resources when
92 servicing your users' transfer requests.
93  
94  
95  
96 =head1 SEE ALSO
97  
98 This class forms part of L<Paws>, describing an object used in L<Paws::Transfer>
99  
100 =head1 BUGS and CONTRIBUTIONS
101  
102 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
103  
104 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
105  
106 =cut
107