File Coverage

blib/lib/Paws/CodeDeploy/MinimumHealthyHosts.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	sub	time	code
1				package Paws::CodeDeploy::MinimumHealthyHosts;
2	1	1	288	use Moose;
	1		2
	1		7
3				has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest']);
4				has Value => (is => 'ro', isa => 'Int', request_name => 'value', traits => ['NameInRequest']);
5				1;
6
7				### main pod documentation begin ###
8
9				=head1 NAME
10
11				Paws::CodeDeploy::MinimumHealthyHosts
12
13				=head1 USAGE
14
15				This class represents one of two things:
16
17				=head3 Arguments in a call to a service
18
19				Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
20				Each attribute should be used as a named argument in the calls that expect this type of object.
21
22				As an example, if Att1 is expected to be a Paws::CodeDeploy::MinimumHealthyHosts object:
23
24				$service_obj->Method(Att1 => { Type => $value, ..., Value => $value });
25
26				=head3 Results returned from an API call
27
28				Use accessors for each attribute. If Att1 is expected to be an Paws::CodeDeploy::MinimumHealthyHosts object:
29
30				$result = $service_obj->Method(...);
31				$result->Att1->Type
32
33				=head1 DESCRIPTION
34
35				Information about minimum healthy instance.
36
37				=head1 ATTRIBUTES
38
39
40				=head2 Type => Str
41
42				The minimum healthy instance type:
43
44				=over
45
46				=item *
47
48				HOST_COUNT: The minimum number of healthy instance as an absolute
49				value.
50
51				=item *
52
53				FLEET_PERCENT: The minimum number of healthy instance as a percentage
54				of the total number of instance in the deployment.
55
56				=back
57
58				In an example of nine instance, if a HOST_COUNT of six is specified,
59				deploy to up to three instances at a time. The deployment will be
60				successful if six or more instances are deployed to successfully;
61				otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified,
62				deploy to up to five instance at a time. The deployment will be
63				successful if four or more instance are deployed to successfully;
64				otherwise, the deployment fails.
65
66				In a call to the get deployment configuration operation,
67				CodeDeployDefault.OneAtATime will return a minimum healthy instance
68				type of MOST_CONCURRENCY and a value of 1. This means a deployment to
69				only one instance at a time. (You cannot set the type to
70				MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition,
71				with CodeDeployDefault.OneAtATime, AWS CodeDeploy will try to ensure
72				that all instances but one are kept in a healthy state during the
73				deployment. Although this allows one instance at a time to be taken
74				offline for a new deployment, it also means that if the deployment to
75				the last instance fails, the overall deployment still succeeds.
76
77				For more information, see AWS CodeDeploy Instance Health in the I<AWS
78				CodeDeploy User Guide>.
79
80
81				=head2 Value => Int
82
83				The minimum healthy instance value.
84
85
86
87				=head1 SEE ALSO
88
89				This class forms part of L<Paws>, describing an object used in L<Paws::CodeDeploy>
90
91				=head1 BUGS and CONTRIBUTIONS
92
93				The source code is located here: https://github.com/pplu/aws-sdk-perl
94
95				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
96
97				=cut
98