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

filter: Statementstmt 0.0% 0 / 24 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 26 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::EC2::CreateFleet;
3 use Moose;
4 has ClientToken => (is => 'ro', isa => 'Str');
5 has Context => (is => 'ro', isa => 'Str');
6 has DryRun => (is => 'ro', isa => 'Bool');
7 has ExcessCapacityTerminationPolicy => (is => 'ro', isa => 'Str');
8 has LaunchTemplateConfigs => (is => 'ro', isa => 'ArrayRef[Paws::EC2::FleetLaunchTemplateConfigRequest]', required => 1);
9 has OnDemandOptions => (is => 'ro', isa => 'Paws::EC2::OnDemandOptionsRequest');
10 has ReplaceUnhealthyInstances => (is => 'ro', isa => 'Bool');
11 has SpotOptions => (is => 'ro', isa => 'Paws::EC2::SpotOptionsRequest');
12 has TagSpecifications => (is => 'ro', isa => 'ArrayRef[Paws::EC2::TagSpecification]', traits => ['NameInRequest'], request_name => 'TagSpecification' );
13 has TargetCapacitySpecification => (is => 'ro', isa => 'Paws::EC2::TargetCapacitySpecificationRequest', required => 1);
14 has TerminateInstancesWithExpiration => (is => 'ro', isa => 'Bool');
15 has Type => (is => 'ro', isa => 'Str');
16 has ValidFrom => (is => 'ro', isa => 'Str');
17 has ValidUntil => (is => 'ro', isa => 'Str');
18  
19 use MooseX::ClassAttribute;
20  
21 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateFleet');
22 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::CreateFleetResult');
23 class_has _result_key => (isa => 'Str', is => 'ro');
24 1;
25  
26 ### main pod documentation begin ###
27  
28 =head1 NAME
29  
30 Paws::EC2::CreateFleet - Arguments for method CreateFleet on L<Paws::EC2>
31  
32 =head1 DESCRIPTION
33  
34 This class represents the parameters used for calling the method CreateFleet on the
35 L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class
36 as arguments to method CreateFleet.
37  
38 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFleet.
39  
40 =head1 SYNOPSIS
41  
42 my $ec2 = Paws->service('EC2');
43 my $CreateFleetResult = $ec2->CreateFleet(
44 LaunchTemplateConfigs => [
45 {
46 LaunchTemplateSpecification => {
47 LaunchTemplateId => 'MyLaunchTemplateId', # OPTIONAL
48 LaunchTemplateName =>
49 'MyLaunchTemplateName', # min: 3, max: 128; OPTIONAL
50 Version => 'MyString', # OPTIONAL
51 }, # OPTIONAL
52 Overrides => [
53 {
54 AvailabilityZone => 'MyString', # OPTIONAL
55 InstanceType => 't1.micro'
56 , # values: t1.micro, t2.nano, t2.micro, t2.small, t2.medium, t2.large, t2.xlarge, t2.2xlarge, t3.nano, t3.micro, t3.small, t3.medium, t3.large, t3.xlarge, t3.2xlarge, t3a.nano, t3a.micro, t3a.small, t3a.medium, t3a.large, t3a.xlarge, t3a.2xlarge, t4g.nano, t4g.micro, t4g.small, t4g.medium, t4g.large, t4g.xlarge, t4g.2xlarge, m1.small, m1.medium, m1.large, m1.xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge, m4.16xlarge, m2.xlarge, m2.2xlarge, m2.4xlarge, cr1.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, r5.large, r5.xlarge, r5.2xlarge, r5.4xlarge, r5.8xlarge, r5.12xlarge, r5.16xlarge, r5.24xlarge, r5.metal, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, r5b.large, r5b.xlarge, r5b.2xlarge, r5b.4xlarge, r5b.8xlarge, r5b.12xlarge, r5b.16xlarge, r5b.24xlarge, r5b.metal, r5d.large, r5d.xlarge, r5d.2xlarge, r5d.4xlarge, r5d.8xlarge, r5d.12xlarge, r5d.16xlarge, r5d.24xlarge, r5d.metal, r5ad.large, r5ad.xlarge, r5ad.2xlarge, r5ad.4xlarge, r5ad.8xlarge, r5ad.12xlarge, r5ad.16xlarge, r5ad.24xlarge, r6g.metal, r6g.medium, r6g.large, r6g.xlarge, r6g.2xlarge, r6g.4xlarge, r6g.8xlarge, r6g.12xlarge, r6g.16xlarge, r6gd.metal, r6gd.medium, r6gd.large, r6gd.xlarge, r6gd.2xlarge, r6gd.4xlarge, r6gd.8xlarge, r6gd.12xlarge, r6gd.16xlarge, x1.16xlarge, x1.32xlarge, x1e.xlarge, x1e.2xlarge, x1e.4xlarge, x1e.8xlarge, x1e.16xlarge, x1e.32xlarge, i2.xlarge, i2.2xlarge, i2.4xlarge, i2.8xlarge, i3.large, i3.xlarge, i3.2xlarge, i3.4xlarge, i3.8xlarge, i3.16xlarge, i3.metal, i3en.large, i3en.xlarge, i3en.2xlarge, i3en.3xlarge, i3en.6xlarge, i3en.12xlarge, i3en.24xlarge, i3en.metal, hi1.4xlarge, hs1.8xlarge, c1.medium, c1.xlarge, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, c5.large, c5.xlarge, c5.2xlarge, c5.4xlarge, c5.9xlarge, c5.12xlarge, c5.18xlarge, c5.24xlarge, c5.metal, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, c5ad.large, c5ad.xlarge, c5ad.2xlarge, c5ad.4xlarge, c5ad.8xlarge, c5ad.12xlarge, c5ad.16xlarge, c5ad.24xlarge, c5d.large, c5d.xlarge, c5d.2xlarge, c5d.4xlarge, c5d.9xlarge, c5d.12xlarge, c5d.18xlarge, c5d.24xlarge, c5d.metal, c5n.large, c5n.xlarge, c5n.2xlarge, c5n.4xlarge, c5n.9xlarge, c5n.18xlarge, c5n.metal, c6g.metal, c6g.medium, c6g.large, c6g.xlarge, c6g.2xlarge, c6g.4xlarge, c6g.8xlarge, c6g.12xlarge, c6g.16xlarge, c6gd.metal, c6gd.medium, c6gd.large, c6gd.xlarge, c6gd.2xlarge, c6gd.4xlarge, c6gd.8xlarge, c6gd.12xlarge, c6gd.16xlarge, c6gn.medium, c6gn.large, c6gn.xlarge, c6gn.2xlarge, c6gn.4xlarge, c6gn.8xlarge, c6gn.12xlarge, c6gn.16xlarge, cc1.4xlarge, cc2.8xlarge, g2.2xlarge, g2.8xlarge, g3.4xlarge, g3.8xlarge, g3.16xlarge, g3s.xlarge, g4ad.4xlarge, g4ad.8xlarge, g4ad.16xlarge, g4dn.xlarge, g4dn.2xlarge, g4dn.4xlarge, g4dn.8xlarge, g4dn.12xlarge, g4dn.16xlarge, g4dn.metal, cg1.4xlarge, p2.xlarge, p2.8xlarge, p2.16xlarge, p3.2xlarge, p3.8xlarge, p3.16xlarge, p3dn.24xlarge, p4d.24xlarge, d2.xlarge, d2.2xlarge, d2.4xlarge, d2.8xlarge, d3.xlarge, d3.2xlarge, d3.4xlarge, d3.8xlarge, d3en.xlarge, d3en.2xlarge, d3en.4xlarge, d3en.6xlarge, d3en.8xlarge, d3en.12xlarge, f1.2xlarge, f1.4xlarge, f1.16xlarge, m5.large, m5.xlarge, m5.2xlarge, m5.4xlarge, m5.8xlarge, m5.12xlarge, m5.16xlarge, m5.24xlarge, m5.metal, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge, m5d.large, m5d.xlarge, m5d.2xlarge, m5d.4xlarge, m5d.8xlarge, m5d.12xlarge, m5d.16xlarge, m5d.24xlarge, m5d.metal, m5ad.large, m5ad.xlarge, m5ad.2xlarge, m5ad.4xlarge, m5ad.8xlarge, m5ad.12xlarge, m5ad.16xlarge, m5ad.24xlarge, m5zn.large, m5zn.xlarge, m5zn.2xlarge, m5zn.3xlarge, m5zn.6xlarge, m5zn.12xlarge, m5zn.metal, h1.2xlarge, h1.4xlarge, h1.8xlarge, h1.16xlarge, z1d.large, z1d.xlarge, z1d.2xlarge, z1d.3xlarge, z1d.6xlarge, z1d.12xlarge, z1d.metal, u-6tb1.56xlarge, u-6tb1.112xlarge, u-9tb1.112xlarge, u-12tb1.112xlarge, u-6tb1.metal, u-9tb1.metal, u-12tb1.metal, u-18tb1.metal, u-24tb1.metal, a1.medium, a1.large, a1.xlarge, a1.2xlarge, a1.4xlarge, a1.metal, m5dn.large, m5dn.xlarge, m5dn.2xlarge, m5dn.4xlarge, m5dn.8xlarge, m5dn.12xlarge, m5dn.16xlarge, m5dn.24xlarge, m5dn.metal, m5n.large, m5n.xlarge, m5n.2xlarge, m5n.4xlarge, m5n.8xlarge, m5n.12xlarge, m5n.16xlarge, m5n.24xlarge, m5n.metal, r5dn.large, r5dn.xlarge, r5dn.2xlarge, r5dn.4xlarge, r5dn.8xlarge, r5dn.12xlarge, r5dn.16xlarge, r5dn.24xlarge, r5dn.metal, r5n.large, r5n.xlarge, r5n.2xlarge, r5n.4xlarge, r5n.8xlarge, r5n.12xlarge, r5n.16xlarge, r5n.24xlarge, r5n.metal, inf1.xlarge, inf1.2xlarge, inf1.6xlarge, inf1.24xlarge, m6g.metal, m6g.medium, m6g.large, m6g.xlarge, m6g.2xlarge, m6g.4xlarge, m6g.8xlarge, m6g.12xlarge, m6g.16xlarge, m6gd.metal, m6gd.medium, m6gd.large, m6gd.xlarge, m6gd.2xlarge, m6gd.4xlarge, m6gd.8xlarge, m6gd.12xlarge, m6gd.16xlarge, mac1.metal, x2gd.medium, x2gd.large, x2gd.xlarge, x2gd.2xlarge, x2gd.4xlarge, x2gd.8xlarge, x2gd.12xlarge, x2gd.16xlarge, x2gd.metal; OPTIONAL
57 MaxPrice => 'MyString', # OPTIONAL
58 Placement => {
59 Affinity => 'MyString', # OPTIONAL
60 AvailabilityZone => 'MyString', # OPTIONAL
61 GroupName => 'MyString', # OPTIONAL
62 HostId => 'MyString', # OPTIONAL
63 HostResourceGroupArn => 'MyString', # OPTIONAL
64 PartitionNumber => 1, # OPTIONAL
65 SpreadDomain => 'MyString', # OPTIONAL
66 Tenancy =>
67 'default', # values: default, dedicated, host; OPTIONAL
68 }, # OPTIONAL
69 Priority => 1, # OPTIONAL
70 SubnetId => 'MySubnetId', # OPTIONAL
71 WeightedCapacity => 1, # OPTIONAL
72 },
73 ...
74 ], # OPTIONAL
75 },
76 ...
77 ],
78 TargetCapacitySpecification => {
79 TotalTargetCapacity => 1, # OPTIONAL
80 DefaultTargetCapacityType => 'spot', # values: spot, on-demand; OPTIONAL
81 OnDemandTargetCapacity => 1, # OPTIONAL
82 SpotTargetCapacity => 1, # OPTIONAL
83 },
84 ClientToken => 'MyString', # OPTIONAL
85 Context => 'MyString', # OPTIONAL
86 DryRun => 1, # OPTIONAL
87 ExcessCapacityTerminationPolicy => 'no-termination', # OPTIONAL
88 OnDemandOptions => {
89 AllocationStrategy =>
90 'lowest-price', # values: lowest-price, prioritized; OPTIONAL
91 CapacityReservationOptions => {
92 UsageStrategy => 'use-capacity-reservations-first'
93 , # values: use-capacity-reservations-first; OPTIONAL
94 }, # OPTIONAL
95 MaxTotalPrice => 'MyString', # OPTIONAL
96 MinTargetCapacity => 1, # OPTIONAL
97 SingleAvailabilityZone => 1,
98 SingleInstanceType => 1,
99 }, # OPTIONAL
100 ReplaceUnhealthyInstances => 1, # OPTIONAL
101 SpotOptions => {
102 AllocationStrategy => 'lowest-price'
103 , # values: lowest-price, diversified, capacity-optimized, capacity-optimized-prioritized; OPTIONAL
104 InstanceInterruptionBehavior =>
105 'hibernate', # values: hibernate, stop, terminate; OPTIONAL
106 InstancePoolsToUseCount => 1, # OPTIONAL
107 MaintenanceStrategies => {
108 CapacityRebalance => {
109 ReplacementStrategy => 'launch', # values: launch; OPTIONAL
110 }, # OPTIONAL
111 }, # OPTIONAL
112 MaxTotalPrice => 'MyString', # OPTIONAL
113 MinTargetCapacity => 1, # OPTIONAL
114 SingleAvailabilityZone => 1,
115 SingleInstanceType => 1,
116 }, # OPTIONAL
117 TagSpecifications => [
118 {
119 ResourceType => 'client-vpn-endpoint'
120 , # values: client-vpn-endpoint, customer-gateway, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, internet-gateway, key-pair, launch-template, local-gateway-route-table-vpc-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, placement-group, reserved-instances, route-table, security-group, snapshot, spot-fleet-request, spot-instances-request, subnet, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-route-table, volume, vpc, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log; OPTIONAL
121 Tags => [
122 {
123 Key => 'MyString', # OPTIONAL
124 Value => 'MyString', # OPTIONAL
125 },
126 ...
127 ], # OPTIONAL
128 },
129 ...
130 ], # OPTIONAL
131 TerminateInstancesWithExpiration => 1, # OPTIONAL
132 Type => 'request', # OPTIONAL
133 ValidFrom => '1970-01-01T01:00:00', # OPTIONAL
134 ValidUntil => '1970-01-01T01:00:00', # OPTIONAL
135 );
136  
137 # Results:
138 my $Errors = $CreateFleetResult->Errors;
139 my $FleetId = $CreateFleetResult->FleetId;
140 my $Instances = $CreateFleetResult->Instances;
141  
142 # Returns a L<Paws::EC2::CreateFleetResult> object.
143  
144 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
145 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/CreateFleet>
146  
147 =head1 ATTRIBUTES
148  
149  
150 =head2 ClientToken => Str
151  
152 Unique, case-sensitive identifier that you provide to ensure the
153 idempotency of the request. For more information, see Ensuring
154 Idempotency
155 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
156  
157  
158  
159 =head2 Context => Str
160  
161 Reserved.
162  
163  
164  
165 =head2 DryRun => Bool
166  
167 Checks whether you have the required permissions for the action,
168 without actually making the request, and provides an error response. If
169 you have the required permissions, the error response is
170 C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
171  
172  
173  
174 =head2 ExcessCapacityTerminationPolicy => Str
175  
176 Indicates whether running instances should be terminated if the total
177 target capacity of the EC2 Fleet is decreased below the current size of
178 the EC2 Fleet.
179  
180 Valid values are: C<"no-termination">, C<"termination">
181  
182 =head2 B<REQUIRED> LaunchTemplateConfigs => ArrayRef[L<Paws::EC2::FleetLaunchTemplateConfigRequest>]
183  
184 The configuration for the EC2 Fleet.
185  
186  
187  
188 =head2 OnDemandOptions => L<Paws::EC2::OnDemandOptionsRequest>
189  
190 Describes the configuration of On-Demand Instances in an EC2 Fleet.
191  
192  
193  
194 =head2 ReplaceUnhealthyInstances => Bool
195  
196 Indicates whether EC2 Fleet should replace unhealthy Spot Instances.
197 Supported only for fleets of type C<maintain>. For more information,
198 see EC2 Fleet health checks
199 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#ec2-fleet-health-checks)
200 in the I<Amazon EC2 User Guide>.
201  
202  
203  
204 =head2 SpotOptions => L<Paws::EC2::SpotOptionsRequest>
205  
206 Describes the configuration of Spot Instances in an EC2 Fleet.
207  
208  
209  
210 =head2 TagSpecifications => ArrayRef[L<Paws::EC2::TagSpecification>]
211  
212 The key-value pair for tagging the EC2 Fleet request on creation. For
213 more information, see Tagging your resources
214 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources).
215  
216 If the fleet type is C<instant>, specify a resource type of C<fleet> to
217 tag the fleet or C<instance> to tag the instances at launch.
218  
219 If the fleet type is C<maintain> or C<request>, specify a resource type
220 of C<fleet> to tag the fleet. You cannot specify a resource type of
221 C<instance>. To tag instances at launch, specify the tags in a launch
222 template
223 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template).
224  
225  
226  
227 =head2 B<REQUIRED> TargetCapacitySpecification => L<Paws::EC2::TargetCapacitySpecificationRequest>
228  
229 The number of units to request.
230  
231  
232  
233 =head2 TerminateInstancesWithExpiration => Bool
234  
235 Indicates whether running instances should be terminated when the EC2
236 Fleet expires.
237  
238  
239  
240 =head2 Type => Str
241  
242 The fleet type. The default value is C<maintain>.
243  
244 =over
245  
246 =item *
247  
248 C<maintain> - The EC2 Fleet places an asynchronous request for your
249 desired capacity, and continues to maintain your desired Spot capacity
250 by replenishing interrupted Spot Instances.
251  
252 =item *
253  
254 C<request> - The EC2 Fleet places an asynchronous one-time request for
255 your desired capacity, but does submit Spot requests in alternative
256 capacity pools if Spot capacity is unavailable, and does not maintain
257 Spot capacity if Spot Instances are interrupted.
258  
259 =item *
260  
261 C<instant> - The EC2 Fleet places a synchronous one-time request for
262 your desired capacity, and returns errors for any instances that could
263 not be launched.
264  
265 =back
266  
267 For more information, see EC2 Fleet request types
268 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-configuration-strategies.html#ec2-fleet-request-type)
269 in the I<Amazon EC2 User Guide>.
270  
271 Valid values are: C<"request">, C<"maintain">, C<"instant">
272  
273 =head2 ValidFrom => Str
274  
275 The start date and time of the request, in UTC format (for example,
276 I<YYYY>-I<MM>-I<DD>TI<HH>:I<MM>:I<SS>Z). The default is to start
277 fulfilling the request immediately.
278  
279  
280  
281 =head2 ValidUntil => Str
282  
283 The end date and time of the request, in UTC format (for example,
284 I<YYYY>-I<MM>-I<DD>TI<HH>:I<MM>:I<SS>Z). At this point, no new EC2
285 Fleet requests are placed or able to fulfill the request. If no value
286 is specified, the request remains until you cancel it.
287  
288  
289  
290  
291 =head1 SEE ALSO
292  
293 This class forms part of L<Paws>, documenting arguments for method CreateFleet in L<Paws::EC2>
294  
295 =head1 BUGS and CONTRIBUTIONS
296  
297 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
298  
299 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
300  
301 =cut
302