Skip to content

Instance

Source code in docs_src/capo_ec2/types/instance.py
class Instance(TypedDict, closed=True):
    architecture: NotRequired["capo_ec2.types.architecture_values.ArchitectureValues"]
    """<p>The architecture of the image.</p>"""
    block_device_mappings: NotRequired[
        "capo_ec2.types.instance_block_device_mapping_list.InstanceBlockDeviceMappingList"
    ]
    """<p>Any block device mapping entries for the instance.</p>"""
    client_token: NotRequired["capo_ec2.types.string.String"]
    """<p>The idempotency token you provided when you launched the instance, if applicable.</p>"""
    ebs_optimized: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>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.</p>"""
    ena_support: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Specifies whether enhanced networking with ENA is enabled.</p>"""
    hypervisor: NotRequired["capo_ec2.types.hypervisor_type.HypervisorType"]
    """<p>The hypervisor type of the instance. The value <code>xen</code> is used for both Xen and Nitro hypervisors.</p>"""
    iam_instance_profile: NotRequired[
        "capo_ec2.types.iam_instance_profile.IamInstanceProfile"
    ]
    """<p>The IAM instance profile associated with the instance, if applicable.</p>"""
    instance_lifecycle: NotRequired[
        "capo_ec2.types.instance_lifecycle_type.InstanceLifecycleType"
    ]
    """<p>Indicates whether this is a Spot Instance or a Scheduled Instance.</p>"""
    elastic_gpu_associations: NotRequired[
        "capo_ec2.types.elastic_gpu_association_list.ElasticGpuAssociationList"
    ]
    """<p>Deprecated.</p> <note> <p>Amazon Elastic Graphics reached end of life on January 8, 2024.</p> </note>"""
    elastic_inference_accelerator_associations: NotRequired[
        "capo_ec2.types.elastic_inference_accelerator_association_list.ElasticInferenceAcceleratorAssociationList"
    ]
    """<p>Deprecated</p> <note> <p>Amazon Elastic Inference is no longer available.</p> </note>"""
    network_interfaces: NotRequired[
        "capo_ec2.types.instance_network_interface_list.InstanceNetworkInterfaceList"
    ]
    """<p>The network interfaces for the instance.</p>"""
    outpost_arn: NotRequired["capo_ec2.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the Outpost.</p>"""
    root_device_name: NotRequired["capo_ec2.types.string.String"]
    """<p>The device name of the root device volume (for example, <code>/dev/sda1</code>).</p>"""
    root_device_type: NotRequired["capo_ec2.types.device_type.DeviceType"]
    """<p>The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.</p>"""
    security_groups: NotRequired[
        "capo_ec2.types.group_identifier_list.GroupIdentifierList"
    ]
    """<p>The security groups for the instance.</p>"""
    source_dest_check: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether source/destination checking is enabled.</p>"""
    spot_instance_request_id: NotRequired["capo_ec2.types.string.String"]
    """<p>If the request is a Spot Instance request, the ID of the request.</p>"""
    sriov_net_support: NotRequired["capo_ec2.types.string.String"]
    """<p>Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.</p>"""
    state_reason: NotRequired["capo_ec2.types.state_reason.StateReason"]
    """<p>The reason for the most recent state transition.</p>"""
    tags: NotRequired["capo_ec2.types.tag_list.TagList"]
    """<p>Any tags assigned to the instance.</p>"""
    virtualization_type: NotRequired[
        "capo_ec2.types.virtualization_type.VirtualizationType"
    ]
    """<p>The virtualization type of the instance.</p>"""
    cpu_options: NotRequired["capo_ec2.types.cpu_options.CpuOptions"]
    """<p>The CPU options for the instance.</p>"""
    capacity_block_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the Capacity Block.</p> <note> <p>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.</p> </note>"""
    capacity_reservation_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the Capacity Reservation.</p>"""
    capacity_reservation_specification: NotRequired[
        "capo_ec2.types.capacity_reservation_specification_response.CapacityReservationSpecificationResponse"
    ]
    """<p>Information about the Capacity Reservation targeting option.</p>"""
    hibernation_options: NotRequired[
        "capo_ec2.types.hibernation_options.HibernationOptions"
    ]
    """<p>Indicates whether the instance is enabled for hibernation.</p>"""
    licenses: NotRequired["capo_ec2.types.license_list.LicenseList"]
    """<p>The license configurations for the instance.</p>"""
    metadata_options: NotRequired[
        "capo_ec2.types.instance_metadata_options_response.InstanceMetadataOptionsResponse"
    ]
    """<p>The metadata options for the instance.</p>"""
    enclave_options: NotRequired["capo_ec2.types.enclave_options.EnclaveOptions"]
    """<p>Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.</p>"""
    boot_mode: NotRequired["capo_ec2.types.boot_mode_values.BootModeValues"]
    """<p>The boot mode that was specified by the AMI. If the value is <code>uefi-preferred</code>, the AMI supports both UEFI and Legacy BIOS. The <code>currentInstanceBootMode</code> parameter is the boot mode that is used to boot the instance at launch or start.</p> <note> <p>The operating system contained in the AMI must be configured to support the specified boot mode.</p> </note> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html">Boot modes</a> in the <i>Amazon EC2 User Guide</i>.</p>"""
    platform_details: NotRequired["capo_ec2.types.string.String"]
    """<p>The platform details value for the instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html">AMI billing information fields</a> in the <i>Amazon EC2 User Guide</i>.</p>"""
    usage_operation: NotRequired["capo_ec2.types.string.String"]
    """<p>The usage operation value for the instance. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html">AMI billing information fields</a> in the <i>Amazon EC2 User Guide</i>.</p>"""
    usage_operation_update_time: NotRequired[
        "capo_ec2.types.millisecond_date_time.MillisecondDateTime"
    ]
    """<p>The time that the usage operation was last updated.</p>"""
    private_dns_name_options: NotRequired[
        "capo_ec2.types.private_dns_name_options_response.PrivateDnsNameOptionsResponse"
    ]
    """<p>The options for the instance hostname.</p>"""
    ipv6_address: NotRequired["capo_ec2.types.string.String"]
    """<p>The IPv6 address assigned to the instance.</p>"""
    tpm_support: NotRequired["capo_ec2.types.string.String"]
    """<p>If the instance is configured for NitroTPM support, the value is <code>v2.0</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html">NitroTPM</a> in the <i>Amazon EC2 User Guide</i>.</p>"""
    maintenance_options: NotRequired[
        "capo_ec2.types.instance_maintenance_options.InstanceMaintenanceOptions"
    ]
    """<p>Provides information on the recovery and maintenance options of your instance.</p>"""
    current_instance_boot_mode: NotRequired[
        "capo_ec2.types.instance_boot_mode_values.InstanceBootModeValues"
    ]
    """<p>The boot mode that is used to boot the instance at launch or start. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html">Boot modes</a> in the <i>Amazon EC2 User Guide</i>.</p>"""
    network_performance_options: NotRequired[
        "capo_ec2.types.instance_network_performance_options.InstanceNetworkPerformanceOptions"
    ]
    """<p>Contains settings for the network performance options for your instance.</p>"""
    operator: NotRequired["capo_ec2.types.operator_response.OperatorResponse"]
    """<p>The service provider that manages the instance.</p>"""
    secondary_interfaces: NotRequired[
        "capo_ec2.types.instance_secondary_interface_list.InstanceSecondaryInterfaceList"
    ]
    """<p>The secondary interfaces for the instance.</p>"""
    instance_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the instance.</p>"""
    image_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the AMI used to launch the instance.</p>"""
    state: NotRequired["capo_ec2.types.instance_state.InstanceState"]
    """<p>The current state of the instance.</p>"""
    private_dns_name: NotRequired["capo_ec2.types.string.String"]
    """<p>[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 <code>running</code> state. </p> <p>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.</p>"""
    public_dns_name: NotRequired["capo_ec2.types.string.String"]
    """<p>The public DNS name assigned to the instance. This name is not available until the instance enters the <code>running</code> state. This name is only available if you've enabled DNS hostnames for your VPC. The format of this name depends on the <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hostname-types.html#public-hostnames">public hostname type</a>.</p>"""
    state_transition_reason: NotRequired["capo_ec2.types.string.String"]
    """<p>The reason for the most recent state transition. This might be an empty string.</p>"""
    key_name: NotRequired["capo_ec2.types.string.String"]
    """<p>The name of the key pair, if this instance was launched with an associated key pair.</p>"""
    ami_launch_index: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The AMI launch index, which can be used to find this instance in the launch group.</p>"""
    product_codes: NotRequired["capo_ec2.types.product_code_list.ProductCodeList"]
    """<p>The product codes attached to this instance, if applicable.</p>"""
    instance_type: NotRequired["capo_ec2.types.instance_type.InstanceType"]
    """<p>The instance type.</p>"""
    launch_time: NotRequired["capo_ec2.types.date_time.DateTime"]
    """<p>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.</p>"""
    placement: NotRequired["capo_ec2.types.placement.Placement"]
    """<p>The location where the instance launched, if applicable.</p>"""
    kernel_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The kernel associated with this instance, if applicable.</p>"""
    ramdisk_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The RAM disk associated with this instance, if applicable.</p>"""
    platform: NotRequired["capo_ec2.types.platform_values.PlatformValues"]
    """<p>The platform. This value is <code>windows</code> for Windows instances; otherwise, it is empty.</p>"""
    monitoring: NotRequired["capo_ec2.types.monitoring.Monitoring"]
    """<p>The monitoring for the instance.</p>"""
    subnet_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the subnet in which the instance is running.</p>"""
    vpc_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the VPC in which the instance is running.</p>"""
    private_ip_address: NotRequired["capo_ec2.types.string.String"]
    """<p>The private IPv4 address assigned to the instance.</p>"""
    public_ip_address: NotRequired["capo_ec2.types.string.String"]
    """<p>The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.</p> <p>A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.</p>"""

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_id instance-attribute

instance_id: NotRequired[String]

The ID of the instance.

instance_lifecycle instance-attribute

instance_lifecycle: NotRequired[InstanceLifecycleType]

Indicates whether this is a Spot Instance or a Scheduled Instance.

instance_type instance-attribute

instance_type: NotRequired[InstanceType]

The instance type.

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 instance-attribute

state: NotRequired[InstanceState]

The current state of the instance.

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.

tags instance-attribute

tags: NotRequired[TagList]

Any tags assigned to the instance.

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.

vpc_id instance-attribute

vpc_id: NotRequired[String]

The ID of the VPC in which the instance is running.