Instance¶
Structure Class¶
dataclass
¶
Bases: _SerdeShape
Describes an instance.
Attributes¶
class-attribute
instance-attribute
¶
ami_launch_index: int | None = ...
The AMI launch index, which can be used to find this instance in the launch group.
class-attribute
instance-attribute
¶
architecture: str | None = ...
The architecture of the image.
class-attribute
instance-attribute
¶
block_device_mappings: list[InstanceBlockDeviceMapping] | None = ...
Any block device mapping entries for the instance.
class-attribute
instance-attribute
¶
boot_mode: str | None = ...
The boot mode that was specified by the AMI. If the value is
uefi-preferred, the AMI supports both UEFI and Legacy BIOS. The
currentInstanceBootMode parameter is the boot mode that is used to
boot the instance at launch or start.
Note
The operating system contained in the AMI must be configured to support the specified boot mode.
For more information, see Boot modes in the Amazon EC2 User Guide.
class-attribute
instance-attribute
¶
capacity_block_id: str | None = ...
The ID of the Capacity Block.
Note
For P5 instances, a Capacity Block ID refers to a group of instances. For Trn2u instances, a capacity block ID refers to an EC2 UltraServer.
class-attribute
instance-attribute
¶
capacity_reservation_id: str | None = ...
The ID of the Capacity Reservation.
class-attribute
instance-attribute
¶
capacity_reservation_specification: CapacityReservationSpecificationResponse | None = ...
Information about the Capacity Reservation targeting option.
class-attribute
instance-attribute
¶
client_token: str | None = ...
The idempotency token you provided when you launched the instance, if applicable.
class-attribute
instance-attribute
¶
cpu_options: CpuOptions | None = ...
The CPU options for the instance.
class-attribute
instance-attribute
¶
current_instance_boot_mode: str | None = ...
The boot mode that is used to boot the instance at launch or start. For more information, see Boot modes in the Amazon EC2 User Guide.
class-attribute
instance-attribute
¶
ebs_optimized: bool | None = ...
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
class-attribute
instance-attribute
¶
elastic_gpu_associations: list[ElasticGpuAssociation] | None = ...
Deprecated.
Note
Amazon Elastic Graphics reached end of life on January 8, 2024.
class-attribute
instance-attribute
¶
elastic_inference_accelerator_associations: list[ElasticInferenceAcceleratorAssociation] | None = ...
Deprecated
Note
Amazon Elastic Inference is no longer available.
class-attribute
instance-attribute
¶
ena_support: bool | None = ...
Specifies whether enhanced networking with ENA is enabled.
class-attribute
instance-attribute
¶
enclave_options: EnclaveOptions | None = ...
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
class-attribute
instance-attribute
¶
hibernation_options: HibernationOptions | None = ...
Indicates whether the instance is enabled for hibernation.
class-attribute
instance-attribute
¶
hypervisor: str | None = ...
The hypervisor type of the instance. The value xen is used for both
Xen and Nitro hypervisors.
class-attribute
instance-attribute
¶
iam_instance_profile: IamInstanceProfile | None = ...
The IAM instance profile associated with the instance, if applicable.
class-attribute
instance-attribute
¶
image_id: str | None = ...
The ID of the AMI used to launch the instance.
class-attribute
instance-attribute
¶
instance_id: str | None = ...
The ID of the instance.
class-attribute
instance-attribute
¶
instance_lifecycle: str | None = ...
Indicates whether this is a Spot Instance or a Scheduled Instance.
class-attribute
instance-attribute
¶
instance_type: str | None = ...
The instance type.
class-attribute
instance-attribute
¶
ipv6_address: str | None = ...
The IPv6 address assigned to the instance.
class-attribute
instance-attribute
¶
kernel_id: str | None = ...
The kernel associated with this instance, if applicable.
class-attribute
instance-attribute
¶
key_name: str | None = ...
The name of the key pair, if this instance was launched with an associated key pair.
class-attribute
instance-attribute
¶
launch_time: datetime | None = ...
The time that the instance was last launched. To determine the time that instance was first launched, see the attachment time for the primary network interface.
class-attribute
instance-attribute
¶
licenses: list[LicenseConfiguration] | None = ...
The license configurations for the instance.
class-attribute
instance-attribute
¶
maintenance_options: InstanceMaintenanceOptions | None = ...
Provides information on the recovery and maintenance options of your instance.
class-attribute
instance-attribute
¶
metadata_options: InstanceMetadataOptionsResponse | None = ...
The metadata options for the instance.
class-attribute
instance-attribute
¶
monitoring: Monitoring | None = ...
The monitoring for the instance.
class-attribute
instance-attribute
¶
network_interfaces: list[InstanceNetworkInterface] | None = ...
The network interfaces for the instance.
class-attribute
instance-attribute
¶
network_performance_options: InstanceNetworkPerformanceOptions | None = ...
Contains settings for the network performance options for your instance.
class-attribute
instance-attribute
¶
operator: OperatorResponse | None = ...
The service provider that manages the instance.
class-attribute
instance-attribute
¶
outpost_arn: str | None = ...
The Amazon Resource Name (ARN) of the Outpost.
class-attribute
instance-attribute
¶
placement: Placement | None = ...
The location where the instance launched, if applicable.
class-attribute
instance-attribute
¶
platform: str | None = ...
The platform. This value is windows for Windows instances; otherwise,
it is empty.
class-attribute
instance-attribute
¶
platform_details: str | None = ...
The platform details value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.
class-attribute
instance-attribute
¶
private_dns_name: str | None = ...
[IPv4 only] The private DNS hostname name assigned to the instance.
This DNS hostname can only be used inside the Amazon EC2 network. This
name is not available until the instance enters the running state.
The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.
class-attribute
instance-attribute
¶
private_dns_name_options: PrivateDnsNameOptionsResponse | None = ...
The options for the instance hostname.
class-attribute
instance-attribute
¶
private_ip_address: str | None = ...
The private IPv4 address assigned to the instance.
class-attribute
instance-attribute
¶
product_codes: list[ProductCode] | None = ...
The product codes attached to this instance, if applicable.
class-attribute
instance-attribute
¶
public_dns_name: str | None = ...
The public DNS name assigned to the instance. This name is not available
until the instance enters the running state. This name is only
available if you've enabled DNS hostnames for your VPC. The format of
this name depends on the public hostname
type.
class-attribute
instance-attribute
¶
public_ip_address: str | None = ...
The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.
A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.
class-attribute
instance-attribute
¶
ramdisk_id: str | None = ...
The RAM disk associated with this instance, if applicable.
class-attribute
instance-attribute
¶
root_device_name: str | None = ...
The device name of the root device volume (for example, /dev/sda1).
class-attribute
instance-attribute
¶
root_device_type: str | None = ...
The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
class-attribute
instance-attribute
¶
secondary_interfaces: list[InstanceSecondaryInterface] | None = ...
The secondary interfaces for the instance.
class-attribute
instance-attribute
¶
security_groups: list[GroupIdentifier] | None = ...
The security groups for the instance.
class-attribute
instance-attribute
¶
source_dest_check: bool | None = ...
Indicates whether source/destination checking is enabled.
class-attribute
instance-attribute
¶
spot_instance_request_id: str | None = ...
If the request is a Spot Instance request, the ID of the request.
class-attribute
instance-attribute
¶
sriov_net_support: str | None = ...
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
class-attribute
instance-attribute
¶
state: InstanceState | None = ...
The current state of the instance.
class-attribute
instance-attribute
¶
state_reason: StateReason | None = ...
The reason for the most recent state transition.
class-attribute
instance-attribute
¶
state_transition_reason: str | None = ...
The reason for the most recent state transition. This might be an empty string.
class-attribute
instance-attribute
¶
subnet_id: str | None = ...
The ID of the subnet in which the instance is running.
class-attribute
instance-attribute
¶
Any tags assigned to the instance.
class-attribute
instance-attribute
¶
tpm_support: str | None = ...
If the instance is configured for NitroTPM support, the value is v2.0.
For more information, see
NitroTPM
in the Amazon EC2 User Guide.
class-attribute
instance-attribute
¶
usage_operation: str | None = ...
The usage operation value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.
class-attribute
instance-attribute
¶
usage_operation_update_time: datetime | None = ...
The time that the usage operation was last updated.