Struct aws_sdk_ec2::types::RequestLaunchTemplateData

#[non_exhaustive]
pub struct RequestLaunchTemplateData {

    pub kernel_id: Option<String>,
    pub ebs_optimized: Option<bool>,
    pub iam_instance_profile: Option<LaunchTemplateIamInstanceProfileSpecificationRequest>,
    pub block_device_mappings: Option<Vec<LaunchTemplateBlockDeviceMappingRequest>>,
    pub network_interfaces: Option<Vec<LaunchTemplateInstanceNetworkInterfaceSpecificationRequest>>,
    pub image_id: Option<String>,
    pub instance_type: Option<InstanceType>,
    pub key_name: Option<String>,
    pub monitoring: Option<LaunchTemplatesMonitoringRequest>,
    pub placement: Option<LaunchTemplatePlacementRequest>,
    pub ram_disk_id: Option<String>,
    pub disable_api_termination: Option<bool>,
    pub instance_initiated_shutdown_behavior: Option<ShutdownBehavior>,
    pub user_data: Option<String>,
    pub tag_specifications: Option<Vec<LaunchTemplateTagSpecificationRequest>>,
    pub elastic_gpu_specifications: Option<Vec<ElasticGpuSpecification>>,
    pub elastic_inference_accelerators: Option<Vec<LaunchTemplateElasticInferenceAccelerator>>,
    pub security_group_ids: Option<Vec<String>>,
    pub security_groups: Option<Vec<String>>,
    pub instance_market_options: Option<LaunchTemplateInstanceMarketOptionsRequest>,
    pub credit_specification: Option<CreditSpecificationRequest>,
    pub cpu_options: Option<LaunchTemplateCpuOptionsRequest>,
    pub capacity_reservation_specification: Option<LaunchTemplateCapacityReservationSpecificationRequest>,
    pub license_specifications: Option<Vec<LaunchTemplateLicenseConfigurationRequest>>,
    pub hibernation_options: Option<LaunchTemplateHibernationOptionsRequest>,
    pub metadata_options: Option<LaunchTemplateInstanceMetadataOptionsRequest>,
    pub enclave_options: Option<LaunchTemplateEnclaveOptionsRequest>,
    pub instance_requirements: Option<InstanceRequirementsRequest>,
    pub private_dns_name_options: Option<LaunchTemplatePrivateDnsNameOptionsRequest>,
    pub maintenance_options: Option<LaunchTemplateInstanceMaintenanceOptionsRequest>,
    pub disable_api_stop: Option<bool>,
}

The information to include in the launch template.

You must specify at least one parameter for the launch template data.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

kernel_id: Option<String>

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 Elastic Compute Cloud User Guide.

ebs_optimized: Option<bool>

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.

iam_instance_profile: Option<LaunchTemplateIamInstanceProfileSpecificationRequest>

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

block_device_mappings: Option<Vec<LaunchTemplateBlockDeviceMappingRequest>>

The block device mapping.

network_interfaces: Option<Vec<LaunchTemplateInstanceNetworkInterfaceSpecificationRequest>>

One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

image_id: Option<String>

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-parameter

Currently, 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 Elastic Compute Cloud User Guide.

instance_type: Option<InstanceType>

The instance type. For more information, see Instance types in the Amazon Elastic Compute Cloud User Guide.

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

key_name: Option<String>

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.

monitoring: Option<LaunchTemplatesMonitoringRequest>

The monitoring for the instance.

placement: Option<LaunchTemplatePlacementRequest>

The placement for the instance.

ram_disk_id: Option<String>

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 Elastic Compute Cloud User Guide.

disable_api_termination: Option<bool>

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 set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

instance_initiated_shutdown_behavior: Option<ShutdownBehavior>

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

Default: stop

user_data: Option<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 on your Linux instance at launch (Linux) or Work with instance user data (Windows) in the Amazon Elastic Compute Cloud 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.

tag_specifications: Option<Vec<LaunchTemplateTagSpecificationRequest>>

The tags to apply to the resources that are created during instance launch.

You can specify tags for the following resources only:

• Instances

• Volumes

• Elastic graphics

• Spot Instance requests

• Network interfaces

To tag a resource after it has been created, see CreateTags.

To tag the launch template itself, you must use the TagSpecification parameter.

elastic_gpu_specifications: Option<Vec<ElasticGpuSpecification>>

An elastic GPU to associate with the instance.

elastic_inference_accelerators: Option<Vec<LaunchTemplateElasticInferenceAccelerator>>

The elastic inference accelerator for the instance.

security_group_ids: Option<Vec<String>>

One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.

security_groups: Option<Vec<String>>

One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.

instance_market_options: Option<LaunchTemplateInstanceMarketOptionsRequest>

The market (purchasing) option for the instances.

credit_specification: Option<CreditSpecificationRequest>

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

cpu_options: Option<LaunchTemplateCpuOptionsRequest>

The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.

capacity_reservation_specification: Option<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).

license_specifications: Option<Vec<LaunchTemplateLicenseConfigurationRequest>>

The license configurations.

hibernation_options: Option<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 instance in the Amazon Elastic Compute Cloud User Guide.

metadata_options: Option<LaunchTemplateInstanceMetadataOptionsRequest>

The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.

enclave_options: Option<LaunchTemplateEnclaveOptionsRequest>

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.

instance_requirements: Option<InstanceRequirementsRequest>

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

private_dns_name_options: Option<LaunchTemplatePrivateDnsNameOptionsRequest>

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

maintenance_options: Option<LaunchTemplateInstanceMaintenanceOptionsRequest>

The maintenance options for the instance.

disable_api_stop: Option<bool>

Indicates whether to enable the instance for stop protection. For more information, see Stop protection in the Amazon Elastic Compute Cloud User Guide.

Implementations

impl RequestLaunchTemplateData

pub fn kernel_id(&self) -> Option<&str>

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 Elastic Compute Cloud User Guide.

pub fn ebs_optimized(&self) -> Option<bool>

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.

pub fn iam_instance_profile( &self ) -> Option<&LaunchTemplateIamInstanceProfileSpecificationRequest>

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

pub fn block_device_mappings( &self ) -> Option<&[LaunchTemplateBlockDeviceMappingRequest]>

The block device mapping.

pub fn network_interfaces( &self ) -> Option<&[LaunchTemplateInstanceNetworkInterfaceSpecificationRequest]>

One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

pub fn image_id(&self) -> Option<&str>

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-parameter

Currently, 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 Elastic Compute Cloud User Guide.

pub fn instance_type(&self) -> Option<&InstanceType>

The instance type. For more information, see Instance types in the Amazon Elastic Compute Cloud User Guide.

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

pub fn key_name(&self) -> Option<&str>

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.

pub fn monitoring(&self) -> Option<&LaunchTemplatesMonitoringRequest>

The monitoring for the instance.

pub fn placement(&self) -> Option<&LaunchTemplatePlacementRequest>

The placement for the instance.

pub fn ram_disk_id(&self) -> Option<&str>

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 Elastic Compute Cloud User Guide.

pub fn disable_api_termination(&self) -> Option<bool>

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 set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

pub fn instance_initiated_shutdown_behavior(&self) -> Option<&ShutdownBehavior>

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

Default: stop

pub fn user_data(&self) -> Option<&str>

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 Linux instance at launch (Linux) or Work with instance user data (Windows) in the Amazon Elastic Compute Cloud 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.

pub fn tag_specifications( &self ) -> Option<&[LaunchTemplateTagSpecificationRequest]>

The tags to apply to the resources that are created during instance launch.

You can specify tags for the following resources only:

• Instances

• Volumes

• Elastic graphics

• Spot Instance requests

• Network interfaces

To tag a resource after it has been created, see CreateTags.

To tag the launch template itself, you must use the TagSpecification parameter.

pub fn elastic_gpu_specifications(&self) -> Option<&[ElasticGpuSpecification]>

An elastic GPU to associate with the instance.

pub fn elastic_inference_accelerators( &self ) -> Option<&[LaunchTemplateElasticInferenceAccelerator]>

The elastic inference accelerator for the instance.

pub fn security_group_ids(&self) -> Option<&[String]>

One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.

pub fn security_groups(&self) -> Option<&[String]>

One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.

pub fn instance_market_options( &self ) -> Option<&LaunchTemplateInstanceMarketOptionsRequest>

The market (purchasing) option for the instances.

pub fn credit_specification(&self) -> Option<&CreditSpecificationRequest>

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

pub fn cpu_options(&self) -> Option<&LaunchTemplateCpuOptionsRequest>

The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.

pub fn capacity_reservation_specification( &self ) -> Option<&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).

pub fn license_specifications( &self ) -> Option<&[LaunchTemplateLicenseConfigurationRequest]>

The license configurations.

pub fn hibernation_options( &self ) -> Option<&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 instance in the Amazon Elastic Compute Cloud User Guide.

pub fn metadata_options( &self ) -> Option<&LaunchTemplateInstanceMetadataOptionsRequest>

The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.

pub fn enclave_options(&self) -> Option<&LaunchTemplateEnclaveOptionsRequest>

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.

pub fn instance_requirements(&self) -> Option<&InstanceRequirementsRequest>

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

pub fn private_dns_name_options( &self ) -> Option<&LaunchTemplatePrivateDnsNameOptionsRequest>

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

pub fn maintenance_options( &self ) -> Option<&LaunchTemplateInstanceMaintenanceOptionsRequest>

The maintenance options for the instance.

pub fn disable_api_stop(&self) -> Option<bool>

Indicates whether to enable the instance for stop protection. For more information, see Stop protection in the Amazon Elastic Compute Cloud User Guide.

impl RequestLaunchTemplateData

pub fn builder() -> RequestLaunchTemplateDataBuilder

Creates a new builder-style object to manufacture RequestLaunchTemplateData.

Trait Implementations

impl Clone for RequestLaunchTemplateData

fn clone(&self) -> RequestLaunchTemplateData

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RequestLaunchTemplateData

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<RequestLaunchTemplateData> for RequestLaunchTemplateData

fn eq(&self, other: &RequestLaunchTemplateData) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RequestLaunchTemplateData