| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ECS::DockerVolumeConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has Autoprovision => (is => 'ro', isa => 'Bool', request_name => 'autoprovision', traits => ['NameInRequest']); | ||
| 5 | has Driver => (is => 'ro', isa => 'Str', request_name => 'driver', traits => ['NameInRequest']); | ||
| 6 | has DriverOpts => (is => 'ro', isa => 'Paws::ECS::StringMap', request_name => 'driverOpts', traits => ['NameInRequest']); | ||
| 7 | has Labels => (is => 'ro', isa => 'Paws::ECS::StringMap', request_name => 'labels', traits => ['NameInRequest']); | ||
| 8 | has Scope => (is => 'ro', isa => 'Str', request_name => 'scope', traits => ['NameInRequest']); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::ECS::DockerVolumeConfiguration | ||
| 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::DockerVolumeConfiguration object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { Autoprovision => $value, ..., Scope => $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::DockerVolumeConfiguration object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->Autoprovision | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | This parameter is specified when you are using Docker volumes. Docker | ||
| 41 | volumes are only supported when you are using the EC2 launch type. | ||
| 42 | Windows containers only support the use of the C<local> driver. To use | ||
| 43 | bind mounts, specify a C<host> instead. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 Autoprovision => Bool | ||
| 49 | |||
| 50 | If this value is C<true>, the Docker volume is created if it does not | ||
| 51 | already exist. | ||
| 52 | |||
| 53 | This field is only used if the C<scope> is C<shared>. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 Driver => Str | ||
| 57 | |||
| 58 | The Docker volume driver to use. The driver value must match the driver | ||
| 59 | name provided by Docker because it is used for task placement. If the | ||
| 60 | driver was installed using the Docker plugin CLI, use C<docker plugin | ||
| 61 | ls> to retrieve the driver name from your container instance. If the | ||
| 62 | driver was installed using another method, use Docker plugin discovery | ||
| 63 | to retrieve the driver name. For more information, see Docker plugin | ||
| 64 | discovery | ||
| 65 | (https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery). | ||
| 66 | This parameter maps to C<Driver> in the Create a volume | ||
| 67 | (https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) | ||
| 68 | section of the Docker Remote API | ||
| 69 | (https://docs.docker.com/engine/api/v1.35/) and the C<xxdriver> option | ||
| 70 | to docker volume create | ||
| 71 | (https://docs.docker.com/engine/reference/commandline/volume_create/). | ||
| 72 | |||
| 73 | |||
| 74 | =head2 DriverOpts => L<Paws::ECS::StringMap> | ||
| 75 | |||
| 76 | A map of Docker driver-specific options passed through. This parameter | ||
| 77 | maps to C<DriverOpts> in the Create a volume | ||
| 78 | (https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) | ||
| 79 | section of the Docker Remote API | ||
| 80 | (https://docs.docker.com/engine/api/v1.35/) and the C<xxopt> option to | ||
| 81 | docker volume create | ||
| 82 | (https://docs.docker.com/engine/reference/commandline/volume_create/). | ||
| 83 | |||
| 84 | |||
| 85 | =head2 Labels => L<Paws::ECS::StringMap> | ||
| 86 | |||
| 87 | Custom metadata to add to your Docker volume. This parameter maps to | ||
| 88 | C<Labels> in the Create a volume | ||
| 89 | (https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) | ||
| 90 | section of the Docker Remote API | ||
| 91 | (https://docs.docker.com/engine/api/v1.35/) and the C<xxlabel> option | ||
| 92 | to docker volume create | ||
| 93 | (https://docs.docker.com/engine/reference/commandline/volume_create/). | ||
| 94 | |||
| 95 | |||
| 96 | =head2 Scope => Str | ||
| 97 | |||
| 98 | The scope for the Docker volume that determines its lifecycle. Docker | ||
| 99 | volumes that are scoped to a C<task> are automatically provisioned when | ||
| 100 | the task starts and destroyed when the task stops. Docker volumes that | ||
| 101 | are scoped as C<shared> persist after the task stops. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head1 SEE ALSO | ||
| 106 | |||
| 107 | This class forms part of L<Paws>, describing an object used in L<Paws::ECS> | ||
| 108 | |||
| 109 | =head1 BUGS and CONTRIBUTIONS | ||
| 110 | |||
| 111 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 112 | |||
| 113 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 114 | |||
| 115 | =cut | ||
| 116 |