| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::EFS::RootDirectory; | ||
| 3 | use Moose; | ||
| 4 | has CreationInfo => (is => 'ro', isa => 'Paws::EFS::CreationInfo'); | ||
| 5 | has Path => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::EFS::RootDirectory | ||
| 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::EFS::RootDirectory object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { CreationInfo => $value, ..., Path => $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::EFS::RootDirectory object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->CreationInfo | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Specifies the directory on the Amazon EFS file system that the access | ||
| 38 | point provides access to. The access point exposes the specified file | ||
| 39 | system path as the root directory of your file system to applications | ||
| 40 | using the access point. NFS clients using the access point can only | ||
| 41 | access data in the access point's C<RootDirectory> and it's | ||
| 42 | subdirectories. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 CreationInfo => L<Paws::EFS::CreationInfo> | ||
| 48 | |||
| 49 | (Optional) Specifies the POSIX IDs and permissions to apply to the | ||
| 50 | access point's C<RootDirectory>. If the C<RootDirectory> E<gt> C<Path> | ||
| 51 | specified does not exist, EFS creates the root directory using the | ||
| 52 | C<CreationInfo> settings when a client connects to an access point. | ||
| 53 | When specifying the C<CreationInfo>, you must provide values for all | ||
| 54 | properties. | ||
| 55 | |||
| 56 | If you do not provide C<CreationInfo> and the specified | ||
| 57 | C<RootDirectory> E<gt> C<Path> does not exist, attempts to mount the | ||
| 58 | file system using the access point will fail. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 Path => Str | ||
| 62 | |||
| 63 | Specifies the path on the EFS file system to expose as the root | ||
| 64 | directory to NFS clients using the access point to access the EFS file | ||
| 65 | system. A path can have up to four subdirectories. If the specified | ||
| 66 | path does not exist, you are required to provide the C<CreationInfo>. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head1 SEE ALSO | ||
| 71 | |||
| 72 | This class forms part of L<Paws>, describing an object used in L<Paws::EFS> | ||
| 73 | |||
| 74 | =head1 BUGS and CONTRIBUTIONS | ||
| 75 | |||
| 76 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 77 | |||
| 78 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 79 | |||
| 80 | =cut | ||
| 81 |