| 1 | |||
| 2 | package Paws::EFS::CreateAccessPoint; | ||
| 3 | use Moose; | ||
| 4 | has ClientToken => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has FileSystemId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has PosixUser => (is => 'ro', isa => 'Paws::EFS::PosixUser'); | ||
| 7 | has RootDirectory => (is => 'ro', isa => 'Paws::EFS::RootDirectory'); | ||
| 8 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::EFS::Tag]'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateAccessPoint'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/2015-02-01/access-points'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EFS::AccessPointDescription'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::EFS::CreateAccessPoint - Arguments for method CreateAccessPoint on L<Paws::EFS> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateAccessPoint on the | ||
| 27 | L<Amazon Elastic File System|Paws::EFS> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateAccessPoint. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateAccessPoint. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $elasticfilesystem = Paws->service('EFS'); | ||
| 35 | my $AccessPointDescription = $elasticfilesystem->CreateAccessPoint( | ||
| 36 | ClientToken => 'MyClientToken', | ||
| 37 | FileSystemId => 'MyFileSystemId', | ||
| 38 | PosixUser => { | ||
| 39 | Gid => 1, # max: 4294967295 | ||
| 40 | Uid => 1, # max: 4294967295 | ||
| 41 | SecondaryGids => [ | ||
| 42 | 1, ... # max: 4294967295 | ||
| 43 | ], # max: 16; OPTIONAL | ||
| 44 | }, # OPTIONAL | ||
| 45 | RootDirectory => { | ||
| 46 | CreationInfo => { | ||
| 47 | OwnerGid => 1, # max: 4294967295 | ||
| 48 | OwnerUid => 1, # max: 4294967295 | ||
| 49 | Permissions => 'MyPermissions', # min: 3, max: 4 | ||
| 50 | |||
| 51 | }, # OPTIONAL | ||
| 52 | Path => 'MyPath', # min: 1, max: 100; OPTIONAL | ||
| 53 | }, # OPTIONAL | ||
| 54 | Tags => [ | ||
| 55 | { | ||
| 56 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 57 | Value => 'MyTagValue', # max: 256 | ||
| 58 | |||
| 59 | }, | ||
| 60 | ... | ||
| 61 | ], # OPTIONAL | ||
| 62 | ); | ||
| 63 | |||
| 64 | # Results: | ||
| 65 | my $AccessPointArn = $AccessPointDescription->AccessPointArn; | ||
| 66 | my $AccessPointId = $AccessPointDescription->AccessPointId; | ||
| 67 | my $ClientToken = $AccessPointDescription->ClientToken; | ||
| 68 | my $FileSystemId = $AccessPointDescription->FileSystemId; | ||
| 69 | my $LifeCycleState = $AccessPointDescription->LifeCycleState; | ||
| 70 | my $Name = $AccessPointDescription->Name; | ||
| 71 | my $OwnerId = $AccessPointDescription->OwnerId; | ||
| 72 | my $PosixUser = $AccessPointDescription->PosixUser; | ||
| 73 | my $RootDirectory = $AccessPointDescription->RootDirectory; | ||
| 74 | my $Tags = $AccessPointDescription->Tags; | ||
| 75 | |||
| 76 | # Returns a L<Paws::EFS::AccessPointDescription> object. | ||
| 77 | |||
| 78 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 79 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem/CreateAccessPoint> | ||
| 80 | |||
| 81 | =head1 ATTRIBUTES | ||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> ClientToken => Str | ||
| 85 | |||
| 86 | A string of up to 64 ASCII characters that Amazon EFS uses to ensure | ||
| 87 | idempotent creation. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 B<REQUIRED> FileSystemId => Str | ||
| 92 | |||
| 93 | The ID of the EFS file system that the access point provides access to. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 PosixUser => L<Paws::EFS::PosixUser> | ||
| 98 | |||
| 99 | The operating system user and group applied to all file system requests | ||
| 100 | made using the access point. | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 RootDirectory => L<Paws::EFS::RootDirectory> | ||
| 105 | |||
| 106 | Specifies the directory on the Amazon EFS file system that the access | ||
| 107 | point exposes as the root directory of your file system to NFS clients | ||
| 108 | using the access point. The clients using the access point can only | ||
| 109 | access the root directory and below. If the C<RootDirectory> E<gt> | ||
| 110 | C<Path> specified does not exist, EFS creates it and applies the | ||
| 111 | C<CreationInfo> settings when a client connects to an access point. | ||
| 112 | When specifying a C<RootDirectory>, you need to provide the C<Path>, | ||
| 113 | and the C<CreationInfo>. | ||
| 114 | |||
| 115 | Amazon EFS creates a root directory only if you have provided the | ||
| 116 | CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you | ||
| 117 | do not provide this information, Amazon EFS does not create the root | ||
| 118 | directory. If the root directory does not exist, attempts to mount | ||
| 119 | using the access point will fail. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head2 Tags => ArrayRef[L<Paws::EFS::Tag>] | ||
| 124 | |||
| 125 | Creates tags associated with the access point. Each tag is a key-value | ||
| 126 | pair. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head1 SEE ALSO | ||
| 132 | |||
| 133 | This class forms part of L<Paws>, documenting arguments for method CreateAccessPoint in L<Paws::EFS> | ||
| 134 | |||
| 135 | =head1 BUGS and CONTRIBUTIONS | ||
| 136 | |||
| 137 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 138 | |||
| 139 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 140 | |||
| 141 | =cut | ||
| 142 |