« blib/lib/Paws/EC2/ModifyAvailabilityZoneGroupResult.pm
↑ Summary
blib/lib/Paws/EC2/ModifyCapacityReservationResult.pm »
| 1 | |||
| 2 | package Paws::EC2::ModifyCapacityReservation; | ||
| 3 | use Moose; | ||
| 4 | has Accept => (is => 'ro', isa => 'Bool'); | ||
| 5 | has CapacityReservationId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 7 | has EndDate => (is => 'ro', isa => 'Str'); | ||
| 8 | has EndDateType => (is => 'ro', isa => 'Str'); | ||
| 9 | has InstanceCount => (is => 'ro', isa => 'Int'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyCapacityReservation'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::ModifyCapacityReservationResult'); | ||
| 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::ModifyCapacityReservation - Arguments for method ModifyCapacityReservation on L<Paws::EC2> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method ModifyCapacityReservation on the | ||
| 27 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 28 | as arguments to method ModifyCapacityReservation. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyCapacityReservation. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $ec2 = Paws->service('EC2'); | ||
| 35 | my $ModifyCapacityReservationResult = $ec2->ModifyCapacityReservation( | ||
| 36 | CapacityReservationId => 'MyCapacityReservationId', | ||
| 37 | Accept => 1, # OPTIONAL | ||
| 38 | DryRun => 1, # OPTIONAL | ||
| 39 | EndDate => '1970-01-01T01:00:00', # OPTIONAL | ||
| 40 | EndDateType => 'unlimited', # OPTIONAL | ||
| 41 | InstanceCount => 1, # OPTIONAL | ||
| 42 | ); | ||
| 43 | |||
| 44 | # Results: | ||
| 45 | my $Return = $ModifyCapacityReservationResult->Return; | ||
| 46 | |||
| 47 | # Returns a L<Paws::EC2::ModifyCapacityReservationResult> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/ModifyCapacityReservation> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 Accept => Bool | ||
| 56 | |||
| 57 | Reserved. Capacity Reservations you have created are accepted by | ||
| 58 | default. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> CapacityReservationId => Str | ||
| 63 | |||
| 64 | The ID of the Capacity Reservation. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 DryRun => Bool | ||
| 69 | |||
| 70 | Checks whether you have the required permissions for the action, | ||
| 71 | without actually making the request, and provides an error response. If | ||
| 72 | you have the required permissions, the error response is | ||
| 73 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 EndDate => Str | ||
| 78 | |||
| 79 | The date and time at which the Capacity Reservation expires. When a | ||
| 80 | Capacity Reservation expires, the reserved capacity is released and you | ||
| 81 | can no longer launch instances into it. The Capacity Reservation's | ||
| 82 | state changes to C<expired> when it reaches its end date and time. | ||
| 83 | |||
| 84 | The Capacity Reservation is cancelled within an hour from the specified | ||
| 85 | time. For example, if you specify 5/31/2019, 13:30:55, the Capacity | ||
| 86 | Reservation is guaranteed to end between 13:30:55 and 14:30:55 on | ||
| 87 | 5/31/2019. | ||
| 88 | |||
| 89 | You must provide an C<EndDate> value if C<EndDateType> is C<limited>. | ||
| 90 | Omit C<EndDate> if C<EndDateType> is C<unlimited>. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 EndDateType => Str | ||
| 95 | |||
| 96 | Indicates the way in which the Capacity Reservation ends. A Capacity | ||
| 97 | Reservation can have one of the following end types: | ||
| 98 | |||
| 99 | =over | ||
| 100 | |||
| 101 | =item * | ||
| 102 | |||
| 103 | C<unlimited> - The Capacity Reservation remains active until you | ||
| 104 | explicitly cancel it. Do not provide an C<EndDate> value if | ||
| 105 | C<EndDateType> is C<unlimited>. | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | C<limited> - The Capacity Reservation expires automatically at a | ||
| 110 | specified date and time. You must provide an C<EndDate> value if | ||
| 111 | C<EndDateType> is C<limited>. | ||
| 112 | |||
| 113 | =back | ||
| 114 | |||
| 115 | |||
| 116 | Valid values are: C<"unlimited">, C<"limited"> | ||
| 117 | |||
| 118 | =head2 InstanceCount => Int | ||
| 119 | |||
| 120 | The number of instances for which to reserve capacity. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head1 SEE ALSO | ||
| 126 | |||
| 127 | This class forms part of L<Paws>, documenting arguments for method ModifyCapacityReservation in L<Paws::EC2> | ||
| 128 | |||
| 129 | =head1 BUGS and CONTRIBUTIONS | ||
| 130 | |||
| 131 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 132 | |||
| 133 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 134 | |||
| 135 | =cut | ||
| 136 |