« blib/lib/Paws/CodeBuild/ProjectEnvironment.pm
↑ Summary
blib/lib/Paws/CodeBuild/ProjectSource.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CodeBuild::ProjectFileSystemLocation; | ||
| 3 | use Moose; | ||
| 4 | has Identifier => (is => 'ro', isa => 'Str', request_name => 'identifier', traits => ['NameInRequest']); | ||
| 5 | has Location => (is => 'ro', isa => 'Str', request_name => 'location', traits => ['NameInRequest']); | ||
| 6 | has MountOptions => (is => 'ro', isa => 'Str', request_name => 'mountOptions', traits => ['NameInRequest']); | ||
| 7 | has MountPoint => (is => 'ro', isa => 'Str', request_name => 'mountPoint', traits => ['NameInRequest']); | ||
| 8 | has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest']); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::CodeBuild::ProjectFileSystemLocation | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::CodeBuild::ProjectFileSystemLocation object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { Identifier => $value, ..., Type => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::CodeBuild::ProjectFileSystemLocation object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->Identifier | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Information about a file system created by Amazon Elastic File System | ||
| 41 | (EFS). For more information, see What Is Amazon Elastic File System? | ||
| 42 | (https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html) | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 Identifier => Str | ||
| 48 | |||
| 49 | The name used to access a file system created by Amazon EFS. CodeBuild | ||
| 50 | creates an environment variable by appending the C<identifier> in all | ||
| 51 | capital letters to C<CODEBUILD_>. For example, if you specify C<my_efs> | ||
| 52 | for C<identifier>, a new environment variable is create named | ||
| 53 | C<CODEBUILD_MY_EFS>. | ||
| 54 | |||
| 55 | The C<identifier> is used to mount your file system. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 Location => Str | ||
| 59 | |||
| 60 | A string that specifies the location of the file system created by | ||
| 61 | Amazon EFS. Its format is C<efs-dns-name:/directory-path>. You can find | ||
| 62 | the DNS name of file system when you view it in the Amazon EFS console. | ||
| 63 | The directory path is a path to a directory in the file system that | ||
| 64 | CodeBuild mounts. For example, if the DNS name of a file system is | ||
| 65 | C<fs-abcd1234.efs.us-west-2.amazonaws.com>, and its mount directory is | ||
| 66 | C<my-efs-mount-directory>, then the C<location> is | ||
| 67 | C<fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory>. | ||
| 68 | |||
| 69 | The directory path in the format C<efs-dns-name:/directory-path> is | ||
| 70 | optional. If you do not specify a directory path, the location is only | ||
| 71 | the DNS name and CodeBuild mounts the entire file system. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 MountOptions => Str | ||
| 75 | |||
| 76 | The mount options for a file system created by Amazon EFS. The default | ||
| 77 | mount options used by CodeBuild are | ||
| 78 | C<nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2>. | ||
| 79 | For more information, see Recommended NFS Mount Options | ||
| 80 | (https://docs.aws.amazon.com/efs/latest/ug/mounting-fs-nfs-mount-settings.html). | ||
| 81 | |||
| 82 | |||
| 83 | =head2 MountPoint => Str | ||
| 84 | |||
| 85 | The location in the container where you mount the file system. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 Type => Str | ||
| 89 | |||
| 90 | The type of the file system. The one supported type is C<EFS>. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head1 SEE ALSO | ||
| 95 | |||
| 96 | This class forms part of L<Paws>, describing an object used in L<Paws::CodeBuild> | ||
| 97 | |||
| 98 | =head1 BUGS and CONTRIBUTIONS | ||
| 99 | |||
| 100 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 101 | |||
| 102 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 103 | |||
| 104 | =cut | ||
| 105 |