« blib/lib/Paws/Transfer/EndpointDetails.pm
↑ Summary
blib/lib/Paws/Transfer/IdentityProviderDetails.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Transfer::HomeDirectoryMapEntry; | ||
| 3 | use Moose; | ||
| 4 | has Entry => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Target => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Transfer::HomeDirectoryMapEntry | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::Transfer::HomeDirectoryMapEntry object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Entry => $value, ..., Target => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::Transfer::HomeDirectoryMapEntry object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Entry | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Represents an object that contains entries and targets for | ||
| 38 | C<HomeDirectoryMappings>. | ||
| 39 | |||
| 40 | The following is an C<Entry> and C<Target> pair example for C<chroot>. | ||
| 41 | |||
| 42 | C<[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]> | ||
| 43 | |||
| 44 | If the target of a logical directory entry does not exist in Amazon S3 | ||
| 45 | or EFS, the entry is ignored. As a workaround, you can use the Amazon | ||
| 46 | S3 API or EFS API to create 0 byte objects as place holders for your | ||
| 47 | directory. If using the CLI, use the C<s3api> or C<efsapi> call instead | ||
| 48 | of C<s3> or C<efs> so you can use the put-object operation. For | ||
| 49 | example, you use the following: C<aws s3api put-object --bucket | ||
| 50 | bucketname --key path/to/folder/>. Make sure that the end of the key | ||
| 51 | name ends in a C</> for it to be considered a folder. | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> Entry => Str | ||
| 57 | |||
| 58 | Represents an entry for C<HomeDirectoryMappings>. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> Target => Str | ||
| 62 | |||
| 63 | Represents the map target that is used in a C<HomeDirectorymapEntry>. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head1 SEE ALSO | ||
| 68 | |||
| 69 | This class forms part of L<Paws>, describing an object used in L<Paws::Transfer> | ||
| 70 | |||
| 71 | =head1 BUGS and CONTRIBUTIONS | ||
| 72 | |||
| 73 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 74 | |||
| 75 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 76 | |||
| 77 | =cut | ||
| 78 |