File Coverage

blib/lib/Paws/OpsWorks/Deployment.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::OpsWorks::Deployment;
2 1     1   585 use Moose;
  1         3  
  1         9  
3             has AppId => (is => 'ro', isa => 'Str');
4             has Command => (is => 'ro', isa => 'Paws::OpsWorks::DeploymentCommand');
5             has Comment => (is => 'ro', isa => 'Str');
6             has CompletedAt => (is => 'ro', isa => 'Str');
7             has CreatedAt => (is => 'ro', isa => 'Str');
8             has CustomJson => (is => 'ro', isa => 'Str');
9             has DeploymentId => (is => 'ro', isa => 'Str');
10             has Duration => (is => 'ro', isa => 'Int');
11             has IamUserArn => (is => 'ro', isa => 'Str');
12             has InstanceIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
13             has StackId => (is => 'ro', isa => 'Str');
14             has Status => (is => 'ro', isa => 'Str');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::OpsWorks::Deployment
22              
23             =head1 USAGE
24              
25             This class represents one of two things:
26              
27             =head3 Arguments in a call to a service
28              
29             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
30             Each attribute should be used as a named argument in the calls that expect this type of object.
31              
32             As an example, if Att1 is expected to be a Paws::OpsWorks::Deployment object:
33              
34             $service_obj->Method(Att1 => { AppId => $value, ..., Status => $value });
35              
36             =head3 Results returned from an API call
37              
38             Use accessors for each attribute. If Att1 is expected to be an Paws::OpsWorks::Deployment object:
39              
40             $result = $service_obj->Method(...);
41             $result->Att1->AppId
42              
43             =head1 DESCRIPTION
44              
45             Describes a deployment of a stack or app.
46              
47             =head1 ATTRIBUTES
48              
49              
50             =head2 AppId => Str
51              
52             The app ID.
53              
54              
55             =head2 Command => L<Paws::OpsWorks::DeploymentCommand>
56              
57            
58              
59              
60             =head2 Comment => Str
61              
62             A user-defined comment.
63              
64              
65             =head2 CompletedAt => Str
66              
67             Date when the deployment completed.
68              
69              
70             =head2 CreatedAt => Str
71              
72             Date when the deployment was created.
73              
74              
75             =head2 CustomJson => Str
76              
77             A string that contains user-defined custom JSON. It can be used to
78             override the corresponding default stack configuration attribute values
79             for stack or to pass data to recipes. The string should be in the
80             following format:
81              
82             C<"{\"key1\": \"value1\", \"key2\": \"value2\",...}">
83              
84             For more information on custom JSON, see Use Custom JSON to Modify the
85             Stack Configuration Attributes.
86              
87              
88             =head2 DeploymentId => Str
89              
90             The deployment ID.
91              
92              
93             =head2 Duration => Int
94              
95             The deployment duration.
96              
97              
98             =head2 IamUserArn => Str
99              
100             The user's IAM ARN.
101              
102              
103             =head2 InstanceIds => ArrayRef[Str|Undef]
104              
105             The IDs of the target instances.
106              
107              
108             =head2 StackId => Str
109              
110             The stack ID.
111              
112              
113             =head2 Status => Str
114              
115             The deployment status:
116              
117             =over
118              
119             =item *
120              
121             running
122              
123             =item *
124              
125             successful
126              
127             =item *
128              
129             failed
130              
131             =back
132              
133              
134              
135              
136             =head1 SEE ALSO
137              
138             This class forms part of L<Paws>, describing an object used in L<Paws::OpsWorks>
139              
140             =head1 BUGS and CONTRIBUTIONS
141              
142             The source code is located here: https://github.com/pplu/aws-sdk-perl
143              
144             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
145              
146             =cut
147