| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ECS::Volume; | ||
| 3 | use Moose; | ||
| 4 | has DockerVolumeConfiguration => (is => 'ro', isa => 'Paws::ECS::DockerVolumeConfiguration', request_name => 'dockerVolumeConfiguration', traits => ['NameInRequest']); | ||
| 5 | has EfsVolumeConfiguration => (is => 'ro', isa => 'Paws::ECS::EFSVolumeConfiguration', request_name => 'efsVolumeConfiguration', traits => ['NameInRequest']); | ||
| 6 | has FsxWindowsFileServerVolumeConfiguration => (is => 'ro', isa => 'Paws::ECS::FSxWindowsFileServerVolumeConfiguration', request_name => 'fsxWindowsFileServerVolumeConfiguration', traits => ['NameInRequest']); | ||
| 7 | has Host => (is => 'ro', isa => 'Paws::ECS::HostVolumeProperties', request_name => 'host', traits => ['NameInRequest']); | ||
| 8 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::ECS::Volume | ||
| 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::ECS::Volume object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { DockerVolumeConfiguration => $value, ..., Name => $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::ECS::Volume object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->DockerVolumeConfiguration | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | A data volume used in a task definition. For tasks that use the Amazon | ||
| 41 | Elastic File System (Amazon EFS), specify an C<efsVolumeConfiguration>. | ||
| 42 | For Windows tasks that use Amazon FSx for Windows File Server file | ||
| 43 | system, specify a C<fsxWindowsFileServerVolumeConfiguration>. For tasks | ||
| 44 | that use a Docker volume, specify a C<DockerVolumeConfiguration>. For | ||
| 45 | tasks that use a bind mount host volume, specify a C<host> and optional | ||
| 46 | C<sourcePath>. For more information, see Using Data Volumes in Tasks | ||
| 47 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html). | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 DockerVolumeConfiguration => L<Paws::ECS::DockerVolumeConfiguration> | ||
| 53 | |||
| 54 | This parameter is specified when you are using Docker volumes. | ||
| 55 | |||
| 56 | Windows containers only support the use of the C<local> driver. To use | ||
| 57 | bind mounts, specify the C<host> parameter instead. | ||
| 58 | |||
| 59 | Docker volumes are not supported by tasks run on AWS Fargate. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 EfsVolumeConfiguration => L<Paws::ECS::EFSVolumeConfiguration> | ||
| 63 | |||
| 64 | This parameter is specified when you are using an Amazon Elastic File | ||
| 65 | System file system for task storage. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 FsxWindowsFileServerVolumeConfiguration => L<Paws::ECS::FSxWindowsFileServerVolumeConfiguration> | ||
| 69 | |||
| 70 | This parameter is specified when you are using Amazon FSx for Windows | ||
| 71 | File Server file system for task storage. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 Host => L<Paws::ECS::HostVolumeProperties> | ||
| 75 | |||
| 76 | This parameter is specified when you are using bind mount host volumes. | ||
| 77 | The contents of the C<host> parameter determine whether your bind mount | ||
| 78 | host volume persists on the host container instance and where it is | ||
| 79 | stored. If the C<host> parameter is empty, then the Docker daemon | ||
| 80 | assigns a host path for your data volume. However, the data is not | ||
| 81 | guaranteed to persist after the containers associated with it stop | ||
| 82 | running. | ||
| 83 | |||
| 84 | Windows containers can mount whole directories on the same drive as | ||
| 85 | C<$env:ProgramData>. Windows containers cannot mount directories on a | ||
| 86 | different drive, and mount point cannot be across drives. For example, | ||
| 87 | you can mount C<C:\my\path:C:\my\path> and C<D:\:D:\>, but not | ||
| 88 | C<D:\my\path:C:\my\path> or C<D:\:C:\my\path>. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 Name => Str | ||
| 92 | |||
| 93 | The name of the volume. Up to 255 letters (uppercase and lowercase), | ||
| 94 | numbers, underscores, and hyphens are allowed. This name is referenced | ||
| 95 | in the C<sourceVolume> parameter of container definition | ||
| 96 | C<mountPoints>. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head1 SEE ALSO | ||
| 101 | |||
| 102 | This class forms part of L<Paws>, describing an object used in L<Paws::ECS> | ||
| 103 | |||
| 104 | =head1 BUGS and CONTRIBUTIONS | ||
| 105 | |||
| 106 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 107 | |||
| 108 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 109 | |||
| 110 | =cut | ||
| 111 |