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

filter: Statementstmt 0.0% 0 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 18 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::EC2::PurchaseHostReservation;
3 use Moose;
4 has ClientToken => (is => 'ro', isa => 'Str');
5 has CurrencyCode => (is => 'ro', isa => 'Str');
6 has HostIdSet => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1);
7 has LimitPrice => (is => 'ro', isa => 'Str');
8 has OfferingId => (is => 'ro', isa => 'Str', required => 1);
9 has TagSpecifications => (is => 'ro', isa => 'ArrayRef[Paws::EC2::TagSpecification]', traits => ['NameInRequest'], request_name => 'TagSpecification' );
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'PurchaseHostReservation');
14 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::PurchaseHostReservationResult');
15 class_has _result_key => (isa => 'Str', is => 'ro');
16 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::EC2::PurchaseHostReservation - Arguments for method PurchaseHostReservation on L<Paws::EC2>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method PurchaseHostReservation on the
27 L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class
28 as arguments to method PurchaseHostReservation.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PurchaseHostReservation.
31  
32 =head1 SYNOPSIS
33  
34 my $ec2 = Paws->service('EC2');
35 my $PurchaseHostReservationResult = $ec2->PurchaseHostReservation(
36 HostIdSet => [ 'MyDedicatedHostId', ... ],
37 OfferingId => 'MyOfferingId',
38 ClientToken => 'MyString', # OPTIONAL
39 CurrencyCode => 'USD', # OPTIONAL
40 LimitPrice => 'MyString', # OPTIONAL
41 TagSpecifications => [
42 {
43 ResourceType => 'client-vpn-endpoint'
44 , # 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
45 Tags => [
46 {
47 Key => 'MyString',
48 Value => 'MyString',
49 },
50 ...
51 ], # OPTIONAL
52 },
53 ...
54 ], # OPTIONAL
55 );
56  
57 # Results:
58 my $ClientToken = $PurchaseHostReservationResult->ClientToken;
59 my $CurrencyCode = $PurchaseHostReservationResult->CurrencyCode;
60 my $Purchase = $PurchaseHostReservationResult->Purchase;
61 my $TotalHourlyPrice = $PurchaseHostReservationResult->TotalHourlyPrice;
62 my $TotalUpfrontPrice = $PurchaseHostReservationResult->TotalUpfrontPrice;
63  
64 # Returns a L<Paws::EC2::PurchaseHostReservationResult> object.
65  
66 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.
67 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/PurchaseHostReservation>
68  
69 =head1 ATTRIBUTES
70  
71  
72 =head2 ClientToken => Str
73  
74 Unique, case-sensitive identifier that you provide to ensure the
75 idempotency of the request. For more information, see Ensuring
76 Idempotency
77 (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
78  
79  
80  
81 =head2 CurrencyCode => Str
82  
83 The currency in which the C<totalUpfrontPrice>, C<LimitPrice>, and
84 C<totalHourlyPrice> amounts are specified. At this time, the only
85 supported currency is C<USD>.
86  
87 Valid values are: C<"USD">
88  
89 =head2 B<REQUIRED> HostIdSet => ArrayRef[Str|Undef]
90  
91 The IDs of the Dedicated Hosts with which the reservation will be
92 associated.
93  
94  
95  
96 =head2 LimitPrice => Str
97  
98 The specified limit is checked against the total upfront cost of the
99 reservation (calculated as the offering's upfront cost multiplied by
100 the host count). If the total upfront cost is greater than the
101 specified price limit, the request fails. This is used to ensure that
102 the purchase does not exceed the expected upfront cost of the purchase.
103 At this time, the only supported currency is C<USD>. For example, to
104 indicate a limit price of USD 100, specify 100.00.
105  
106  
107  
108 =head2 B<REQUIRED> OfferingId => Str
109  
110 The ID of the offering.
111  
112  
113  
114 =head2 TagSpecifications => ArrayRef[L<Paws::EC2::TagSpecification>]
115  
116 The tags to apply to the Dedicated Host Reservation during purchase.
117  
118  
119  
120  
121 =head1 SEE ALSO
122  
123 This class forms part of L<Paws>, documenting arguments for method PurchaseHostReservation in L<Paws::EC2>
124  
125 =head1 BUGS and CONTRIBUTIONS
126  
127 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
128  
129 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
130  
131 =cut
132