| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Transfer::DescribedUser; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str', required => 1); | ||
| 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 | has SshPublicKeys => (is => 'ro', isa => 'ArrayRef[Paws::Transfer::SshPublicKey]'); | ||
| 12 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Transfer::Tag]'); | ||
| 13 | has UserName => (is => 'ro', isa => 'Str'); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Transfer::DescribedUser | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::Transfer::DescribedUser object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { Arn => $value, ..., UserName => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::Transfer::DescribedUser object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->Arn | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | Describes the properties of a user that was specified. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> Arn => Str | ||
| 51 | |||
| 52 | Specifies the unique Amazon Resource Name (ARN) for the user that was | ||
| 53 | requested to be described. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 HomeDirectory => Str | ||
| 57 | |||
| 58 | The landing directory (folder) for a user when they log in to the | ||
| 59 | server using the client. | ||
| 60 | |||
| 61 | A C<HomeDirectory> example is C</bucket_name/home/mydirectory>. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 HomeDirectoryMappings => ArrayRef[L<Paws::Transfer::HomeDirectoryMapEntry>] | ||
| 65 | |||
| 66 | Logical directory mappings that specify what Amazon S3 or Amazon EFS | ||
| 67 | paths and keys should be visible to your user and how you want to make | ||
| 68 | them visible. You must specify the C<Entry> and C<Target> pair, where | ||
| 69 | C<Entry> shows how the path is made visible and C<Target> is the actual | ||
| 70 | Amazon S3 or Amazon EFS path. If you only specify a target, it is | ||
| 71 | displayed as is. You also must ensure that your Amazon Web Services | ||
| 72 | Identity and Access Management (IAM) role provides access to paths in | ||
| 73 | C<Target>. This value can only be set when C<HomeDirectoryType> is set | ||
| 74 | to I<LOGICAL>. | ||
| 75 | |||
| 76 | In most cases, you can use this value instead of the scope-down policy | ||
| 77 | to lock your user down to the designated home directory ("C<chroot>"). | ||
| 78 | To do this, you can set C<Entry> to '/' and set C<Target> to the | ||
| 79 | HomeDirectory parameter value. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 HomeDirectoryType => Str | ||
| 83 | |||
| 84 | The type of landing directory (folder) you want your users' home | ||
| 85 | directory to be when they log into the server. If you set it to | ||
| 86 | C<PATH>, the user will see the absolute Amazon S3 bucket or EFS paths | ||
| 87 | as is in their file transfer protocol clients. If you set it | ||
| 88 | C<LOGICAL>, you will need to provide mappings in the | ||
| 89 | C<HomeDirectoryMappings> for how you want to make Amazon S3 or EFS | ||
| 90 | paths visible to your users. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 Policy => Str | ||
| 94 | |||
| 95 | A scope-down policy for your user so that you can use the same IAM role | ||
| 96 | across multiple users. This policy scopes down user access to portions | ||
| 97 | of their Amazon S3 bucket. Variables that you can use inside this | ||
| 98 | policy include C<${Transfer:UserName}>, C<${Transfer:HomeDirectory}>, | ||
| 99 | and C<${Transfer:HomeBucket}>. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 PosixProfile => L<Paws::Transfer::PosixProfile> | ||
| 103 | |||
| 104 | Specifies the full POSIX identity, including user ID (C<Uid>), group ID | ||
| 105 | (C<Gid>), and any secondary groups IDs (C<SecondaryGids>), that | ||
| 106 | controls your users' access to your Amazon Elastic File System (Amazon | ||
| 107 | EFS) file systems. The POSIX permissions that are set on files and | ||
| 108 | directories in your file system determine the level of access your | ||
| 109 | users get when transferring files into and out of your Amazon EFS file | ||
| 110 | systems. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 Role => Str | ||
| 114 | |||
| 115 | Specifies the Amazon Resource Name (ARN) of the IAM role that controls | ||
| 116 | your users' access to your Amazon S3 bucket or EFS file system. The | ||
| 117 | policies attached to this role determine the level of access that you | ||
| 118 | want to provide your users when transferring files into and out of your | ||
| 119 | Amazon S3 bucket or EFS file system. The IAM role should also contain a | ||
| 120 | trust relationship that allows the server to access your resources when | ||
| 121 | servicing your users' transfer requests. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 SshPublicKeys => ArrayRef[L<Paws::Transfer::SshPublicKey>] | ||
| 125 | |||
| 126 | Specifies the public key portion of the Secure Shell (SSH) keys stored | ||
| 127 | for the described user. | ||
| 128 | |||
| 129 | |||
| 130 | =head2 Tags => ArrayRef[L<Paws::Transfer::Tag>] | ||
| 131 | |||
| 132 | Specifies the key-value pairs for the user requested. Tag can be used | ||
| 133 | to search for and group users for a variety of purposes. | ||
| 134 | |||
| 135 | |||
| 136 | =head2 UserName => Str | ||
| 137 | |||
| 138 | Specifies the name of the user that was requested to be described. User | ||
| 139 | names are used for authentication purposes. This is the string that | ||
| 140 | will be used by your user when they log in to your server. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head1 SEE ALSO | ||
| 145 | |||
| 146 | This class forms part of L<Paws>, describing an object used in L<Paws::Transfer> | ||
| 147 | |||
| 148 | =head1 BUGS and CONTRIBUTIONS | ||
| 149 | |||
| 150 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 151 | |||
| 152 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 153 | |||
| 154 | =cut | ||
| 155 |