Instance
¶
Source code in docs_src/capo_ec2/types/instance.py
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 | |
ami_launch_index
instance-attribute
¶
ami_launch_index: NotRequired[Integer]
The AMI launch index, which can be used to find this instance in the launch group.
architecture
instance-attribute
¶
architecture: NotRequired[ArchitectureValues]
The architecture of the image.
block_device_mappings
instance-attribute
¶
block_device_mappings: NotRequired[InstanceBlockDeviceMappingList]
Any block device mapping entries for the instance.
boot_mode
instance-attribute
¶
boot_mode: NotRequired[BootModeValues]
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.
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.
capacity_block_id
instance-attribute
¶
capacity_block_id: NotRequired[String]
The ID of the Capacity Block.
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.
capacity_reservation_id
instance-attribute
¶
capacity_reservation_id: NotRequired[String]
The ID of the Capacity Reservation.
capacity_reservation_specification
instance-attribute
¶
capacity_reservation_specification: NotRequired[
CapacityReservationSpecificationResponse
]
Information about the Capacity Reservation targeting option.
client_token
instance-attribute
¶
client_token: NotRequired[String]
The idempotency token you provided when you launched the instance, if applicable.
cpu_options
instance-attribute
¶
cpu_options: NotRequired[CpuOptions]
The CPU options for the instance.
current_instance_boot_mode
instance-attribute
¶
current_instance_boot_mode: NotRequired[InstanceBootModeValues]
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.
ebs_optimized
instance-attribute
¶
ebs_optimized: NotRequired[Boolean]
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.
elastic_gpu_associations
instance-attribute
¶
elastic_gpu_associations: NotRequired[ElasticGpuAssociationList]
Deprecated.
Amazon Elastic Graphics reached end of life on January 8, 2024.
elastic_inference_accelerator_associations
instance-attribute
¶
elastic_inference_accelerator_associations: NotRequired[
ElasticInferenceAcceleratorAssociationList
]
Deprecated
Amazon Elastic Inference is no longer available.
ena_support
instance-attribute
¶
ena_support: NotRequired[Boolean]
Specifies whether enhanced networking with ENA is enabled.
enclave_options
instance-attribute
¶
enclave_options: NotRequired[EnclaveOptions]
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
hibernation_options
instance-attribute
¶
hibernation_options: NotRequired[HibernationOptions]
Indicates whether the instance is enabled for hibernation.
hypervisor
instance-attribute
¶
hypervisor: NotRequired[HypervisorType]
The hypervisor type of the instance. The value xen is used for both Xen and Nitro hypervisors.
iam_instance_profile
instance-attribute
¶
iam_instance_profile: NotRequired[IamInstanceProfile]
The IAM instance profile associated with the instance, if applicable.
image_id
instance-attribute
¶
image_id: NotRequired[String]
The ID of the AMI used to launch the instance.
instance_lifecycle
instance-attribute
¶
instance_lifecycle: NotRequired[InstanceLifecycleType]
Indicates whether this is a Spot Instance or a Scheduled Instance.
ipv6_address
instance-attribute
¶
ipv6_address: NotRequired[String]
The IPv6 address assigned to the instance.
kernel_id
instance-attribute
¶
kernel_id: NotRequired[String]
The kernel associated with this instance, if applicable.
key_name
instance-attribute
¶
key_name: NotRequired[String]
The name of the key pair, if this instance was launched with an associated key pair.
launch_time
instance-attribute
¶
launch_time: NotRequired[DateTime]
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.
licenses
instance-attribute
¶
licenses: NotRequired[LicenseList]
The license configurations for the instance.
maintenance_options
instance-attribute
¶
maintenance_options: NotRequired[InstanceMaintenanceOptions]
Provides information on the recovery and maintenance options of your instance.
metadata_options
instance-attribute
¶
metadata_options: NotRequired[InstanceMetadataOptionsResponse]
The metadata options for the instance.
monitoring
instance-attribute
¶
monitoring: NotRequired[Monitoring]
The monitoring for the instance.
network_interfaces
instance-attribute
¶
network_interfaces: NotRequired[InstanceNetworkInterfaceList]
The network interfaces for the instance.
network_performance_options
instance-attribute
¶
network_performance_options: NotRequired[InstanceNetworkPerformanceOptions]
Contains settings for the network performance options for your instance.
operator
instance-attribute
¶
operator: NotRequired[OperatorResponse]
The service provider that manages the instance.
outpost_arn
instance-attribute
¶
outpost_arn: NotRequired[String]
The Amazon Resource Name (ARN) of the Outpost.
placement
instance-attribute
¶
placement: NotRequired[Placement]
The location where the instance launched, if applicable.
platform
instance-attribute
¶
platform: NotRequired[PlatformValues]
The platform. This value is windows for Windows instances; otherwise, it is empty.
platform_details
instance-attribute
¶
platform_details: NotRequired[String]
The platform details value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.
private_dns_name
instance-attribute
¶
private_dns_name: NotRequired[String]
[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.
private_dns_name_options
instance-attribute
¶
private_dns_name_options: NotRequired[PrivateDnsNameOptionsResponse]
The options for the instance hostname.
private_ip_address
instance-attribute
¶
private_ip_address: NotRequired[String]
The private IPv4 address assigned to the instance.
product_codes
instance-attribute
¶
product_codes: NotRequired[ProductCodeList]
The product codes attached to this instance, if applicable.
public_dns_name
instance-attribute
¶
public_dns_name: NotRequired[String]
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.
public_ip_address
instance-attribute
¶
public_ip_address: NotRequired[String]
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.
ramdisk_id
instance-attribute
¶
ramdisk_id: NotRequired[String]
The RAM disk associated with this instance, if applicable.
root_device_name
instance-attribute
¶
root_device_name: NotRequired[String]
The device name of the root device volume (for example, /dev/sda1).
root_device_type
instance-attribute
¶
root_device_type: NotRequired[DeviceType]
The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
secondary_interfaces
instance-attribute
¶
secondary_interfaces: NotRequired[InstanceSecondaryInterfaceList]
The secondary interfaces for the instance.
security_groups
instance-attribute
¶
security_groups: NotRequired[GroupIdentifierList]
The security groups for the instance.
source_dest_check
instance-attribute
¶
source_dest_check: NotRequired[Boolean]
Indicates whether source/destination checking is enabled.
spot_instance_request_id
instance-attribute
¶
spot_instance_request_id: NotRequired[String]
If the request is a Spot Instance request, the ID of the request.
sriov_net_support
instance-attribute
¶
sriov_net_support: NotRequired[String]
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
state_reason
instance-attribute
¶
state_reason: NotRequired[StateReason]
The reason for the most recent state transition.
state_transition_reason
instance-attribute
¶
state_transition_reason: NotRequired[String]
The reason for the most recent state transition. This might be an empty string.
subnet_id
instance-attribute
¶
subnet_id: NotRequired[String]
The ID of the subnet in which the instance is running.
tpm_support
instance-attribute
¶
tpm_support: NotRequired[String]
If the instance is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.
usage_operation
instance-attribute
¶
usage_operation: NotRequired[String]
The usage operation value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.
usage_operation_update_time
instance-attribute
¶
usage_operation_update_time: NotRequired[MillisecondDateTime]
The time that the usage operation was last updated.
virtualization_type
instance-attribute
¶
virtualization_type: NotRequired[VirtualizationType]
The virtualization type of the instance.