File Coverage

blib/lib/Paws/SSM/DocumentParameter.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::SSM::DocumentParameter;
2 1     1   277 use Moose;
  1         3  
  1         6  
3             has DefaultValue => (is => 'ro', isa => 'Str');
4             has Description => (is => 'ro', isa => 'Str');
5             has Name => (is => 'ro', isa => 'Str');
6             has Type => (is => 'ro', isa => 'Str');
7             1;
8              
9             ### main pod documentation begin ###
10              
11             =head1 NAME
12              
13             Paws::SSM::DocumentParameter
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::SSM::DocumentParameter object:
25              
26             $service_obj->Method(Att1 => { DefaultValue => $value, ..., Type => $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::SSM::DocumentParameter object:
31              
32             $result = $service_obj->Method(...);
33             $result->Att1->DefaultValue
34              
35             =head1 DESCRIPTION
36              
37             Parameters specified in a System Manager document that execute on the
38             server when the command is run.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 DefaultValue => Str
44              
45             If specified, the default values for the parameters. Parameters without
46             a default value are required. Parameters with a default value are
47             optional.
48              
49              
50             =head2 Description => Str
51              
52             A description of what the parameter does, how to use it, the default
53             value, and whether or not the parameter is optional.
54              
55              
56             =head2 Name => Str
57              
58             The name of the parameter.
59              
60              
61             =head2 Type => Str
62              
63             The type of parameter. The type can be either String or StringList.
64              
65              
66              
67             =head1 SEE ALSO
68              
69             This class forms part of L<Paws>, describing an object used in L<Paws::SSM>
70              
71             =head1 BUGS and CONTRIBUTIONS
72              
73             The source code is located here: https://github.com/pplu/aws-sdk-perl
74              
75             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
76              
77             =cut
78