| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Batch::EFSVolumeConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has AuthorizationConfig => (is => 'ro', isa => 'Paws::Batch::EFSAuthorizationConfig', request_name => 'authorizationConfig', traits => ['NameInRequest']); | ||
| 5 | has FileSystemId => (is => 'ro', isa => 'Str', request_name => 'fileSystemId', traits => ['NameInRequest'], required => 1); | ||
| 6 | has RootDirectory => (is => 'ro', isa => 'Str', request_name => 'rootDirectory', traits => ['NameInRequest']); | ||
| 7 | has TransitEncryption => (is => 'ro', isa => 'Str', request_name => 'transitEncryption', traits => ['NameInRequest']); | ||
| 8 | has TransitEncryptionPort => (is => 'ro', isa => 'Int', request_name => 'transitEncryptionPort', traits => ['NameInRequest']); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::Batch::EFSVolumeConfiguration | ||
| 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::Batch::EFSVolumeConfiguration object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { AuthorizationConfig => $value, ..., TransitEncryptionPort => $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::Batch::EFSVolumeConfiguration object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->AuthorizationConfig | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | This parameter is specified when you are using an Amazon Elastic File | ||
| 41 | System file system for task storage. For more information, see Amazon | ||
| 42 | EFS Volumes | ||
| 43 | (https://docs.aws.amazon.com/batch/latest/ug/efs-volumes.html) in the | ||
| 44 | I<AWS Batch User Guide>. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 AuthorizationConfig => L<Paws::Batch::EFSAuthorizationConfig> | ||
| 50 | |||
| 51 | The authorization configuration details for the Amazon EFS file system. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> FileSystemId => Str | ||
| 55 | |||
| 56 | The Amazon EFS file system ID to use. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 RootDirectory => Str | ||
| 60 | |||
| 61 | The directory within the Amazon EFS file system to mount as the root | ||
| 62 | directory inside the host. If this parameter is omitted, the root of | ||
| 63 | the Amazon EFS volume will be used. Specifying C</> will have the same | ||
| 64 | effect as omitting this parameter. | ||
| 65 | |||
| 66 | If an EFS access point is specified in the C<authorizationConfig>, the | ||
| 67 | root directory parameter must either be omitted or set to C</> which | ||
| 68 | will enforce the path set on the Amazon EFS access point. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 TransitEncryption => Str | ||
| 72 | |||
| 73 | Whether or not to enable encryption for Amazon EFS data in transit | ||
| 74 | between the Amazon ECS host and the Amazon EFS server. Transit | ||
| 75 | encryption must be enabled if Amazon EFS IAM authorization is used. If | ||
| 76 | this parameter is omitted, the default value of C<DISABLED> is used. | ||
| 77 | For more information, see Encrypting data in transit | ||
| 78 | (https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) | ||
| 79 | in the I<Amazon Elastic File System User Guide>. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 TransitEncryptionPort => Int | ||
| 83 | |||
| 84 | The port to use when sending encrypted data between the Amazon ECS host | ||
| 85 | and the Amazon EFS server. If you do not specify a transit encryption | ||
| 86 | port, it will use the port selection strategy that the Amazon EFS mount | ||
| 87 | helper uses. For more information, see EFS Mount Helper | ||
| 88 | (https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in | ||
| 89 | the I<Amazon Elastic File System User Guide>. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head1 SEE ALSO | ||
| 94 | |||
| 95 | This class forms part of L<Paws>, describing an object used in L<Paws::Batch> | ||
| 96 | |||
| 97 | =head1 BUGS and CONTRIBUTIONS | ||
| 98 | |||
| 99 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 100 | |||
| 101 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 102 | |||
| 103 | =cut | ||
| 104 |