Class DescribeInstanceTypesRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.DescribeInstanceTypesRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeInstanceTypesRequest.Builder,DescribeInstanceTypesRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeInstanceTypesRequest extends Ec2Request implements ToCopyableBuilder<DescribeInstanceTypesRequest.Builder,DescribeInstanceTypesRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeInstanceTypesRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DescribeInstanceTypesRequest.Builder
builder()
Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
List<Filter>
filters()
One or more filters.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasFilters()
For responses, this returns true if the service returned a value for the Filters property.int
hashCode()
boolean
hasInstanceTypes()
For responses, this returns true if the service returned a value for the InstanceTypes property.List<InstanceType>
instanceTypes()
The instance types.List<String>
instanceTypesAsStrings()
The instance types.Integer
maxResults()
The maximum number of items to return for this request.String
nextToken()
The token returned from a previous paginated request.List<SdkField<?>>
sdkFields()
static Class<? extends DescribeInstanceTypesRequest.Builder>
serializableBuilderClass()
DescribeInstanceTypesRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
dryRun
public final Boolean dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
instanceTypes
public final List<InstanceType> instanceTypes()
The instance types. For more information, see Instance types in the Amazon EC2 User Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasInstanceTypes()
method.- Returns:
- The instance types. For more information, see Instance types in the Amazon EC2 User Guide.
-
hasInstanceTypes
public final boolean hasInstanceTypes()
For responses, this returns true if the service returned a value for the InstanceTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
instanceTypesAsStrings
public final List<String> instanceTypesAsStrings()
The instance types. For more information, see Instance types in the Amazon EC2 User Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasInstanceTypes()
method.- Returns:
- The instance types. For more information, see Instance types in the Amazon EC2 User Guide.
-
hasFilters
public final boolean hasFilters()
For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
filters
public final List<Filter> filters()
One or more filters. Filter names and values are case-sensitive.
-
auto-recovery-supported
- Indicates whether Amazon CloudWatch action based recovery is supported (true
|false
). -
bare-metal
- Indicates whether it is a bare metal instance type (true
|false
). -
burstable-performance-supported
- Indicates whether the instance type is a burstable performance T instance type (true
|false
). -
current-generation
- Indicates whether this instance type is the latest generation instance type of an instance family (true
|false
). -
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps
- The baseline bandwidth performance for an EBS-optimized instance type, in Mbps. -
ebs-info.ebs-optimized-info.baseline-iops
- The baseline input/output storage operations per second for an EBS-optimized instance type. -
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps
- The baseline throughput performance for an EBS-optimized instance type, in MB/s. -
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps
- The maximum bandwidth performance for an EBS-optimized instance type, in Mbps. -
ebs-info.ebs-optimized-info.maximum-iops
- The maximum input/output storage operations per second for an EBS-optimized instance type. -
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps
- The maximum throughput performance for an EBS-optimized instance type, in MB/s. -
ebs-info.ebs-optimized-support
- Indicates whether the instance type is EBS-optimized (supported
|unsupported
|default
). -
ebs-info.encryption-support
- Indicates whether EBS encryption is supported (supported
|unsupported
). -
ebs-info.nvme-support
- Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required
|supported
|unsupported
). -
free-tier-eligible
- Indicates whether the instance type is eligible to use in the free tier (true
|false
). -
hibernation-supported
- Indicates whether On-Demand hibernation is supported (true
|false
). -
hypervisor
- The hypervisor (nitro
|xen
). -
instance-storage-info.disk.count
- The number of local disks. -
instance-storage-info.disk.size-in-gb
- The storage size of each instance storage disk, in GB. -
instance-storage-info.disk.type
- The storage technology for the local instance storage disks (hdd
|ssd
). -
instance-storage-info.encryption-support
- Indicates whether data is encrypted at rest (required
|supported
|unsupported
). -
instance-storage-info.nvme-support
- Indicates whether non-volatile memory express (NVMe) is supported for instance store (required
|supported
|unsupported
). -
instance-storage-info.total-size-in-gb
- The total amount of storage available from all local instance storage, in GB. -
instance-storage-supported
- Indicates whether the instance type has local instance storage (true
|false
). -
instance-type
- The instance type (for examplec5.2xlarge
or c5*). -
memory-info.size-in-mib
- The memory size. -
network-info.efa-info.maximum-efa-interfaces
- The maximum number of Elastic Fabric Adapters (EFAs) per instance. -
network-info.efa-supported
- Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true
|false
). -
network-info.ena-support
- Indicates whether Elastic Network Adapter (ENA) is supported or required (required
|supported
|unsupported
). -
network-info.encryption-in-transit-supported
- Indicates whether the instance type automatically encrypts in-transit traffic between instances (true
|false
). -
network-info.ipv4-addresses-per-interface
- The maximum number of private IPv4 addresses per network interface. -
network-info.ipv6-addresses-per-interface
- The maximum number of private IPv6 addresses per network interface. -
network-info.ipv6-supported
- Indicates whether the instance type supports IPv6 (true
|false
). -
network-info.maximum-network-cards
- The maximum number of network cards per instance. -
network-info.maximum-network-interfaces
- The maximum number of network interfaces per instance. -
network-info.network-performance
- The network performance (for example, "25 Gigabit"). -
nitro-enclaves-support
- Indicates whether Nitro Enclaves is supported (supported
|unsupported
). -
nitro-tpm-support
- Indicates whether NitroTPM is supported (supported
|unsupported
). -
nitro-tpm-info.supported-versions
- The supported NitroTPM version (2.0
). -
processor-info.supported-architecture
- The CPU architecture (arm64
|i386
|x86_64
). -
processor-info.sustained-clock-speed-in-ghz
- The CPU clock speed, in GHz. -
processor-info.supported-features
- The supported CPU features (amd-sev-snp
). -
supported-boot-mode
- The boot mode (legacy-bios
|uefi
). -
supported-root-device-type
- The root device type (ebs
|instance-store
). -
supported-usage-class
- The usage class (on-demand
|spot
). -
supported-virtualization-type
- The virtualization type (hvm
|paravirtual
). -
vcpu-info.default-cores
- The default number of cores for the instance type. -
vcpu-info.default-threads-per-core
- The default number of threads per core for the instance type. -
vcpu-info.default-vcpus
- The default number of vCPUs for the instance type. -
vcpu-info.valid-cores
- The number of cores that can be configured for the instance type. -
vcpu-info.valid-threads-per-core
- The number of threads per core that can be configured for the instance type. For example, "1" or "1,2".
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFilters()
method.- Returns:
- One or more filters. Filter names and values are case-sensitive.
-
auto-recovery-supported
- Indicates whether Amazon CloudWatch action based recovery is supported (true
|false
). -
bare-metal
- Indicates whether it is a bare metal instance type (true
|false
). -
burstable-performance-supported
- Indicates whether the instance type is a burstable performance T instance type (true
|false
). -
current-generation
- Indicates whether this instance type is the latest generation instance type of an instance family (true
|false
). -
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps
- The baseline bandwidth performance for an EBS-optimized instance type, in Mbps. -
ebs-info.ebs-optimized-info.baseline-iops
- The baseline input/output storage operations per second for an EBS-optimized instance type. -
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps
- The baseline throughput performance for an EBS-optimized instance type, in MB/s. -
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps
- The maximum bandwidth performance for an EBS-optimized instance type, in Mbps. -
ebs-info.ebs-optimized-info.maximum-iops
- The maximum input/output storage operations per second for an EBS-optimized instance type. -
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps
- The maximum throughput performance for an EBS-optimized instance type, in MB/s. -
ebs-info.ebs-optimized-support
- Indicates whether the instance type is EBS-optimized (supported
|unsupported
|default
). -
ebs-info.encryption-support
- Indicates whether EBS encryption is supported (supported
|unsupported
). -
ebs-info.nvme-support
- Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required
|supported
|unsupported
). -
free-tier-eligible
- Indicates whether the instance type is eligible to use in the free tier (true
|false
). -
hibernation-supported
- Indicates whether On-Demand hibernation is supported (true
|false
). -
hypervisor
- The hypervisor (nitro
|xen
). -
instance-storage-info.disk.count
- The number of local disks. -
instance-storage-info.disk.size-in-gb
- The storage size of each instance storage disk, in GB. -
instance-storage-info.disk.type
- The storage technology for the local instance storage disks (hdd
|ssd
). -
instance-storage-info.encryption-support
- Indicates whether data is encrypted at rest (required
|supported
|unsupported
). -
instance-storage-info.nvme-support
- Indicates whether non-volatile memory express (NVMe) is supported for instance store (required
|supported
|unsupported
). -
instance-storage-info.total-size-in-gb
- The total amount of storage available from all local instance storage, in GB. -
instance-storage-supported
- Indicates whether the instance type has local instance storage (true
|false
). -
instance-type
- The instance type (for examplec5.2xlarge
or c5*). -
memory-info.size-in-mib
- The memory size. -
network-info.efa-info.maximum-efa-interfaces
- The maximum number of Elastic Fabric Adapters (EFAs) per instance. -
network-info.efa-supported
- Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true
|false
). -
network-info.ena-support
- Indicates whether Elastic Network Adapter (ENA) is supported or required (required
|supported
|unsupported
). -
network-info.encryption-in-transit-supported
- Indicates whether the instance type automatically encrypts in-transit traffic between instances (true
|false
). -
network-info.ipv4-addresses-per-interface
- The maximum number of private IPv4 addresses per network interface. -
network-info.ipv6-addresses-per-interface
- The maximum number of private IPv6 addresses per network interface. -
network-info.ipv6-supported
- Indicates whether the instance type supports IPv6 (true
|false
). -
network-info.maximum-network-cards
- The maximum number of network cards per instance. -
network-info.maximum-network-interfaces
- The maximum number of network interfaces per instance. -
network-info.network-performance
- The network performance (for example, "25 Gigabit"). -
nitro-enclaves-support
- Indicates whether Nitro Enclaves is supported (supported
|unsupported
). -
nitro-tpm-support
- Indicates whether NitroTPM is supported (supported
|unsupported
). -
nitro-tpm-info.supported-versions
- The supported NitroTPM version (2.0
). -
processor-info.supported-architecture
- The CPU architecture (arm64
|i386
|x86_64
). -
processor-info.sustained-clock-speed-in-ghz
- The CPU clock speed, in GHz. -
processor-info.supported-features
- The supported CPU features (amd-sev-snp
). -
supported-boot-mode
- The boot mode (legacy-bios
|uefi
). -
supported-root-device-type
- The root device type (ebs
|instance-store
). -
supported-usage-class
- The usage class (on-demand
|spot
). -
supported-virtualization-type
- The virtualization type (hvm
|paravirtual
). -
vcpu-info.default-cores
- The default number of cores for the instance type. -
vcpu-info.default-threads-per-core
- The default number of threads per core for the instance type. -
vcpu-info.default-vcpus
- The default number of vCPUs for the instance type. -
vcpu-info.valid-cores
- The number of cores that can be configured for the instance type. -
vcpu-info.valid-threads-per-core
- The number of threads per core that can be configured for the instance type. For example, "1" or "1,2".
-
-
-
maxResults
public final Integer maxResults()
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
- Returns:
- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
-
nextToken
public final String nextToken()
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
- Returns:
- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
-
toBuilder
public DescribeInstanceTypesRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeInstanceTypesRequest.Builder,DescribeInstanceTypesRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static DescribeInstanceTypesRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeInstanceTypesRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-