File Coverage

blib/lib/Paws/CodeDeploy/DeploymentInfo.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::CodeDeploy::DeploymentInfo;
2 1     1   326 use Moose;
  1         2  
  1         7  
3             has AdditionalDeploymentStatusInfo => (is => 'ro', isa => 'Str', request_name => 'additionalDeploymentStatusInfo', traits => ['NameInRequest']);
4             has ApplicationName => (is => 'ro', isa => 'Str', request_name => 'applicationName', traits => ['NameInRequest']);
5             has AutoRollbackConfiguration => (is => 'ro', isa => 'Paws::CodeDeploy::AutoRollbackConfiguration', request_name => 'autoRollbackConfiguration', traits => ['NameInRequest']);
6             has BlueGreenDeploymentConfiguration => (is => 'ro', isa => 'Paws::CodeDeploy::BlueGreenDeploymentConfiguration', request_name => 'blueGreenDeploymentConfiguration', traits => ['NameInRequest']);
7             has CompleteTime => (is => 'ro', isa => 'Str', request_name => 'completeTime', traits => ['NameInRequest']);
8             has CreateTime => (is => 'ro', isa => 'Str', request_name => 'createTime', traits => ['NameInRequest']);
9             has Creator => (is => 'ro', isa => 'Str', request_name => 'creator', traits => ['NameInRequest']);
10             has DeploymentConfigName => (is => 'ro', isa => 'Str', request_name => 'deploymentConfigName', traits => ['NameInRequest']);
11             has DeploymentGroupName => (is => 'ro', isa => 'Str', request_name => 'deploymentGroupName', traits => ['NameInRequest']);
12             has DeploymentId => (is => 'ro', isa => 'Str', request_name => 'deploymentId', traits => ['NameInRequest']);
13             has DeploymentOverview => (is => 'ro', isa => 'Paws::CodeDeploy::DeploymentOverview', request_name => 'deploymentOverview', traits => ['NameInRequest']);
14             has DeploymentStyle => (is => 'ro', isa => 'Paws::CodeDeploy::DeploymentStyle', request_name => 'deploymentStyle', traits => ['NameInRequest']);
15             has Description => (is => 'ro', isa => 'Str', request_name => 'description', traits => ['NameInRequest']);
16             has ErrorInformation => (is => 'ro', isa => 'Paws::CodeDeploy::ErrorInformation', request_name => 'errorInformation', traits => ['NameInRequest']);
17             has FileExistsBehavior => (is => 'ro', isa => 'Str', request_name => 'fileExistsBehavior', traits => ['NameInRequest']);
18             has IgnoreApplicationStopFailures => (is => 'ro', isa => 'Bool', request_name => 'ignoreApplicationStopFailures', traits => ['NameInRequest']);
19             has InstanceTerminationWaitTimeStarted => (is => 'ro', isa => 'Bool', request_name => 'instanceTerminationWaitTimeStarted', traits => ['NameInRequest']);
20             has LoadBalancerInfo => (is => 'ro', isa => 'Paws::CodeDeploy::LoadBalancerInfo', request_name => 'loadBalancerInfo', traits => ['NameInRequest']);
21             has PreviousRevision => (is => 'ro', isa => 'Paws::CodeDeploy::RevisionLocation', request_name => 'previousRevision', traits => ['NameInRequest']);
22             has Revision => (is => 'ro', isa => 'Paws::CodeDeploy::RevisionLocation', request_name => 'revision', traits => ['NameInRequest']);
23             has RollbackInfo => (is => 'ro', isa => 'Paws::CodeDeploy::RollbackInfo', request_name => 'rollbackInfo', traits => ['NameInRequest']);
24             has StartTime => (is => 'ro', isa => 'Str', request_name => 'startTime', traits => ['NameInRequest']);
25             has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']);
26             has TargetInstances => (is => 'ro', isa => 'Paws::CodeDeploy::TargetInstances', request_name => 'targetInstances', traits => ['NameInRequest']);
27             has UpdateOutdatedInstancesOnly => (is => 'ro', isa => 'Bool', request_name => 'updateOutdatedInstancesOnly', traits => ['NameInRequest']);
28             1;
29              
30             ### main pod documentation begin ###
31              
32             =head1 NAME
33              
34             Paws::CodeDeploy::DeploymentInfo
35              
36             =head1 USAGE
37              
38             This class represents one of two things:
39              
40             =head3 Arguments in a call to a service
41              
42             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
43             Each attribute should be used as a named argument in the calls that expect this type of object.
44              
45             As an example, if Att1 is expected to be a Paws::CodeDeploy::DeploymentInfo object:
46              
47             $service_obj->Method(Att1 => { AdditionalDeploymentStatusInfo => $value, ..., UpdateOutdatedInstancesOnly => $value });
48              
49             =head3 Results returned from an API call
50              
51             Use accessors for each attribute. If Att1 is expected to be an Paws::CodeDeploy::DeploymentInfo object:
52              
53             $result = $service_obj->Method(...);
54             $result->Att1->AdditionalDeploymentStatusInfo
55              
56             =head1 DESCRIPTION
57              
58             Information about a deployment.
59              
60             =head1 ATTRIBUTES
61              
62              
63             =head2 AdditionalDeploymentStatusInfo => Str
64              
65             Provides information about the results of a deployment, such as whether
66             instances in the original environment in a blue/green deployment were
67             not terminated.
68              
69              
70             =head2 ApplicationName => Str
71              
72             The application name.
73              
74              
75             =head2 AutoRollbackConfiguration => L<Paws::CodeDeploy::AutoRollbackConfiguration>
76              
77             Information about the automatic rollback configuration associated with
78             the deployment.
79              
80              
81             =head2 BlueGreenDeploymentConfiguration => L<Paws::CodeDeploy::BlueGreenDeploymentConfiguration>
82              
83             Information about blue/green deployment options for this deployment.
84              
85              
86             =head2 CompleteTime => Str
87              
88             A timestamp indicating when the deployment was complete.
89              
90              
91             =head2 CreateTime => Str
92              
93             A timestamp indicating when the deployment was created.
94              
95              
96             =head2 Creator => Str
97              
98             The means by which the deployment was created:
99              
100             =over
101              
102             =item *
103              
104             user: A user created the deployment.
105              
106             =item *
107              
108             autoscaling: Auto Scaling created the deployment.
109              
110             =item *
111              
112             codeDeployRollback: A rollback process created the deployment.
113              
114             =back
115              
116              
117              
118             =head2 DeploymentConfigName => Str
119              
120             The deployment configuration name.
121              
122              
123             =head2 DeploymentGroupName => Str
124              
125             The deployment group name.
126              
127              
128             =head2 DeploymentId => Str
129              
130             The deployment ID.
131              
132              
133             =head2 DeploymentOverview => L<Paws::CodeDeploy::DeploymentOverview>
134              
135             A summary of the deployment status of the instances in the deployment.
136              
137              
138             =head2 DeploymentStyle => L<Paws::CodeDeploy::DeploymentStyle>
139              
140             Information about the type of deployment, either in-place or
141             blue/green, you want to run and whether to route deployment traffic
142             behind a load balancer.
143              
144              
145             =head2 Description => Str
146              
147             A comment about the deployment.
148              
149              
150             =head2 ErrorInformation => L<Paws::CodeDeploy::ErrorInformation>
151              
152             Information about any error associated with this deployment.
153              
154              
155             =head2 FileExistsBehavior => Str
156              
157             Information about how AWS CodeDeploy handles files that already exist
158             in a deployment target location but weren't part of the previous
159             successful deployment.
160              
161             =over
162              
163             =item *
164              
165             DISALLOW: The deployment fails. This is also the default behavior if no
166             option is specified.
167              
168             =item *
169              
170             OVERWRITE: The version of the file from the application revision
171             currently being deployed replaces the version already on the instance.
172              
173             =item *
174              
175             RETAIN: The version of the file already on the instance is kept and
176             used as part of the new deployment.
177              
178             =back
179              
180              
181              
182             =head2 IgnoreApplicationStopFailures => Bool
183              
184             If true, then if the deployment causes the ApplicationStop deployment
185             lifecycle event to an instance to fail, the deployment to that instance
186             will not be considered to have failed at that point and will continue
187             on to the BeforeInstall deployment lifecycle event.
188              
189             If false or not specified, then if the deployment causes the
190             ApplicationStop deployment lifecycle event to an instance to fail, the
191             deployment to that instance will stop, and the deployment to that
192             instance will be considered to have failed.
193              
194              
195             =head2 InstanceTerminationWaitTimeStarted => Bool
196              
197             Indicates whether the wait period set for the termination of instances
198             in the original environment has started. Status is 'false' if the
199             KEEP_ALIVE option is specified; otherwise, 'true' as soon as the
200             termination wait period starts.
201              
202              
203             =head2 LoadBalancerInfo => L<Paws::CodeDeploy::LoadBalancerInfo>
204              
205             Information about the load balancer used in the deployment.
206              
207              
208             =head2 PreviousRevision => L<Paws::CodeDeploy::RevisionLocation>
209              
210             Information about the application revision that was deployed to the
211             deployment group before the most recent successful deployment.
212              
213              
214             =head2 Revision => L<Paws::CodeDeploy::RevisionLocation>
215              
216             Information about the location of stored application artifacts and the
217             service from which to retrieve them.
218              
219              
220             =head2 RollbackInfo => L<Paws::CodeDeploy::RollbackInfo>
221              
222             Information about a deployment rollback.
223              
224              
225             =head2 StartTime => Str
226              
227             A timestamp indicating when the deployment was deployed to the
228             deployment group.
229              
230             In some cases, the reported value of the start time may be later than
231             the complete time. This is due to differences in the clock settings of
232             back-end servers that participate in the deployment process.
233              
234              
235             =head2 Status => Str
236              
237             The current state of the deployment as a whole.
238              
239              
240             =head2 TargetInstances => L<Paws::CodeDeploy::TargetInstances>
241              
242             Information about the instances that belong to the replacement
243             environment in a blue/green deployment.
244              
245              
246             =head2 UpdateOutdatedInstancesOnly => Bool
247              
248             Indicates whether only instances that are not running the latest
249             application revision are to be deployed to.
250              
251              
252              
253             =head1 SEE ALSO
254              
255             This class forms part of L<Paws>, describing an object used in L<Paws::CodeDeploy>
256              
257             =head1 BUGS and CONTRIBUTIONS
258              
259             The source code is located here: https://github.com/pplu/aws-sdk-perl
260              
261             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
262              
263             =cut
264