blib/lib/Paws/EC2/SpotFleetRequestConfigData.pm untested

filter: Statementstmt 0.0% 0 / 53 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 54 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 package Paws::EC2::SpotFleetRequestConfigData;
2 use Moose;
3 has AllocationStrategy => (is => 'ro', isa => 'Str', request_name => 'allocationStrategy', traits => ['NameInRequest']);
4 has ClientToken => (is => 'ro', isa => 'Str', request_name => 'clientToken', traits => ['NameInRequest']);
5 has Context => (is => 'ro', isa => 'Str', request_name => 'context', traits => ['NameInRequest']);
6 has ExcessCapacityTerminationPolicy => (is => 'ro', isa => 'Str', request_name => 'excessCapacityTerminationPolicy', traits => ['NameInRequest']);
7 has FulfilledCapacity => (is => 'ro', isa => 'Num', request_name => 'fulfilledCapacity', traits => ['NameInRequest']);
8 has IamFleetRole => (is => 'ro', isa => 'Str', request_name => 'iamFleetRole', traits => ['NameInRequest'], required => 1);
9 has InstanceInterruptionBehavior => (is => 'ro', isa => 'Str', request_name => 'instanceInterruptionBehavior', traits => ['NameInRequest']);
10 has InstancePoolsToUseCount => (is => 'ro', isa => 'Int', request_name => 'instancePoolsToUseCount', traits => ['NameInRequest']);
11 has LaunchSpecifications => (is => 'ro', isa => 'ArrayRef[Paws::EC2::SpotFleetLaunchSpecification]', request_name => 'launchSpecifications', traits => ['NameInRequest']);
12 has LaunchTemplateConfigs => (is => 'ro', isa => 'ArrayRef[Paws::EC2::LaunchTemplateConfig]', request_name => 'launchTemplateConfigs', traits => ['NameInRequest']);
13 has LoadBalancersConfig => (is => 'ro', isa => 'Paws::EC2::LoadBalancersConfig', request_name => 'loadBalancersConfig', traits => ['NameInRequest']);
14 has OnDemandAllocationStrategy => (is => 'ro', isa => 'Str', request_name => 'onDemandAllocationStrategy', traits => ['NameInRequest']);
15 has OnDemandFulfilledCapacity => (is => 'ro', isa => 'Num', request_name => 'onDemandFulfilledCapacity', traits => ['NameInRequest']);
16 has OnDemandMaxTotalPrice => (is => 'ro', isa => 'Str', request_name => 'onDemandMaxTotalPrice', traits => ['NameInRequest']);
17 has OnDemandTargetCapacity => (is => 'ro', isa => 'Int', request_name => 'onDemandTargetCapacity', traits => ['NameInRequest']);
18 has ReplaceUnhealthyInstances => (is => 'ro', isa => 'Bool', request_name => 'replaceUnhealthyInstances', traits => ['NameInRequest']);
19 has SpotMaintenanceStrategies => (is => 'ro', isa => 'Paws::EC2::SpotMaintenanceStrategies', request_name => 'spotMaintenanceStrategies', traits => ['NameInRequest']);
20 has SpotMaxTotalPrice => (is => 'ro', isa => 'Str', request_name => 'spotMaxTotalPrice', traits => ['NameInRequest']);
21 has SpotPrice => (is => 'ro', isa => 'Str', request_name => 'spotPrice', traits => ['NameInRequest']);
22 has TagSpecifications => (is => 'ro', isa => 'ArrayRef[Paws::EC2::TagSpecification]', request_name => 'TagSpecification', traits => ['NameInRequest']);
23 has TargetCapacity => (is => 'ro', isa => 'Int', request_name => 'targetCapacity', traits => ['NameInRequest'], required => 1);
24 has TerminateInstancesWithExpiration => (is => 'ro', isa => 'Bool', request_name => 'terminateInstancesWithExpiration', traits => ['NameInRequest']);
25 has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest']);
26 has ValidFrom => (is => 'ro', isa => 'Str', request_name => 'validFrom', traits => ['NameInRequest']);
27 has ValidUntil => (is => 'ro', isa => 'Str', request_name => 'validUntil', traits => ['NameInRequest']);
28 1;
29  
30 ### main pod documentation begin ###
31  
32 =head1 NAME
33  
34 Paws::EC2::SpotFleetRequestConfigData
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::EC2::SpotFleetRequestConfigData object:
46  
47 $service_obj->Method(Att1 => { AllocationStrategy => $value, ..., ValidUntil => $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::EC2::SpotFleetRequestConfigData object:
52  
53 $result = $service_obj->Method(...);
54 $result->Att1->AllocationStrategy
55  
56 =head1 DESCRIPTION
57  
58 This class has no description
59  
60 =head1 ATTRIBUTES
61  
62  
63 =head2 AllocationStrategy => Str
64  
65 Indicates how to allocate the target Spot Instance capacity across the
66 Spot Instance pools specified by the Spot Fleet request.
67  
68 If the allocation strategy is C<lowestPrice>, Spot Fleet launches
69 instances from the Spot Instance pools with the lowest price. This is
70 the default allocation strategy.
71  
72 If the allocation strategy is C<diversified>, Spot Fleet launches
73 instances from all the Spot Instance pools that you specify.
74  
75 If the allocation strategy is C<capacityOptimized> (recommended), Spot
76 Fleet launches instances from Spot Instance pools with optimal capacity
77 for the number of instances that are launching. To give certain
78 instance types a higher chance of launching first, use
79 C<capacityOptimizedPrioritized>. Set a priority for each instance type
80 by using the C<Priority> parameter for C<LaunchTemplateOverrides>. You
81 can assign the same priority to different C<LaunchTemplateOverrides>.
82 EC2 implements the priorities on a best-effort basis, but optimizes for
83 capacity first. C<capacityOptimizedPrioritized> is supported only if
84 your Spot Fleet uses a launch template. Note that if the
85 C<OnDemandAllocationStrategy> is set to C<prioritized>, the same
86 priority is applied when fulfilling On-Demand capacity.
87  
88  
89 =head2 ClientToken => Str
90  
91 A unique, case-sensitive identifier that you provide to ensure the
92 idempotency of your listings. This helps to avoid duplicate listings.
93 For more information, see Ensuring Idempotency
94 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
95  
96  
97 =head2 Context => Str
98  
99 Reserved.
100  
101  
102 =head2 ExcessCapacityTerminationPolicy => Str
103  
104 Indicates whether running Spot Instances should be terminated if you
105 decrease the target capacity of the Spot Fleet request below the
106 current size of the Spot Fleet.
107  
108  
109 =head2 FulfilledCapacity => Num
110  
111 The number of units fulfilled by this request compared to the set
112 target capacity. You cannot set this value.
113  
114  
115 =head2 B<REQUIRED> IamFleetRole => Str
116  
117 The Amazon Resource Name (ARN) of an Identity and Access Management
118 (IAM) role that grants the Spot Fleet the permission to request,
119 launch, terminate, and tag instances on your behalf. For more
120 information, see Spot Fleet prerequisites
121 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html#spot-fleet-prerequisites)
122 in the I<Amazon EC2 User Guide for Linux Instances>. Spot Fleet can
123 terminate Spot Instances on your behalf when you cancel its Spot Fleet
124 request using CancelSpotFleetRequests
125 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CancelSpotFleetRequests)
126 or when the Spot Fleet request expires, if you set
127 C<TerminateInstancesWithExpiration>.
128  
129  
130 =head2 InstanceInterruptionBehavior => Str
131  
132 The behavior when a Spot Instance is interrupted. The default is
133 C<terminate>.
134  
135  
136 =head2 InstancePoolsToUseCount => Int
137  
138 The number of Spot pools across which to allocate your target Spot
139 capacity. Valid only when Spot B<AllocationStrategy> is set to
140 C<lowest-price>. Spot Fleet selects the cheapest Spot pools and evenly
141 allocates your target Spot capacity across the number of Spot pools
142 that you specify.
143  
144 Note that Spot Fleet attempts to draw Spot Instances from the number of
145 pools that you specify on a best effort basis. If a pool runs out of
146 Spot capacity before fulfilling your target capacity, Spot Fleet will
147 continue to fulfill your request by drawing from the next cheapest
148 pool. To ensure that your target capacity is met, you might receive
149 Spot Instances from more than the number of pools that you specified.
150 Similarly, if most of the pools have no Spot capacity, you might
151 receive your full target capacity from fewer than the number of pools
152 that you specified.
153  
154  
155 =head2 LaunchSpecifications => ArrayRef[L<Paws::EC2::SpotFleetLaunchSpecification>]
156  
157 The launch specifications for the Spot Fleet request. If you specify
158 C<LaunchSpecifications>, you can't specify C<LaunchTemplateConfigs>. If
159 you include On-Demand capacity in your request, you must use
160 C<LaunchTemplateConfigs>.
161  
162  
163 =head2 LaunchTemplateConfigs => ArrayRef[L<Paws::EC2::LaunchTemplateConfig>]
164  
165 The launch template and overrides. If you specify
166 C<LaunchTemplateConfigs>, you can't specify C<LaunchSpecifications>. If
167 you include On-Demand capacity in your request, you must use
168 C<LaunchTemplateConfigs>.
169  
170  
171 =head2 LoadBalancersConfig => L<Paws::EC2::LoadBalancersConfig>
172  
173 One or more Classic Load Balancers and target groups to attach to the
174 Spot Fleet request. Spot Fleet registers the running Spot Instances
175 with the specified Classic Load Balancers and target groups.
176  
177 With Network Load Balancers, Spot Fleet cannot register instances that
178 have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1,
179 G1, G2, HI1, HS1, M1, M2, M3, and T1.
180  
181  
182 =head2 OnDemandAllocationStrategy => Str
183  
184 The order of the launch template overrides to use in fulfilling
185 On-Demand capacity. If you specify C<lowestPrice>, Spot Fleet uses
186 price to determine the order, launching the lowest price first. If you
187 specify C<prioritized>, Spot Fleet uses the priority that you assign to
188 each Spot Fleet launch template override, launching the highest
189 priority first. If you do not specify a value, Spot Fleet defaults to
190 C<lowestPrice>.
191  
192  
193 =head2 OnDemandFulfilledCapacity => Num
194  
195 The number of On-Demand units fulfilled by this request compared to the
196 set target On-Demand capacity.
197  
198  
199 =head2 OnDemandMaxTotalPrice => Str
200  
201 The maximum amount per hour for On-Demand Instances that you're willing
202 to pay. You can use the C<onDemandMaxTotalPrice> parameter, the
203 C<spotMaxTotalPrice> parameter, or both parameters to ensure that your
204 fleet cost does not exceed your budget. If you set a maximum price per
205 hour for the On-Demand Instances and Spot Instances in your request,
206 Spot Fleet will launch instances until it reaches the maximum amount
207 you're willing to pay. When the maximum amount you're willing to pay is
208 reached, the fleet stops launching instances even if it hasnE<rsquo>t
209 met the target capacity.
210  
211  
212 =head2 OnDemandTargetCapacity => Int
213  
214 The number of On-Demand units to request. You can choose to set the
215 target capacity in terms of instances or a performance characteristic
216 that is important to your application workload, such as vCPUs, memory,
217 or I/O. If the request type is C<maintain>, you can specify a target
218 capacity of 0 and add capacity later.
219  
220  
221 =head2 ReplaceUnhealthyInstances => Bool
222  
223 Indicates whether Spot Fleet should replace unhealthy instances.
224  
225  
226 =head2 SpotMaintenanceStrategies => L<Paws::EC2::SpotMaintenanceStrategies>
227  
228 The strategies for managing your Spot Instances that are at an elevated
229 risk of being interrupted.
230  
231  
232 =head2 SpotMaxTotalPrice => Str
233  
234 The maximum amount per hour for Spot Instances that you're willing to
235 pay. You can use the C<spotdMaxTotalPrice> parameter, the
236 C<onDemandMaxTotalPrice> parameter, or both parameters to ensure that
237 your fleet cost does not exceed your budget. If you set a maximum price
238 per hour for the On-Demand Instances and Spot Instances in your
239 request, Spot Fleet will launch instances until it reaches the maximum
240 amount you're willing to pay. When the maximum amount you're willing to
241 pay is reached, the fleet stops launching instances even if it
242 hasnE<rsquo>t met the target capacity.
243  
244  
245 =head2 SpotPrice => Str
246  
247 The maximum price per unit hour that you are willing to pay for a Spot
248 Instance. The default is the On-Demand price.
249  
250  
251 =head2 TagSpecifications => ArrayRef[L<Paws::EC2::TagSpecification>]
252  
253 The key-value pair for tagging the Spot Fleet request on creation. The
254 value for C<ResourceType> must be C<spot-fleet-request>, otherwise the
255 Spot Fleet request fails. To tag instances at launch, specify the tags
256 in the launch template
257 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template)
258 (valid only if you use C<LaunchTemplateConfigs>) or in the
259 C<SpotFleetTagSpecification>
260 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetTagSpecification.html)
261 (valid only if you use C<LaunchSpecifications>). For information about
262 tagging after launch, see Tagging Your Resources
263 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources).
264  
265  
266 =head2 B<REQUIRED> TargetCapacity => Int
267  
268 The number of units to request for the Spot Fleet. You can choose to
269 set the target capacity in terms of instances or a performance
270 characteristic that is important to your application workload, such as
271 vCPUs, memory, or I/O. If the request type is C<maintain>, you can
272 specify a target capacity of 0 and add capacity later.
273  
274  
275 =head2 TerminateInstancesWithExpiration => Bool
276  
277 Indicates whether running Spot Instances are terminated when the Spot
278 Fleet request expires.
279  
280  
281 =head2 Type => Str
282  
283 The type of request. Indicates whether the Spot Fleet only requests the
284 target capacity or also attempts to maintain it. When this value is
285 C<request>, the Spot Fleet only places the required requests. It does
286 not attempt to replenish Spot Instances if capacity is diminished, nor
287 does it submit requests in alternative Spot pools if capacity is not
288 available. When this value is C<maintain>, the Spot Fleet maintains the
289 target capacity. The Spot Fleet places the required requests to meet
290 capacity and automatically replenishes any interrupted instances.
291 Default: C<maintain>. C<instant> is listed but is not used by Spot
292 Fleet.
293  
294  
295 =head2 ValidFrom => Str
296  
297 The start date and time of the request, in UTC format
298 (I<YYYY>-I<MM>-I<DD>TI<HH>:I<MM>:I<SS>Z). By default, Amazon EC2 starts
299 fulfilling the request immediately.
300  
301  
302 =head2 ValidUntil => Str
303  
304 The end date and time of the request, in UTC format
305 (I<YYYY>-I<MM>-I<DD>TI<HH>:I<MM>:I<SS>Z). After the end date and time,
306 no new Spot Instance requests are placed or able to fulfill the
307 request. If no value is specified, the Spot Fleet request remains until
308 you cancel it.
309  
310  
311  
312 =head1 SEE ALSO
313  
314 This class forms part of L<Paws>, describing an object used in L<Paws::EC2>
315  
316 =head1 BUGS and CONTRIBUTIONS
317  
318 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
319  
320 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
321  
322 =cut