Intel® Optimized Cloud Modules for Terraform

AWS VM module

Configuration in this directory creates an AWS VM (EC2 Instance). The instance is created on an 3rd Generation Intel® Xeon® Scalable Processor (IceLake) by default.

Performance Data

Find all the information below plus even more by navigating our full library

INTEL CLOUD PERFORMANCE DATA LIBRARY for AWS

Achieve up to 1.79x higher HPC STREAM Triad throughput on 3rd Generation Intel® Xeon® Scalable Processor (Ice Lake) vs. AMD EPYC

Achieve up to 1.46x more SQL Server performance on 3rd Generation Intel® Xeon® Scalable Processor (Ice Lake) vs. previous generation

Up to 1.79 times better Java Server performance on 3rd Generation Intel® Xeon® Scalable Processor (Ice Lake) vs. AMD EPYC

Get up to 3.0x better NGINX performance with AWS Instances featuring 3rd Generation Intel® Xeon® Scalable Processor (Ice Lake) vs. AMD EPYC

Process up to 1.42x more database transactions with AWS Instances featuring 3rd Generation Intel® Xeon® Scalable Processor (Ice Lake) vs. previous generation

Achieve up to 6.5x more BERT Deep Learning performance with AWS M6i Instances enabled by 3rd Generation Intel® Xeon® Scalable Processor (Ice Lake) vs. AMD EPYC

Up to 1.5x more MongoDB Operations/Sec with C6i Instances featuring 3rd Generation Intel® Xeon® Scalable Processor (Ice Lake) vs. Graviton

Up to 1.31x more MongoDB transactions with C6i Instances featuring 3rd Generation Intel® Xeon® Scalable Processor (Ice Lake) vs. AMD EPYC

Achieve up to 1.56x more Floating Point performance on 3rd Generation Intel® Xeon® Scalable Processor (Ice Lake) vs. AMD EPYC

Achieve up to 1.29x more Floating Point performance with C6i Instances featuring 3rd Generation Intel® Xeon® Scalable Processor (Ice Lake) vs. Graviton

Usage

You can reference the examples folder for sample code that meets your use case: Each example will have a usage description listed in the README documentation.

Example of main.tf

module "ec2-vm" {
  source = "intel/aws-vm/intel"
  tags = {
    Name     = "my-test-vm-${random_id.rid.dec}"
    Owner    = "OwnerName-${random_id.rid.dec}",
    Duration = "2"
  }
}

Execution steps:

terraform init  
terraform plan
terraform apply

Note that this example may create resources. Run terraform destroy when you don't need these resources anymore.

Supported Regions

These modules support all AWS Regions that are enabled in your AWS account.

Deployment Time

Each example module will spin up resources under 5 minutes. Refer to each example README file for specific instructions on the required paramaters you must input for your AWS Account and region for deployment.

Deployment Guide

Each Example will have specific instructions listed in the README file. This file will list the required variables you need to populate in order to deploy the module.

All example modules are open source and are covered under the Apache License Version 2.0.

You will need an active AWS account along with knowledge of how to use the AWS CLI to configure your client to access your AWS account.

Security

When using any of these modules in your AWS account, do not use the AWS account root user. Leverage the IAM service to create IAM credentials and follow the principle of "least privilege" permissions for the credentials you create.
When deploying EC2 instances with this module all EC2 Keypairs that are generated will download and keeps the private key in the same folder from where the terraform apply was run.

Considerations

Using HashiCorp Modules alongside green-blue deployment allows for a secure and efficient deployment process. The modules can be easily integrated into both the active and inactive environments, ensuring consistency across both environments.
- Instance - If you apply the instances will shut down immediately and restart, creating service interruption.
- Platform - If you apply, it will wait for the next maintenance window to change the instance & configuration. You can force apply with additional TF code.

Requirements

Name	Version
terraform	>= 0.13.1
aws	~> 5.31

Providers

Name	Version
aws	~> 5.31

Modules

No modules.

Resources

Name	Type
aws_iam_instance_profile.this	resource
aws_iam_role.this	resource
aws_iam_role_policy_attachment.this	resource
aws_instance.this	resource
aws_spot_instance_request.this	resource
aws_iam_policy_document.assume_role_policy	data source
aws_partition.current	data source
aws_ssm_parameter.this	data source

Inputs

Name	Description	Type	Default	Required
ami	ID of AMI to use for the instance	`string`	`null`	no
ami_ssm_parameter	SSM parameter name for the AMI ID. For Amazon Linux AMI SSM parameters see reference. To find the latest Windows AMI using Systems Manager, use this reference	`string`	`"/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2"`	no
associate_public_ip_address	Whether to associate a public IP address with an instance in a VPC	`bool`	`null`	no
availability_zone	AZ to start the instance in	`string`	`null`	no
capacity_reservation_specification	Describes an instance's Capacity Reservation targeting option	`any`	`{}`	no
cpu_core_count	Sets the number of CPU cores for an instance.	`number`	`null`	no
cpu_credits	The credit option for CPU usage (unlimited or standard)	`string`	`null`	no
cpu_threads_per_core	Sets the number of CPU threads per core for an instance (has no effect unless cpu_core_count is also set).	`number`	`null`	no
create	Whether to create an instance	`bool`	`true`	no
create_iam_instance_profile	Determines whether an IAM instance profile is created or to use an existing IAM instance profile	`bool`	`false`	no
create_spot_instance	Depicts if the instance is a spot instance	`bool`	`false`	no
disable_api_stop	If true, enables EC2 Instance Stop Protection.	`bool`	`null`	no
disable_api_termination	If true, enables EC2 Instance Termination Protection	`bool`	`null`	no
ebs_block_device	Additional EBS block devices to attach to the instance	`list(map(string))`	`[]`	no
ebs_optimized	If true, the launched EC2 instance will be EBS-optimized	`bool`	`null`	no
enable_volume_tags	Whether to enable volume tags (if enabled it conflicts with root_block_device tags)	`bool`	`true`	no
enclave_options_enabled	Whether Nitro Enclaves will be enabled on the instance. Defaults to `false`	`bool`	`null`	no
ephemeral_block_device	Customize Ephemeral (also known as Instance Store) volumes on the instance	`list(map(string))`	`[]`	no
get_password_data	If true, wait for password data to become available and retrieve it.	`bool`	`null`	no
hibernation	If true, the launched EC2 instance will support hibernation	`bool`	`null`	no
host_id	ID of a dedicated host that the instance will be assigned to. Use when an instance is to be launched on a specific dedicated host	`string`	`null`	no
iam_instance_profile	IAM Instance Profile to launch the instance with. Specified as the name of the Instance Profile	`string`	`null`	no
iam_role_description	Description of the role	`string`	`null`	no
iam_role_name	Name to use on IAM role created	`string`	`null`	no
iam_role_path	IAM role path	`string`	`null`	no
iam_role_permissions_boundary	ARN of the policy that is used to set the permissions boundary for the IAM role	`string`	`null`	no
iam_role_policies	Policies attached to the IAM role	`map(string)`	`{}`	no
iam_role_tags	A map of additional tags to add to the IAM role/profile created	`map(string)`	`{}`	no
iam_role_use_name_prefix	Determines whether the IAM role name (`iam_role_name` or `name`) is used as a prefix	`bool`	`true`	no
instance_initiated_shutdown_behavior	Shutdown behavior for the instance. Amazon defaults this to stop for EBS-backed instances and terminate for instance-store instances. Cannot be set on instance-store instance	`string`	`null`	no
instance_type	Instance SKU, see comments above for guidance	`string`	`"m7i.large"`	no
ipv6_address_count	A number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet	`number`	`null`	no
ipv6_addresses	Specify one or more IPv6 addresses from the range of the subnet to associate with the primary network interface	`list(string)`	`null`	no
key_name	Key name of the Key Pair to use for the instance; which can be managed using the `aws_key_pair` resource	`string`	`null`	no
launch_template	Specifies a Launch Template to configure the instance. Parameters configured on this resource will override the corresponding parameters in the Launch Template	`map(string)`	`null`	no
metadata_options	Customize the metadata options of the instance	`map(string)`	`{}`	no
monitoring	If true, the launched EC2 instance will have detailed monitoring enabled	`bool`	`false`	no
name	Name to be used on EC2 instance created	`string`	`""`	no
network_interface	Customize network interfaces to be attached at instance boot time	`list(map(string))`	`[]`	no
placement_group	The Placement Group to start the instance in	`string`	`null`	no
private_ip	Private IP address to associate with the instance in a VPC	`string`	`null`	no
root_block_device	Customize details about the root block device of the instance. See Block Devices below for details	`list(any)`	`[]`	no
secondary_private_ips	A list of secondary private IPv4 addresses to assign to the instance's primary network interface (eth0) in a VPC. Can only be assigned to the primary network interface (eth0) attached at instance creation, not a pre-existing network interface i.e. referenced in a `network_interface block`	`list(string)`	`null`	no
source_dest_check	Controls if traffic is routed to the instance when the destination address does not match the instance. Used for NAT or VPNs.	`bool`	`true`	no
spot_block_duration_minutes	The required duration for the Spot instances, in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360)	`number`	`null`	no
spot_instance_interruption_behavior	Indicates Spot instance behavior when it is interrupted. Valid values are `terminate`, `stop`, or `hibernate`	`string`	`"terminate"`	no
spot_instance_type	If set to one-time, after the instance is terminated, the spot request will be closed. Default `persistent`	`string`	`"one-time"`	no
spot_launch_group	A launch group is a group of spot instances that launch together and terminate together. If left empty instances are launched and terminated individually	`string`	`null`	no
spot_price	The maximum price to request on the spot market. Defaults to on-demand price	`string`	`null`	no
spot_valid_from	The start date and time of the request, in UTC RFC3339 format(for example, YYYY-MM-DDTHH:MM:SSZ)	`string`	`null`	no
spot_valid_until	The end date and time of the request, in UTC RFC3339 format(for example, YYYY-MM-DDTHH:MM:SSZ)	`string`	`null`	no
spot_wait_for_fulfillment	If set, Terraform will wait for the Spot Request to be fulfilled, and will throw an error if the timeout of 10m is reached	`bool`	`null`	no
subnet_id	The VPC Subnet ID to launch in	`string`	`null`	no
tags	A mapping of tags to assign to the resource	`map(string)`	`{}`	no
tenancy	The tenancy of the instance (if the instance is running in a VPC). Available values: default, dedicated, host.	`string`	`null`	no
timeouts	Define maximum timeout for creating, updating, and deleting EC2 instance resources	`map(string)`	`{}`	no
user_data	The user data to provide when launching the instance. Do not pass gzip-compressed data via this argument; see user_data_base64 instead.	`string`	`null`	no
user_data_base64	Can be used instead of user_data to pass base64-encoded binary data directly. Use this instead of user_data whenever the value is not a valid UTF-8 string. For example, gzip-encoded user data must be base64-encoded and passed via this argument to avoid corruption.	`string`	`null`	no
user_data_replace_on_change	When used in combination with user_data or user_data_base64 will trigger a destroy and recreate when set to true. Defaults to false if not set.	`bool`	`false`	no
volume_tags	A mapping of tags to assign to the devices created by the instance at launch time	`map(string)`	`{}`	no
vpc_security_group_ids	A list of security group IDs to associate with	`list(string)`	`null`	no

Outputs

Name	Description
arn	The ARN of the instance
capacity_reservation_specification	Capacity reservation specification of the instance
iam_instance_profile_arn	ARN assigned by AWS to the instance profile
iam_instance_profile_id	Instance profile's ID
iam_instance_profile_unique	Stable and unique string identifying the IAM instance profile
iam_role_arn	The Amazon Resource Name (ARN) specifying the IAM role
iam_role_name	The name of the IAM role
iam_role_unique_id	Stable and unique string identifying the IAM role
id	The ID of the instance
instance_state	The state of the instance. One of: `pending`, `running`, `shutting-down`, `terminated`, `stopping`, `stopped`
ipv6_addresses	The IPv6 address assigned to the instance, if applicable.
outpost_arn	The ARN of the Outpost the instance is assigned to
password_data	Base-64 encoded encrypted password data for the instance. Useful for getting the administrator password for instances running Microsoft Windows. This attribute is only exported if `get_password_data` is true
primary_network_interface_id	The ID of the instance's primary network interface
private_dns	The private DNS name assigned to the instance. Can only be used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC
private_ip	The private IP address assigned to the instance.
public_dns	The public DNS name assigned to the instance. For EC2-VPC, this is only available if you've enabled DNS hostnames for your VPC
public_ip	The public IP address assigned to the instance, if applicable. NOTE: If you are using an aws_eip with your instance, you should refer to the EIP's address directly and not use `public_ip` as this field will change after the EIP is attached
spot_bid_status	The current bid status of the Spot Instance Request
spot_instance_id	The Instance ID (if any) that is currently fulfilling the Spot Instance request
spot_request_state	The current request state of the Spot Instance Request
tags_all	A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block

intel/terraform-intel-aws-vm