| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Batch::EFSAuthorizationConfig; | ||
| 3 | use Moose; | ||
| 4 | has AccessPointId => (is => 'ro', isa => 'Str', request_name => 'accessPointId', traits => ['NameInRequest']); | ||
| 5 | has Iam => (is => 'ro', isa => 'Str', request_name => 'iam', traits => ['NameInRequest']); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Batch::EFSAuthorizationConfig | ||
| 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::Batch::EFSAuthorizationConfig object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { AccessPointId => $value, ..., Iam => $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::Batch::EFSAuthorizationConfig object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->AccessPointId | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | The authorization configuration details for the Amazon EFS file system. | ||
| 38 | |||
| 39 | =head1 ATTRIBUTES | ||
| 40 | |||
| 41 | |||
| 42 | =head2 AccessPointId => Str | ||
| 43 | |||
| 44 | The Amazon EFS access point ID to use. If an access point is specified, | ||
| 45 | the root directory value specified in the C<EFSVolumeConfiguration> | ||
| 46 | must either be omitted or set to C</> which will enforce the path set | ||
| 47 | on the EFS access point. If an access point is used, transit encryption | ||
| 48 | must be enabled in the C<EFSVolumeConfiguration>. For more information, | ||
| 49 | see Working with Amazon EFS Access Points | ||
| 50 | (https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in | ||
| 51 | the I<Amazon Elastic File System User Guide>. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 Iam => Str | ||
| 55 | |||
| 56 | Whether or not to use the AWS Batch execution IAM role defined in a job | ||
| 57 | definition when mounting the Amazon EFS file system. If enabled, | ||
| 58 | transit encryption must be enabled in the C<EFSVolumeConfiguration>. If | ||
| 59 | this parameter is omitted, the default value of C<DISABLED> is used. | ||
| 60 | For more information, see Using Amazon EFS Access Points | ||
| 61 | (https://docs.aws.amazon.com/batch/latest/ug/efs-volumes.html#efs-volume-accesspoints) | ||
| 62 | in the I<AWS Batch User Guide>. EFS IAM authorization requires that | ||
| 63 | C<TransitEncryption> be C<ENABLED> and that a C<JobRoleArn> is | ||
| 64 | specified. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head1 SEE ALSO | ||
| 69 | |||
| 70 | This class forms part of L<Paws>, describing an object used in L<Paws::Batch> | ||
| 71 | |||
| 72 | =head1 BUGS and CONTRIBUTIONS | ||
| 73 | |||
| 74 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 75 | |||
| 76 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 77 | |||
| 78 | =cut | ||
| 79 |