Home

Awesome

<!-- markdownlint-disable -->

<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/terraform-aws-ec2-instance/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/> <p align="right"> <a href="https://github.com/cloudposse/terraform-aws-ec2-instance/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-ec2-instance.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-ec2-instance/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-ec2-instance.svg?style=for-the-badge" alt="Last Updated"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>

<!-- markdownlint-restore --> <!-- ** DO NOT EDIT THIS FILE ** ** This file was automatically generated by the `cloudposse/build-harness`. ** 1) Make all changes to `README.yaml` ** 2) Run `make init` (you only need to do this once) ** 3) Run`make readme` to rebuild this file. ** ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.) ** -->

Terraform Module for provisioning a general purpose EC2 host.

Included features:

[!TIP]

πŸ‘½ Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform. <br/> Works with Github Actions, Atlantis, or Spacelift.

<details> <summary><strong>Watch demo of using Atmos with Terraform</strong></summary> <img src="https://github.com/cloudposse/atmos/blob/master/docs/demo.gif?raw=true"/><br/> <i>Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial.</i> </detalis>

Usage

Note: add ${var.ssh_key_pair} private key to the ssh agent.

Include this repository as a module in your existing terraform code.

Simple example:

module "instance" {
  source = "cloudposse/ec2-instance/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"
  ssh_key_pair                = var.ssh_key_pair
  instance_type               = var.instance_type
  vpc_id                      = var.vpc_id
  security_groups             = var.security_groups
  subnet                      = var.subnet
  name                        = "ec2"
  namespace                   = "eg"
  stage                       = "dev"
}

Example with additional volumes and EIP

module "kafka_instance" {
  source = "cloudposse/ec2-instance/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"
  ssh_key_pair                = var.ssh_key_pair
  vpc_id                      = var.vpc_id
  security_groups             = var.security_groups
  subnet                      = var.subnet
  associate_public_ip_address = true
  name                        = "kafka"
  namespace                   = "eg"
  stage                       = "dev"
  additional_ips_count        = 1
  ebs_volume_count            = 2
  security_group_rules = [
    {
      type        = "egress"
      from_port   = 0
      to_port     = 65535
      protocol    = "-1"
      cidr_blocks = ["0.0.0.0/0"]
    },
    {
      type        = "ingress"
      from_port   = 22
      to_port     = 22
      protocol    = "tcp"
      cidr_blocks = ["0.0.0.0/0"]
    },
    {
      type        = "ingress"
      from_port   = 80
      to_port     = 80
      protocol    = "tcp"
      cidr_blocks = ["0.0.0.0/0"]
    },
    {
      type        = "ingress"
      from_port   = 443
      to_port     = 443
      protocol    = "tcp"
      cidr_blocks = ["0.0.0.0/0"]
    },
    {
      type        = "ingress"
      from_port   = 53
      to_port     = 53
      protocol    = "udp"
      cidr_blocks = ["0.0.0.0/0"]
    },
  ]
}

[!IMPORTANT] In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

<!-- markdownlint-disable -->

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

<!-- markdownlint-restore --> <!-- markdownlint-disable -->

Requirements

NameVersion
<a name="requirement_terraform"></a> terraform>= 1.0
<a name="requirement_aws"></a> aws>= 4.7.0
<a name="requirement_null"></a> null>= 2.0

Providers

NameVersion
<a name="provider_aws"></a> aws>= 4.7.0
<a name="provider_null"></a> null>= 2.0

Modules

NameSourceVersion
<a name="module_label_ssm_patch_s3_log_policy"></a> label_ssm_patch_s3_log_policycloudposse/label/null0.25.0
<a name="module_security_group"></a> security_groupcloudposse/security-group/aws0.3.3
<a name="module_this"></a> thiscloudposse/label/null0.25.0

Resources

NameType
aws_cloudwatch_metric_alarm.defaultresource
aws_ebs_volume.defaultresource
aws_eip.additionalresource
aws_eip.defaultresource
aws_iam_instance_profile.defaultresource
aws_iam_policy.ssm_patch_s3_log_policyresource
aws_iam_role.defaultresource
aws_iam_role_policy_attachment.ssm_coreresource
aws_iam_role_policy_attachment.ssm_s3_policyresource
aws_instance.defaultresource
aws_network_interface.additionalresource
aws_network_interface_attachment.additionalresource
aws_volume_attachment.defaultresource
null_resource.check_alarm_actionresource
aws_ami.defaultdata source
aws_ami.infodata source
aws_caller_identity.defaultdata source
aws_iam_instance_profile.givendata source
aws_iam_policy_document.defaultdata source
aws_iam_policy_document.ssm_patch_s3_log_policydata source
aws_partition.defaultdata source
aws_region.defaultdata source
aws_subnet.defaultdata source

Inputs

NameDescriptionTypeDefaultRequired
<a name="input_additional_ips_count"></a> additional_ips_countCount of additional EIPsnumber0no
<a name="input_additional_tag_map"></a> additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.<br/>This is for some rare cases where resources want additional configuration of tags<br/>and therefore take a list of maps with tag key, value, and additional configuration.map(string){}no
<a name="input_ami"></a> amiThe AMI to use for the instance. By default it is the AMI provided by Amazon with Ubuntu 16.04string""no
<a name="input_ami_owner"></a> ami_ownerOwner of the given AMI (ignored if ami unset, required if set)string""no
<a name="input_applying_period"></a> applying_periodThe period in seconds over which the specified statistic is appliednumber60no
<a name="input_assign_eip_address"></a> assign_eip_addressAssign an Elastic IP address to the instancebooltrueno
<a name="input_associate_public_ip_address"></a> associate_public_ip_addressAssociate a public IP address with the instanceboolfalseno
<a name="input_attributes"></a> attributesID element. Additional attributes (e.g. workers or cluster) to add to id,<br/>in the order they appear in the list. New attributes are appended to the<br/>end of the list. The elements of the list are joined by the delimiter<br/>and treated as a single ID element.list(string)[]no
<a name="input_availability_zone"></a> availability_zoneAvailability Zone the instance is launched in. If not set, will be launched in the first AZ of the regionstring""no
<a name="input_burstable_mode"></a> burstable_modeEnable burstable mode for the instance. Can be standard or unlimited. Applicable only for T2/T3/T4g instance types.stringnullno
<a name="input_comparison_operator"></a> comparison_operatorThe arithmetic operation to use when comparing the specified Statistic and Threshold. Possible values are: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold.string"GreaterThanOrEqualToThreshold"no
<a name="input_context"></a> contextSingle object for setting entire context at once.<br/>See description of individual variables for details.<br/>Leave string and numeric variables as null to use default value.<br/>Individual variable settings (non-null) override settings in context object,<br/>except for attributes, tags, and additional_tag_map, which are merged.any<pre>{<br/> "additional_tag_map": {},<br/> "attributes": [],<br/> "delimiter": null,<br/> "descriptor_formats": {},<br/> "enabled": true,<br/> "environment": null,<br/> "id_length_limit": null,<br/> "label_key_case": null,<br/> "label_order": [],<br/> "label_value_case": null,<br/> "labels_as_tags": [<br/> "unset"<br/> ],<br/> "name": null,<br/> "namespace": null,<br/> "regex_replace_chars": null,<br/> "stage": null,<br/> "tags": {},<br/> "tenant": null<br/>}</pre>no
<a name="input_default_alarm_action"></a> default_alarm_actionDefault alarm actionstring"action/actions/AWS_EC2.InstanceId.Reboot/1.0"no
<a name="input_delete_on_termination"></a> delete_on_terminationWhether the volume should be destroyed on instance terminationbooltrueno
<a name="input_delimiter"></a> delimiterDelimiter to be used between ID elements.<br/>Defaults to - (hyphen). Set to "" to use no delimiter at all.stringnullno
<a name="input_descriptor_formats"></a> descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.<br/>Map of maps. Keys are names of descriptors. Values are maps of the form<br/>{<br/> format = string<br/> labels = list(string)<br/>}<br/>(Type is any so the map values can later be enhanced to provide additional options.)<br/>format is a Terraform format string to be passed to the format() function.<br/>labels is a list of labels, in order, to pass to format() function.<br/>Label values will be normalized before being passed to format() so they will be<br/>identical to how they appear in id.<br/>Default is {} (descriptors output will be empty).any{}no
<a name="input_disable_alarm_action"></a> disable_alarm_actionDisable the creation of Alarm Actionboolfalseno
<a name="input_disable_api_stop"></a> disable_api_stopEnable EC2 Instance Stop Protectionboolfalseno
<a name="input_disable_api_termination"></a> disable_api_terminationEnable EC2 Instance Termination Protectionboolfalseno
<a name="input_ebs_device_name"></a> ebs_device_nameName of the EBS device to mountlist(string)<pre>[<br/> "/dev/xvdb",<br/> "/dev/xvdc",<br/> "/dev/xvdd",<br/> "/dev/xvde",<br/> "/dev/xvdf",<br/> "/dev/xvdg",<br/> "/dev/xvdh",<br/> "/dev/xvdi",<br/> "/dev/xvdj",<br/> "/dev/xvdk",<br/> "/dev/xvdl",<br/> "/dev/xvdm",<br/> "/dev/xvdn",<br/> "/dev/xvdo",<br/> "/dev/xvdp",<br/> "/dev/xvdq",<br/> "/dev/xvdr",<br/> "/dev/xvds",<br/> "/dev/xvdt",<br/> "/dev/xvdu",<br/> "/dev/xvdv",<br/> "/dev/xvdw",<br/> "/dev/xvdx",<br/> "/dev/xvdy",<br/> "/dev/xvdz"<br/>]</pre>no
<a name="input_ebs_iops"></a> ebs_iopsAmount of provisioned IOPS. This must be set with a volume_type of io1, io2 or gp3number0no
<a name="input_ebs_optimized"></a> ebs_optimizedLaunched EC2 instance will be EBS-optimizedbooltrueno
<a name="input_ebs_throughput"></a> ebs_throughputAmount of throughput. This must be set if volume_type is set to gp3number0no
<a name="input_ebs_volume_count"></a> ebs_volume_countCount of EBS volumes that will be attached to the instancenumber0no
<a name="input_ebs_volume_encrypted"></a> ebs_volume_encryptedWhether to encrypt the additional EBS volumesbooltrueno
<a name="input_ebs_volume_size"></a> ebs_volume_sizeSize of the additional EBS volumes in gigabytesnumber10no
<a name="input_ebs_volume_type"></a> ebs_volume_typeThe type of the additional EBS volumes. Can be standard, gp2, gp3, io1 or io2string"gp2"no
<a name="input_enabled"></a> enabledSet to false to prevent the module from creating any resourcesboolnullno
<a name="input_environment"></a> environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
<a name="input_evaluation_periods"></a> evaluation_periodsThe number of periods over which data is compared to the specified threshold.number5no
<a name="input_external_network_interface_enabled"></a> external_network_interface_enabledWheter to attach an external ENI as the eth0 interface for the instance. Any change to the interface will force instance recreation.boolfalseno
<a name="input_external_network_interfaces"></a> external_network_interfacesThe external interface definitions to attach to the instances. This depends on the instance type<pre>list(object({<br/> delete_on_termination = bool<br/> device_index = number<br/> network_card_index = number<br/> network_interface_id = string<br/> }))</pre>nullno
<a name="input_id_length_limit"></a> id_length_limitLimit id to this many characters (minimum 6).<br/>Set to 0 for unlimited length.<br/>Set to null for keep the existing setting, which defaults to 0.<br/>Does not affect id_full.numbernullno
<a name="input_instance_initiated_shutdown_behavior"></a> instance_initiated_shutdown_behaviorSpecifies whether an instance stops or terminates when you initiate shutdown from the instance. Can be one of 'stop' or 'terminate'.stringnullno
<a name="input_instance_profile"></a> instance_profileA pre-defined profile to attach to the instance (default is to build our own)string""no
<a name="input_instance_profile_enabled"></a> instance_profile_enabledWhether an IAM instance profile is created to pass a role to an Amazon EC2 instance when the instance startsbooltrueno
<a name="input_instance_type"></a> instance_typeThe type of the instancestring"t2.micro"no
<a name="input_ipv6_address_count"></a> ipv6_address_countNumber of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet (-1 to use subnet default)number0no
<a name="input_ipv6_addresses"></a> ipv6_addressesList of IPv6 addresses from the range of the subnet to associate with the primary network interfacelist(string)[]no
<a name="input_kms_key_id"></a> kms_key_idKMS key ID used to encrypt EBS volume. When specifying kms_key_id, ebs_volume_encrypted needs to be set to truestringnullno
<a name="input_label_key_case"></a> label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.<br/>Does not affect keys of tags passed in via the tags input.<br/>Possible values: lower, title, upper.<br/>Default value: title.stringnullno
<a name="input_label_order"></a> label_orderThe order in which the labels (ID elements) appear in the id.<br/>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br/>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.list(string)nullno
<a name="input_label_value_case"></a> label_value_caseControls the letter case of ID elements (labels) as included in id,<br/>set as tag values, and output by this module individually.<br/>Does not affect values of tags passed in via the tags input.<br/>Possible values: lower, title, upper and none (no transformation).<br/>Set this to title and set delimiter to "" to yield Pascal Case IDs.<br/>Default value: lower.stringnullno
<a name="input_labels_as_tags"></a> labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.<br/>Default is to include all labels.<br/>Tags with empty values will not be included in the tags output.<br/>Set to [] to suppress all generated tags.<br/>Notes:<br/> The value of the name tag, if included, will be the id, not the name.<br/> Unlike other null-label inputs, the initial setting of labels_as_tags cannot be<br/> changed in later chained modules. Attempts to change it will be silently ignored.set(string)<pre>[<br/> "default"<br/>]</pre>no
<a name="input_metadata_http_endpoint_enabled"></a> metadata_http_endpoint_enabledWhether the metadata service is availablebooltrueno
<a name="input_metadata_http_put_response_hop_limit"></a> metadata_http_put_response_hop_limitThe desired HTTP PUT response hop limit (between 1 and 64) for instance metadata requests.number2no
<a name="input_metadata_http_tokens_required"></a> metadata_http_tokens_requiredWhether or not the metadata service requires session tokens, also referred to as Instance Metadata Service Version 2.booltrueno
<a name="input_metadata_tags_enabled"></a> metadata_tags_enabledWhether the tags are enabled in the metadata service.boolfalseno
<a name="input_metric_name"></a> metric_nameThe name for the alarm's associated metric. Allowed values can be found in https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ec2-metricscollected.htmlstring"StatusCheckFailed_Instance"no
<a name="input_metric_namespace"></a> metric_namespaceThe namespace for the alarm's associated metric. Allowed values can be found in https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-namespaces.htmlstring"AWS/EC2"no
<a name="input_metric_threshold"></a> metric_thresholdThe value against which the specified statistic is comparednumber1no
<a name="input_metric_treat_missing_data"></a> metric_treat_missing_dataSets how this alarm is to handle missing data points. The following values are supported: missing, ignore, breaching and notBreaching. Defaults to missing.string"missing"no
<a name="input_monitoring"></a> monitoringLaunched EC2 instance will have detailed monitoring enabledbooltrueno
<a name="input_name"></a> nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br/>This is the only ID element not also included as a tag.<br/>The "name" tag is set to the full id string. There is no tag with the value of the name input.stringnullno
<a name="input_namespace"></a> namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
<a name="input_permissions_boundary_arn"></a> permissions_boundary_arnPolicy ARN to attach to instance role as a permissions boundarystring""no
<a name="input_private_ip"></a> private_ipPrivate IP address to associate with the instance in the VPCstringnullno
<a name="input_regex_replace_chars"></a> regex_replace_charsTerraform regular expression (regex) string.<br/>Characters matching the regex will be removed from the ID elements.<br/>If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.stringnullno
<a name="input_region"></a> regionAWS Region the instance is launched instring""no
<a name="input_root_block_device_encrypted"></a> root_block_device_encryptedWhether to encrypt the root block devicebooltrueno
<a name="input_root_block_device_kms_key_id"></a> root_block_device_kms_key_idKMS key ID used to encrypt EBS volume. When specifying root_block_device_kms_key_id, root_block_device_encrypted needs to be set to truestringnullno
<a name="input_root_iops"></a> root_iopsAmount of provisioned IOPS. This must be set if root_volume_type is set of io1, io2 or gp3number0no
<a name="input_root_throughput"></a> root_throughputAmount of throughput. This must be set if root_volume_type is set to gp3number0no
<a name="input_root_volume_size"></a> root_volume_sizeSize of the root volume in gigabytesnumber10no
<a name="input_root_volume_type"></a> root_volume_typeType of root volume. Can be standard, gp2, gp3, io1 or io2string"gp2"no
<a name="input_secondary_private_ips"></a> secondary_private_ipsList of secondary private IP addresses to associate with the instance in the VPClist(string)[]no
<a name="input_security_group_description"></a> security_group_descriptionThe Security Group description.string"EC2 Security Group"no
<a name="input_security_group_enabled"></a> security_group_enabledWhether to create default Security Group for EC2.booltrueno
<a name="input_security_group_rules"></a> security_group_rulesA list of maps of Security Group rules.<br/>The values of map is fully complated with aws_security_group_rule resource.<br/>To get more info see https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule .list(any)<pre>[<br/> {<br/> "cidr_blocks": [<br/> "0.0.0.0/0"<br/> ],<br/> "description": "Allow all outbound traffic",<br/> "from_port": 0,<br/> "protocol": "-1",<br/> "to_port": 65535,<br/> "type": "egress"<br/> }<br/>]</pre>no
<a name="input_security_group_use_name_prefix"></a> security_group_use_name_prefixWhether to create a default Security Group with unique name beginning with the normalized prefix.boolfalseno
<a name="input_security_groups"></a> security_groupsA list of Security Group IDs to associate with EC2 instance.list(string)[]no
<a name="input_source_dest_check"></a> source_dest_checkControls if traffic is routed to the instance when the destination address does not match the instance. Used for NAT or VPNsbooltrueno
<a name="input_ssh_key_pair"></a> ssh_key_pairSSH key pair to be provisioned on the instancestringnullno
<a name="input_ssm_patch_manager_enabled"></a> ssm_patch_manager_enabledWhether to enable SSM Patch managerboolfalseno
<a name="input_ssm_patch_manager_iam_policy_arn"></a> ssm_patch_manager_iam_policy_arnIAM policy ARN to allow Patch Manager to manage the instance. If not provided, arn:aws:iam::aws:policy/AmazonSSMManagedInstanceCore will be usedstringnullno
<a name="input_ssm_patch_manager_s3_log_bucket"></a> ssm_patch_manager_s3_log_bucketThe name of the s3 bucket to export the patch log tostringnullno
<a name="input_stage"></a> stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
<a name="input_statistic_level"></a> statistic_levelThe statistic to apply to the alarm's associated metric. Allowed values are: SampleCount, Average, Sum, Minimum, Maximumstring"Maximum"no
<a name="input_subnet"></a> subnetVPC Subnet ID the instance is launched instringn/ayes
<a name="input_tags"></a> tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).<br/>Neither the tag keys nor the tag values will be modified by this module.map(string){}no
<a name="input_tenancy"></a> tenancyTenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of 'dedicated' runs on single-tenant hardware. The 'host' tenancy is not supported for the import-instance command. Valid values are 'default', 'dedicated', and 'host'.string"default"no
<a name="input_tenant"></a> tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
<a name="input_user_data"></a> user_dataThe user data to provide when launching the instance. Do not pass gzip-compressed data via this argument; use user_data_base64 insteadstringnullno
<a name="input_user_data_base64"></a> user_data_base64Can 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 corruptionstringnullno
<a name="input_user_data_replace_on_change"></a> user_data_replace_on_changeWhen used in combination with user_data or user_data_base64 will trigger a destroy and recreate when set to true.boolfalseno
<a name="input_volume_tags_enabled"></a> volume_tags_enabledWhether or not to copy instance tags to root and EBS volumesbooltrueno
<a name="input_vpc_id"></a> vpc_idThe ID of the VPC that the instance security group belongs tostringn/ayes

Outputs

NameDescription
<a name="output_additional_eni_ids"></a> additional_eni_idsMap of ENI to EIP
<a name="output_alarm"></a> alarmCloudWatch Alarm ID
<a name="output_arn"></a> arnARN of the instance
<a name="output_ebs_ids"></a> ebs_idsIDs of EBSs
<a name="output_id"></a> idDisambiguated ID of the instance
<a name="output_instance_profile"></a> instance_profileName of the instance's profile (either built or supplied)
<a name="output_name"></a> nameInstance name
<a name="output_primary_network_interface_id"></a> primary_network_interface_idID of the instance's primary network interface
<a name="output_private_dns"></a> private_dnsPrivate DNS of instance
<a name="output_private_ip"></a> private_ipPrivate IP of instance
<a name="output_public_dns"></a> public_dnsPublic DNS of instance (or DNS of EIP)
<a name="output_public_ip"></a> public_ipPublic IP of instance (or EIP)
<a name="output_role"></a> roleName of AWS IAM Role associated with the instance
<a name="output_role_arn"></a> role_arnARN of AWS IAM Role associated with the instance
<a name="output_security_group_arn"></a> security_group_arnEC2 instance Security Group ARN
<a name="output_security_group_id"></a> security_group_idEC2 instance Security Group ID
<a name="output_security_group_ids"></a> security_group_idsIDs on the AWS Security Groups associated with the instance
<a name="output_security_group_name"></a> security_group_nameEC2 instance Security Group name
<a name="output_ssh_key_pair"></a> ssh_key_pairName of the SSH key pair provisioned on the instance
<!-- markdownlint-restore -->

Related Projects

Check out these related projects.

References

For additional context, refer to some of these links.

[!TIP]

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

βœ… We build it together with your team.<br/> βœ… Your team owns everything.<br/> βœ… 100% Open Source and backed by fanatical support.<br/>

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

<details><summary>πŸ“š <strong>Learn More</strong></summary> <br/>

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

Day-2: Your Operational Mastery

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

</details>

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

<a href="https://github.com/cloudposse/terraform-aws-ec2-instance/graphs/contributors"> <img src="https://contrib.rocks/image?repo=cloudposse/terraform-aws-ec2-instance&max=24" /> </a>

For πŸ› bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Review our Code of Conduct and Contributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

πŸ“° Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week β€” and usually a 5-minute read.

πŸ“† Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>

<details> <summary>Preamble to the Apache License, Version 2.0</summary> <br/> <br/>

Complete license is available in the LICENSE file.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
</details>

Trademarks

All other trademarks referenced herein are the property of their respective owners.


Copyright Β© 2017-2024 Cloud Posse, LLC

<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-instance&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>

<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/terraform-aws-ec2-instance?pixel&cs=github&cm=readme&an=terraform-aws-ec2-instance"/>