ec2/aws.sdk.kotlin.services.ec2.model/RequestLaunchTemplateData/Builder

Builder

Properties

var blockDeviceMappings: List<LaunchTemplateBlockDeviceMappingRequest>?

The block device mapping.

var capacityReservationSpecification: LaunchTemplateCapacityReservationSpecificationRequest?

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).

cpuOptions

var cpuOptions: LaunchTemplateCpuOptionsRequest?

The CPU options for the instance. For more information, see CPU options for Amazon EC2 instances in the Amazon EC2 User Guide.

creditSpecification

var creditSpecification: CreditSpecificationRequest?

The credit option for CPU usage of the instance. Valid only for T instances.

disableApiStop

var disableApiStop: Boolean?

Indicates whether to enable the instance for stop protection. For more information, see Enable stop protection for your EC2 instances in the Amazon EC2 User Guide.

disableApiTermination

var disableApiTermination: Boolean?

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.

ebsOptimized

var ebsOptimized: Boolean?

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

elasticGpuSpecifications

var elasticGpuSpecifications: List<ElasticGpuSpecification>?

Deprecated.

elasticInferenceAccelerators

var elasticInferenceAccelerators: List<LaunchTemplateElasticInferenceAccelerator>?

Amazon Elastic Inference is no longer available.

enclaveOptions

var enclaveOptions: LaunchTemplateEnclaveOptionsRequest?

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.

hibernationOptions

var hibernationOptions: LaunchTemplateHibernationOptionsRequest?

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.

iamInstanceProfile

var iamInstanceProfile: LaunchTemplateIamInstanceProfileSpecificationRequest?

The name or Amazon Resource Name (ARN) of an IAM instance profile.

imageId

var imageId: String?

The ID of the AMI in the format ami-0ac394d6a3example.

instanceInitiatedShutdownBehavior

var instanceInitiatedShutdownBehavior: ShutdownBehavior?

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

instanceMarketOptions

var instanceMarketOptions: LaunchTemplateInstanceMarketOptionsRequest?

The market (purchasing) option for the instances.

instanceRequirements

var instanceRequirements: InstanceRequirementsRequest?

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

instanceType

var instanceType: InstanceType?

The instance type. For more information, see Amazon EC2 instance types in the Amazon EC2 User Guide.

kernelId

var kernelId: String?

The ID of the kernel.

keyName

var keyName: String?

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

licenseSpecifications

var licenseSpecifications: List<LaunchTemplateLicenseConfigurationRequest>?

The license configurations.

maintenanceOptions

var maintenanceOptions: LaunchTemplateInstanceMaintenanceOptionsRequest?

The maintenance options for the instance.

metadataOptions

var metadataOptions: LaunchTemplateInstanceMetadataOptionsRequest?

The metadata options for the instance. For more information, see Configure the Instance Metadata Service options in the Amazon EC2 User Guide.

monitoring

var monitoring: LaunchTemplatesMonitoringRequest?

The monitoring for the instance.

networkInterfaces

var networkInterfaces: List<LaunchTemplateInstanceNetworkInterfaceSpecificationRequest>?

The network interfaces for the instance.

networkPerformanceOptions

var networkPerformanceOptions: LaunchTemplateNetworkPerformanceOptionsRequest?

Contains launch template settings to boost network performance for the type of workload that runs on your instance.

operator

var operator: OperatorRequest?

The entity that manages the launch template.

placement

var placement: LaunchTemplatePlacementRequest?

The placement for the instance.

privateDnsNameOptions

var privateDnsNameOptions: LaunchTemplatePrivateDnsNameOptionsRequest?

The options for the instance hostname. The default values are inherited from the subnet.

ramDiskId

var ramDiskId: String?

The ID of the RAM disk.

securityGroupIds

var securityGroupIds: List<String>?

The IDs of the security groups.

securityGroups

var securityGroups: List<String>?

The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

tagSpecifications

var tagSpecifications: List<LaunchTemplateTagSpecificationRequest>?

The tags to apply to the resources that are created during instance launch. These tags are not applied to the launch template.

userData

var userData: String?

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 when you launch an EC2 instance with user data input in the Amazon EC2 User Guide.