Instance is the Schema for the Instances API
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
Each additional property must conform to the following schema
Type: stringCreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
Each additional property must conform to the following schema
Type: stringManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
No Additional ItemsManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.
APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
Manager is an identifier of the workflow managing these fields.
Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
Same definition as creationTimestampName must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
No Additional ItemsOwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.
API version of the referent.
If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
If true, this reference points to the managing controller.
Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
InstanceSpec defines the desired state of Instance.
Describes an instance.
The block device mapping, which defines the EBS volumes and instance store
volumes to attach to the instance at launch. For more information, see Block
device mappings (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html)
in the Amazon EC2 User Guide.
Describes a block device mapping, which defines the EBS volumes and instance
store volumes to attach to an instance at launch.
Describes a block device for an EBS volume.
Information about the Capacity Reservation targeting option. If you do not
specify this parameter, the instance's Capacity Reservation preference defaults
to open, which enables it to run in any open Capacity Reservation that has
matching attributes (instance type, platform, Availability Zone, and tenancy).
Describes a target Capacity Reservation or Capacity Reservation group.
The CPU options for the instance. For more information, see Optimize CPU
options (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html)
in the Amazon EC2 User Guide.
The credit option for CPU usage of the burstable performance instance. Valid
values are standard and unlimited. To change this attribute after launch,
use ModifyInstanceCreditSpecification (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html).
For more information, see Burstable performance instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html)
in the Amazon EC2 User Guide.
Default: standard (T2 instances) or unlimited (T3/T3a/T4g instances)
For T3 instances with host tenancy, only standard is supported.
Indicates whether an instance is enabled for stop protection. For more information,
see Enable stop protection for your EC2 instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-stop-protection.html).
Indicates whether termination protection is enabled for the instance. The
default is false, which means that you can terminate the instance using the
Amazon EC2 console, command line tools, or API. You can enable termination
protection when you launch an instance, while the instance is running, or
while the instance is stopped.
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 Amazon EBS I/O performance. This optimization isn't
available with all instance types. Additional usage charges apply when using
an EBS-optimized instance.
Default: false
An elastic GPU to associate with the instance.
Amazon Elastic Graphics reached end of life on January 8, 2024.
No Additional ItemsAmazon Elastic Graphics reached end of life on January 8, 2024.
A specification for an Elastic Graphics accelerator.
An elastic inference accelerator to associate with the instance.
Amazon Elastic Inference is no longer available.
No Additional ItemsAmazon Elastic Inference is no longer available.
Describes an elastic inference accelerator.
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
For more information, see Amazon Web Services Nitro Enclaves User Guide (https://docs.aws.amazon.com/enclaves/latest/user/).
You can't enable Amazon Web Services Nitro Enclaves and hibernation on the
same instance.
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.
The name or Amazon Resource Name (ARN) of an IAM instance profile.
The ID of the AMI. An AMI ID is required to launch an instance and must be
specified here or in a launch template.
Indicates whether an instance stops or terminates when you initiate shutdown
from the instance (using the operating system command for system shutdown).
Default: stop
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.
The options for Spot Instances.
The instance type. For more information, see Amazon EC2 Instance Types Guide
(https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-types.html).
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.
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.
Describes an IPv6 address.
The name of the key pair. For more information, see Create a key pair for
your EC2 instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.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.
The launch template. Any additional parameters that you specify for the new
instance overwrite the corresponding parameters included in the launch template.
Reference field for LaunchTemplateID
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
The license configurations.
No Additional ItemsDescribes a license configuration.
The maintenance and recovery options for the instance.
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).
The metadata options for the instance. For more information, see Configure
the Instance Metadata Service options (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html).
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).
Specifies whether detailed monitoring is enabled for the instance.
The network interfaces to associate with the instance.
No Additional ItemsDescribes a network interface.
Describes the IPv4 prefix option for a network interface.
Describes an IPv6 address.
Describes the IPv6 prefix option for a network interface.
Describes a secondary private IPv4 address for a network interface.
The placement for the instance.
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.
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.
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.
The IDs 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 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.
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.
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using 'from' field
Ex:
APIIDRef:
from:
name: my-api
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name)
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 Run commands at launch using
instance user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html).
InstanceStatus defines the observed state of Instance
All CRs managed by ACK have a common Status.ACKResourceMetadata member
that is used to contain resource sync state, account ownership,
constructed ARN for the resource
ARN is the Amazon Resource Name for the resource. This is a
globally-unique identifier and is set only by the ACK service controller
once the controller has orchestrated the creation of the resource OR
when it has verified that an "adopted" resource (a resource where the
ARN annotation was set by the Kubernetes user on the CR) exists and
matches the supplied CR's Spec field values.
https://github.com/aws/aws-controllers-k8s/issues/270
OwnerAccountID is the AWS Account ID of the account that owns the
backend AWS service API resource.
Partition is the AWS partition in which the resource exists or will exist
Region is the AWS region in which the resource exists or will exist.
The AMI launch index, which can be used to find this instance in the launch
group.
The architecture of the image.
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 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html)
in the Amazon EC2 User Guide.
The ID of the Capacity Reservation.
All CRs managed by ACK have a common Status.Conditions member that
contains a collection of ackv1alpha1.Condition objects that describe
the various terminal states of the CR and its backend AWS service API
resource
Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource
Last time the condition transitioned from one status to another.
A human readable message indicating details about the transition.
The reason for the condition's last transition.
Status of the condition, one of True, False, Unknown.
Type is the type of the Condition
Deprecated.
Amazon Elastic Graphics reached end of life on January 8, 2024.
No Additional ItemsAmazon Elastic Graphics reached end of life on January 8, 2024.
Describes the association between an instance and an Elastic Graphics accelerator.
Deprecated
Amazon Elastic Inference is no longer available.
No Additional ItemsAmazon Elastic Inference is no longer available.
Describes the association between an instance and an elastic inference accelerator.
Specifies whether enhanced networking with ENA is enabled.
The hypervisor type of the instance. The value xen is used for both Xen and
Nitro hypervisors.
The ID of the instance.
Indicates whether this is a Spot Instance or a Scheduled Instance.
The IPv6 address assigned to the instance.
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.
The license configurations for the instance.
No Additional ItemsDescribes a license configuration.
The Amazon Resource Name (ARN) of the Outpost.
The platform. This value is windows for Windows instances; otherwise, it
is empty.
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.
[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.
The product codes attached to this instance, if applicable.
No Additional ItemsDescribes a product code.
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 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hostname-types.html#public-hostnames).
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.
The device name of the root device volume (for example, /dev/sda1).
The root device type used by the AMI. The AMI can use an EBS volume or an
instance store volume.
Indicates whether source/destination checking is enabled.
If the request is a Spot Instance request, the ID of the request.
Specifies whether enhanced networking with the Intel 82599 Virtual Function
interface is enabled.
The current state of the instance.
The reason for the most recent state transition.
The reason for the most recent state transition. This might be an empty 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.
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.
The time that the usage operation was last updated.
The virtualization type of the instance.
The ID of the VPC in which the instance is running.