LaunchTemplate

ec2.services.k8s.aws/v1alpha1

Type	Link
GoDoc	ec2-controller/apis/v1alpha1#LaunchTemplate

Metadata

Property	Value
Scope	Namespaced
Kind	`LaunchTemplate`
ListKind	`LaunchTemplateList`
Plural	`launchtemplates`
Singular	`launchtemplate`

Describes a launch template.

Spec

data: 
  blockDeviceMappings:
  - deviceName: string
    ebs: 
      deleteOnTermination: boolean
      encrypted: boolean
      iops: integer
      kmsKeyID: string
      snapshotID: string
      throughput: integer
      volumeSize: integer
      volumeType: string
    noDevice: string
    virtualName: string
  capacityReservationSpecification: 
    capacityReservationPreference: string
    capacityReservationTarget: 
      capacityReservationID: string
      capacityReservationResourceGroupARN: string
  cpuOptions: 
    amdSevSnp: string
    coreCount: integer
    threadsPerCore: integer
  creditSpecification: 
    cpuCredits: string
  disableAPIStop: boolean
  disableAPITermination: boolean
  ebsOptimized: boolean
  elasticGPUSpecifications:
  - 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
  instanceRequirements: 
    acceleratorCount: 
      max: integer
      min: integer
    acceleratorManufacturers:
    - string
    acceleratorNames:
    - string
    acceleratorTotalMemoryMiB: 
      max: integer
      min: integer
    acceleratorTypes:
    - string
    allowedInstanceTypes:
    - string
    bareMetal: string
    baselineEBSBandwidthMbps: 
      max: integer
      min: integer
    baselinePerformanceFactors: 
      cpu: 
        references:
        - instanceFamily: string
    burstablePerformance: string
    cpuManufacturers:
    - string
    excludedInstanceTypes:
    - string
    instanceGenerations:
    - string
    localStorage: string
    localStorageTypes:
    - string
    maxSpotPriceAsPercentageOfOptimalOnDemandPrice: integer
    memoryGiBPerVCPU: 
      max: number
      min: number
    memoryMiB: 
      max: integer
      min: integer
    networkBandwidthGbps: 
      max: number
      min: number
    networkInterfaceCount: 
      max: integer
      min: integer
    onDemandMaxPricePercentageOverLowestPrice: integer
    requireHibernateSupport: boolean
    spotMaxPricePercentageOverLowestPrice: integer
    totalLocalStorageGB: 
      max: number
      min: number
    vCPUCount: 
      max: integer
      min: integer
  instanceType: string
  kernelID: string
  keyName: string
  licenseSpecifications:
  - licenseConfigurationARN: string
  maintenanceOptions: 
    autoRecovery: string
  metadataOptions: 
    httpEndpoint: string
    httpProtocolIPv6: string
    httpPutResponseHopLimit: integer
    httpTokens: string
    instanceMetadataTags: string
  monitoring: 
    enabled: boolean
  networkInterfaces:
  - associateCarrierIPAddress: boolean
    associatePublicIPAddress: boolean
    deleteOnTermination: boolean
    description: string
    deviceIndex: integer
    groups:
    - string
    interfaceType: string
    ipv4PrefixCount: integer
    ipv4Prefixes:
    - ipv4Prefix: string
    ipv6AddressCount: integer
    ipv6Addresses:
    - ipv6Address: string
    ipv6PrefixCount: integer
    ipv6Prefixes:
    - ipv6Prefix: string
    networkCardIndex: integer
    networkInterfaceID: string
    primaryIPv6: boolean
    privateIPAddress: string
    privateIPAddresses:
    - primary: boolean
      privateIPAddress: string
    secondaryPrivateIPAddressCount: integer
    subnetID: string
  placement: 
    affinity: string
    availabilityZone: string
    groupID: string
    groupName: string
    hostID: string
    hostResourceGroupARN: string
    partitionNumber: integer
    spreadDomain: string
    tenancy: string
  privateDNSNameOptions: 
    enableResourceNameDNSAAAARecord: boolean
    enableResourceNameDNSARecord: boolean
    hostnameType: string
  ramDiskID: string
  securityGroupIDs:
  - string
  securityGroups:
  - string
  userData: string
defaultVersion: integer
name: string
tags:
- key: string
  value: string
versionDescription: string

Field	Description
data Required	object The information for the launch template.
data.blockDeviceMappings Optional	array
data.blockDeviceMappings.[] Required	object Describes a block device mapping.
data.blockDeviceMappings.[].ebs Optional	object The parameters for a block device for an EBS volume.
data.blockDeviceMappings.[].ebs.deleteOnTermination Optional	boolean
data.blockDeviceMappings.[].ebs.encrypted Optional	boolean
data.blockDeviceMappings.[].ebs.iops Optional	integer
data.blockDeviceMappings.[].ebs.kmsKeyID Optional	string
data.blockDeviceMappings.[].ebs.snapshotID Optional	string
data.blockDeviceMappings.[].ebs.throughput Optional	integer
data.blockDeviceMappings.[].ebs.volumeSize Optional	integer
data.blockDeviceMappings.[].ebs.volumeType Optional	string
data.blockDeviceMappings.[].noDevice Optional	string
data.blockDeviceMappings.[].virtualName Optional	string
data.capacityReservationSpecification Optional	object Describes an instance’s Capacity Reservation targeting option. You can specify only one option at a time. Use the CapacityReservationPreference parameter to configure the instance to run in On-Demand capacity or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.
data.capacityReservationSpecification.capacityReservationPreference Optional	string
data.capacityReservationSpecification.capacityReservationTarget Optional	object Describes a target Capacity Reservation or Capacity Reservation group.
data.capacityReservationSpecification.capacityReservationTarget.capacityReservationID Optional	string
data.capacityReservationSpecification.capacityReservationTarget.capacityReservationResourceGroupARN Optional	string
data.cpuOptions Optional	object The CPU options for the instance. Both the core count and threads per core must be specified in the request.
data.cpuOptions.amdSevSnp Optional	string
data.cpuOptions.coreCount Optional	integer
data.cpuOptions.threadsPerCore Optional	integer
data.creditSpecification Optional	object The credit option for CPU usage of a T instance.
data.creditSpecification.cpuCredits Optional	string
data.disableAPIStop Optional	boolean
data.disableAPITermination Optional	boolean
data.ebsOptimized Optional	boolean
data.elasticGPUSpecifications Optional	array
data.elasticGPUSpecifications.[] Required	object Amazon Elastic Graphics reached end of life on January 8, 2024.

A specification for an Elastic Graphics accelerator. || data.elasticGPUSpecifications.[].type
Optional | string
| | data.elasticInferenceAccelerators
Optional | array
| | data.elasticInferenceAccelerators.[]
Required | object
Amazon Elastic Inference is no longer available.

Describes an elastic inference accelerator. || data.elasticInferenceAccelerators.[].count
Optional | integer
| | data.elasticInferenceAccelerators.[].type
Optional | string
| | data.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. | | data.enclaveOptions.enabled
Optional | boolean
| | data.hibernationOptions
Optional | object
Indicates whether the instance is configured 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). | | data.hibernationOptions.configured
Optional | boolean
| | data.iamInstanceProfile
Optional | object
An IAM instance profile. | | data.iamInstanceProfile.arn
Optional | string
| | data.iamInstanceProfile.name
Optional | string
| | data.imageID
Optional | string
| | data.instanceInitiatedShutdownBehavior
Optional | string
| | data.instanceMarketOptions
Optional | object
The market (purchasing) option for the instances. | | data.instanceMarketOptions.marketType
Optional | string
| | data.instanceMarketOptions.spotOptions
Optional | object
The options for Spot Instances. | | data.instanceMarketOptions.spotOptions.blockDurationMinutes
Optional | integer
| | data.instanceMarketOptions.spotOptions.instanceInterruptionBehavior
Optional | string
| | data.instanceMarketOptions.spotOptions.maxPrice
Optional | string
| | data.instanceMarketOptions.spotOptions.spotInstanceType
Optional | string
| | data.instanceMarketOptions.spotOptions.validUntil
Optional | string
| | data.instanceRequirements
Optional | object
The attributes for the instance types. When you specify instance attributes,
Amazon EC2 will identify instance types with these attributes.

You must specify VCpuCount and MemoryMiB. All other attributes are optional.
Any unspecified optional attribute is set to its default.

When you specify multiple attributes, you get instance types that satisfy
all of the specified attributes. If you specify multiple values for an attribute,
you get instance types that satisfy any of the specified values.

To limit the list of instance types from which Amazon EC2 can identify matching
instance types, you can use one of the following parameters, but not both
in the same request:

* AllowedInstanceTypes - The instance types to include in the list. All
other instance types are ignored, even if they match your specified attributes.

* ExcludedInstanceTypes - The instance types to exclude from the list,
even if they match your specified attributes.

If you specify InstanceRequirements, you can’t specify InstanceType.

Attribute-based instance type selection is only supported when using Auto
Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan
to use the launch template in the launch instance wizard (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html),
or with the RunInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html)
API or AWS::EC2::Instance (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html)
Amazon Web Services CloudFormation resource, you can’t specify InstanceRequirements.

For more information, see Specify attributes for instance type selection
for EC2 Fleet or Spot Fleet (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html)
and Spot placement score (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html)
in the Amazon EC2 User Guide. | | data.instanceRequirements.acceleratorCount
Optional | object
The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web
Services Inferentia chips) on an instance. To exclude accelerator-enabled
instance types, set Max to 0. | | data.instanceRequirements.acceleratorCount.max
Optional | integer
| | data.instanceRequirements.acceleratorCount.min
Optional | integer
| | data.instanceRequirements.acceleratorManufacturers
Optional | array
| | data.instanceRequirements.acceleratorManufacturers.[]
Required | string
|| data.instanceRequirements.acceleratorNames
Optional | array
| | data.instanceRequirements.acceleratorNames.[]
Required | string
|| data.instanceRequirements.acceleratorTotalMemoryMiB
Optional | object
The minimum and maximum amount of total accelerator memory, in MiB. | | data.instanceRequirements.acceleratorTotalMemoryMiB.max
Optional | integer
| | data.instanceRequirements.acceleratorTotalMemoryMiB.min
Optional | integer
| | data.instanceRequirements.acceleratorTypes
Optional | array
| | data.instanceRequirements.acceleratorTypes.[]
Required | string
|| data.instanceRequirements.allowedInstanceTypes
Optional | array
| | data.instanceRequirements.allowedInstanceTypes.[]
Required | string
|| data.instanceRequirements.bareMetal
Optional | string
| | data.instanceRequirements.baselineEBSBandwidthMbps
Optional | object
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more
information, see Amazon EBS–optimized instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html)
in the Amazon EC2 User Guide. | | data.instanceRequirements.baselineEBSBandwidthMbps.max
Optional | integer
| | data.instanceRequirements.baselineEBSBandwidthMbps.min
Optional | integer
| | data.instanceRequirements.baselinePerformanceFactors
Optional | object
The baseline performance to consider, using an instance family as a baseline
reference. The instance family establishes the lowest acceptable level of
performance. Amazon EC2 uses this baseline to guide instance type selection,
but there is no guarantee that the selected instance types will always exceed
the baseline for every application.

Currently, this parameter only supports CPU performance as a baseline performance
factor. For example, specifying c6i would use the CPU performance of the
c6i family as the baseline reference. | | data.instanceRequirements.baselinePerformanceFactors.cpu
Optional | object
The CPU performance to consider, using an instance family as the baseline
reference. | | data.instanceRequirements.baselinePerformanceFactors.cpu.references
Optional | array
| | data.instanceRequirements.baselinePerformanceFactors.cpu.references.[]
Required | object
Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture.

Currently, only one instance family can be specified in the list. || data.instanceRequirements.baselinePerformanceFactors.cpu.references.[].instanceFamily
Optional | string
| | data.instanceRequirements.burstablePerformance
Optional | string
| | data.instanceRequirements.cpuManufacturers
Optional | array
| | data.instanceRequirements.cpuManufacturers.[]
Required | string
|| data.instanceRequirements.excludedInstanceTypes
Optional | array
| | data.instanceRequirements.excludedInstanceTypes.[]
Required | string
|| data.instanceRequirements.instanceGenerations
Optional | array
| | data.instanceRequirements.instanceGenerations.[]
Required | string
|| data.instanceRequirements.localStorage
Optional | string
| | data.instanceRequirements.localStorageTypes
Optional | array
| | data.instanceRequirements.localStorageTypes.[]
Required | string
|| data.instanceRequirements.maxSpotPriceAsPercentageOfOptimalOnDemandPrice
Optional | integer
| | data.instanceRequirements.memoryGiBPerVCPU
Optional | object
The minimum and maximum amount of memory per vCPU, in GiB. | | data.instanceRequirements.memoryGiBPerVCPU.max
Optional | number
| | data.instanceRequirements.memoryGiBPerVCPU.min
Optional | number
| | data.instanceRequirements.memoryMiB
Optional | object
The minimum and maximum amount of memory, in MiB. | | data.instanceRequirements.memoryMiB.max
Optional | integer
| | data.instanceRequirements.memoryMiB.min
Optional | integer
| | data.instanceRequirements.networkBandwidthGbps
Optional | object
The minimum and maximum amount of network bandwidth, in gigabits per second
(Gbps).

Setting the minimum bandwidth does not guarantee that your instance will
achieve the minimum bandwidth. Amazon EC2 will identify instance types that
support the specified minimum bandwidth, but the actual bandwidth of your
instance might go below the specified minimum at times. For more information,
see Available instance bandwidth (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth)
in the Amazon EC2 User Guide. | | data.instanceRequirements.networkBandwidthGbps.max
Optional | number
| | data.instanceRequirements.networkBandwidthGbps.min
Optional | number
| | data.instanceRequirements.networkInterfaceCount
Optional | object
The minimum and maximum number of network interfaces. | | data.instanceRequirements.networkInterfaceCount.max
Optional | integer
| | data.instanceRequirements.networkInterfaceCount.min
Optional | integer
| | data.instanceRequirements.onDemandMaxPricePercentageOverLowestPrice
Optional | integer
| | data.instanceRequirements.requireHibernateSupport
Optional | boolean
| | data.instanceRequirements.spotMaxPricePercentageOverLowestPrice
Optional | integer
| | data.instanceRequirements.totalLocalStorageGB
Optional | object
The minimum and maximum amount of total local storage, in GB. | | data.instanceRequirements.totalLocalStorageGB.max
Optional | number
| | data.instanceRequirements.totalLocalStorageGB.min
Optional | number
| | data.instanceRequirements.vCPUCount
Optional | object
The minimum and maximum number of vCPUs. | | data.instanceRequirements.vCPUCount.max
Optional | integer
| | data.instanceRequirements.vCPUCount.min
Optional | integer
| | data.instanceType
Optional | string
| | data.kernelID
Optional | string
| | data.keyName
Optional | string
| | data.licenseSpecifications
Optional | array
| | data.licenseSpecifications.[]
Required | object
Describes a license configuration. || data.licenseSpecifications.[].licenseConfigurationARN
Optional | string
| | data.maintenanceOptions
Optional | object
The maintenance options of your instance. | | data.maintenanceOptions.autoRecovery
Optional | string
| | data.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)
in the Amazon EC2 User Guide. | | data.metadataOptions.httpEndpoint
Optional | string
| | data.metadataOptions.httpProtocolIPv6
Optional | string
| | data.metadataOptions.httpPutResponseHopLimit
Optional | integer
| | data.metadataOptions.httpTokens
Optional | string
| | data.metadataOptions.instanceMetadataTags
Optional | string
| | data.monitoring
Optional | object
Describes the monitoring for the instance. | | data.monitoring.enabled
Optional | boolean
| | data.networkInterfaces
Optional | array
| | data.networkInterfaces.[]
Required | object
The parameters for a network interface. || data.networkInterfaces.[].associateCarrierIPAddress
Optional | boolean
| | data.networkInterfaces.[].associatePublicIPAddress
Optional | boolean
| | data.networkInterfaces.[].deleteOnTermination
Optional | boolean
| | data.networkInterfaces.[].description
Optional | string
| | data.networkInterfaces.[].deviceIndex
Optional | integer
| | data.networkInterfaces.[].groups
Optional | array
| | data.networkInterfaces.[].groups.[]
Required | string
|| data.networkInterfaces.[].interfaceType
Optional | string
| | data.networkInterfaces.[].ipv4PrefixCount
Optional | integer
| | data.networkInterfaces.[].ipv4Prefixes
Optional | array
| | data.networkInterfaces.[].ipv4Prefixes.[]
Required | object
Describes the IPv4 prefix option for a network interface. || data.networkInterfaces.[].ipv4Prefixes.[].ipv4Prefix
Optional | string
| | data.networkInterfaces.[].ipv6AddressCount
Optional | integer
| | data.networkInterfaces.[].ipv6Addresses
Optional | array
| | data.networkInterfaces.[].ipv6Addresses.[]
Required | object
Describes an IPv6 address. || data.networkInterfaces.[].ipv6Addresses.[].ipv6Address
Optional | string
| | data.networkInterfaces.[].ipv6PrefixCount
Optional | integer
| | data.networkInterfaces.[].ipv6Prefixes
Optional | array
| | data.networkInterfaces.[].ipv6Prefixes.[]
Required | object
Describes the IPv4 prefix option for a network interface. || data.networkInterfaces.[].ipv6Prefixes.[].ipv6Prefix
Optional | string
| | data.networkInterfaces.[].networkCardIndex
Optional | integer
| | data.networkInterfaces.[].networkInterfaceID
Optional | string
| | data.networkInterfaces.[].primaryIPv6
Optional | boolean
| | data.networkInterfaces.[].privateIPAddress
Optional | string
| | data.networkInterfaces.[].privateIPAddresses
Optional | array
| | data.networkInterfaces.[].privateIPAddresses.[]
Required | object
Describes a secondary private IPv4 address for a network interface. || data.networkInterfaces.[].privateIPAddresses.[].primary
Optional | boolean
| | data.networkInterfaces.[].privateIPAddresses.[].privateIPAddress
Optional | string
| | data.networkInterfaces.[].secondaryPrivateIPAddressCount
Optional | integer
| | data.networkInterfaces.[].subnetID
Optional | string
| | data.placement
Optional | object
Describes the placement of an instance. | | data.placement.affinity
Optional | string
| | data.placement.availabilityZone
Optional | string
| | data.placement.groupID
Optional | string
| | data.placement.groupName
Optional | string
| | data.placement.hostID
Optional | string
| | data.placement.hostResourceGroupARN
Optional | string
| | data.placement.partitionNumber
Optional | integer
| | data.placement.spreadDomain
Optional | string
| | data.placement.tenancy
Optional | string
| | data.privateDNSNameOptions
Optional | object
Describes the options for instance hostnames. | | data.privateDNSNameOptions.enableResourceNameDNSAAAARecord
Optional | boolean
| | data.privateDNSNameOptions.enableResourceNameDNSARecord
Optional | boolean
| | data.privateDNSNameOptions.hostnameType
Optional | string
| | data.ramDiskID
Optional | string
| | data.securityGroupIDs
Optional | array
| | data.securityGroupIDs.[]
Required | string
|| data.securityGroups
Optional | array
| | data.securityGroups.[]
Required | string
|| data.userData
Optional | string
| | defaultVersion
Optional | integer
The version number of the default version of the launch template. | | name
Required | string
A name for the launch template. | | 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
| | versionDescription
Optional | string
A description for the first version of the launch template. |

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
createTime: string
createdBy: string
id: string
latestVersion: integer
operator: 
  managed: boolean
  principal: string

Field	Description
ackResourceMetadata Optional	object 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
ackResourceMetadata.arn Optional	string 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
ackResourceMetadata.ownerAccountID Required	string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.
ackResourceMetadata.region Required	string Region is the AWS region in which the resource exists or will exist.
conditions Optional	array 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
conditions.[] Required	object 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
conditions.[].message Optional	string A human readable message indicating details about the transition.
conditions.[].reason Optional	string The reason for the condition’s last transition.
conditions.[].status Optional	string Status of the condition, one of True, False, Unknown.
conditions.[].type Optional	string Type is the type of the Condition
createTime Optional	string The time launch template was created.
createdBy Optional	string The principal that created the launch template.
id Optional	string The ID of the launch template.
latestVersion Optional	integer The version number of the latest version of the launch template.
operator Optional	object The entity that manages the launch template.
operator.managed Optional	boolean
operator.principal Optional	string

LaunchTemplate

Metadata#

Spec#

Status#

Metadata

Spec

Status