/AWS1/CL_EC2REQLAUNCHTMPLDATA¶
The information to include in the launch template.
You must specify at least one parameter for the launch template data.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
IV_KERNELID TYPE /AWS1/EC2KERNELID /AWS1/EC2KERNELID¶
The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide.
IV_EBSOPTIMIZED TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN¶
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.
IO_IAMINSTANCEPROFILE TYPE REF TO /AWS1/CL_EC2LAUNCHTMPLIAMINS00 /AWS1/CL_EC2LAUNCHTMPLIAMINS00¶
The name or Amazon Resource Name (ARN) of an IAM instance profile.
IT_BLOCKDEVICEMAPPINGS TYPE /AWS1/CL_EC2LAUNCHTMPLBLKDEV00=>TT_LAUNCHTMPLBLOCKDEVMAPREQLST TT_LAUNCHTMPLBLOCKDEVMAPREQLST¶
The block device mapping.
IT_NETWORKINTERFACES TYPE /AWS1/CL_EC2LAUNCHTMPLINSTNE00=>TT_LAUNCHTMPLINSTNETWORKINTE00 TT_LAUNCHTMPLINSTNETWORKINTE00¶
The network interfaces for the instance.
IV_IMAGEID TYPE /AWS1/EC2IMAGEID /AWS1/EC2IMAGEID¶
The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch.
Valid formats:
ami-17characters00000
resolve:ssm:parameter-name
resolve:ssm:parameter-name:version-number
resolve:ssm:parameter-name:label
resolve:ssm:public-parameterCurrently, EC2 Fleet and Spot Fleet do not support specifying a Systems Manager parameter. If the launch template will be used by an EC2 Fleet or Spot Fleet, you must specify the AMI ID.
For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon EC2 User Guide.
IV_INSTANCETYPE TYPE /AWS1/EC2INSTANCETYPE /AWS1/EC2INSTANCETYPE¶
The instance type. For more information, see Amazon EC2 instance types in the Amazon EC2 User Guide.
If you specify
InstanceType, you can't specifyInstanceRequirements.
IV_KEYNAME TYPE /AWS1/EC2KEYPAIRNAME /AWS1/EC2KEYPAIRNAME¶
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
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.
IO_MONITORING TYPE REF TO /AWS1/CL_EC2LAUNCHTMPLSMONREQ /AWS1/CL_EC2LAUNCHTMPLSMONREQ¶
The monitoring for the instance.
IO_PLACEMENT TYPE REF TO /AWS1/CL_EC2LAUNCHTMPLPLCMTREQ /AWS1/CL_EC2LAUNCHTMPLPLCMTREQ¶
The placement for the instance.
IV_RAMDISKID TYPE /AWS1/EC2RAMDISKID /AWS1/EC2RAMDISKID¶
The ID of the RAM disk.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide.
IV_DISABLEAPITERMINATION TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN¶
If you set this parameter to
true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you setInstanceInitiatedShutdownBehaviortoterminate, you can terminate the instance by running the shutdown command from the instance.
IV_INSTINITIATEDSHUTDOWNBE00 TYPE /AWS1/EC2SHUTDOWNBEHAVIOR /AWS1/EC2SHUTDOWNBEHAVIOR¶
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default:
stop
IV_USERDATA TYPE /AWS1/EC2SENSITIVEUSERDATA /AWS1/EC2SENSITIVEUSERDATA¶
The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Run commands on your Amazon EC2 instance at launch in the Amazon EC2 User Guide.
If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
IT_TAGSPECIFICATIONS TYPE /AWS1/CL_EC2LAUNCHTMPLTGSPEC00=>TT_LAUNCHTMPLTAGSPECREQLIST TT_LAUNCHTMPLTAGSPECREQLIST¶
The tags to apply to the resources that are created during instance launch. These tags are not applied to the launch template.
IT_ELASTICGPUSPECIFICATIONS TYPE /AWS1/CL_EC2ELASTICGPUSPEC=>TT_ELASTICGPUSPECIFICATIONLIST TT_ELASTICGPUSPECIFICATIONLIST¶
Deprecated.
Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
IT_ELASTICINFERENCEACCELER00 TYPE /AWS1/CL_EC2LAUNCHTMPLELASTI00=>TT_LAUNCHTMPLELASTICINFERENC00 TT_LAUNCHTMPLELASTICINFERENC00¶
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
IT_SECURITYGROUPIDS TYPE /AWS1/CL_EC2SECGRPIDSTRLIST_W=>TT_SECURITYGROUPIDSTRINGLIST TT_SECURITYGROUPIDSTRINGLIST¶
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.
IT_SECURITYGROUPS TYPE /AWS1/CL_EC2SECGROUPSTRLIST_W=>TT_SECURITYGROUPSTRINGLIST TT_SECURITYGROUPSTRINGLIST¶
The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
IO_INSTANCEMARKETOPTIONS TYPE REF TO /AWS1/CL_EC2LAUNCHTMPLINSTMA00 /AWS1/CL_EC2LAUNCHTMPLINSTMA00¶
The market (purchasing) option for the instances.
IO_CREDITSPECIFICATION TYPE REF TO /AWS1/CL_EC2CREDITSPECREQUEST /AWS1/CL_EC2CREDITSPECREQUEST¶
The credit option for CPU usage of the instance. Valid only for T instances.
IO_CPUOPTIONS TYPE REF TO /AWS1/CL_EC2LAUNCHTMPLCPUOPT00 /AWS1/CL_EC2LAUNCHTMPLCPUOPT00¶
The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.
IO_CAPACITYRESERVATIONSPEC TYPE REF TO /AWS1/CL_EC2LAUNCHTMPLCAPRSV00 /AWS1/CL_EC2LAUNCHTMPLCAPRSV00¶
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).
IT_LICENSESPECIFICATIONS TYPE /AWS1/CL_EC2LAUNCHTMPLLICENS00=>TT_LAUNCHTMPLLICENSESPECLSTREQ TT_LAUNCHTMPLLICENSESPECLSTREQ¶
The license configurations.
IO_HIBERNATIONOPTIONS TYPE REF TO /AWS1/CL_EC2LAUNCHTMPLHIBERN00 /AWS1/CL_EC2LAUNCHTMPLHIBERN00¶
Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide.
IO_METADATAOPTIONS TYPE REF TO /AWS1/CL_EC2LAUNCHTMPLINSTME00 /AWS1/CL_EC2LAUNCHTMPLINSTME00¶
The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.
IO_ENCLAVEOPTIONS TYPE REF TO /AWS1/CL_EC2LAUNCHTMPLENCLOP00 /AWS1/CL_EC2LAUNCHTMPLENCLOP00¶
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.
You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
IO_INSTANCEREQUIREMENTS TYPE REF TO /AWS1/CL_EC2INSTREQUIREMENTS00 /AWS1/CL_EC2INSTREQUIREMENTS00¶
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
You must specify
VCpuCountandMemoryMiB. 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 specifyInstanceType.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, or with the RunInstances API or AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can't specify
InstanceRequirements.For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.
IO_PRIVATEDNSNAMEOPTIONS TYPE REF TO /AWS1/CL_EC2LAUNCHTMPLPVTDNS00 /AWS1/CL_EC2LAUNCHTMPLPVTDNS00¶
The options for the instance hostname. The default values are inherited from the subnet.
IO_MAINTENANCEOPTIONS TYPE REF TO /AWS1/CL_EC2LAUNCHTMPLINSTMA01 /AWS1/CL_EC2LAUNCHTMPLINSTMA01¶
The maintenance options for the instance.
IV_DISABLEAPISTOP TYPE /AWS1/EC2BOOLEAN /AWS1/EC2BOOLEAN¶
Indicates whether to enable the instance for stop protection. For more information, see Enable stop protection for your instance in the Amazon EC2 User Guide.
Queryable Attributes¶
KernelId¶
The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KERNELID() |
Getter for KERNELID, with configurable default |
ASK_KERNELID() |
Getter for KERNELID w/ exceptions if field has no value |
HAS_KERNELID() |
Determine if KERNELID has a value |
EbsOptimized¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EBSOPTIMIZED() |
Getter for EBSOPTIMIZED, with configurable default |
ASK_EBSOPTIMIZED() |
Getter for EBSOPTIMIZED w/ exceptions if field has no value |
HAS_EBSOPTIMIZED() |
Determine if EBSOPTIMIZED has a value |
IamInstanceProfile¶
The name or Amazon Resource Name (ARN) of an IAM instance profile.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IAMINSTANCEPROFILE() |
Getter for IAMINSTANCEPROFILE |
BlockDeviceMappings¶
The block device mapping.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BLOCKDEVICEMAPPINGS() |
Getter for BLOCKDEVICEMAPPINGS, with configurable default |
ASK_BLOCKDEVICEMAPPINGS() |
Getter for BLOCKDEVICEMAPPINGS w/ exceptions if field has no |
HAS_BLOCKDEVICEMAPPINGS() |
Determine if BLOCKDEVICEMAPPINGS has a value |
NetworkInterfaces¶
The network interfaces for the instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NETWORKINTERFACES() |
Getter for NETWORKINTERFACES, with configurable default |
ASK_NETWORKINTERFACES() |
Getter for NETWORKINTERFACES w/ exceptions if field has no v |
HAS_NETWORKINTERFACES() |
Determine if NETWORKINTERFACES has a value |
ImageId¶
The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch.
Valid formats:
ami-17characters00000
resolve:ssm:parameter-name
resolve:ssm:parameter-name:version-number
resolve:ssm:parameter-name:label
resolve:ssm:public-parameterCurrently, EC2 Fleet and Spot Fleet do not support specifying a Systems Manager parameter. If the launch template will be used by an EC2 Fleet or Spot Fleet, you must specify the AMI ID.
For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon EC2 User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IMAGEID() |
Getter for IMAGEID, with configurable default |
ASK_IMAGEID() |
Getter for IMAGEID w/ exceptions if field has no value |
HAS_IMAGEID() |
Determine if IMAGEID has a value |
InstanceType¶
The instance type. For more information, see Amazon EC2 instance types in the Amazon EC2 User Guide.
If you specify
InstanceType, you can't specifyInstanceRequirements.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INSTANCETYPE() |
Getter for INSTANCETYPE, with configurable default |
ASK_INSTANCETYPE() |
Getter for INSTANCETYPE w/ exceptions if field has no value |
HAS_INSTANCETYPE() |
Determine if INSTANCETYPE has a value |
KeyName¶
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KEYNAME() |
Getter for KEYNAME, with configurable default |
ASK_KEYNAME() |
Getter for KEYNAME w/ exceptions if field has no value |
HAS_KEYNAME() |
Determine if KEYNAME has a value |
Monitoring¶
The monitoring for the instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MONITORING() |
Getter for MONITORING |
Placement¶
The placement for the instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PLACEMENT() |
Getter for PLACEMENT |
RamDiskId¶
The ID of the RAM disk.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon EC2 User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RAMDISKID() |
Getter for RAMDISKID, with configurable default |
ASK_RAMDISKID() |
Getter for RAMDISKID w/ exceptions if field has no value |
HAS_RAMDISKID() |
Determine if RAMDISKID has a value |
DisableApiTermination¶
If you set this parameter to
true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you setInstanceInitiatedShutdownBehaviortoterminate, you can terminate the instance by running the shutdown command from the instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DISABLEAPITERMINATION() |
Getter for DISABLEAPITERMINATION, with configurable default |
ASK_DISABLEAPITERMINATION() |
Getter for DISABLEAPITERMINATION w/ exceptions if field has |
HAS_DISABLEAPITERMINATION() |
Determine if DISABLEAPITERMINATION has a value |
InstanceInitiatedShutdownBehavior¶
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default:
stop
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INSTINITIATEDSHUTDOWNB00() |
Getter for INSTINITIATEDSHUTDOWNBEHAV, with configurable def |
ASK_INSTINITIATEDSHUTDOWNB00() |
Getter for INSTINITIATEDSHUTDOWNBEHAV w/ exceptions if field |
HAS_INSTINITIATEDSHUTDOWNB00() |
Determine if INSTINITIATEDSHUTDOWNBEHAV has a value |
UserData¶
The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Run commands on your Amazon EC2 instance at launch in the Amazon EC2 User Guide.
If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USERDATA() |
Getter for USERDATA, with configurable default |
ASK_USERDATA() |
Getter for USERDATA w/ exceptions if field has no value |
HAS_USERDATA() |
Determine if USERDATA has a value |
TagSpecifications¶
The tags to apply to the resources that are created during instance launch. These tags are not applied to the launch template.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGSPECIFICATIONS() |
Getter for TAGSPECIFICATIONS, with configurable default |
ASK_TAGSPECIFICATIONS() |
Getter for TAGSPECIFICATIONS w/ exceptions if field has no v |
HAS_TAGSPECIFICATIONS() |
Determine if TAGSPECIFICATIONS has a value |
ElasticGpuSpecifications¶
Deprecated.
Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ELASTICGPUSPECIFICATIONS() |
Getter for ELASTICGPUSPECIFICATIONS, with configurable defau |
ASK_ELASTICGPUSPECIFICATIONS() |
Getter for ELASTICGPUSPECIFICATIONS w/ exceptions if field h |
HAS_ELASTICGPUSPECIFICATIONS() |
Determine if ELASTICGPUSPECIFICATIONS has a value |
ElasticInferenceAccelerators¶
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ELASTICINFERENCEACCELE00() |
Getter for ELASTICINFERENCEACCELERATORS, with configurable d |
ASK_ELASTICINFERENCEACCELE00() |
Getter for ELASTICINFERENCEACCELERATORS w/ exceptions if fie |
HAS_ELASTICINFERENCEACCELE00() |
Determine if ELASTICINFERENCEACCELERATORS has a value |
SecurityGroupIds¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SECURITYGROUPIDS() |
Getter for SECURITYGROUPIDS, with configurable default |
ASK_SECURITYGROUPIDS() |
Getter for SECURITYGROUPIDS w/ exceptions if field has no va |
HAS_SECURITYGROUPIDS() |
Determine if SECURITYGROUPIDS has a value |
SecurityGroups¶
The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SECURITYGROUPS() |
Getter for SECURITYGROUPS, with configurable default |
ASK_SECURITYGROUPS() |
Getter for SECURITYGROUPS w/ exceptions if field has no valu |
HAS_SECURITYGROUPS() |
Determine if SECURITYGROUPS has a value |
InstanceMarketOptions¶
The market (purchasing) option for the instances.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INSTANCEMARKETOPTIONS() |
Getter for INSTANCEMARKETOPTIONS |
CreditSpecification¶
The credit option for CPU usage of the instance. Valid only for T instances.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREDITSPECIFICATION() |
Getter for CREDITSPECIFICATION |
CpuOptions¶
The CPU options for the instance. For more information, see Optimize CPU options in the Amazon EC2 User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CPUOPTIONS() |
Getter for CPUOPTIONS |
CapacityReservationSpecification¶
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).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CAPACITYRESERVATIONSPEC() |
Getter for CAPACITYRESERVATIONSPEC |
LicenseSpecifications¶
The license configurations.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LICENSESPECIFICATIONS() |
Getter for LICENSESPECIFICATIONS, with configurable default |
ASK_LICENSESPECIFICATIONS() |
Getter for LICENSESPECIFICATIONS w/ exceptions if field has |
HAS_LICENSESPECIFICATIONS() |
Determine if LICENSESPECIFICATIONS has a value |
HibernationOptions¶
Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your Amazon EC2 instance in the Amazon EC2 User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HIBERNATIONOPTIONS() |
Getter for HIBERNATIONOPTIONS |
MetadataOptions¶
The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_METADATAOPTIONS() |
Getter for METADATAOPTIONS |
EnclaveOptions¶
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.
You can't enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENCLAVEOPTIONS() |
Getter for ENCLAVEOPTIONS |
InstanceRequirements¶
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
You must specify
VCpuCountandMemoryMiB. 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 specifyInstanceType.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, or with the RunInstances API or AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can't specify
InstanceRequirements.For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INSTANCEREQUIREMENTS() |
Getter for INSTANCEREQUIREMENTS |
PrivateDnsNameOptions¶
The options for the instance hostname. The default values are inherited from the subnet.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PRIVATEDNSNAMEOPTIONS() |
Getter for PRIVATEDNSNAMEOPTIONS |
MaintenanceOptions¶
The maintenance options for the instance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MAINTENANCEOPTIONS() |
Getter for MAINTENANCEOPTIONS |
DisableApiStop¶
Indicates whether to enable the instance for stop protection. For more information, see Enable stop protection for your instance in the Amazon EC2 User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DISABLEAPISTOP() |
Getter for DISABLEAPISTOP, with configurable default |
ASK_DISABLEAPISTOP() |
Getter for DISABLEAPISTOP w/ exceptions if field has no valu |
HAS_DISABLEAPISTOP() |
Determine if DISABLEAPISTOP has a value |