Instance

ec2.services.k8s.aws/v1alpha1

Metadata#

Describes an instance.

Spec#

blockDeviceMappings:
- deviceName: string
  ebs: 
    deleteOnTermination: boolean
    encrypted: boolean
    iops: integer
    kmsKeyID: string
    outpostARN: string
    snapshotID: string
    throughput: integer
    volumeSize: integer
    volumeType: string
  noDevice: string
  virtualName: string
capacityReservationSpecification: 
  capacityReservationPreference: string
  capacityReservationTarget: 
    capacityReservationID: string
    capacityReservationResourceGroupARN: string
cpuOptions: 
  coreCount: integer
  threadsPerCore: integer
creditSpecification: 
  cpuCredits: string
disableAPIStop: boolean
disableAPITermination: boolean
ebsOptimized: boolean
elasticGPUSpecification:
- type_: string
elasticInferenceAccelerators:
- count: integer
  type_: string
enclaveOptions: 
  enabled: boolean
hibernationOptions: 
  configured: boolean
iamInstanceProfile: 
  arn: string
  name: string
imageID: string
instanceInitiatedShutdownBehavior: string
instanceMarketOptions: 
  marketType: string
  spotOptions: 
    blockDurationMinutes: integer
    instanceInterruptionBehavior: string
    maxPrice: string
    spotInstanceType: string
    validUntil: string
instanceType: string
ipv6AddressCount: integer
ipv6Addresses:
- ipv6Address: string
kernelID: string
keyName: string
launchTemplate: 
  launchTemplateID: string
  launchTemplateName: string
  version: string
licenseSpecifications:
- licenseConfigurationARN: string
maintenanceOptions: 
  autoRecovery: string
maxCount: integer
metadataOptions: 
  httpEndpoint: string
  httpProtocolIPv6: string
  httpPutResponseHopLimit: integer
  httpTokens: string
  instanceMetadataTags: string
minCount: integer
monitoring: 
  enabled: boolean
networkInterfaces:
- associateCarrierIPAddress: boolean
  associatePublicIPAddress: boolean
  deleteOnTermination: boolean
  description: string
  deviceIndex: integer
  interfaceType: string
  ipv4PrefixCount: integer
  ipv4Prefixes:
  - ipv4Prefix: string
  ipv6AddressCount: integer
  ipv6Addresses:
  - ipv6Address: string
  ipv6PrefixCount: integer
  ipv6Prefixes:
  - ipv6Prefix: string
  networkCardIndex: integer
  networkInterfaceID: string
  privateIPAddress: string
  privateIPAddresses:
  - primary: boolean
    privateIPAddress: string
  secondaryPrivateIPAddressCount: integer
  subnetID: string
placement: 
  affinity: string
  availabilityZone: string
  groupName: string
  hostID: string
  hostResourceGroupARN: string
  partitionNumber: integer
  spreadDomain: string
  tenancy: string
privateDNSNameOptions: 
  enableResourceNameDNSAAAARecord: boolean
  enableResourceNameDNSARecord: boolean
  hostnameType: string
privateIPAddress: string
ramDiskID: string
securityGroupIDs:
- string
securityGroups:
- string
subnetID: string
tags:
- key: string
  value: string
userData: string

A specification for an Elastic Graphics accelerator. || **elasticGPUSpecification.[].type_**
Optional | **string**
| | **elasticInferenceAccelerators**
Optional | **array**
An elastic inference accelerator to associate with the instance.

Amazon Elastic Inference is no longer available. | | **elasticInferenceAccelerators.[]**
Required | **object**
Amazon Elastic Inference is no longer available.

Describes an elastic inference accelerator. || elasticInferenceAccelerators.[].count
Optional | integer
| | **elasticInferenceAccelerators.[].type_**
Optional | **string**
| | **enclaveOptions**
Optional | **object**
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
For more information, see What is Amazon Web Services Nitro Enclaves? (https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html)
in the Amazon Web Services Nitro Enclaves User Guide.

You can’t enable Amazon Web Services Nitro Enclaves and hibernation on the
same instance. | | **enclaveOptions.enabled**
Optional | **boolean**
| | **hibernationOptions**
Optional | **object**
Indicates whether an instance is enabled for hibernation. This parameter
is valid only if the instance meets the hibernation prerequisites (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html).
For more information, see Hibernate your Amazon EC2 instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html)
in the Amazon EC2 User Guide.

You can’t enable hibernation and Amazon Web Services Nitro Enclaves on the
same instance. | | **hibernationOptions.configured**
Optional | **boolean**
| | **iamInstanceProfile**
Optional | **object**
The name or Amazon Resource Name (ARN) of an IAM instance profile. | | **iamInstanceProfile.arn**
Optional | **string**
| | **iamInstanceProfile.name**
Optional | **string**
| | **imageID**
Optional | **string**
The ID of the AMI. An AMI ID is required to launch an instance and must be
specified here or in a launch template. | | **instanceInitiatedShutdownBehavior**
Optional | **string**
Indicates whether an instance stops or terminates when you initiate shutdown
from the instance (using the operating system command for system shutdown).

Default: stop | | **instanceMarketOptions**
Optional | **object**
The market (purchasing) option for the instances.

For RunInstances, persistent Spot Instance requests are only supported when
InstanceInterruptionBehavior is set to either hibernate or stop. | | **instanceMarketOptions.marketType**
Optional | **string**
| | **instanceMarketOptions.spotOptions**
Optional | **object**
The options for Spot Instances. | | **instanceMarketOptions.spotOptions.blockDurationMinutes**
Optional | **integer**
| | **instanceMarketOptions.spotOptions.instanceInterruptionBehavior**
Optional | **string**
| | **instanceMarketOptions.spotOptions.maxPrice**
Optional | **string**
| | **instanceMarketOptions.spotOptions.spotInstanceType**
Optional | **string**
| | **instanceMarketOptions.spotOptions.validUntil**
Optional | **string**
| | **instanceType**
Optional | **string**
The instance type. For more information, see Amazon EC2 instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html)
in the Amazon EC2 User Guide. | | **ipv6AddressCount**
Optional | **integer**
The number of IPv6 addresses to associate with the primary network interface.
Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You
cannot specify this option and the option to assign specific IPv6 addresses
in the same request. You can specify this option if you’ve specified a minimum
number of instances to launch.

You cannot specify this option and the network interfaces option in the same
request. | | **ipv6Addresses**
Optional | **array**
The IPv6 addresses from the range of the subnet to associate with the primary
network interface. You cannot specify this option and the option to assign
a number of IPv6 addresses in the same request. You cannot specify this option
if you’ve specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same
request. | | **ipv6Addresses.[]**
Required | **object**
Describes an IPv6 address. || **ipv6Addresses.[].ipv6Address**
Optional | **string**
| | **kernelID**
Optional | **string**
The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more
information, see PV-GRUB (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html)
in the Amazon EC2 User Guide. | | **keyName**
Optional | **string**
The name of the key pair. You can create a key pair using CreateKeyPair (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html)
or ImportKeyPair (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html).

If you do not specify a key pair, you can’t connect to the instance unless
you choose an AMI that is configured to allow users another way to log in. | | **launchTemplate**
Optional | **object**
The launch template. Any additional parameters that you specify for the new
instance overwrite the corresponding parameters included in the launch template. | | **launchTemplate.launchTemplateID**
Optional | **string**
| | **launchTemplate.launchTemplateName**
Optional | **string**
| | **launchTemplate.version**
Optional | **string**
| | **licenseSpecifications**
Optional | **array**
The license configurations. | | **licenseSpecifications.[]**
Required | **object**
Describes a license configuration. || **licenseSpecifications.[].licenseConfigurationARN**
Optional | **string**
| | **maintenanceOptions**
Optional | **object**
The maintenance and recovery options for the instance. | | **maintenanceOptions.autoRecovery**
Optional | **string**
| | **maxCount**
Optional | **integer**
The maximum number of instances to launch. If you specify a value that is
more capacity than Amazon EC2 can launch in the target Availability Zone,
Amazon EC2 launches the largest possible number of instances above the specified
minimum count.

Constraints: Between 1 and the quota for the specified instance type for
your account for this Region. For more information, see Amazon EC2 instance
type quotas (https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-instance-quotas.html). | | **metadataOptions**
Optional | **object**
The metadata options for the instance. For more information, see Instance
metadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html). | | **metadataOptions.httpEndpoint**
Optional | **string**
| | **metadataOptions.httpProtocolIPv6**
Optional | **string**
| | **metadataOptions.httpPutResponseHopLimit**
Optional | **integer**
| | **metadataOptions.httpTokens**
Optional | **string**
| | **metadataOptions.instanceMetadataTags**
Optional | **string**
| | **minCount**
Optional | **integer**
The minimum number of instances to launch. If you specify a value that is
more capacity than Amazon EC2 can provide in the target Availability Zone,
Amazon EC2 does not launch any instances.

Constraints: Between 1 and the quota for the specified instance type for
your account for this Region. For more information, see Amazon EC2 instance
type quotas (https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-instance-quotas.html). | | **monitoring**
Optional | **object**
Specifies whether detailed monitoring is enabled for the instance. | | **monitoring.enabled**
Optional | **boolean**
| | **networkInterfaces**
Optional | **array**
The network interfaces to associate with the instance. | | **networkInterfaces.[]**
Required | **object**
Describes a network interface. || **networkInterfaces.[].associateCarrierIPAddress**
Optional | **boolean**
| | **networkInterfaces.[].associatePublicIPAddress**
Optional | **boolean**
| | **networkInterfaces.[].deleteOnTermination**
Optional | **boolean**
| | **networkInterfaces.[].description**
Optional | **string**
| | **networkInterfaces.[].deviceIndex**
Optional | **integer**
| | **networkInterfaces.[].interfaceType**
Optional | **string**
| | **networkInterfaces.[].ipv4PrefixCount**
Optional | **integer**
| | **networkInterfaces.[].ipv4Prefixes**
Optional | **array**
| | **networkInterfaces.[].ipv4Prefixes.[]**
Required | **object**
Describes the IPv4 prefix option for a network interface. || **networkInterfaces.[].ipv4Prefixes.[].ipv4Prefix**
Optional | **string**
| | **networkInterfaces.[].ipv6AddressCount**
Optional | **integer**
| | **networkInterfaces.[].ipv6Addresses**
Optional | **array**
| | **networkInterfaces.[].ipv6Addresses.[]**
Required | **object**
Describes an IPv6 address. || **networkInterfaces.[].ipv6Addresses.[].ipv6Address**
Optional | **string**
| | **networkInterfaces.[].ipv6PrefixCount**
Optional | **integer**
| | **networkInterfaces.[].ipv6Prefixes**
Optional | **array**
| | **networkInterfaces.[].ipv6Prefixes.[]**
Required | **object**
Describes the IPv4 prefix option for a network interface. || **networkInterfaces.[].ipv6Prefixes.[].ipv6Prefix**
Optional | **string**
| | **networkInterfaces.[].networkCardIndex**
Optional | **integer**
| | **networkInterfaces.[].networkInterfaceID**
Optional | **string**
| | **networkInterfaces.[].privateIPAddress**
Optional | **string**
| | **networkInterfaces.[].privateIPAddresses**
Optional | **array**
| | **networkInterfaces.[].privateIPAddresses.[]**
Required | **object**
Describes a secondary private IPv4 address for a network interface. || **networkInterfaces.[].privateIPAddresses.[].primary**
Optional | **boolean**
| | **networkInterfaces.[].privateIPAddresses.[].privateIPAddress**
Optional | **string**
| | **networkInterfaces.[].secondaryPrivateIPAddressCount**
Optional | **integer**
| | **networkInterfaces.[].subnetID**
Optional | **string**
| | **placement**
Optional | **object**
The placement for the instance. | | **placement.affinity**
Optional | **string**
| | **placement.availabilityZone**
Optional | **string**
| | **placement.groupName**
Optional | **string**
| | **placement.hostID**
Optional | **string**
| | **placement.hostResourceGroupARN**
Optional | **string**
| | **placement.partitionNumber**
Optional | **integer**
| | **placement.spreadDomain**
Optional | **string**
| | **placement.tenancy**
Optional | **string**
| | **privateDNSNameOptions**
Optional | **object**
The options for the instance hostname. The default values are inherited from
the subnet. Applies only if creating a network interface, not attaching an
existing one. | | **privateDNSNameOptions.enableResourceNameDNSAAAARecord**
Optional | **boolean**
| | **privateDNSNameOptions.enableResourceNameDNSARecord**
Optional | **boolean**
| | **privateDNSNameOptions.hostnameType**
Optional | **string**
| | **privateIPAddress**
Optional | **string**
The primary IPv4 address. You must specify a value from the IPv4 address
range of the subnet.

Only one private IP address can be designated as primary. You can’t specify
this option if you’ve specified the option to designate a private IP address
as the primary IP address in a network interface specification. You cannot
specify this option if you’re launching more than one instance in the request.

You cannot specify this option and the network interfaces option in the same
request. | | **ramDiskID**
Optional | **string**
The ID of the RAM disk to select. Some kernels require additional drivers
at launch. Check the kernel requirements for information about whether you
need to specify a RAM disk. To find kernel requirements, go to the Amazon
Web Services Resource Center and search for the kernel ID.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more
information, see PV-GRUB (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html)
in the Amazon EC2 User Guide. | | **securityGroupIDs**
Optional | **array**
The IDs of the security groups. You can create a security group using CreateSecurityGroup
(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html).

If you specify a network interface, you must specify any security groups
as part of the network interface instead of using this parameter. | | **securityGroupIDs.[]**
Required | **string**
|| **securityGroups**
Optional | **array**
[Default VPC] The names of the security groups.

If you specify a network interface, you must specify any security groups
as part of the network interface instead of using this parameter.

Default: Amazon EC2 uses the default security group. | | **securityGroups.[]**
Required | **string**
|| **subnetID**
Optional | **string**
The ID of the subnet to launch the instance into.

If you specify a network interface, you must specify any subnets as part
of the network interface instead of using this parameter. | | **tags**
Optional | **array**
The tags. The value parameter is required, but if you don’t want the tag
to have a value, specify the parameter with no value, and we set the value
to an empty string. | | **tags.[]**
Required | **object**
Describes a tag. || **tags.[].key**
Optional | **string**
| | **tags.[].value**
Optional | **string**
| | **userData**
Optional | **string**
The user data to make available to the instance. User data must be base64-encoded.
Depending on the tool or SDK that you’re using, the base64-encoding might
be performed for you. For more information, see Work with instance user data
(https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-add-user-data.html). |

Status#

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
amiLaunchIndex: integer
architecture: string
bootMode: string
capacityReservationID: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
elasticGPUAssociations:
- elasticGPUAssociationID: string
  elasticGPUAssociationState: string
  elasticGPUAssociationTime: string
  elasticGPUID: string
elasticInferenceAcceleratorAssociations:
- elasticInferenceAcceleratorARN: string
  elasticInferenceAcceleratorAssociationID: string
  elasticInferenceAcceleratorAssociationState: string
  elasticInferenceAcceleratorAssociationTime: string
enaSupport: boolean
hypervisor: string
instanceID: string
instanceLifecycle: string
ipv6Address: string
launchTime: string
licenses:
- licenseConfigurationARN: string
outpostARN: string
platform: string
platformDetails: string
privateDNSName: string
productCodes:
- productCodeID: string
  productCodeType: string
publicDNSName: string
publicIPAddress: string
rootDeviceName: string
rootDeviceType: string
sourceDestCheck: boolean
spotInstanceRequestID: string
sriovNetSupport: string
state: 
  code: integer
  name: string
stateReason: 
  code: string
  message: string
stateTransitionReason: string
tpmSupport: string
usageOperation: string
usageOperationUpdateTime: string
virtualizationType: string
vpcID: string

Describes the association between an instance and an Elastic Graphics accelerator. || elasticGPUAssociations.[].elasticGPUAssociationID
Optional | string
| | elasticGPUAssociations.[].elasticGPUAssociationState
Optional | string
| | elasticGPUAssociations.[].elasticGPUAssociationTime
Optional | string
| | elasticGPUAssociations.[].elasticGPUID
Optional | string
| | elasticInferenceAcceleratorAssociations
Optional | array
Deprecated

Amazon Elastic Inference is no longer available. | | elasticInferenceAcceleratorAssociations.[]
Required | object
Amazon Elastic Inference is no longer available.

Describes the association between an instance and an elastic inference accelerator. || elasticInferenceAcceleratorAssociations.[].elasticInferenceAcceleratorARN
Optional | string
| | elasticInferenceAcceleratorAssociations.[].elasticInferenceAcceleratorAssociationID
Optional | string
| | elasticInferenceAcceleratorAssociations.[].elasticInferenceAcceleratorAssociationState
Optional | string
| | elasticInferenceAcceleratorAssociations.[].elasticInferenceAcceleratorAssociationTime
Optional | string
| | enaSupport
Optional | boolean
Specifies whether enhanced networking with ENA is enabled. | | hypervisor
Optional | string
The hypervisor type of the instance. The value xen is used for both Xen and
Nitro hypervisors. | | instanceID
Optional | string
The ID of the instance. | | instanceLifecycle
Optional | string
Indicates whether this is a Spot Instance or a Scheduled Instance. | | ipv6Address
Optional | string
The IPv6 address assigned to the instance. | | launchTime
Optional | string
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
Optional | array
The license configurations for the instance. | | licenses.[]
Required | object
Describes a license configuration. || licenses.[].licenseConfigurationARN
Optional | string
| | outpostARN
Optional | string
The Amazon Resource Name (ARN) of the Outpost. | | platform
Optional | string
The platform. This value is windows for Windows instances; otherwise, it
is empty. | | platformDetails
Optional | string
The platform details value for the instance. For more information, see AMI
billing information fields (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html)
in the Amazon EC2 User Guide. | | privateDNSName
Optional | 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. | | productCodes
Optional | array
The product codes attached to this instance, if applicable. | | productCodes.[]
Required | object
Describes a product code. || productCodes.[].productCodeID
Optional | string
| | productCodes.[].productCodeType
Optional | string
| | publicDNSName
Optional | string
[IPv4 only] 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. | | publicIPAddress
Optional | 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. | | rootDeviceName
Optional | string
The device name of the root device volume (for example, /dev/sda1). | | rootDeviceType
Optional | string
The root device type used by the AMI. The AMI can use an EBS volume or an
instance store volume. | | sourceDestCheck
Optional | boolean
Indicates whether source/destination checking is enabled. | | spotInstanceRequestID
Optional | string
If the request is a Spot Instance request, the ID of the request. | | sriovNetSupport
Optional | string
Specifies whether enhanced networking with the Intel 82599 Virtual Function
interface is enabled. | | state
Optional | object
The current state of the instance. | | state.code
Optional | integer
| | state.name
Optional | string
| | stateReason
Optional | object
The reason for the most recent state transition. | | stateReason.code
Optional | string
| | stateReason.message
Optional | string
| | stateTransitionReason
Optional | string
The reason for the most recent state transition. This might be an empty string. | | tpmSupport
Optional | string
If the instance is configured for NitroTPM support, the value is v2.0. For
more information, see NitroTPM (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html)
in the Amazon EC2 User Guide. | | usageOperation
Optional | string
The usage operation value for the instance. For more information, see AMI
billing information fields (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html)
in the Amazon EC2 User Guide. | | usageOperationUpdateTime
Optional | string
The time that the usage operation was last updated. | | virtualizationType
Optional | string
The virtualization type of the instance. | | vpcID
Optional | string
The ID of the VPC in which the instance is running. |