software.amazon.awssdk.services.ec2.model.DescribeInstancesRequest Maven / Gradle / Ivy
Show all versions of ec2 Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.ec2.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeInstancesRequest extends Ec2Request implements
ToCopyableBuilder {
private static final SdkField> INSTANCE_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("InstanceIds")
.getter(getter(DescribeInstancesRequest::instanceIds))
.setter(setter(Builder::instanceIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InstanceId")
.unmarshallLocationName("InstanceId").build(),
ListTrait
.builder()
.memberLocationName("InstanceId")
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("InstanceId").unmarshallLocationName("InstanceId").build())
.build()).build()).build();
private static final SdkField DRY_RUN_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("DryRun")
.getter(getter(DescribeInstancesRequest::dryRun))
.setter(setter(Builder::dryRun))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DryRun")
.unmarshallLocationName("dryRun").build()).build();
private static final SdkField> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Filters")
.getter(getter(DescribeInstancesRequest::filters))
.setter(setter(Builder::filters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Filter")
.unmarshallLocationName("Filter").build(),
ListTrait
.builder()
.memberLocationName("Filter")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Filter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Filter").unmarshallLocationName("Filter").build()).build())
.build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("NextToken")
.getter(getter(DescribeInstancesRequest::nextToken))
.setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken")
.unmarshallLocationName("nextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField
. builder(MarshallingType.INTEGER)
.memberName("MaxResults")
.getter(getter(DescribeInstancesRequest::maxResults))
.setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults")
.unmarshallLocationName("maxResults").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INSTANCE_IDS_FIELD,
DRY_RUN_FIELD, FILTERS_FIELD, NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("InstanceId", INSTANCE_IDS_FIELD);
put("DryRun", DRY_RUN_FIELD);
put("Filter", FILTERS_FIELD);
put("NextToken", NEXT_TOKEN_FIELD);
put("MaxResults", MAX_RESULTS_FIELD);
}
});
private final List instanceIds;
private final Boolean dryRun;
private final List filters;
private final String nextToken;
private final Integer maxResults;
private DescribeInstancesRequest(BuilderImpl builder) {
super(builder);
this.instanceIds = builder.instanceIds;
this.dryRun = builder.dryRun;
this.filters = builder.filters;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
}
/**
* For responses, this returns true if the service returned a value for the InstanceIds property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} 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.
*/
public final boolean hasInstanceIds() {
return instanceIds != null && !(instanceIds instanceof SdkAutoConstructList);
}
/**
*
* The instance IDs.
*
*
* Default: Describes all your instances.
*
*
* 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 {@link #hasInstanceIds} method.
*
*
* @return The instance IDs.
*
* Default: Describes all your instances.
*/
public final List instanceIds() {
return instanceIds;
}
/**
*
* Checks whether you have the required permissions for the operation, without actually making the request, and
* provides an error response. If you have the required permissions, the error response is
* DryRunOperation. Otherwise, it is UnauthorizedOperation.
*
*
* @return Checks whether you have the required permissions for the operation, without actually making the request,
* and provides an error response. If you have the required permissions, the error response is
* DryRunOperation. Otherwise, it is UnauthorizedOperation.
*/
public final Boolean dryRun() {
return dryRun;
}
/**
* 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 the {@code isEmpty()} 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.
*/
public final boolean hasFilters() {
return filters != null && !(filters instanceof SdkAutoConstructList);
}
/**
*
* The filters.
*
*
* -
*
* affinity - The affinity setting for an instance running on a Dedicated Host (default |
* host).
*
*
* -
*
* architecture - The instance architecture (i386 | x86_64 |
* arm64).
*
*
* -
*
* availability-zone - The Availability Zone of the instance.
*
*
* -
*
* block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for
* example, 2022-09-15T17:15:20.000Z.
*
*
* -
*
* block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is
* deleted on instance termination.
*
*
* -
*
* block-device-mapping.device-name - The device name specified in the block device mapping (for
* example, /dev/sdh or xvdh).
*
*
* -
*
* block-device-mapping.status - The status for the EBS volume (attaching |
* attached | detaching | detached).
*
*
* -
*
* block-device-mapping.volume-id - The volume ID of the EBS volume.
*
*
* -
*
* boot-mode - The boot mode that was specified by the AMI (legacy-bios |
* uefi | uefi-preferred).
*
*
* -
*
* capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-preference - The instance's Capacity
* Reservation preference (open | none).
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id - The ID of
* the targeted Capacity Reservation.
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn
* - The ARN of the targeted Capacity Reservation group.
*
*
* -
*
* client-token - The idempotency token you provided when you launched the instance.
*
*
* -
*
* current-instance-boot-mode - The boot mode that is used to launch the instance at launch or start (
* legacy-bios | uefi).
*
*
* -
*
* dns-name - The public DNS name of the instance.
*
*
* -
*
* ebs-optimized - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O.
*
*
* -
*
* ena-support - A Boolean that indicates whether the instance is enabled for enhanced networking with
* ENA.
*
*
* -
*
* enclave-options.enabled - A Boolean that indicates whether the instance is enabled for Amazon Web
* Services Nitro Enclaves.
*
*
* -
*
* hibernation-options.configured - A Boolean that indicates whether the instance is enabled for
* hibernation. A value of true means that the instance is enabled for hibernation.
*
*
* -
*
* host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
*
*
* -
*
* hypervisor - The hypervisor type of the instance (ovm | xen). The value
* xen is used for both Xen and Nitro hypervisors.
*
*
* -
*
* iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
*
*
* -
*
* iam-instance-profile.id - The instance profile associated with the instance. Specified as an ID.
*
*
* -
*
* image-id - The ID of the image used to launch the instance.
*
*
* -
*
* instance-id - The ID of the instance.
*
*
* -
*
* instance-lifecycle - Indicates whether this is a Spot Instance, a Scheduled Instance, or a Capacity
* Block (spot | scheduled | capacity-block).
*
*
* -
*
* instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used
* for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values
* are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
*
*
* -
*
* instance-state-name - The state of the instance (pending | running |
* shutting-down | terminated | stopping | stopped).
*
*
* -
*
* instance-type - The type of instance (for example, t2.micro).
*
*
* -
*
* instance.group-id - The ID of the security group for the instance.
*
*
* -
*
* instance.group-name - The name of the security group for the instance.
*
*
* -
*
* ip-address - The public IPv4 address of the instance.
*
*
* -
*
* ipv6-address - The IPv6 address of the instance.
*
*
* -
*
* kernel-id - The kernel ID.
*
*
* -
*
* key-name - The name of the key pair used when the instance was launched.
*
*
* -
*
* launch-index - When launching multiple instances, this is the index for the instance in the launch
* group (for example, 0, 1, 2, and so on).
*
*
* -
*
* launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone
* (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (
* *), for example, 2021-09-29T*, which matches an entire day.
*
*
* -
*
* maintenance-options.auto-recovery - The current automatic recovery behavior of the instance (
* disabled | default).
*
*
* -
*
* metadata-options.http-endpoint - The status of access to the HTTP metadata endpoint on your instance
* (enabled | disabled)
*
*
* -
*
* metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint is enabled (
* disabled | enabled).
*
*
* -
*
* metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 endpoint is enabled (
* disabled | enabled).
*
*
* -
*
* metadata-options.http-put-response-hop-limit - The HTTP metadata request put response hop limit
* (integer, possible values 1 to 64)
*
*
* -
*
* metadata-options.http-tokens - The metadata request authorization state (optional |
* required)
*
*
* -
*
* metadata-options.instance-metadata-tags - The status of access to instance tags from the instance
* metadata (enabled | disabled)
*
*
* -
*
* metadata-options.state - The state of the metadata option changes (pending |
* applied).
*
*
* -
*
* monitoring-state - Indicates whether detailed monitoring is enabled (disabled |
* enabled).
*
*
* -
*
* network-interface.addresses.association.allocation-id - The allocation ID.
*
*
* -
*
* network-interface.addresses.association.association-id - The association ID.
*
*
* -
*
* network-interface.addresses.association.carrier-ip - The carrier IP address.
*
*
* -
*
* network-interface.addresses.association.customer-owned-ip - The customer-owned IP address.
*
*
* -
*
* network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address
* associated with the network interface.
*
*
* -
*
* network-interface.addresses.association.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP
* address (IPv4) with a network interface.
*
*
* -
*
* network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is
* the primary private IPv4 address.
*
*
* -
*
* network-interface.addresses.private-dns-name - The private DNS name.
*
*
* -
*
* network-interface.addresses.private-ip-address - The private IPv4 address associated with the
* network interface.
*
*
* -
*
* network-interface.association.allocation-id - The allocation ID returned when you allocated the
* Elastic IP address (IPv4) for your network interface.
*
*
* -
*
* network-interface.association.association-id - The association ID returned when the network
* interface was associated with an IPv4 address.
*
*
* -
*
* network-interface.association.carrier-ip - The customer-owned IP address.
*
*
* -
*
* network-interface.association.customer-owned-ip - The customer-owned IP address.
*
*
* -
*
* network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated
* with the network interface.
*
*
* -
*
* network-interface.association.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the
* network interface.
*
*
* -
*
* network-interface.attachment.attach-time - The time that the network interface was attached to an
* instance.
*
*
* -
*
* network-interface.attachment.attachment-id - The ID of the interface attachment.
*
*
* -
*
* network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted
* when an instance is terminated.
*
*
* -
*
* network-interface.attachment.device-index - The device index to which the network interface is
* attached.
*
*
* -
*
* network-interface.attachment.instance-id - The ID of the instance to which the network interface is
* attached.
*
*
* -
*
* network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network
* interface is attached.
*
*
* -
*
* network-interface.attachment.network-card-index - The index of the network card.
*
*
* -
*
* network-interface.attachment.status - The status of the attachment (attaching |
* attached | detaching | detached).
*
*
* -
*
* network-interface.availability-zone - The Availability Zone for the network interface.
*
*
* -
*
* network-interface.deny-all-igw-traffic - A Boolean that indicates whether a network interface with
* an IPv6 address is unreachable from the public internet.
*
*
* -
*
* network-interface.description - The description of the network interface.
*
*
* -
*
* network-interface.group-id - The ID of a security group associated with the network interface.
*
*
* -
*
* network-interface.group-name - The name of a security group associated with the network interface.
*
*
* -
*
* network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the network
* interface.
*
*
* -
*
* network-interface.ipv6-address - The IPv6 address associated with the network interface.
*
*
* -
*
* network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network
* interface.
*
*
* -
*
* network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this is the
* primary IPv6 address.
*
*
* -
*
* network-interface.ipv6-native - A Boolean that indicates whether this is an IPv6 only network
* interface.
*
*
* -
*
* network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network interface.
*
*
* -
*
* network-interface.mac-address - The MAC address of the network interface.
*
*
* -
*
* network-interface.network-interface-id - The ID of the network interface.
*
*
* -
*
* network-interface.outpost-arn - The ARN of the Outpost.
*
*
* -
*
* network-interface.owner-id - The ID of the owner of the network interface.
*
*
* -
*
* network-interface.private-dns-name - The private DNS name of the network interface.
*
*
* -
*
* network-interface.private-ip-address - The private IPv4 address.
*
*
* -
*
* network-interface.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.requester-id - The requester ID for the network interface.
*
*
* -
*
* network-interface.requester-managed - Indicates whether the network interface is being managed by
* Amazon Web Services.
*
*
* -
*
* network-interface.status - The status of the network interface (available) |
* in-use).
*
*
* -
*
* network-interface.source-dest-check - Whether the network interface performs source/destination
* checking. A value of true means that checking is enabled, and false means that checking
* is disabled. The value must be false for the network interface to perform network address
* translation (NAT) in your VPC.
*
*
* -
*
* network-interface.subnet-id - The ID of the subnet for the network interface.
*
*
* -
*
* network-interface.tag-key - The key of a tag assigned to the network interface.
*
*
* -
*
* network-interface.tag-value - The value of a tag assigned to the network interface.
*
*
* -
*
* network-interface.vpc-id - The ID of the VPC for the network interface.
*
*
* -
*
* outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the instance owner.
*
*
* -
*
* placement-group-name - The name of the placement group for the instance.
*
*
* -
*
* placement-partition-number - The partition in which the instance is located.
*
*
* -
*
* platform - The platform. To list only Windows instances, use windows.
*
*
* -
*
* platform-details - The platform (Linux/UNIX | Red Hat BYOL Linux |
* Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA |
* Red Hat Enterprise Linux with SQL Server Standard and HA |
* Red Hat Enterprise Linux with SQL Server Enterprise and HA |
* Red Hat Enterprise Linux with SQL Server Standard |
* Red Hat Enterprise Linux with SQL Server Web |
* Red Hat Enterprise Linux with SQL Server Enterprise | SQL Server Enterprise |
* SQL Server Standard | SQL Server Web | SUSE Linux |
* Ubuntu Pro | Windows | Windows BYOL |
* Windows with SQL Server Enterprise | Windows with SQL Server Standard |
* Windows with SQL Server Web).
*
*
* -
*
* private-dns-name - The private IPv4 DNS name of the instance.
*
*
* -
*
* private-dns-name-options.enable-resource-name-dns-a-record - A Boolean that indicates whether to
* respond to DNS queries for instance hostnames with DNS A records.
*
*
* -
*
* private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean that indicates whether to
* respond to DNS queries for instance hostnames with DNS AAAA records.
*
*
* -
*
* private-dns-name-options.hostname-type - The type of hostname (ip-name |
* resource-name).
*
*
* -
*
* private-ip-address - The private IPv4 address of the instance. This can only be used to filter by
* the primary IP address of the network interface attached to the instance. To filter by additional IP addresses
* assigned to the network interface, use the filter network-interface.addresses.private-ip-address.
*
*
* -
*
* product-code - The product code associated with the AMI used to launch the instance.
*
*
* -
*
* product-code.type - The type of product code (devpay | marketplace).
*
*
* -
*
* ramdisk-id - The RAM disk ID.
*
*
* -
*
* reason - The reason for the current state of the instance (for example, shows
* "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.
*
*
* -
*
* requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon
* Web Services Management Console, Auto Scaling, and so on).
*
*
* -
*
* reservation-id - The ID of the instance's reservation. A reservation ID is created any time you
* launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be
* associated with more than one instance if you launch multiple instances using the same launch request. For
* example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same
* launch request, you also get one reservation ID.
*
*
* -
*
* root-device-name - The device name of the root device volume (for example, /dev/sda1).
*
*
* -
*
* root-device-type - The type of the root device volume (ebs |
* instance-store).
*
*
* -
*
* source-dest-check - Indicates whether the instance performs source/destination checking. A value of
* true means that checking is enabled, and false means that checking is disabled. The
* value must be false for the instance to perform network address translation (NAT) in your VPC.
*
*
* -
*
* spot-instance-request-id - The ID of the Spot Instance request.
*
*
* -
*
* state-reason-code - The reason code for the state change.
*
*
* -
*
* state-reason-message - A message that describes the state change.
*
*
* -
*
* subnet-id - The ID of the subnet for the instance.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* tenancy - The tenancy of an instance (dedicated | default |
* host).
*
*
* -
*
* tpm-support - Indicates if the instance is configured for NitroTPM support (v2.0).
*
*
* -
*
* usage-operation - The usage operation value for the instance (RunInstances |
* RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 |
* RunInstances:1014 | RunInstances:1110 | RunInstances:0014 |
* RunInstances:0210 | RunInstances:0110 | RunInstances:0100 |
* RunInstances:0004 | RunInstances:0200 | RunInstances:000g |
* RunInstances:0g00 | RunInstances:0002 | RunInstances:0800 |
* RunInstances:0102 | RunInstances:0006 | RunInstances:0202).
*
*
* -
*
* usage-operation-update-time - The time that the usage operation was last updated, for example,
* 2022-09-15T17:15:20.000Z.
*
*
* -
*
* virtualization-type - The virtualization type of the instance (paravirtual |
* hvm).
*
*
* -
*
* vpc-id - The ID of the VPC that the instance is running in.
*
*
*
*
* 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 {@link #hasFilters} method.
*
*
* @return The filters.
*
* -
*
* affinity - The affinity setting for an instance running on a Dedicated Host (
* default | host).
*
*
* -
*
* architecture - The instance architecture (i386 | x86_64 |
* arm64).
*
*
* -
*
* availability-zone - The Availability Zone of the instance.
*
*
* -
*
* block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance,
* for example, 2022-09-15T17:15:20.000Z.
*
*
* -
*
* block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume
* is deleted on instance termination.
*
*
* -
*
* block-device-mapping.device-name - The device name specified in the block device mapping
* (for example, /dev/sdh or xvdh).
*
*
* -
*
* block-device-mapping.status - The status for the EBS volume (attaching |
* attached | detaching | detached).
*
*
* -
*
* block-device-mapping.volume-id - The volume ID of the EBS volume.
*
*
* -
*
* boot-mode - The boot mode that was specified by the AMI (legacy-bios |
* uefi | uefi-preferred).
*
*
* -
*
* capacity-reservation-id - The ID of the Capacity Reservation into which the instance was
* launched.
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-preference - The instance's Capacity
* Reservation preference (open | none).
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id - The
* ID of the targeted Capacity Reservation.
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn
* - The ARN of the targeted Capacity Reservation group.
*
*
* -
*
* client-token - The idempotency token you provided when you launched the instance.
*
*
* -
*
* current-instance-boot-mode - The boot mode that is used to launch the instance at launch or
* start (legacy-bios | uefi).
*
*
* -
*
* dns-name - The public DNS name of the instance.
*
*
* -
*
* ebs-optimized - A Boolean that indicates whether the instance is optimized for Amazon EBS
* I/O.
*
*
* -
*
* ena-support - A Boolean that indicates whether the instance is enabled for enhanced
* networking with ENA.
*
*
* -
*
* enclave-options.enabled - A Boolean that indicates whether the instance is enabled for
* Amazon Web Services Nitro Enclaves.
*
*
* -
*
* hibernation-options.configured - A Boolean that indicates whether the instance is enabled
* for hibernation. A value of true means that the instance is enabled for hibernation.
*
*
* -
*
* host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
*
*
* -
*
* hypervisor - The hypervisor type of the instance (ovm | xen). The
* value xen is used for both Xen and Nitro hypervisors.
*
*
* -
*
* iam-instance-profile.arn - The instance profile associated with the instance. Specified as
* an ARN.
*
*
* -
*
* iam-instance-profile.id - The instance profile associated with the instance. Specified as an
* ID.
*
*
* -
*
* image-id - The ID of the image used to launch the instance.
*
*
* -
*
* instance-id - The ID of the instance.
*
*
* -
*
* instance-lifecycle - Indicates whether this is a Spot Instance, a Scheduled Instance, or a
* Capacity Block (spot | scheduled | capacity-block).
*
*
* -
*
* instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte
* is used for internal purposes and should be ignored. The low byte is set based on the state represented.
* The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and
* 80 (stopped).
*
*
* -
*
* instance-state-name - The state of the instance (pending | running
* | shutting-down | terminated | stopping | stopped).
*
*
* -
*
* instance-type - The type of instance (for example, t2.micro).
*
*
* -
*
* instance.group-id - The ID of the security group for the instance.
*
*
* -
*
* instance.group-name - The name of the security group for the instance.
*
*
* -
*
* ip-address - The public IPv4 address of the instance.
*
*
* -
*
* ipv6-address - The IPv6 address of the instance.
*
*
* -
*
* kernel-id - The kernel ID.
*
*
* -
*
* key-name - The name of the key pair used when the instance was launched.
*
*
* -
*
* launch-index - When launching multiple instances, this is the index for the instance in the
* launch group (for example, 0, 1, 2, and so on).
*
*
* -
*
* launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC
* time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a
* wildcard (*), for example, 2021-09-29T*, which matches an entire day.
*
*
* -
*
* maintenance-options.auto-recovery - The current automatic recovery behavior of the instance
* (disabled | default).
*
*
* -
*
* metadata-options.http-endpoint - The status of access to the HTTP metadata endpoint on your
* instance (enabled | disabled)
*
*
* -
*
* metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint is enabled (
* disabled | enabled).
*
*
* -
*
* metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 endpoint is enabled (
* disabled | enabled).
*
*
* -
*
* metadata-options.http-put-response-hop-limit - The HTTP metadata request put response hop
* limit (integer, possible values 1 to 64)
*
*
* -
*
* metadata-options.http-tokens - The metadata request authorization state (
* optional | required)
*
*
* -
*
* metadata-options.instance-metadata-tags - The status of access to instance tags from the
* instance metadata (enabled | disabled)
*
*
* -
*
* metadata-options.state - The state of the metadata option changes (pending |
* applied).
*
*
* -
*
* monitoring-state - Indicates whether detailed monitoring is enabled (disabled |
* enabled).
*
*
* -
*
* network-interface.addresses.association.allocation-id - The allocation ID.
*
*
* -
*
* network-interface.addresses.association.association-id - The association ID.
*
*
* -
*
* network-interface.addresses.association.carrier-ip - The carrier IP address.
*
*
* -
*
* network-interface.addresses.association.customer-owned-ip - The customer-owned IP address.
*
*
* -
*
* network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4
* address associated with the network interface.
*
*
* -
*
* network-interface.addresses.association.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.addresses.association.public-ip - The ID of the association of an Elastic
* IP address (IPv4) with a network interface.
*
*
* -
*
* network-interface.addresses.primary - Specifies whether the IPv4 address of the network
* interface is the primary private IPv4 address.
*
*
* -
*
* network-interface.addresses.private-dns-name - The private DNS name.
*
*
* -
*
* network-interface.addresses.private-ip-address - The private IPv4 address associated with
* the network interface.
*
*
* -
*
* network-interface.association.allocation-id - The allocation ID returned when you allocated
* the Elastic IP address (IPv4) for your network interface.
*
*
* -
*
* network-interface.association.association-id - The association ID returned when the network
* interface was associated with an IPv4 address.
*
*
* -
*
* network-interface.association.carrier-ip - The customer-owned IP address.
*
*
* -
*
* network-interface.association.customer-owned-ip - The customer-owned IP address.
*
*
* -
*
* network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4)
* associated with the network interface.
*
*
* -
*
* network-interface.association.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound
* to the network interface.
*
*
* -
*
* network-interface.attachment.attach-time - The time that the network interface was attached
* to an instance.
*
*
* -
*
* network-interface.attachment.attachment-id - The ID of the interface attachment.
*
*
* -
*
* network-interface.attachment.delete-on-termination - Specifies whether the attachment is
* deleted when an instance is terminated.
*
*
* -
*
* network-interface.attachment.device-index - The device index to which the network interface
* is attached.
*
*
* -
*
* network-interface.attachment.instance-id - The ID of the instance to which the network
* interface is attached.
*
*
* -
*
* network-interface.attachment.instance-owner-id - The owner ID of the instance to which the
* network interface is attached.
*
*
* -
*
* network-interface.attachment.network-card-index - The index of the network card.
*
*
* -
*
* network-interface.attachment.status - The status of the attachment (attaching |
* attached | detaching | detached).
*
*
* -
*
* network-interface.availability-zone - The Availability Zone for the network interface.
*
*
* -
*
* network-interface.deny-all-igw-traffic - A Boolean that indicates whether a network
* interface with an IPv6 address is unreachable from the public internet.
*
*
* -
*
* network-interface.description - The description of the network interface.
*
*
* -
*
* network-interface.group-id - The ID of a security group associated with the network
* interface.
*
*
* -
*
* network-interface.group-name - The name of a security group associated with the network
* interface.
*
*
* -
*
* network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the
* network interface.
*
*
* -
*
* network-interface.ipv6-address - The IPv6 address associated with the network interface.
*
*
* -
*
* network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network
* interface.
*
*
* -
*
* network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this is
* the primary IPv6 address.
*
*
* -
*
* network-interface.ipv6-native - A Boolean that indicates whether this is an IPv6 only
* network interface.
*
*
* -
*
* network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network
* interface.
*
*
* -
*
* network-interface.mac-address - The MAC address of the network interface.
*
*
* -
*
* network-interface.network-interface-id - The ID of the network interface.
*
*
* -
*
* network-interface.outpost-arn - The ARN of the Outpost.
*
*
* -
*
* network-interface.owner-id - The ID of the owner of the network interface.
*
*
* -
*
* network-interface.private-dns-name - The private DNS name of the network interface.
*
*
* -
*
* network-interface.private-ip-address - The private IPv4 address.
*
*
* -
*
* network-interface.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.requester-id - The requester ID for the network interface.
*
*
* -
*
* network-interface.requester-managed - Indicates whether the network interface is being
* managed by Amazon Web Services.
*
*
* -
*
* network-interface.status - The status of the network interface (available) |
* in-use).
*
*
* -
*
* network-interface.source-dest-check - Whether the network interface performs
* source/destination checking. A value of true means that checking is enabled, and
* false means that checking is disabled. The value must be false for the network
* interface to perform network address translation (NAT) in your VPC.
*
*
* -
*
* network-interface.subnet-id - The ID of the subnet for the network interface.
*
*
* -
*
* network-interface.tag-key - The key of a tag assigned to the network interface.
*
*
* -
*
* network-interface.tag-value - The value of a tag assigned to the network interface.
*
*
* -
*
* network-interface.vpc-id - The ID of the VPC for the network interface.
*
*
* -
*
* outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the instance owner.
*
*
* -
*
* placement-group-name - The name of the placement group for the instance.
*
*
* -
*
* placement-partition-number - The partition in which the instance is located.
*
*
* -
*
* platform - The platform. To list only Windows instances, use windows.
*
*
* -
*
* platform-details - The platform (Linux/UNIX | Red Hat BYOL Linux |
* Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA |
* Red Hat Enterprise Linux with SQL Server Standard and HA |
* Red Hat Enterprise Linux with SQL Server Enterprise and HA |
* Red Hat Enterprise Linux with SQL Server Standard |
* Red Hat Enterprise Linux with SQL Server Web |
* Red Hat Enterprise Linux with SQL Server Enterprise | SQL Server Enterprise |
* SQL Server Standard | SQL Server Web | SUSE Linux |
* Ubuntu Pro | Windows | Windows BYOL |
* Windows with SQL Server Enterprise | Windows with SQL Server Standard |
* Windows with SQL Server Web).
*
*
* -
*
* private-dns-name - The private IPv4 DNS name of the instance.
*
*
* -
*
* private-dns-name-options.enable-resource-name-dns-a-record - A Boolean that indicates
* whether to respond to DNS queries for instance hostnames with DNS A records.
*
*
* -
*
* private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean that indicates
* whether to respond to DNS queries for instance hostnames with DNS AAAA records.
*
*
* -
*
* private-dns-name-options.hostname-type - The type of hostname (ip-name |
* resource-name).
*
*
* -
*
* private-ip-address - The private IPv4 address of the instance. This can only be used to
* filter by the primary IP address of the network interface attached to the instance. To filter by
* additional IP addresses assigned to the network interface, use the filter
* network-interface.addresses.private-ip-address.
*
*
* -
*
* product-code - The product code associated with the AMI used to launch the instance.
*
*
* -
*
* product-code.type - The type of product code (devpay | marketplace
* ).
*
*
* -
*
* ramdisk-id - The RAM disk ID.
*
*
* -
*
* reason - The reason for the current state of the instance (for example, shows
* "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code
* filter.
*
*
* -
*
* requester-id - The ID of the entity that launched the instance on your behalf (for example,
* Amazon Web Services Management Console, Auto Scaling, and so on).
*
*
* -
*
* reservation-id - The ID of the instance's reservation. A reservation ID is created any time
* you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request,
* but can be associated with more than one instance if you launch multiple instances using the same launch
* request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances
* using the same launch request, you also get one reservation ID.
*
*
* -
*
* root-device-name - The device name of the root device volume (for example,
* /dev/sda1).
*
*
* -
*
* root-device-type - The type of the root device volume (ebs |
* instance-store).
*
*
* -
*
* source-dest-check - Indicates whether the instance performs source/destination checking. A
* value of true means that checking is enabled, and false means that checking is
* disabled. The value must be false for the instance to perform network address translation
* (NAT) in your VPC.
*
*
* -
*
* spot-instance-request-id - The ID of the Spot Instance request.
*
*
* -
*
* state-reason-code - The reason code for the state change.
*
*
* -
*
* state-reason-message - A message that describes the state change.
*
*
* -
*
* subnet-id - The ID of the subnet for the instance.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that
* have a tag with the key Owner and the value TeamA, specify
* tag:Owner for the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* that have a tag with a specific key, regardless of the tag value.
*
*
* -
*
* tenancy - The tenancy of an instance (dedicated | default |
* host).
*
*
* -
*
* tpm-support - Indicates if the instance is configured for NitroTPM support (
* v2.0).
*
*
* -
*
* usage-operation - The usage operation value for the instance (RunInstances |
* RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 |
* RunInstances:1014 | RunInstances:1110 | RunInstances:0014 |
* RunInstances:0210 | RunInstances:0110 | RunInstances:0100 |
* RunInstances:0004 | RunInstances:0200 | RunInstances:000g |
* RunInstances:0g00 | RunInstances:0002 | RunInstances:0800 |
* RunInstances:0102 | RunInstances:0006 | RunInstances:0202).
*
*
* -
*
* usage-operation-update-time - The time that the usage operation was last updated, for
* example, 2022-09-15T17:15:20.000Z.
*
*
* -
*
* virtualization-type - The virtualization type of the instance (paravirtual |
* hvm).
*
*
* -
*
* vpc-id - The ID of the VPC that the instance is running in.
*
*
*/
public final List filters() {
return filters;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @return The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* 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.
*
*
* You cannot specify this parameter and the instance IDs parameter in the same request.
*
*
* @return 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.
*
* You cannot specify this parameter and the instance IDs parameter in the same request.
*/
public final Integer maxResults() {
return maxResults;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(hasInstanceIds() ? instanceIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(dryRun());
hashCode = 31 * hashCode + Objects.hashCode(hasFilters() ? filters() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeInstancesRequest)) {
return false;
}
DescribeInstancesRequest other = (DescribeInstancesRequest) obj;
return hasInstanceIds() == other.hasInstanceIds() && Objects.equals(instanceIds(), other.instanceIds())
&& Objects.equals(dryRun(), other.dryRun()) && hasFilters() == other.hasFilters()
&& Objects.equals(filters(), other.filters()) && Objects.equals(nextToken(), other.nextToken())
&& Objects.equals(maxResults(), other.maxResults());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("DescribeInstancesRequest").add("InstanceIds", hasInstanceIds() ? instanceIds() : null)
.add("DryRun", dryRun()).add("Filters", hasFilters() ? filters() : null).add("NextToken", nextToken())
.add("MaxResults", maxResults()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "InstanceIds":
return Optional.ofNullable(clazz.cast(instanceIds()));
case "DryRun":
return Optional.ofNullable(clazz.cast(dryRun()));
case "Filters":
return Optional.ofNullable(clazz.cast(filters()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeInstancesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder {
/**
*
* The instance IDs.
*
*
* Default: Describes all your instances.
*
*
* @param instanceIds
* The instance IDs.
*
* Default: Describes all your instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceIds(Collection instanceIds);
/**
*
* The instance IDs.
*
*
* Default: Describes all your instances.
*
*
* @param instanceIds
* The instance IDs.
*
* Default: Describes all your instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceIds(String... instanceIds);
/**
*
* Checks whether you have the required permissions for the operation, without actually making the request, and
* provides an error response. If you have the required permissions, the error response is
* DryRunOperation. Otherwise, it is UnauthorizedOperation.
*
*
* @param dryRun
* Checks whether you have the required permissions for the operation, without actually making the
* request, and provides an error response. If you have the required permissions, the error response is
* DryRunOperation. Otherwise, it is UnauthorizedOperation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dryRun(Boolean dryRun);
/**
*
* The filters.
*
*
* -
*
* affinity - The affinity setting for an instance running on a Dedicated Host (
* default | host).
*
*
* -
*
* architecture - The instance architecture (i386 | x86_64 |
* arm64).
*
*
* -
*
* availability-zone - The Availability Zone of the instance.
*
*
* -
*
* block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for
* example, 2022-09-15T17:15:20.000Z.
*
*
* -
*
* block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is
* deleted on instance termination.
*
*
* -
*
* block-device-mapping.device-name - The device name specified in the block device mapping (for
* example, /dev/sdh or xvdh).
*
*
* -
*
* block-device-mapping.status - The status for the EBS volume (attaching |
* attached | detaching | detached).
*
*
* -
*
* block-device-mapping.volume-id - The volume ID of the EBS volume.
*
*
* -
*
* boot-mode - The boot mode that was specified by the AMI (legacy-bios |
* uefi | uefi-preferred).
*
*
* -
*
* capacity-reservation-id - The ID of the Capacity Reservation into which the instance was
* launched.
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-preference - The instance's Capacity
* Reservation preference (open | none).
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id - The ID
* of the targeted Capacity Reservation.
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn
* - The ARN of the targeted Capacity Reservation group.
*
*
* -
*
* client-token - The idempotency token you provided when you launched the instance.
*
*
* -
*
* current-instance-boot-mode - The boot mode that is used to launch the instance at launch or
* start (legacy-bios | uefi).
*
*
* -
*
* dns-name - The public DNS name of the instance.
*
*
* -
*
* ebs-optimized - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O.
*
*
* -
*
* ena-support - A Boolean that indicates whether the instance is enabled for enhanced networking
* with ENA.
*
*
* -
*
* enclave-options.enabled - A Boolean that indicates whether the instance is enabled for Amazon
* Web Services Nitro Enclaves.
*
*
* -
*
* hibernation-options.configured - A Boolean that indicates whether the instance is enabled for
* hibernation. A value of true means that the instance is enabled for hibernation.
*
*
* -
*
* host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
*
*
* -
*
* hypervisor - The hypervisor type of the instance (ovm | xen). The
* value xen is used for both Xen and Nitro hypervisors.
*
*
* -
*
* iam-instance-profile.arn - The instance profile associated with the instance. Specified as an
* ARN.
*
*
* -
*
* iam-instance-profile.id - The instance profile associated with the instance. Specified as an ID.
*
*
* -
*
* image-id - The ID of the image used to launch the instance.
*
*
* -
*
* instance-id - The ID of the instance.
*
*
* -
*
* instance-lifecycle - Indicates whether this is a Spot Instance, a Scheduled Instance, or a
* Capacity Block (spot | scheduled | capacity-block).
*
*
* -
*
* instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is
* used for internal purposes and should be ignored. The low byte is set based on the state represented. The
* valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80
* (stopped).
*
*
* -
*
* instance-state-name - The state of the instance (pending | running |
* shutting-down | terminated | stopping | stopped).
*
*
* -
*
* instance-type - The type of instance (for example, t2.micro).
*
*
* -
*
* instance.group-id - The ID of the security group for the instance.
*
*
* -
*
* instance.group-name - The name of the security group for the instance.
*
*
* -
*
* ip-address - The public IPv4 address of the instance.
*
*
* -
*
* ipv6-address - The IPv6 address of the instance.
*
*
* -
*
* kernel-id - The kernel ID.
*
*
* -
*
* key-name - The name of the key pair used when the instance was launched.
*
*
* -
*
* launch-index - When launching multiple instances, this is the index for the instance in the
* launch group (for example, 0, 1, 2, and so on).
*
*
* -
*
* launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time
* zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (
* *), for example, 2021-09-29T*, which matches an entire day.
*
*
* -
*
* maintenance-options.auto-recovery - The current automatic recovery behavior of the instance (
* disabled | default).
*
*
* -
*
* metadata-options.http-endpoint - The status of access to the HTTP metadata endpoint on your
* instance (enabled | disabled)
*
*
* -
*
* metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint is enabled (
* disabled | enabled).
*
*
* -
*
* metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 endpoint is enabled (
* disabled | enabled).
*
*
* -
*
* metadata-options.http-put-response-hop-limit - The HTTP metadata request put response hop limit
* (integer, possible values 1 to 64)
*
*
* -
*
* metadata-options.http-tokens - The metadata request authorization state (optional |
* required)
*
*
* -
*
* metadata-options.instance-metadata-tags - The status of access to instance tags from the
* instance metadata (enabled | disabled)
*
*
* -
*
* metadata-options.state - The state of the metadata option changes (pending |
* applied).
*
*
* -
*
* monitoring-state - Indicates whether detailed monitoring is enabled (disabled |
* enabled).
*
*
* -
*
* network-interface.addresses.association.allocation-id - The allocation ID.
*
*
* -
*
* network-interface.addresses.association.association-id - The association ID.
*
*
* -
*
* network-interface.addresses.association.carrier-ip - The carrier IP address.
*
*
* -
*
* network-interface.addresses.association.customer-owned-ip - The customer-owned IP address.
*
*
* -
*
* network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address
* associated with the network interface.
*
*
* -
*
* network-interface.addresses.association.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP
* address (IPv4) with a network interface.
*
*
* -
*
* network-interface.addresses.primary - Specifies whether the IPv4 address of the network
* interface is the primary private IPv4 address.
*
*
* -
*
* network-interface.addresses.private-dns-name - The private DNS name.
*
*
* -
*
* network-interface.addresses.private-ip-address - The private IPv4 address associated with the
* network interface.
*
*
* -
*
* network-interface.association.allocation-id - The allocation ID returned when you allocated the
* Elastic IP address (IPv4) for your network interface.
*
*
* -
*
* network-interface.association.association-id - The association ID returned when the network
* interface was associated with an IPv4 address.
*
*
* -
*
* network-interface.association.carrier-ip - The customer-owned IP address.
*
*
* -
*
* network-interface.association.customer-owned-ip - The customer-owned IP address.
*
*
* -
*
* network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4)
* associated with the network interface.
*
*
* -
*
* network-interface.association.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to
* the network interface.
*
*
* -
*
* network-interface.attachment.attach-time - The time that the network interface was attached to
* an instance.
*
*
* -
*
* network-interface.attachment.attachment-id - The ID of the interface attachment.
*
*
* -
*
* network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted
* when an instance is terminated.
*
*
* -
*
* network-interface.attachment.device-index - The device index to which the network interface is
* attached.
*
*
* -
*
* network-interface.attachment.instance-id - The ID of the instance to which the network interface
* is attached.
*
*
* -
*
* network-interface.attachment.instance-owner-id - The owner ID of the instance to which the
* network interface is attached.
*
*
* -
*
* network-interface.attachment.network-card-index - The index of the network card.
*
*
* -
*
* network-interface.attachment.status - The status of the attachment (attaching |
* attached | detaching | detached).
*
*
* -
*
* network-interface.availability-zone - The Availability Zone for the network interface.
*
*
* -
*
* network-interface.deny-all-igw-traffic - A Boolean that indicates whether a network interface
* with an IPv6 address is unreachable from the public internet.
*
*
* -
*
* network-interface.description - The description of the network interface.
*
*
* -
*
* network-interface.group-id - The ID of a security group associated with the network interface.
*
*
* -
*
* network-interface.group-name - The name of a security group associated with the network
* interface.
*
*
* -
*
* network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the network
* interface.
*
*
* -
*
* network-interface.ipv6-address - The IPv6 address associated with the network interface.
*
*
* -
*
* network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network
* interface.
*
*
* -
*
* network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this is the
* primary IPv6 address.
*
*
* -
*
* network-interface.ipv6-native - A Boolean that indicates whether this is an IPv6 only network
* interface.
*
*
* -
*
* network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network interface.
*
*
* -
*
* network-interface.mac-address - The MAC address of the network interface.
*
*
* -
*
* network-interface.network-interface-id - The ID of the network interface.
*
*
* -
*
* network-interface.outpost-arn - The ARN of the Outpost.
*
*
* -
*
* network-interface.owner-id - The ID of the owner of the network interface.
*
*
* -
*
* network-interface.private-dns-name - The private DNS name of the network interface.
*
*
* -
*
* network-interface.private-ip-address - The private IPv4 address.
*
*
* -
*
* network-interface.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.requester-id - The requester ID for the network interface.
*
*
* -
*
* network-interface.requester-managed - Indicates whether the network interface is being managed
* by Amazon Web Services.
*
*
* -
*
* network-interface.status - The status of the network interface (available) |
* in-use).
*
*
* -
*
* network-interface.source-dest-check - Whether the network interface performs source/destination
* checking. A value of true means that checking is enabled, and false means that
* checking is disabled. The value must be false for the network interface to perform network
* address translation (NAT) in your VPC.
*
*
* -
*
* network-interface.subnet-id - The ID of the subnet for the network interface.
*
*
* -
*
* network-interface.tag-key - The key of a tag assigned to the network interface.
*
*
* -
*
* network-interface.tag-value - The value of a tag assigned to the network interface.
*
*
* -
*
* network-interface.vpc-id - The ID of the VPC for the network interface.
*
*
* -
*
* outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the instance owner.
*
*
* -
*
* placement-group-name - The name of the placement group for the instance.
*
*
* -
*
* placement-partition-number - The partition in which the instance is located.
*
*
* -
*
* platform - The platform. To list only Windows instances, use windows.
*
*
* -
*
* platform-details - The platform (Linux/UNIX | Red Hat BYOL Linux |
* Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA |
* Red Hat Enterprise Linux with SQL Server Standard and HA |
* Red Hat Enterprise Linux with SQL Server Enterprise and HA |
* Red Hat Enterprise Linux with SQL Server Standard |
* Red Hat Enterprise Linux with SQL Server Web |
* Red Hat Enterprise Linux with SQL Server Enterprise | SQL Server Enterprise |
* SQL Server Standard | SQL Server Web | SUSE Linux |
* Ubuntu Pro | Windows | Windows BYOL |
* Windows with SQL Server Enterprise | Windows with SQL Server Standard |
* Windows with SQL Server Web).
*
*
* -
*
* private-dns-name - The private IPv4 DNS name of the instance.
*
*
* -
*
* private-dns-name-options.enable-resource-name-dns-a-record - A Boolean that indicates whether to
* respond to DNS queries for instance hostnames with DNS A records.
*
*
* -
*
* private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean that indicates whether
* to respond to DNS queries for instance hostnames with DNS AAAA records.
*
*
* -
*
* private-dns-name-options.hostname-type - The type of hostname (ip-name |
* resource-name).
*
*
* -
*
* private-ip-address - The private IPv4 address of the instance. This can only be used to filter
* by the primary IP address of the network interface attached to the instance. To filter by additional IP
* addresses assigned to the network interface, use the filter
* network-interface.addresses.private-ip-address.
*
*
* -
*
* product-code - The product code associated with the AMI used to launch the instance.
*
*
* -
*
* product-code.type - The type of product code (devpay | marketplace).
*
*
* -
*
* ramdisk-id - The RAM disk ID.
*
*
* -
*
* reason - The reason for the current state of the instance (for example, shows
* "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.
*
*
* -
*
* requester-id - The ID of the entity that launched the instance on your behalf (for example,
* Amazon Web Services Management Console, Auto Scaling, and so on).
*
*
* -
*
* reservation-id - The ID of the instance's reservation. A reservation ID is created any time you
* launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can
* be associated with more than one instance if you launch multiple instances using the same launch request. For
* example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same
* launch request, you also get one reservation ID.
*
*
* -
*
* root-device-name - The device name of the root device volume (for example,
* /dev/sda1).
*
*
* -
*
* root-device-type - The type of the root device volume (ebs |
* instance-store).
*
*
* -
*
* source-dest-check - Indicates whether the instance performs source/destination checking. A value
* of true means that checking is enabled, and false means that checking is disabled.
* The value must be false for the instance to perform network address translation (NAT) in your
* VPC.
*
*
* -
*
* spot-instance-request-id - The ID of the Spot Instance request.
*
*
* -
*
* state-reason-code - The reason code for the state change.
*
*
* -
*
* state-reason-message - A message that describes the state change.
*
*
* -
*
* subnet-id - The ID of the subnet for the instance.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key
* in the filter name and the tag value as the filter value. For example, to find all resources that have a tag
* with the key Owner and the value TeamA, specify tag:Owner for the
* filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that
* have a tag with a specific key, regardless of the tag value.
*
*
* -
*
* tenancy - The tenancy of an instance (dedicated | default |
* host).
*
*
* -
*
* tpm-support - Indicates if the instance is configured for NitroTPM support (v2.0).
*
*
* -
*
* usage-operation - The usage operation value for the instance (RunInstances |
* RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 |
* RunInstances:1014 | RunInstances:1110 | RunInstances:0014 |
* RunInstances:0210 | RunInstances:0110 | RunInstances:0100 |
* RunInstances:0004 | RunInstances:0200 | RunInstances:000g |
* RunInstances:0g00 | RunInstances:0002 | RunInstances:0800 |
* RunInstances:0102 | RunInstances:0006 | RunInstances:0202).
*
*
* -
*
* usage-operation-update-time - The time that the usage operation was last updated, for example,
* 2022-09-15T17:15:20.000Z.
*
*
* -
*
* virtualization-type - The virtualization type of the instance (paravirtual |
* hvm).
*
*
* -
*
* vpc-id - The ID of the VPC that the instance is running in.
*
*
*
*
* @param filters
* The filters.
*
* -
*
* affinity - The affinity setting for an instance running on a Dedicated Host (
* default | host).
*
*
* -
*
* architecture - The instance architecture (i386 | x86_64 |
* arm64).
*
*
* -
*
* availability-zone - The Availability Zone of the instance.
*
*
* -
*
* block-device-mapping.attach-time - The attach time for an EBS volume mapped to the
* instance, for example, 2022-09-15T17:15:20.000Z.
*
*
* -
*
* block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS
* volume is deleted on instance termination.
*
*
* -
*
* block-device-mapping.device-name - The device name specified in the block device mapping
* (for example, /dev/sdh or xvdh).
*
*
* -
*
* block-device-mapping.status - The status for the EBS volume (attaching |
* attached | detaching | detached).
*
*
* -
*
* block-device-mapping.volume-id - The volume ID of the EBS volume.
*
*
* -
*
* boot-mode - The boot mode that was specified by the AMI (legacy-bios |
* uefi | uefi-preferred).
*
*
* -
*
* capacity-reservation-id - The ID of the Capacity Reservation into which the instance was
* launched.
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-preference - The instance's
* Capacity Reservation preference (open | none).
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id -
* The ID of the targeted Capacity Reservation.
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn
* - The ARN of the targeted Capacity Reservation group.
*
*
* -
*
* client-token - The idempotency token you provided when you launched the instance.
*
*
* -
*
* current-instance-boot-mode - The boot mode that is used to launch the instance at launch
* or start (legacy-bios | uefi).
*
*
* -
*
* dns-name - The public DNS name of the instance.
*
*
* -
*
* ebs-optimized - A Boolean that indicates whether the instance is optimized for Amazon EBS
* I/O.
*
*
* -
*
* ena-support - A Boolean that indicates whether the instance is enabled for enhanced
* networking with ENA.
*
*
* -
*
* enclave-options.enabled - A Boolean that indicates whether the instance is enabled for
* Amazon Web Services Nitro Enclaves.
*
*
* -
*
* hibernation-options.configured - A Boolean that indicates whether the instance is enabled
* for hibernation. A value of true means that the instance is enabled for hibernation.
*
*
* -
*
* host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
*
*
* -
*
* hypervisor - The hypervisor type of the instance (ovm | xen).
* The value xen is used for both Xen and Nitro hypervisors.
*
*
* -
*
* iam-instance-profile.arn - The instance profile associated with the instance. Specified
* as an ARN.
*
*
* -
*
* iam-instance-profile.id - The instance profile associated with the instance. Specified as
* an ID.
*
*
* -
*
* image-id - The ID of the image used to launch the instance.
*
*
* -
*
* instance-id - The ID of the instance.
*
*
* -
*
* instance-lifecycle - Indicates whether this is a Spot Instance, a Scheduled Instance, or
* a Capacity Block (spot | scheduled | capacity-block).
*
*
* -
*
* instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high
* byte is used for internal purposes and should be ignored. The low byte is set based on the state
* represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64
* (stopping), and 80 (stopped).
*
*
* -
*
* instance-state-name - The state of the instance (pending |
* running | shutting-down | terminated | stopping |
* stopped).
*
*
* -
*
* instance-type - The type of instance (for example, t2.micro).
*
*
* -
*
* instance.group-id - The ID of the security group for the instance.
*
*
* -
*
* instance.group-name - The name of the security group for the instance.
*
*
* -
*
* ip-address - The public IPv4 address of the instance.
*
*
* -
*
* ipv6-address - The IPv6 address of the instance.
*
*
* -
*
* kernel-id - The kernel ID.
*
*
* -
*
* key-name - The name of the key pair used when the instance was launched.
*
*
* -
*
* launch-index - When launching multiple instances, this is the index for the instance in
* the launch group (for example, 0, 1, 2, and so on).
*
*
* -
*
* launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC
* time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use
* a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
*
*
* -
*
* maintenance-options.auto-recovery - The current automatic recovery behavior of the
* instance (disabled | default).
*
*
* -
*
* metadata-options.http-endpoint - The status of access to the HTTP metadata endpoint on
* your instance (enabled | disabled)
*
*
* -
*
* metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint is enabled (
* disabled | enabled).
*
*
* -
*
* metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 endpoint is enabled (
* disabled | enabled).
*
*
* -
*
* metadata-options.http-put-response-hop-limit - The HTTP metadata request put response hop
* limit (integer, possible values 1 to 64)
*
*
* -
*
* metadata-options.http-tokens - The metadata request authorization state (
* optional | required)
*
*
* -
*
* metadata-options.instance-metadata-tags - The status of access to instance tags from the
* instance metadata (enabled | disabled)
*
*
* -
*
* metadata-options.state - The state of the metadata option changes (pending |
* applied).
*
*
* -
*
* monitoring-state - Indicates whether detailed monitoring is enabled (
* disabled | enabled).
*
*
* -
*
* network-interface.addresses.association.allocation-id - The allocation ID.
*
*
* -
*
* network-interface.addresses.association.association-id - The association ID.
*
*
* -
*
* network-interface.addresses.association.carrier-ip - The carrier IP address.
*
*
* -
*
* network-interface.addresses.association.customer-owned-ip - The customer-owned IP
* address.
*
*
* -
*
* network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4
* address associated with the network interface.
*
*
* -
*
* network-interface.addresses.association.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.addresses.association.public-ip - The ID of the association of an
* Elastic IP address (IPv4) with a network interface.
*
*
* -
*
* network-interface.addresses.primary - Specifies whether the IPv4 address of the network
* interface is the primary private IPv4 address.
*
*
* -
*
* network-interface.addresses.private-dns-name - The private DNS name.
*
*
* -
*
* network-interface.addresses.private-ip-address - The private IPv4 address associated with
* the network interface.
*
*
* -
*
* network-interface.association.allocation-id - The allocation ID returned when you
* allocated the Elastic IP address (IPv4) for your network interface.
*
*
* -
*
* network-interface.association.association-id - The association ID returned when the
* network interface was associated with an IPv4 address.
*
*
* -
*
* network-interface.association.carrier-ip - The customer-owned IP address.
*
*
* -
*
* network-interface.association.customer-owned-ip - The customer-owned IP address.
*
*
* -
*
* network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4)
* associated with the network interface.
*
*
* -
*
* network-interface.association.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.association.public-ip - The address of the Elastic IP address (IPv4)
* bound to the network interface.
*
*
* -
*
* network-interface.attachment.attach-time - The time that the network interface was
* attached to an instance.
*
*
* -
*
* network-interface.attachment.attachment-id - The ID of the interface attachment.
*
*
* -
*
* network-interface.attachment.delete-on-termination - Specifies whether the attachment is
* deleted when an instance is terminated.
*
*
* -
*
* network-interface.attachment.device-index - The device index to which the network
* interface is attached.
*
*
* -
*
* network-interface.attachment.instance-id - The ID of the instance to which the network
* interface is attached.
*
*
* -
*
* network-interface.attachment.instance-owner-id - The owner ID of the instance to which
* the network interface is attached.
*
*
* -
*
* network-interface.attachment.network-card-index - The index of the network card.
*
*
* -
*
* network-interface.attachment.status - The status of the attachment (
* attaching | attached | detaching | detached).
*
*
* -
*
* network-interface.availability-zone - The Availability Zone for the network interface.
*
*
* -
*
* network-interface.deny-all-igw-traffic - A Boolean that indicates whether a network
* interface with an IPv6 address is unreachable from the public internet.
*
*
* -
*
* network-interface.description - The description of the network interface.
*
*
* -
*
* network-interface.group-id - The ID of a security group associated with the network
* interface.
*
*
* -
*
* network-interface.group-name - The name of a security group associated with the network
* interface.
*
*
* -
*
* network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the
* network interface.
*
*
* -
*
* network-interface.ipv6-address - The IPv6 address associated with the network interface.
*
*
* -
*
* network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the
* network interface.
*
*
* -
*
* network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this
* is the primary IPv6 address.
*
*
* -
*
* network-interface.ipv6-native - A Boolean that indicates whether this is an IPv6 only
* network interface.
*
*
* -
*
* network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network
* interface.
*
*
* -
*
* network-interface.mac-address - The MAC address of the network interface.
*
*
* -
*
* network-interface.network-interface-id - The ID of the network interface.
*
*
* -
*
* network-interface.outpost-arn - The ARN of the Outpost.
*
*
* -
*
* network-interface.owner-id - The ID of the owner of the network interface.
*
*
* -
*
* network-interface.private-dns-name - The private DNS name of the network interface.
*
*
* -
*
* network-interface.private-ip-address - The private IPv4 address.
*
*
* -
*
* network-interface.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.requester-id - The requester ID for the network interface.
*
*
* -
*
* network-interface.requester-managed - Indicates whether the network interface is being
* managed by Amazon Web Services.
*
*
* -
*
* network-interface.status - The status of the network interface (available) |
* in-use).
*
*
* -
*
* network-interface.source-dest-check - Whether the network interface performs
* source/destination checking. A value of true means that checking is enabled, and
* false means that checking is disabled. The value must be false for the
* network interface to perform network address translation (NAT) in your VPC.
*
*
* -
*
* network-interface.subnet-id - The ID of the subnet for the network interface.
*
*
* -
*
* network-interface.tag-key - The key of a tag assigned to the network interface.
*
*
* -
*
* network-interface.tag-value - The value of a tag assigned to the network interface.
*
*
* -
*
* network-interface.vpc-id - The ID of the VPC for the network interface.
*
*
* -
*
* outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the instance owner.
*
*
* -
*
* placement-group-name - The name of the placement group for the instance.
*
*
* -
*
* placement-partition-number - The partition in which the instance is located.
*
*
* -
*
* platform - The platform. To list only Windows instances, use windows.
*
*
* -
*
* platform-details - The platform (Linux/UNIX |
* Red Hat BYOL Linux | Red Hat Enterprise Linux |
* Red Hat Enterprise Linux with HA |
* Red Hat Enterprise Linux with SQL Server Standard and HA |
* Red Hat Enterprise Linux with SQL Server Enterprise and HA |
* Red Hat Enterprise Linux with SQL Server Standard |
* Red Hat Enterprise Linux with SQL Server Web |
* Red Hat Enterprise Linux with SQL Server Enterprise | SQL Server Enterprise
* | SQL Server Standard | SQL Server Web | SUSE Linux |
* Ubuntu Pro | Windows | Windows BYOL |
* Windows with SQL Server Enterprise | Windows with SQL Server Standard |
* Windows with SQL Server Web).
*
*
* -
*
* private-dns-name - The private IPv4 DNS name of the instance.
*
*
* -
*
* private-dns-name-options.enable-resource-name-dns-a-record - A Boolean that indicates
* whether to respond to DNS queries for instance hostnames with DNS A records.
*
*
* -
*
* private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean that indicates
* whether to respond to DNS queries for instance hostnames with DNS AAAA records.
*
*
* -
*
* private-dns-name-options.hostname-type - The type of hostname (ip-name |
* resource-name).
*
*
* -
*
* private-ip-address - The private IPv4 address of the instance. This can only be used to
* filter by the primary IP address of the network interface attached to the instance. To filter by
* additional IP addresses assigned to the network interface, use the filter
* network-interface.addresses.private-ip-address.
*
*
* -
*
* product-code - The product code associated with the AMI used to launch the instance.
*
*
* -
*
* product-code.type - The type of product code (devpay |
* marketplace).
*
*
* -
*
* ramdisk-id - The RAM disk ID.
*
*
* -
*
* reason - The reason for the current state of the instance (for example, shows
* "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code
* filter.
*
*
* -
*
* requester-id - The ID of the entity that launched the instance on your behalf (for
* example, Amazon Web Services Management Console, Auto Scaling, and so on).
*
*
* -
*
* reservation-id - The ID of the instance's reservation. A reservation ID is created any
* time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch
* request, but can be associated with more than one instance if you launch multiple instances using the
* same launch request. For example, if you launch one instance, you get one reservation ID. If you
* launch ten instances using the same launch request, you also get one reservation ID.
*
*
* -
*
* root-device-name - The device name of the root device volume (for example,
* /dev/sda1).
*
*
* -
*
* root-device-type - The type of the root device volume (ebs |
* instance-store).
*
*
* -
*
* source-dest-check - Indicates whether the instance performs source/destination checking.
* A value of true means that checking is enabled, and false means that
* checking is disabled. The value must be false for the instance to perform network address
* translation (NAT) in your VPC.
*
*
* -
*
* spot-instance-request-id - The ID of the Spot Instance request.
*
*
* -
*
* state-reason-code - The reason code for the state change.
*
*
* -
*
* state-reason-message - A message that describes the state change.
*
*
* -
*
* subnet-id - The ID of the subnet for the instance.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the
* tag key in the filter name and the tag value as the filter value. For example, to find all resources
* that have a tag with the key Owner and the value TeamA, specify
* tag:Owner for the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all
* resources that have a tag with a specific key, regardless of the tag value.
*
*
* -
*
* tenancy - The tenancy of an instance (dedicated | default |
* host).
*
*
* -
*
* tpm-support - Indicates if the instance is configured for NitroTPM support (
* v2.0).
*
*
* -
*
* usage-operation - The usage operation value for the instance (RunInstances |
* RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 |
* RunInstances:1014 | RunInstances:1110 | RunInstances:0014 |
* RunInstances:0210 | RunInstances:0110 | RunInstances:0100 |
* RunInstances:0004 | RunInstances:0200 | RunInstances:000g |
* RunInstances:0g00 | RunInstances:0002 | RunInstances:0800 |
* RunInstances:0102 | RunInstances:0006 | RunInstances:0202).
*
*
* -
*
* usage-operation-update-time - The time that the usage operation was last updated, for
* example, 2022-09-15T17:15:20.000Z.
*
*
* -
*
* virtualization-type - The virtualization type of the instance (paravirtual |
* hvm).
*
*
* -
*
* vpc-id - The ID of the VPC that the instance is running in.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Collection filters);
/**
*
* The filters.
*
*
* -
*
* affinity - The affinity setting for an instance running on a Dedicated Host (
* default | host).
*
*
* -
*
* architecture - The instance architecture (i386 | x86_64 |
* arm64).
*
*
* -
*
* availability-zone - The Availability Zone of the instance.
*
*
* -
*
* block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for
* example, 2022-09-15T17:15:20.000Z.
*
*
* -
*
* block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is
* deleted on instance termination.
*
*
* -
*
* block-device-mapping.device-name - The device name specified in the block device mapping (for
* example, /dev/sdh or xvdh).
*
*
* -
*
* block-device-mapping.status - The status for the EBS volume (attaching |
* attached | detaching | detached).
*
*
* -
*
* block-device-mapping.volume-id - The volume ID of the EBS volume.
*
*
* -
*
* boot-mode - The boot mode that was specified by the AMI (legacy-bios |
* uefi | uefi-preferred).
*
*
* -
*
* capacity-reservation-id - The ID of the Capacity Reservation into which the instance was
* launched.
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-preference - The instance's Capacity
* Reservation preference (open | none).
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id - The ID
* of the targeted Capacity Reservation.
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn
* - The ARN of the targeted Capacity Reservation group.
*
*
* -
*
* client-token - The idempotency token you provided when you launched the instance.
*
*
* -
*
* current-instance-boot-mode - The boot mode that is used to launch the instance at launch or
* start (legacy-bios | uefi).
*
*
* -
*
* dns-name - The public DNS name of the instance.
*
*
* -
*
* ebs-optimized - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O.
*
*
* -
*
* ena-support - A Boolean that indicates whether the instance is enabled for enhanced networking
* with ENA.
*
*
* -
*
* enclave-options.enabled - A Boolean that indicates whether the instance is enabled for Amazon
* Web Services Nitro Enclaves.
*
*
* -
*
* hibernation-options.configured - A Boolean that indicates whether the instance is enabled for
* hibernation. A value of true means that the instance is enabled for hibernation.
*
*
* -
*
* host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
*
*
* -
*
* hypervisor - The hypervisor type of the instance (ovm | xen). The
* value xen is used for both Xen and Nitro hypervisors.
*
*
* -
*
* iam-instance-profile.arn - The instance profile associated with the instance. Specified as an
* ARN.
*
*
* -
*
* iam-instance-profile.id - The instance profile associated with the instance. Specified as an ID.
*
*
* -
*
* image-id - The ID of the image used to launch the instance.
*
*
* -
*
* instance-id - The ID of the instance.
*
*
* -
*
* instance-lifecycle - Indicates whether this is a Spot Instance, a Scheduled Instance, or a
* Capacity Block (spot | scheduled | capacity-block).
*
*
* -
*
* instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is
* used for internal purposes and should be ignored. The low byte is set based on the state represented. The
* valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80
* (stopped).
*
*
* -
*
* instance-state-name - The state of the instance (pending | running |
* shutting-down | terminated | stopping | stopped).
*
*
* -
*
* instance-type - The type of instance (for example, t2.micro).
*
*
* -
*
* instance.group-id - The ID of the security group for the instance.
*
*
* -
*
* instance.group-name - The name of the security group for the instance.
*
*
* -
*
* ip-address - The public IPv4 address of the instance.
*
*
* -
*
* ipv6-address - The IPv6 address of the instance.
*
*
* -
*
* kernel-id - The kernel ID.
*
*
* -
*
* key-name - The name of the key pair used when the instance was launched.
*
*
* -
*
* launch-index - When launching multiple instances, this is the index for the instance in the
* launch group (for example, 0, 1, 2, and so on).
*
*
* -
*
* launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time
* zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (
* *), for example, 2021-09-29T*, which matches an entire day.
*
*
* -
*
* maintenance-options.auto-recovery - The current automatic recovery behavior of the instance (
* disabled | default).
*
*
* -
*
* metadata-options.http-endpoint - The status of access to the HTTP metadata endpoint on your
* instance (enabled | disabled)
*
*
* -
*
* metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint is enabled (
* disabled | enabled).
*
*
* -
*
* metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 endpoint is enabled (
* disabled | enabled).
*
*
* -
*
* metadata-options.http-put-response-hop-limit - The HTTP metadata request put response hop limit
* (integer, possible values 1 to 64)
*
*
* -
*
* metadata-options.http-tokens - The metadata request authorization state (optional |
* required)
*
*
* -
*
* metadata-options.instance-metadata-tags - The status of access to instance tags from the
* instance metadata (enabled | disabled)
*
*
* -
*
* metadata-options.state - The state of the metadata option changes (pending |
* applied).
*
*
* -
*
* monitoring-state - Indicates whether detailed monitoring is enabled (disabled |
* enabled).
*
*
* -
*
* network-interface.addresses.association.allocation-id - The allocation ID.
*
*
* -
*
* network-interface.addresses.association.association-id - The association ID.
*
*
* -
*
* network-interface.addresses.association.carrier-ip - The carrier IP address.
*
*
* -
*
* network-interface.addresses.association.customer-owned-ip - The customer-owned IP address.
*
*
* -
*
* network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address
* associated with the network interface.
*
*
* -
*
* network-interface.addresses.association.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP
* address (IPv4) with a network interface.
*
*
* -
*
* network-interface.addresses.primary - Specifies whether the IPv4 address of the network
* interface is the primary private IPv4 address.
*
*
* -
*
* network-interface.addresses.private-dns-name - The private DNS name.
*
*
* -
*
* network-interface.addresses.private-ip-address - The private IPv4 address associated with the
* network interface.
*
*
* -
*
* network-interface.association.allocation-id - The allocation ID returned when you allocated the
* Elastic IP address (IPv4) for your network interface.
*
*
* -
*
* network-interface.association.association-id - The association ID returned when the network
* interface was associated with an IPv4 address.
*
*
* -
*
* network-interface.association.carrier-ip - The customer-owned IP address.
*
*
* -
*
* network-interface.association.customer-owned-ip - The customer-owned IP address.
*
*
* -
*
* network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4)
* associated with the network interface.
*
*
* -
*
* network-interface.association.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to
* the network interface.
*
*
* -
*
* network-interface.attachment.attach-time - The time that the network interface was attached to
* an instance.
*
*
* -
*
* network-interface.attachment.attachment-id - The ID of the interface attachment.
*
*
* -
*
* network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted
* when an instance is terminated.
*
*
* -
*
* network-interface.attachment.device-index - The device index to which the network interface is
* attached.
*
*
* -
*
* network-interface.attachment.instance-id - The ID of the instance to which the network interface
* is attached.
*
*
* -
*
* network-interface.attachment.instance-owner-id - The owner ID of the instance to which the
* network interface is attached.
*
*
* -
*
* network-interface.attachment.network-card-index - The index of the network card.
*
*
* -
*
* network-interface.attachment.status - The status of the attachment (attaching |
* attached | detaching | detached).
*
*
* -
*
* network-interface.availability-zone - The Availability Zone for the network interface.
*
*
* -
*
* network-interface.deny-all-igw-traffic - A Boolean that indicates whether a network interface
* with an IPv6 address is unreachable from the public internet.
*
*
* -
*
* network-interface.description - The description of the network interface.
*
*
* -
*
* network-interface.group-id - The ID of a security group associated with the network interface.
*
*
* -
*
* network-interface.group-name - The name of a security group associated with the network
* interface.
*
*
* -
*
* network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the network
* interface.
*
*
* -
*
* network-interface.ipv6-address - The IPv6 address associated with the network interface.
*
*
* -
*
* network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network
* interface.
*
*
* -
*
* network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this is the
* primary IPv6 address.
*
*
* -
*
* network-interface.ipv6-native - A Boolean that indicates whether this is an IPv6 only network
* interface.
*
*
* -
*
* network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network interface.
*
*
* -
*
* network-interface.mac-address - The MAC address of the network interface.
*
*
* -
*
* network-interface.network-interface-id - The ID of the network interface.
*
*
* -
*
* network-interface.outpost-arn - The ARN of the Outpost.
*
*
* -
*
* network-interface.owner-id - The ID of the owner of the network interface.
*
*
* -
*
* network-interface.private-dns-name - The private DNS name of the network interface.
*
*
* -
*
* network-interface.private-ip-address - The private IPv4 address.
*
*
* -
*
* network-interface.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.requester-id - The requester ID for the network interface.
*
*
* -
*
* network-interface.requester-managed - Indicates whether the network interface is being managed
* by Amazon Web Services.
*
*
* -
*
* network-interface.status - The status of the network interface (available) |
* in-use).
*
*
* -
*
* network-interface.source-dest-check - Whether the network interface performs source/destination
* checking. A value of true means that checking is enabled, and false means that
* checking is disabled. The value must be false for the network interface to perform network
* address translation (NAT) in your VPC.
*
*
* -
*
* network-interface.subnet-id - The ID of the subnet for the network interface.
*
*
* -
*
* network-interface.tag-key - The key of a tag assigned to the network interface.
*
*
* -
*
* network-interface.tag-value - The value of a tag assigned to the network interface.
*
*
* -
*
* network-interface.vpc-id - The ID of the VPC for the network interface.
*
*
* -
*
* outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the instance owner.
*
*
* -
*
* placement-group-name - The name of the placement group for the instance.
*
*
* -
*
* placement-partition-number - The partition in which the instance is located.
*
*
* -
*
* platform - The platform. To list only Windows instances, use windows.
*
*
* -
*
* platform-details - The platform (Linux/UNIX | Red Hat BYOL Linux |
* Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA |
* Red Hat Enterprise Linux with SQL Server Standard and HA |
* Red Hat Enterprise Linux with SQL Server Enterprise and HA |
* Red Hat Enterprise Linux with SQL Server Standard |
* Red Hat Enterprise Linux with SQL Server Web |
* Red Hat Enterprise Linux with SQL Server Enterprise | SQL Server Enterprise |
* SQL Server Standard | SQL Server Web | SUSE Linux |
* Ubuntu Pro | Windows | Windows BYOL |
* Windows with SQL Server Enterprise | Windows with SQL Server Standard |
* Windows with SQL Server Web).
*
*
* -
*
* private-dns-name - The private IPv4 DNS name of the instance.
*
*
* -
*
* private-dns-name-options.enable-resource-name-dns-a-record - A Boolean that indicates whether to
* respond to DNS queries for instance hostnames with DNS A records.
*
*
* -
*
* private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean that indicates whether
* to respond to DNS queries for instance hostnames with DNS AAAA records.
*
*
* -
*
* private-dns-name-options.hostname-type - The type of hostname (ip-name |
* resource-name).
*
*
* -
*
* private-ip-address - The private IPv4 address of the instance. This can only be used to filter
* by the primary IP address of the network interface attached to the instance. To filter by additional IP
* addresses assigned to the network interface, use the filter
* network-interface.addresses.private-ip-address.
*
*
* -
*
* product-code - The product code associated with the AMI used to launch the instance.
*
*
* -
*
* product-code.type - The type of product code (devpay | marketplace).
*
*
* -
*
* ramdisk-id - The RAM disk ID.
*
*
* -
*
* reason - The reason for the current state of the instance (for example, shows
* "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.
*
*
* -
*
* requester-id - The ID of the entity that launched the instance on your behalf (for example,
* Amazon Web Services Management Console, Auto Scaling, and so on).
*
*
* -
*
* reservation-id - The ID of the instance's reservation. A reservation ID is created any time you
* launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can
* be associated with more than one instance if you launch multiple instances using the same launch request. For
* example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same
* launch request, you also get one reservation ID.
*
*
* -
*
* root-device-name - The device name of the root device volume (for example,
* /dev/sda1).
*
*
* -
*
* root-device-type - The type of the root device volume (ebs |
* instance-store).
*
*
* -
*
* source-dest-check - Indicates whether the instance performs source/destination checking. A value
* of true means that checking is enabled, and false means that checking is disabled.
* The value must be false for the instance to perform network address translation (NAT) in your
* VPC.
*
*
* -
*
* spot-instance-request-id - The ID of the Spot Instance request.
*
*
* -
*
* state-reason-code - The reason code for the state change.
*
*
* -
*
* state-reason-message - A message that describes the state change.
*
*
* -
*
* subnet-id - The ID of the subnet for the instance.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key
* in the filter name and the tag value as the filter value. For example, to find all resources that have a tag
* with the key Owner and the value TeamA, specify tag:Owner for the
* filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that
* have a tag with a specific key, regardless of the tag value.
*
*
* -
*
* tenancy - The tenancy of an instance (dedicated | default |
* host).
*
*
* -
*
* tpm-support - Indicates if the instance is configured for NitroTPM support (v2.0).
*
*
* -
*
* usage-operation - The usage operation value for the instance (RunInstances |
* RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 |
* RunInstances:1014 | RunInstances:1110 | RunInstances:0014 |
* RunInstances:0210 | RunInstances:0110 | RunInstances:0100 |
* RunInstances:0004 | RunInstances:0200 | RunInstances:000g |
* RunInstances:0g00 | RunInstances:0002 | RunInstances:0800 |
* RunInstances:0102 | RunInstances:0006 | RunInstances:0202).
*
*
* -
*
* usage-operation-update-time - The time that the usage operation was last updated, for example,
* 2022-09-15T17:15:20.000Z.
*
*
* -
*
* virtualization-type - The virtualization type of the instance (paravirtual |
* hvm).
*
*
* -
*
* vpc-id - The ID of the VPC that the instance is running in.
*
*
*
*
* @param filters
* The filters.
*
* -
*
* affinity - The affinity setting for an instance running on a Dedicated Host (
* default | host).
*
*
* -
*
* architecture - The instance architecture (i386 | x86_64 |
* arm64).
*
*
* -
*
* availability-zone - The Availability Zone of the instance.
*
*
* -
*
* block-device-mapping.attach-time - The attach time for an EBS volume mapped to the
* instance, for example, 2022-09-15T17:15:20.000Z.
*
*
* -
*
* block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS
* volume is deleted on instance termination.
*
*
* -
*
* block-device-mapping.device-name - The device name specified in the block device mapping
* (for example, /dev/sdh or xvdh).
*
*
* -
*
* block-device-mapping.status - The status for the EBS volume (attaching |
* attached | detaching | detached).
*
*
* -
*
* block-device-mapping.volume-id - The volume ID of the EBS volume.
*
*
* -
*
* boot-mode - The boot mode that was specified by the AMI (legacy-bios |
* uefi | uefi-preferred).
*
*
* -
*
* capacity-reservation-id - The ID of the Capacity Reservation into which the instance was
* launched.
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-preference - The instance's
* Capacity Reservation preference (open | none).
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id -
* The ID of the targeted Capacity Reservation.
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn
* - The ARN of the targeted Capacity Reservation group.
*
*
* -
*
* client-token - The idempotency token you provided when you launched the instance.
*
*
* -
*
* current-instance-boot-mode - The boot mode that is used to launch the instance at launch
* or start (legacy-bios | uefi).
*
*
* -
*
* dns-name - The public DNS name of the instance.
*
*
* -
*
* ebs-optimized - A Boolean that indicates whether the instance is optimized for Amazon EBS
* I/O.
*
*
* -
*
* ena-support - A Boolean that indicates whether the instance is enabled for enhanced
* networking with ENA.
*
*
* -
*
* enclave-options.enabled - A Boolean that indicates whether the instance is enabled for
* Amazon Web Services Nitro Enclaves.
*
*
* -
*
* hibernation-options.configured - A Boolean that indicates whether the instance is enabled
* for hibernation. A value of true means that the instance is enabled for hibernation.
*
*
* -
*
* host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
*
*
* -
*
* hypervisor - The hypervisor type of the instance (ovm | xen).
* The value xen is used for both Xen and Nitro hypervisors.
*
*
* -
*
* iam-instance-profile.arn - The instance profile associated with the instance. Specified
* as an ARN.
*
*
* -
*
* iam-instance-profile.id - The instance profile associated with the instance. Specified as
* an ID.
*
*
* -
*
* image-id - The ID of the image used to launch the instance.
*
*
* -
*
* instance-id - The ID of the instance.
*
*
* -
*
* instance-lifecycle - Indicates whether this is a Spot Instance, a Scheduled Instance, or
* a Capacity Block (spot | scheduled | capacity-block).
*
*
* -
*
* instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high
* byte is used for internal purposes and should be ignored. The low byte is set based on the state
* represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64
* (stopping), and 80 (stopped).
*
*
* -
*
* instance-state-name - The state of the instance (pending |
* running | shutting-down | terminated | stopping |
* stopped).
*
*
* -
*
* instance-type - The type of instance (for example, t2.micro).
*
*
* -
*
* instance.group-id - The ID of the security group for the instance.
*
*
* -
*
* instance.group-name - The name of the security group for the instance.
*
*
* -
*
* ip-address - The public IPv4 address of the instance.
*
*
* -
*
* ipv6-address - The IPv6 address of the instance.
*
*
* -
*
* kernel-id - The kernel ID.
*
*
* -
*
* key-name - The name of the key pair used when the instance was launched.
*
*
* -
*
* launch-index - When launching multiple instances, this is the index for the instance in
* the launch group (for example, 0, 1, 2, and so on).
*
*
* -
*
* launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC
* time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use
* a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
*
*
* -
*
* maintenance-options.auto-recovery - The current automatic recovery behavior of the
* instance (disabled | default).
*
*
* -
*
* metadata-options.http-endpoint - The status of access to the HTTP metadata endpoint on
* your instance (enabled | disabled)
*
*
* -
*
* metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint is enabled (
* disabled | enabled).
*
*
* -
*
* metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 endpoint is enabled (
* disabled | enabled).
*
*
* -
*
* metadata-options.http-put-response-hop-limit - The HTTP metadata request put response hop
* limit (integer, possible values 1 to 64)
*
*
* -
*
* metadata-options.http-tokens - The metadata request authorization state (
* optional | required)
*
*
* -
*
* metadata-options.instance-metadata-tags - The status of access to instance tags from the
* instance metadata (enabled | disabled)
*
*
* -
*
* metadata-options.state - The state of the metadata option changes (pending |
* applied).
*
*
* -
*
* monitoring-state - Indicates whether detailed monitoring is enabled (
* disabled | enabled).
*
*
* -
*
* network-interface.addresses.association.allocation-id - The allocation ID.
*
*
* -
*
* network-interface.addresses.association.association-id - The association ID.
*
*
* -
*
* network-interface.addresses.association.carrier-ip - The carrier IP address.
*
*
* -
*
* network-interface.addresses.association.customer-owned-ip - The customer-owned IP
* address.
*
*
* -
*
* network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4
* address associated with the network interface.
*
*
* -
*
* network-interface.addresses.association.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.addresses.association.public-ip - The ID of the association of an
* Elastic IP address (IPv4) with a network interface.
*
*
* -
*
* network-interface.addresses.primary - Specifies whether the IPv4 address of the network
* interface is the primary private IPv4 address.
*
*
* -
*
* network-interface.addresses.private-dns-name - The private DNS name.
*
*
* -
*
* network-interface.addresses.private-ip-address - The private IPv4 address associated with
* the network interface.
*
*
* -
*
* network-interface.association.allocation-id - The allocation ID returned when you
* allocated the Elastic IP address (IPv4) for your network interface.
*
*
* -
*
* network-interface.association.association-id - The association ID returned when the
* network interface was associated with an IPv4 address.
*
*
* -
*
* network-interface.association.carrier-ip - The customer-owned IP address.
*
*
* -
*
* network-interface.association.customer-owned-ip - The customer-owned IP address.
*
*
* -
*
* network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4)
* associated with the network interface.
*
*
* -
*
* network-interface.association.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.association.public-ip - The address of the Elastic IP address (IPv4)
* bound to the network interface.
*
*
* -
*
* network-interface.attachment.attach-time - The time that the network interface was
* attached to an instance.
*
*
* -
*
* network-interface.attachment.attachment-id - The ID of the interface attachment.
*
*
* -
*
* network-interface.attachment.delete-on-termination - Specifies whether the attachment is
* deleted when an instance is terminated.
*
*
* -
*
* network-interface.attachment.device-index - The device index to which the network
* interface is attached.
*
*
* -
*
* network-interface.attachment.instance-id - The ID of the instance to which the network
* interface is attached.
*
*
* -
*
* network-interface.attachment.instance-owner-id - The owner ID of the instance to which
* the network interface is attached.
*
*
* -
*
* network-interface.attachment.network-card-index - The index of the network card.
*
*
* -
*
* network-interface.attachment.status - The status of the attachment (
* attaching | attached | detaching | detached).
*
*
* -
*
* network-interface.availability-zone - The Availability Zone for the network interface.
*
*
* -
*
* network-interface.deny-all-igw-traffic - A Boolean that indicates whether a network
* interface with an IPv6 address is unreachable from the public internet.
*
*
* -
*
* network-interface.description - The description of the network interface.
*
*
* -
*
* network-interface.group-id - The ID of a security group associated with the network
* interface.
*
*
* -
*
* network-interface.group-name - The name of a security group associated with the network
* interface.
*
*
* -
*
* network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the
* network interface.
*
*
* -
*
* network-interface.ipv6-address - The IPv6 address associated with the network interface.
*
*
* -
*
* network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the
* network interface.
*
*
* -
*
* network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this
* is the primary IPv6 address.
*
*
* -
*
* network-interface.ipv6-native - A Boolean that indicates whether this is an IPv6 only
* network interface.
*
*
* -
*
* network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network
* interface.
*
*
* -
*
* network-interface.mac-address - The MAC address of the network interface.
*
*
* -
*
* network-interface.network-interface-id - The ID of the network interface.
*
*
* -
*
* network-interface.outpost-arn - The ARN of the Outpost.
*
*
* -
*
* network-interface.owner-id - The ID of the owner of the network interface.
*
*
* -
*
* network-interface.private-dns-name - The private DNS name of the network interface.
*
*
* -
*
* network-interface.private-ip-address - The private IPv4 address.
*
*
* -
*
* network-interface.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.requester-id - The requester ID for the network interface.
*
*
* -
*
* network-interface.requester-managed - Indicates whether the network interface is being
* managed by Amazon Web Services.
*
*
* -
*
* network-interface.status - The status of the network interface (available) |
* in-use).
*
*
* -
*
* network-interface.source-dest-check - Whether the network interface performs
* source/destination checking. A value of true means that checking is enabled, and
* false means that checking is disabled. The value must be false for the
* network interface to perform network address translation (NAT) in your VPC.
*
*
* -
*
* network-interface.subnet-id - The ID of the subnet for the network interface.
*
*
* -
*
* network-interface.tag-key - The key of a tag assigned to the network interface.
*
*
* -
*
* network-interface.tag-value - The value of a tag assigned to the network interface.
*
*
* -
*
* network-interface.vpc-id - The ID of the VPC for the network interface.
*
*
* -
*
* outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the instance owner.
*
*
* -
*
* placement-group-name - The name of the placement group for the instance.
*
*
* -
*
* placement-partition-number - The partition in which the instance is located.
*
*
* -
*
* platform - The platform. To list only Windows instances, use windows.
*
*
* -
*
* platform-details - The platform (Linux/UNIX |
* Red Hat BYOL Linux | Red Hat Enterprise Linux |
* Red Hat Enterprise Linux with HA |
* Red Hat Enterprise Linux with SQL Server Standard and HA |
* Red Hat Enterprise Linux with SQL Server Enterprise and HA |
* Red Hat Enterprise Linux with SQL Server Standard |
* Red Hat Enterprise Linux with SQL Server Web |
* Red Hat Enterprise Linux with SQL Server Enterprise | SQL Server Enterprise
* | SQL Server Standard | SQL Server Web | SUSE Linux |
* Ubuntu Pro | Windows | Windows BYOL |
* Windows with SQL Server Enterprise | Windows with SQL Server Standard |
* Windows with SQL Server Web).
*
*
* -
*
* private-dns-name - The private IPv4 DNS name of the instance.
*
*
* -
*
* private-dns-name-options.enable-resource-name-dns-a-record - A Boolean that indicates
* whether to respond to DNS queries for instance hostnames with DNS A records.
*
*
* -
*
* private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean that indicates
* whether to respond to DNS queries for instance hostnames with DNS AAAA records.
*
*
* -
*
* private-dns-name-options.hostname-type - The type of hostname (ip-name |
* resource-name).
*
*
* -
*
* private-ip-address - The private IPv4 address of the instance. This can only be used to
* filter by the primary IP address of the network interface attached to the instance. To filter by
* additional IP addresses assigned to the network interface, use the filter
* network-interface.addresses.private-ip-address.
*
*
* -
*
* product-code - The product code associated with the AMI used to launch the instance.
*
*
* -
*
* product-code.type - The type of product code (devpay |
* marketplace).
*
*
* -
*
* ramdisk-id - The RAM disk ID.
*
*
* -
*
* reason - The reason for the current state of the instance (for example, shows
* "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code
* filter.
*
*
* -
*
* requester-id - The ID of the entity that launched the instance on your behalf (for
* example, Amazon Web Services Management Console, Auto Scaling, and so on).
*
*
* -
*
* reservation-id - The ID of the instance's reservation. A reservation ID is created any
* time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch
* request, but can be associated with more than one instance if you launch multiple instances using the
* same launch request. For example, if you launch one instance, you get one reservation ID. If you
* launch ten instances using the same launch request, you also get one reservation ID.
*
*
* -
*
* root-device-name - The device name of the root device volume (for example,
* /dev/sda1).
*
*
* -
*
* root-device-type - The type of the root device volume (ebs |
* instance-store).
*
*
* -
*
* source-dest-check - Indicates whether the instance performs source/destination checking.
* A value of true means that checking is enabled, and false means that
* checking is disabled. The value must be false for the instance to perform network address
* translation (NAT) in your VPC.
*
*
* -
*
* spot-instance-request-id - The ID of the Spot Instance request.
*
*
* -
*
* state-reason-code - The reason code for the state change.
*
*
* -
*
* state-reason-message - A message that describes the state change.
*
*
* -
*
* subnet-id - The ID of the subnet for the instance.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the
* tag key in the filter name and the tag value as the filter value. For example, to find all resources
* that have a tag with the key Owner and the value TeamA, specify
* tag:Owner for the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all
* resources that have a tag with a specific key, regardless of the tag value.
*
*
* -
*
* tenancy - The tenancy of an instance (dedicated | default |
* host).
*
*
* -
*
* tpm-support - Indicates if the instance is configured for NitroTPM support (
* v2.0).
*
*
* -
*
* usage-operation - The usage operation value for the instance (RunInstances |
* RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 |
* RunInstances:1014 | RunInstances:1110 | RunInstances:0014 |
* RunInstances:0210 | RunInstances:0110 | RunInstances:0100 |
* RunInstances:0004 | RunInstances:0200 | RunInstances:000g |
* RunInstances:0g00 | RunInstances:0002 | RunInstances:0800 |
* RunInstances:0102 | RunInstances:0006 | RunInstances:0202).
*
*
* -
*
* usage-operation-update-time - The time that the usage operation was last updated, for
* example, 2022-09-15T17:15:20.000Z.
*
*
* -
*
* virtualization-type - The virtualization type of the instance (paravirtual |
* hvm).
*
*
* -
*
* vpc-id - The ID of the VPC that the instance is running in.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Filter... filters);
/**
*
* The filters.
*
*
* -
*
* affinity - The affinity setting for an instance running on a Dedicated Host (
* default | host).
*
*
* -
*
* architecture - The instance architecture (i386 | x86_64 |
* arm64).
*
*
* -
*
* availability-zone - The Availability Zone of the instance.
*
*
* -
*
* block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for
* example, 2022-09-15T17:15:20.000Z.
*
*
* -
*
* block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is
* deleted on instance termination.
*
*
* -
*
* block-device-mapping.device-name - The device name specified in the block device mapping (for
* example, /dev/sdh or xvdh).
*
*
* -
*
* block-device-mapping.status - The status for the EBS volume (attaching |
* attached | detaching | detached).
*
*
* -
*
* block-device-mapping.volume-id - The volume ID of the EBS volume.
*
*
* -
*
* boot-mode - The boot mode that was specified by the AMI (legacy-bios |
* uefi | uefi-preferred).
*
*
* -
*
* capacity-reservation-id - The ID of the Capacity Reservation into which the instance was
* launched.
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-preference - The instance's Capacity
* Reservation preference (open | none).
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id - The ID
* of the targeted Capacity Reservation.
*
*
* -
*
* capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn
* - The ARN of the targeted Capacity Reservation group.
*
*
* -
*
* client-token - The idempotency token you provided when you launched the instance.
*
*
* -
*
* current-instance-boot-mode - The boot mode that is used to launch the instance at launch or
* start (legacy-bios | uefi).
*
*
* -
*
* dns-name - The public DNS name of the instance.
*
*
* -
*
* ebs-optimized - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O.
*
*
* -
*
* ena-support - A Boolean that indicates whether the instance is enabled for enhanced networking
* with ENA.
*
*
* -
*
* enclave-options.enabled - A Boolean that indicates whether the instance is enabled for Amazon
* Web Services Nitro Enclaves.
*
*
* -
*
* hibernation-options.configured - A Boolean that indicates whether the instance is enabled for
* hibernation. A value of true means that the instance is enabled for hibernation.
*
*
* -
*
* host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
*
*
* -
*
* hypervisor - The hypervisor type of the instance (ovm | xen). The
* value xen is used for both Xen and Nitro hypervisors.
*
*
* -
*
* iam-instance-profile.arn - The instance profile associated with the instance. Specified as an
* ARN.
*
*
* -
*
* iam-instance-profile.id - The instance profile associated with the instance. Specified as an ID.
*
*
* -
*
* image-id - The ID of the image used to launch the instance.
*
*
* -
*
* instance-id - The ID of the instance.
*
*
* -
*
* instance-lifecycle - Indicates whether this is a Spot Instance, a Scheduled Instance, or a
* Capacity Block (spot | scheduled | capacity-block).
*
*
* -
*
* instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is
* used for internal purposes and should be ignored. The low byte is set based on the state represented. The
* valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80
* (stopped).
*
*
* -
*
* instance-state-name - The state of the instance (pending | running |
* shutting-down | terminated | stopping | stopped).
*
*
* -
*
* instance-type - The type of instance (for example, t2.micro).
*
*
* -
*
* instance.group-id - The ID of the security group for the instance.
*
*
* -
*
* instance.group-name - The name of the security group for the instance.
*
*
* -
*
* ip-address - The public IPv4 address of the instance.
*
*
* -
*
* ipv6-address - The IPv6 address of the instance.
*
*
* -
*
* kernel-id - The kernel ID.
*
*
* -
*
* key-name - The name of the key pair used when the instance was launched.
*
*
* -
*
* launch-index - When launching multiple instances, this is the index for the instance in the
* launch group (for example, 0, 1, 2, and so on).
*
*
* -
*
* launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time
* zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (
* *), for example, 2021-09-29T*, which matches an entire day.
*
*
* -
*
* maintenance-options.auto-recovery - The current automatic recovery behavior of the instance (
* disabled | default).
*
*
* -
*
* metadata-options.http-endpoint - The status of access to the HTTP metadata endpoint on your
* instance (enabled | disabled)
*
*
* -
*
* metadata-options.http-protocol-ipv4 - Indicates whether the IPv4 endpoint is enabled (
* disabled | enabled).
*
*
* -
*
* metadata-options.http-protocol-ipv6 - Indicates whether the IPv6 endpoint is enabled (
* disabled | enabled).
*
*
* -
*
* metadata-options.http-put-response-hop-limit - The HTTP metadata request put response hop limit
* (integer, possible values 1 to 64)
*
*
* -
*
* metadata-options.http-tokens - The metadata request authorization state (optional |
* required)
*
*
* -
*
* metadata-options.instance-metadata-tags - The status of access to instance tags from the
* instance metadata (enabled | disabled)
*
*
* -
*
* metadata-options.state - The state of the metadata option changes (pending |
* applied).
*
*
* -
*
* monitoring-state - Indicates whether detailed monitoring is enabled (disabled |
* enabled).
*
*
* -
*
* network-interface.addresses.association.allocation-id - The allocation ID.
*
*
* -
*
* network-interface.addresses.association.association-id - The association ID.
*
*
* -
*
* network-interface.addresses.association.carrier-ip - The carrier IP address.
*
*
* -
*
* network-interface.addresses.association.customer-owned-ip - The customer-owned IP address.
*
*
* -
*
* network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address
* associated with the network interface.
*
*
* -
*
* network-interface.addresses.association.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP
* address (IPv4) with a network interface.
*
*
* -
*
* network-interface.addresses.primary - Specifies whether the IPv4 address of the network
* interface is the primary private IPv4 address.
*
*
* -
*
* network-interface.addresses.private-dns-name - The private DNS name.
*
*
* -
*
* network-interface.addresses.private-ip-address - The private IPv4 address associated with the
* network interface.
*
*
* -
*
* network-interface.association.allocation-id - The allocation ID returned when you allocated the
* Elastic IP address (IPv4) for your network interface.
*
*
* -
*
* network-interface.association.association-id - The association ID returned when the network
* interface was associated with an IPv4 address.
*
*
* -
*
* network-interface.association.carrier-ip - The customer-owned IP address.
*
*
* -
*
* network-interface.association.customer-owned-ip - The customer-owned IP address.
*
*
* -
*
* network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4)
* associated with the network interface.
*
*
* -
*
* network-interface.association.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to
* the network interface.
*
*
* -
*
* network-interface.attachment.attach-time - The time that the network interface was attached to
* an instance.
*
*
* -
*
* network-interface.attachment.attachment-id - The ID of the interface attachment.
*
*
* -
*
* network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted
* when an instance is terminated.
*
*
* -
*
* network-interface.attachment.device-index - The device index to which the network interface is
* attached.
*
*
* -
*
* network-interface.attachment.instance-id - The ID of the instance to which the network interface
* is attached.
*
*
* -
*
* network-interface.attachment.instance-owner-id - The owner ID of the instance to which the
* network interface is attached.
*
*
* -
*
* network-interface.attachment.network-card-index - The index of the network card.
*
*
* -
*
* network-interface.attachment.status - The status of the attachment (attaching |
* attached | detaching | detached).
*
*
* -
*
* network-interface.availability-zone - The Availability Zone for the network interface.
*
*
* -
*
* network-interface.deny-all-igw-traffic - A Boolean that indicates whether a network interface
* with an IPv6 address is unreachable from the public internet.
*
*
* -
*
* network-interface.description - The description of the network interface.
*
*
* -
*
* network-interface.group-id - The ID of a security group associated with the network interface.
*
*
* -
*
* network-interface.group-name - The name of a security group associated with the network
* interface.
*
*
* -
*
* network-interface.ipv4-prefixes.ipv4-prefix - The IPv4 prefixes that are assigned to the network
* interface.
*
*
* -
*
* network-interface.ipv6-address - The IPv6 address associated with the network interface.
*
*
* -
*
* network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network
* interface.
*
*
* -
*
* network-interface.ipv6-addresses.is-primary-ipv6 - A Boolean that indicates whether this is the
* primary IPv6 address.
*
*
* -
*
* network-interface.ipv6-native - A Boolean that indicates whether this is an IPv6 only network
* interface.
*
*
* -
*
* network-interface.ipv6-prefixes.ipv6-prefix - The IPv6 prefix assigned to the network interface.
*
*
* -
*
* network-interface.mac-address - The MAC address of the network interface.
*
*
* -
*
* network-interface.network-interface-id - The ID of the network interface.
*
*
* -
*
* network-interface.outpost-arn - The ARN of the Outpost.
*
*
* -
*
* network-interface.owner-id - The ID of the owner of the network interface.
*
*
* -
*
* network-interface.private-dns-name - The private DNS name of the network interface.
*
*
* -
*
* network-interface.private-ip-address - The private IPv4 address.
*
*
* -
*
* network-interface.public-dns-name - The public DNS name.
*
*
* -
*
* network-interface.requester-id - The requester ID for the network interface.
*
*
* -
*
* network-interface.requester-managed - Indicates whether the network interface is being managed
* by Amazon Web Services.
*
*
* -
*
* network-interface.status - The status of the network interface (available) |
* in-use).
*
*
* -
*
* network-interface.source-dest-check - Whether the network interface performs source/destination
* checking. A value of true means that checking is enabled, and false means that
* checking is disabled. The value must be false for the network interface to perform network
* address translation (NAT) in your VPC.
*
*
* -
*
* network-interface.subnet-id - The ID of the subnet for the network interface.
*
*
* -
*
* network-interface.tag-key - The key of a tag assigned to the network interface.
*
*
* -
*
* network-interface.tag-value - The value of a tag assigned to the network interface.
*
*
* -
*
* network-interface.vpc-id - The ID of the VPC for the network interface.
*
*
* -
*
* outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the instance owner.
*
*
* -
*
* placement-group-name - The name of the placement group for the instance.
*
*
* -
*
* placement-partition-number - The partition in which the instance is located.
*
*
* -
*
* platform - The platform. To list only Windows instances, use windows.
*
*
* -
*
* platform-details - The platform (Linux/UNIX | Red Hat BYOL Linux |
* Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA |
* Red Hat Enterprise Linux with SQL Server Standard and HA |
* Red Hat Enterprise Linux with SQL Server Enterprise and HA |
* Red Hat Enterprise Linux with SQL Server Standard |
* Red Hat Enterprise Linux with SQL Server Web |
* Red Hat Enterprise Linux with SQL Server Enterprise | SQL Server Enterprise |
* SQL Server Standard | SQL Server Web | SUSE Linux |
* Ubuntu Pro | Windows | Windows BYOL |
* Windows with SQL Server Enterprise | Windows with SQL Server Standard |
* Windows with SQL Server Web).
*
*
* -
*
* private-dns-name - The private IPv4 DNS name of the instance.
*
*
* -
*
* private-dns-name-options.enable-resource-name-dns-a-record - A Boolean that indicates whether to
* respond to DNS queries for instance hostnames with DNS A records.
*
*
* -
*
* private-dns-name-options.enable-resource-name-dns-aaaa-record - A Boolean that indicates whether
* to respond to DNS queries for instance hostnames with DNS AAAA records.
*
*
* -
*
* private-dns-name-options.hostname-type - The type of hostname (ip-name |
* resource-name).
*
*
* -
*
* private-ip-address - The private IPv4 address of the instance. This can only be used to filter
* by the primary IP address of the network interface attached to the instance. To filter by additional IP
* addresses assigned to the network interface, use the filter
* network-interface.addresses.private-ip-address.
*
*
* -
*
* product-code - The product code associated with the AMI used to launch the instance.
*
*
* -
*
* product-code.type - The type of product code (devpay | marketplace).
*
*
* -
*
* ramdisk-id - The RAM disk ID.
*
*
* -
*
* reason - The reason for the current state of the instance (for example, shows
* "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.
*
*
* -
*
* requester-id - The ID of the entity that launched the instance on your behalf (for example,
* Amazon Web Services Management Console, Auto Scaling, and so on).
*
*
* -
*
* reservation-id - The ID of the instance's reservation. A reservation ID is created any time you
* launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can
* be associated with more than one instance if you launch multiple instances using the same launch request. For
* example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same
* launch request, you also get one reservation ID.
*
*
* -
*
* root-device-name - The device name of the root device volume (for example,
* /dev/sda1).
*
*
* -
*
* root-device-type - The type of the root device volume (ebs |
* instance-store).
*
*
* -
*
* source-dest-check - Indicates whether the instance performs source/destination checking. A value
* of true means that checking is enabled, and false means that checking is disabled.
* The value must be false for the instance to perform network address translation (NAT) in your
* VPC.
*
*
* -
*
* spot-instance-request-id - The ID of the Spot Instance request.
*
*
* -
*
* state-reason-code - The reason code for the state change.
*
*
* -
*
* state-reason-message - A message that describes the state change.
*
*
* -
*
* subnet-id - The ID of the subnet for the instance.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key
* in the filter name and the tag value as the filter value. For example, to find all resources that have a tag
* with the key Owner and the value TeamA, specify tag:Owner for the
* filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that
* have a tag with a specific key, regardless of the tag value.
*
*
* -
*
* tenancy - The tenancy of an instance (dedicated | default |
* host).
*
*
* -
*
* tpm-support - Indicates if the instance is configured for NitroTPM support (v2.0).
*
*
* -
*
* usage-operation - The usage operation value for the instance (RunInstances |
* RunInstances:00g0 | RunInstances:0010 | RunInstances:1010 |
* RunInstances:1014 | RunInstances:1110 | RunInstances:0014 |
* RunInstances:0210 | RunInstances:0110 | RunInstances:0100 |
* RunInstances:0004 | RunInstances:0200 | RunInstances:000g |
* RunInstances:0g00 | RunInstances:0002 | RunInstances:0800 |
* RunInstances:0102 | RunInstances:0006 | RunInstances:0202).
*
*
* -
*
* usage-operation-update-time - The time that the usage operation was last updated, for example,
* 2022-09-15T17:15:20.000Z.
*
*
* -
*
* virtualization-type - The virtualization type of the instance (paravirtual |
* hvm).
*
*
* -
*
* vpc-id - The ID of the VPC that the instance is running in.
*
*
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ec2.model.Filter.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.ec2.model.Filter#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.ec2.model.Filter.Builder#build()}
* is called immediately and its result is passed to {@link #filters(List)}.
*
* @param filters
* a consumer that will call methods on {@link software.amazon.awssdk.services.ec2.model.Filter.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #filters(java.util.Collection)
*/
Builder filters(Consumer... filters);
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned
* by the previous request.
*
*
* @param nextToken
* The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* 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.
*
*
* You cannot specify this parameter and the instance IDs parameter in the same request.
*
*
* @param 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.
*
* You cannot specify this parameter and the instance IDs parameter in the same request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends Ec2Request.BuilderImpl implements Builder {
private List instanceIds = DefaultSdkAutoConstructList.getInstance();
private Boolean dryRun;
private List filters = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private Integer maxResults;
private BuilderImpl() {
}
private BuilderImpl(DescribeInstancesRequest model) {
super(model);
instanceIds(model.instanceIds);
dryRun(model.dryRun);
filters(model.filters);
nextToken(model.nextToken);
maxResults(model.maxResults);
}
public final Collection getInstanceIds() {
if (instanceIds instanceof SdkAutoConstructList) {
return null;
}
return instanceIds;
}
public final void setInstanceIds(Collection instanceIds) {
this.instanceIds = InstanceIdStringListCopier.copy(instanceIds);
}
@Override
public final Builder instanceIds(Collection instanceIds) {
this.instanceIds = InstanceIdStringListCopier.copy(instanceIds);
return this;
}
@Override
@SafeVarargs
public final Builder instanceIds(String... instanceIds) {
instanceIds(Arrays.asList(instanceIds));
return this;
}
public final Boolean getDryRun() {
return dryRun;
}
public final void setDryRun(Boolean dryRun) {
this.dryRun = dryRun;
}
@Override
public final Builder dryRun(Boolean dryRun) {
this.dryRun = dryRun;
return this;
}
public final List getFilters() {
List result = FilterListCopier.copyToBuilder(this.filters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setFilters(Collection filters) {
this.filters = FilterListCopier.copyFromBuilder(filters);
}
@Override
public final Builder filters(Collection filters) {
this.filters = FilterListCopier.copy(filters);
return this;
}
@Override
@SafeVarargs
public final Builder filters(Filter... filters) {
filters(Arrays.asList(filters));
return this;
}
@Override
@SafeVarargs
public final Builder filters(Consumer... filters) {
filters(Stream.of(filters).map(c -> Filter.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeInstancesRequest build() {
return new DescribeInstancesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}