« blib/lib/Paws/EC2/CancelSpotFleetRequestsSuccessItem.pm
↑ Summary
blib/lib/Paws/EC2/CapacityReservationGroup.pm »
| 1 | package Paws::EC2::CapacityReservation; | ||
| 2 | use Moose; | ||
| 3 | has AvailabilityZone => (is => 'ro', isa => 'Str', request_name => 'availabilityZone', traits => ['NameInRequest']); | ||
| 4 | has AvailabilityZoneId => (is => 'ro', isa => 'Str', request_name => 'availabilityZoneId', traits => ['NameInRequest']); | ||
| 5 | has AvailableInstanceCount => (is => 'ro', isa => 'Int', request_name => 'availableInstanceCount', traits => ['NameInRequest']); | ||
| 6 | has CapacityReservationArn => (is => 'ro', isa => 'Str', request_name => 'capacityReservationArn', traits => ['NameInRequest']); | ||
| 7 | has CapacityReservationId => (is => 'ro', isa => 'Str', request_name => 'capacityReservationId', traits => ['NameInRequest']); | ||
| 8 | has CreateDate => (is => 'ro', isa => 'Str', request_name => 'createDate', traits => ['NameInRequest']); | ||
| 9 | has EbsOptimized => (is => 'ro', isa => 'Bool', request_name => 'ebsOptimized', traits => ['NameInRequest']); | ||
| 10 | has EndDate => (is => 'ro', isa => 'Str', request_name => 'endDate', traits => ['NameInRequest']); | ||
| 11 | has EndDateType => (is => 'ro', isa => 'Str', request_name => 'endDateType', traits => ['NameInRequest']); | ||
| 12 | has EphemeralStorage => (is => 'ro', isa => 'Bool', request_name => 'ephemeralStorage', traits => ['NameInRequest']); | ||
| 13 | has InstanceMatchCriteria => (is => 'ro', isa => 'Str', request_name => 'instanceMatchCriteria', traits => ['NameInRequest']); | ||
| 14 | has InstancePlatform => (is => 'ro', isa => 'Str', request_name => 'instancePlatform', traits => ['NameInRequest']); | ||
| 15 | has InstanceType => (is => 'ro', isa => 'Str', request_name => 'instanceType', traits => ['NameInRequest']); | ||
| 16 | has OutpostArn => (is => 'ro', isa => 'Str', request_name => 'outpostArn', traits => ['NameInRequest']); | ||
| 17 | has OwnerId => (is => 'ro', isa => 'Str', request_name => 'ownerId', traits => ['NameInRequest']); | ||
| 18 | has StartDate => (is => 'ro', isa => 'Str', request_name => 'startDate', traits => ['NameInRequest']); | ||
| 19 | has State => (is => 'ro', isa => 'Str', request_name => 'state', traits => ['NameInRequest']); | ||
| 20 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Tag]', request_name => 'tagSet', traits => ['NameInRequest']); | ||
| 21 | has Tenancy => (is => 'ro', isa => 'Str', request_name => 'tenancy', traits => ['NameInRequest']); | ||
| 22 | has TotalInstanceCount => (is => 'ro', isa => 'Int', request_name => 'totalInstanceCount', traits => ['NameInRequest']); | ||
| 23 | 1; | ||
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::EC2::CapacityReservation | ||
| 30 | |||
| 31 | =head1 USAGE | ||
| 32 | |||
| 33 | This class represents one of two things: | ||
| 34 | |||
| 35 | =head3 Arguments in a call to a service | ||
| 36 | |||
| 37 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 38 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 39 | |||
| 40 | As an example, if Att1 is expected to be a Paws::EC2::CapacityReservation object: | ||
| 41 | |||
| 42 | $service_obj->Method(Att1 => { AvailabilityZone => $value, ..., TotalInstanceCount => $value }); | ||
| 43 | |||
| 44 | =head3 Results returned from an API call | ||
| 45 | |||
| 46 | Use accessors for each attribute. If Att1 is expected to be an Paws::EC2::CapacityReservation object: | ||
| 47 | |||
| 48 | $result = $service_obj->Method(...); | ||
| 49 | $result->Att1->AvailabilityZone | ||
| 50 | |||
| 51 | =head1 DESCRIPTION | ||
| 52 | |||
| 53 | This class has no description | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 AvailabilityZone => Str | ||
| 59 | |||
| 60 | The Availability Zone in which the capacity is reserved. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 AvailabilityZoneId => Str | ||
| 64 | |||
| 65 | The Availability Zone ID of the Capacity Reservation. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 AvailableInstanceCount => Int | ||
| 69 | |||
| 70 | The remaining capacity. Indicates the number of instances that can be | ||
| 71 | launched in the Capacity Reservation. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 CapacityReservationArn => Str | ||
| 75 | |||
| 76 | The Amazon Resource Name (ARN) of the Capacity Reservation. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 CapacityReservationId => Str | ||
| 80 | |||
| 81 | The ID of the Capacity Reservation. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 CreateDate => Str | ||
| 85 | |||
| 86 | The date and time at which the Capacity Reservation was created. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 EbsOptimized => Bool | ||
| 90 | |||
| 91 | Indicates whether the Capacity Reservation supports EBS-optimized | ||
| 92 | instances. This optimization provides dedicated throughput to Amazon | ||
| 93 | EBS and an optimized configuration stack to provide optimal I/O | ||
| 94 | performance. This optimization isn't available with all instance types. | ||
| 95 | Additional usage charges apply when using an EBS- optimized instance. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 EndDate => Str | ||
| 99 | |||
| 100 | The date and time at which the Capacity Reservation expires. When a | ||
| 101 | Capacity Reservation expires, the reserved capacity is released and you | ||
| 102 | can no longer launch instances into it. The Capacity Reservation's | ||
| 103 | state changes to C<expired> when it reaches its end date and time. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 EndDateType => Str | ||
| 107 | |||
| 108 | Indicates the way in which the Capacity Reservation ends. A Capacity | ||
| 109 | Reservation can have one of the following end types: | ||
| 110 | |||
| 111 | =over | ||
| 112 | |||
| 113 | =item * | ||
| 114 | |||
| 115 | C<unlimited> - The Capacity Reservation remains active until you | ||
| 116 | explicitly cancel it. | ||
| 117 | |||
| 118 | =item * | ||
| 119 | |||
| 120 | C<limited> - The Capacity Reservation expires automatically at a | ||
| 121 | specified date and time. | ||
| 122 | |||
| 123 | =back | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 EphemeralStorage => Bool | ||
| 128 | |||
| 129 | Indicates whether the Capacity Reservation supports instances with | ||
| 130 | temporary, block-level storage. | ||
| 131 | |||
| 132 | |||
| 133 | =head2 InstanceMatchCriteria => Str | ||
| 134 | |||
| 135 | Indicates the type of instance launches that the Capacity Reservation | ||
| 136 | accepts. The options include: | ||
| 137 | |||
| 138 | =over | ||
| 139 | |||
| 140 | =item * | ||
| 141 | |||
| 142 | C<open> - The Capacity Reservation accepts all instances that have | ||
| 143 | matching attributes (instance type, platform, and Availability Zone). | ||
| 144 | Instances that have matching attributes launch into the Capacity | ||
| 145 | Reservation automatically without specifying any additional parameters. | ||
| 146 | |||
| 147 | =item * | ||
| 148 | |||
| 149 | C<targeted> - The Capacity Reservation only accepts instances that have | ||
| 150 | matching attributes (instance type, platform, and Availability Zone), | ||
| 151 | and explicitly target the Capacity Reservation. This ensures that only | ||
| 152 | permitted instances can use the reserved capacity. | ||
| 153 | |||
| 154 | =back | ||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head2 InstancePlatform => Str | ||
| 159 | |||
| 160 | The type of operating system for which the Capacity Reservation | ||
| 161 | reserves capacity. | ||
| 162 | |||
| 163 | |||
| 164 | =head2 InstanceType => Str | ||
| 165 | |||
| 166 | The type of instance for which the Capacity Reservation reserves | ||
| 167 | capacity. | ||
| 168 | |||
| 169 | |||
| 170 | =head2 OutpostArn => Str | ||
| 171 | |||
| 172 | The Amazon Resource Name (ARN) of the Outpost on which the Capacity | ||
| 173 | Reservation was created. | ||
| 174 | |||
| 175 | |||
| 176 | =head2 OwnerId => Str | ||
| 177 | |||
| 178 | The ID of the account that owns the Capacity Reservation. | ||
| 179 | |||
| 180 | |||
| 181 | =head2 StartDate => Str | ||
| 182 | |||
| 183 | The date and time at which the Capacity Reservation was started. | ||
| 184 | |||
| 185 | |||
| 186 | =head2 State => Str | ||
| 187 | |||
| 188 | The current state of the Capacity Reservation. A Capacity Reservation | ||
| 189 | can be in one of the following states: | ||
| 190 | |||
| 191 | =over | ||
| 192 | |||
| 193 | =item * | ||
| 194 | |||
| 195 | C<active> - The Capacity Reservation is active and the capacity is | ||
| 196 | available for your use. | ||
| 197 | |||
| 198 | =item * | ||
| 199 | |||
| 200 | C<expired> - The Capacity Reservation expired automatically at the date | ||
| 201 | and time specified in your request. The reserved capacity is no longer | ||
| 202 | available for your use. | ||
| 203 | |||
| 204 | =item * | ||
| 205 | |||
| 206 | C<cancelled> - The Capacity Reservation was cancelled. The reserved | ||
| 207 | capacity is no longer available for your use. | ||
| 208 | |||
| 209 | =item * | ||
| 210 | |||
| 211 | C<pending> - The Capacity Reservation request was successful but the | ||
| 212 | capacity provisioning is still pending. | ||
| 213 | |||
| 214 | =item * | ||
| 215 | |||
| 216 | C<failed> - The Capacity Reservation request has failed. A request | ||
| 217 | might fail due to invalid request parameters, capacity constraints, or | ||
| 218 | instance limit constraints. Failed requests are retained for 60 | ||
| 219 | minutes. | ||
| 220 | |||
| 221 | =back | ||
| 222 | |||
| 223 | |||
| 224 | |||
| 225 | =head2 Tags => ArrayRef[L<Paws::EC2::Tag>] | ||
| 226 | |||
| 227 | Any tags assigned to the Capacity Reservation. | ||
| 228 | |||
| 229 | |||
| 230 | =head2 Tenancy => Str | ||
| 231 | |||
| 232 | Indicates the tenancy of the Capacity Reservation. A Capacity | ||
| 233 | Reservation can have one of the following tenancy settings: | ||
| 234 | |||
| 235 | =over | ||
| 236 | |||
| 237 | =item * | ||
| 238 | |||
| 239 | C<default> - The Capacity Reservation is created on hardware that is | ||
| 240 | shared with other accounts. | ||
| 241 | |||
| 242 | =item * | ||
| 243 | |||
| 244 | C<dedicated> - The Capacity Reservation is created on single-tenant | ||
| 245 | hardware that is dedicated to a single account. | ||
| 246 | |||
| 247 | =back | ||
| 248 | |||
| 249 | |||
| 250 | |||
| 251 | =head2 TotalInstanceCount => Int | ||
| 252 | |||
| 253 | The total number of instances for which the Capacity Reservation | ||
| 254 | reserves capacity. | ||
| 255 | |||
| 256 | |||
| 257 | |||
| 258 | =head1 SEE ALSO | ||
| 259 | |||
| 260 | This class forms part of L<Paws>, describing an object used in L<Paws::EC2> | ||
| 261 | |||
| 262 | =head1 BUGS and CONTRIBUTIONS | ||
| 263 | |||
| 264 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 265 | |||
| 266 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 267 | |||
| 268 | =cut |