| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::EFS::CreationInfo; | ||
| 3 | use Moose; | ||
| 4 | has OwnerGid => (is => 'ro', isa => 'Int', required => 1); | ||
| 5 | has OwnerUid => (is => 'ro', isa => 'Int', required => 1); | ||
| 6 | has Permissions => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::EFS::CreationInfo | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::EFS::CreationInfo object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { OwnerGid => $value, ..., Permissions => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::EFS::CreationInfo object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->OwnerGid | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Required if the C<RootDirectory> E<gt> C<Path> specified does not | ||
| 39 | exist. Specifies the POSIX IDs and permissions to apply to the access | ||
| 40 | point's C<RootDirectory> E<gt> C<Path>. If the access point root | ||
| 41 | directory does not exist, EFS creates it with these settings when a | ||
| 42 | client connects to the access point. When specifying C<CreationInfo>, | ||
| 43 | you must include values for all properties. | ||
| 44 | |||
| 45 | Amazon EFS creates a root directory only if you have provided the | ||
| 46 | CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you | ||
| 47 | do not provide this information, Amazon EFS does not create the root | ||
| 48 | directory. If the root directory does not exist, attempts to mount | ||
| 49 | using the access point will fail. | ||
| 50 | |||
| 51 | If you do not provide C<CreationInfo> and the specified | ||
| 52 | C<RootDirectory> does not exist, attempts to mount the file system | ||
| 53 | using the access point will fail. | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> OwnerGid => Int | ||
| 59 | |||
| 60 | Specifies the POSIX group ID to apply to the C<RootDirectory>. Accepts | ||
| 61 | values from 0 to 2^32 (4294967295). | ||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> OwnerUid => Int | ||
| 65 | |||
| 66 | Specifies the POSIX user ID to apply to the C<RootDirectory>. Accepts | ||
| 67 | values from 0 to 2^32 (4294967295). | ||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> Permissions => Str | ||
| 71 | |||
| 72 | Specifies the POSIX permissions to apply to the C<RootDirectory>, in | ||
| 73 | the format of an octal number representing the file's mode bits. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head1 SEE ALSO | ||
| 78 | |||
| 79 | This class forms part of L<Paws>, describing an object used in L<Paws::EFS> | ||
| 80 | |||
| 81 | =head1 BUGS and CONTRIBUTIONS | ||
| 82 | |||
| 83 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 84 | |||
| 85 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 86 | |||
| 87 | =cut | ||
| 88 |