« blib/lib/Paws/EC2/DescribeInstanceTypeOfferingsResult.pm
↑ Summary
blib/lib/Paws/EC2/DescribeInstanceTypesResult.pm »
| 1 | |||
| 2 | package Paws::EC2::DescribeInstanceTypes; | ||
| 3 | use Moose; | ||
| 4 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 5 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' ); | ||
| 6 | has InstanceTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'InstanceType' ); | ||
| 7 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 8 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeInstanceTypes'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeInstanceTypesResult'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::EC2::DescribeInstanceTypes - Arguments for method DescribeInstanceTypes on L<Paws::EC2> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeInstanceTypes on the | ||
| 26 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribeInstanceTypes. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeInstanceTypes. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $ec2 = Paws->service('EC2'); | ||
| 34 | my $DescribeInstanceTypesResult = $ec2->DescribeInstanceTypes( | ||
| 35 | DryRun => 1, # OPTIONAL | ||
| 36 | Filters => [ | ||
| 37 | { | ||
| 38 | Name => 'MyString', # OPTIONAL | ||
| 39 | Values => [ | ||
| 40 | 'MyString', ... # OPTIONAL | ||
| 41 | ], # OPTIONAL | ||
| 42 | }, | ||
| 43 | ... | ||
| 44 | ], # OPTIONAL | ||
| 45 | InstanceTypes => [ | ||
| 46 | 't1.micro', | ||
| 47 | ... # 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 | ||
| 48 | ], # OPTIONAL | ||
| 49 | MaxResults => 1, # OPTIONAL | ||
| 50 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 51 | ); | ||
| 52 | |||
| 53 | # Results: | ||
| 54 | my $InstanceTypes = $DescribeInstanceTypesResult->InstanceTypes; | ||
| 55 | my $NextToken = $DescribeInstanceTypesResult->NextToken; | ||
| 56 | |||
| 57 | # Returns a L<Paws::EC2::DescribeInstanceTypesResult> object. | ||
| 58 | |||
| 59 | 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. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeInstanceTypes> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 DryRun => Bool | ||
| 66 | |||
| 67 | Checks whether you have the required permissions for the action, | ||
| 68 | without actually making the request, and provides an error response. If | ||
| 69 | you have the required permissions, the error response is | ||
| 70 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 Filters => ArrayRef[L<Paws::EC2::Filter>] | ||
| 75 | |||
| 76 | One or more filters. Filter names and values are case-sensitive. | ||
| 77 | |||
| 78 | =over | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | C<auto-recovery-supported> - Indicates whether auto recovery is | ||
| 83 | supported (C<true> | C<false>). | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | C<bare-metal> - Indicates whether it is a bare metal instance type | ||
| 88 | (C<true> | C<false>). | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | C<burstable-performance-supported> - Indicates whether it is a | ||
| 93 | burstable performance instance type (C<true> | C<false>). | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | C<current-generation> - Indicates whether this instance type is the | ||
| 98 | latest generation instance type of an instance family (C<true> | | ||
| 99 | C<false>). | ||
| 100 | |||
| 101 | =item * | ||
| 102 | |||
| 103 | C<ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps> - The | ||
| 104 | baseline bandwidth performance for an EBS-optimized instance type, in | ||
| 105 | Mbps. | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | C<ebs-info.ebs-optimized-info.baseline-iops> - The baseline | ||
| 110 | input/output storage operations per second for an EBS-optimized | ||
| 111 | instance type. | ||
| 112 | |||
| 113 | =item * | ||
| 114 | |||
| 115 | C<ebs-info.ebs-optimized-info.baseline-throughput-in-mbps> - The | ||
| 116 | baseline throughput performance for an EBS-optimized instance type, in | ||
| 117 | MB/s. | ||
| 118 | |||
| 119 | =item * | ||
| 120 | |||
| 121 | C<ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps> - The maximum | ||
| 122 | bandwidth performance for an EBS-optimized instance type, in Mbps. | ||
| 123 | |||
| 124 | =item * | ||
| 125 | |||
| 126 | C<ebs-info.ebs-optimized-info.maximum-iops> - The maximum input/output | ||
| 127 | storage operations per second for an EBS-optimized instance type. | ||
| 128 | |||
| 129 | =item * | ||
| 130 | |||
| 131 | C<ebs-info.ebs-optimized-info.maximum-throughput-in-mbps> - The maximum | ||
| 132 | throughput performance for an EBS-optimized instance type, in MB/s. | ||
| 133 | |||
| 134 | =item * | ||
| 135 | |||
| 136 | C<ebs-info.ebs-optimized-support> - Indicates whether the instance type | ||
| 137 | is EBS-optimized (C<supported> | C<unsupported> | C<default>). | ||
| 138 | |||
| 139 | =item * | ||
| 140 | |||
| 141 | C<ebs-info.encryption-support> - Indicates whether EBS encryption is | ||
| 142 | supported (C<supported> | C<unsupported>). | ||
| 143 | |||
| 144 | =item * | ||
| 145 | |||
| 146 | C<ebs-info.nvme-support> - Indicates whether non-volatile memory | ||
| 147 | express (NVMe) is supported for EBS volumes (C<required> | C<supported> | ||
| 148 | | C<unsupported>). | ||
| 149 | |||
| 150 | =item * | ||
| 151 | |||
| 152 | C<free-tier-eligible> - Indicates whether the instance type is eligible | ||
| 153 | to use in the free tier (C<true> | C<false>). | ||
| 154 | |||
| 155 | =item * | ||
| 156 | |||
| 157 | C<hibernation-supported> - Indicates whether On-Demand hibernation is | ||
| 158 | supported (C<true> | C<false>). | ||
| 159 | |||
| 160 | =item * | ||
| 161 | |||
| 162 | C<hypervisor> - The hypervisor (C<nitro> | C<xen>). | ||
| 163 | |||
| 164 | =item * | ||
| 165 | |||
| 166 | C<instance-storage-info.disk.count> - The number of local disks. | ||
| 167 | |||
| 168 | =item * | ||
| 169 | |||
| 170 | C<instance-storage-info.disk.size-in-gb> - The storage size of each | ||
| 171 | instance storage disk, in GB. | ||
| 172 | |||
| 173 | =item * | ||
| 174 | |||
| 175 | C<instance-storage-info.disk.type> - The storage technology for the | ||
| 176 | local instance storage disks (C<hdd> | C<ssd>). | ||
| 177 | |||
| 178 | =item * | ||
| 179 | |||
| 180 | C<instance-storage-info.nvme-support> - Indicates whether non-volatile | ||
| 181 | memory express (NVMe) is supported for instance store (C<required> | | ||
| 182 | C<supported>) | C<unsupported>). | ||
| 183 | |||
| 184 | =item * | ||
| 185 | |||
| 186 | C<instance-storage-info.total-size-in-gb> - The total amount of storage | ||
| 187 | available from all local instance storage, in GB. | ||
| 188 | |||
| 189 | =item * | ||
| 190 | |||
| 191 | C<instance-storage-supported> - Indicates whether the instance type has | ||
| 192 | local instance storage (C<true> | C<false>). | ||
| 193 | |||
| 194 | =item * | ||
| 195 | |||
| 196 | C<instance-type> - The instance type (for example C<c5.2xlarge> or | ||
| 197 | c5*). | ||
| 198 | |||
| 199 | =item * | ||
| 200 | |||
| 201 | C<memory-info.size-in-mib> - The memory size. | ||
| 202 | |||
| 203 | =item * | ||
| 204 | |||
| 205 | C<network-info.efa-info.maximum-efa-interfaces> - The maximum number of | ||
| 206 | Elastic Fabric Adapters (EFAs) per instance. | ||
| 207 | |||
| 208 | =item * | ||
| 209 | |||
| 210 | C<network-info.efa-supported> - Indicates whether the instance type | ||
| 211 | supports Elastic Fabric Adapter (EFA) (C<true> | C<false>). | ||
| 212 | |||
| 213 | =item * | ||
| 214 | |||
| 215 | C<network-info.ena-support> - Indicates whether Elastic Network Adapter | ||
| 216 | (ENA) is supported or required (C<required> | C<supported> | | ||
| 217 | C<unsupported>). | ||
| 218 | |||
| 219 | =item * | ||
| 220 | |||
| 221 | C<network-info.ipv4-addresses-per-interface> - The maximum number of | ||
| 222 | private IPv4 addresses per network interface. | ||
| 223 | |||
| 224 | =item * | ||
| 225 | |||
| 226 | C<network-info.ipv6-addresses-per-interface> - The maximum number of | ||
| 227 | private IPv6 addresses per network interface. | ||
| 228 | |||
| 229 | =item * | ||
| 230 | |||
| 231 | C<network-info.ipv6-supported> - Indicates whether the instance type | ||
| 232 | supports IPv6 (C<true> | C<false>). | ||
| 233 | |||
| 234 | =item * | ||
| 235 | |||
| 236 | C<network-info.maximum-network-interfaces> - The maximum number of | ||
| 237 | network interfaces per instance. | ||
| 238 | |||
| 239 | =item * | ||
| 240 | |||
| 241 | C<network-info.network-performance> - The network performance (for | ||
| 242 | example, "25 Gigabit"). | ||
| 243 | |||
| 244 | =item * | ||
| 245 | |||
| 246 | C<processor-info.supported-architecture> - The CPU architecture | ||
| 247 | (C<arm64> | C<i386> | C<x86_64>). | ||
| 248 | |||
| 249 | =item * | ||
| 250 | |||
| 251 | C<processor-info.sustained-clock-speed-in-ghz> - The CPU clock speed, | ||
| 252 | in GHz. | ||
| 253 | |||
| 254 | =item * | ||
| 255 | |||
| 256 | C<supported-boot-mode> - The boot mode (C<legacy-bios> | C<uefi>). | ||
| 257 | |||
| 258 | =item * | ||
| 259 | |||
| 260 | C<supported-root-device-type> - The root device type (C<ebs> | | ||
| 261 | C<instance-store>). | ||
| 262 | |||
| 263 | =item * | ||
| 264 | |||
| 265 | C<supported-usage-class> - The usage class (C<on-demand> | C<spot>). | ||
| 266 | |||
| 267 | =item * | ||
| 268 | |||
| 269 | C<supported-virtualization-type> - The virtualization type (C<hvm> | | ||
| 270 | C<paravirtual>). | ||
| 271 | |||
| 272 | =item * | ||
| 273 | |||
| 274 | C<vcpu-info.default-cores> - The default number of cores for the | ||
| 275 | instance type. | ||
| 276 | |||
| 277 | =item * | ||
| 278 | |||
| 279 | C<vcpu-info.default-threads-per-core> - The default number of threads | ||
| 280 | per core for the instance type. | ||
| 281 | |||
| 282 | =item * | ||
| 283 | |||
| 284 | C<vcpu-info.default-vcpus> - The default number of vCPUs for the | ||
| 285 | instance type. | ||
| 286 | |||
| 287 | =item * | ||
| 288 | |||
| 289 | C<vcpu-info.valid-cores> - The number of cores that can be configured | ||
| 290 | for the instance type. | ||
| 291 | |||
| 292 | =item * | ||
| 293 | |||
| 294 | C<vcpu-info.valid-threads-per-core> - The number of threads per core | ||
| 295 | that can be configured for the instance type. For example, "1" or | ||
| 296 | "1,2". | ||
| 297 | |||
| 298 | =back | ||
| 299 | |||
| 300 | |||
| 301 | |||
| 302 | |||
| 303 | =head2 InstanceTypes => ArrayRef[Str|Undef] | ||
| 304 | |||
| 305 | The instance types. For more information, see Instance types | ||
| 306 | (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) | ||
| 307 | in the I<Amazon EC2 User Guide>. | ||
| 308 | |||
| 309 | |||
| 310 | |||
| 311 | =head2 MaxResults => Int | ||
| 312 | |||
| 313 | The maximum number of results to return for the request in a single | ||
| 314 | page. The remaining results can be seen by sending another request with | ||
| 315 | the next token value. | ||
| 316 | |||
| 317 | |||
| 318 | |||
| 319 | =head2 NextToken => Str | ||
| 320 | |||
| 321 | The token to retrieve the next page of results. | ||
| 322 | |||
| 323 | |||
| 324 | |||
| 325 | |||
| 326 | =head1 SEE ALSO | ||
| 327 | |||
| 328 | This class forms part of L<Paws>, documenting arguments for method DescribeInstanceTypes in L<Paws::EC2> | ||
| 329 | |||
| 330 | =head1 BUGS and CONTRIBUTIONS | ||
| 331 | |||
| 332 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 333 | |||
| 334 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 335 | |||
| 336 | =cut | ||
| 337 |