This module can be used to provision a SingleInstance AWS Elastic Beanstalk environment.
Initial hopes were to allow for different types of Elastic Beanstalk environments. This turned out to be more time consuming for our limited usage of Elastic Beanstalk.
If this module is used for more applications, it should be modified or a separate module should be created for load balanced setups.
Additional resources for load balanced environments:
Cloud Posse's Elastic Beanstalk Module
BasileTrujilo Elastic Beanstalk Module
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| alb_zone_id | ALB zone id | map | <map> |
no |
| allow_url_fopen | Specifies if PHP's file functions are allowed to retrieve data from remote locations, such as websites or FTP servers. | string | "On" |
no |
| app | EBS application name | string | n/a | yes |
| application_port | Port application is listening on | string | "80" |
no |
| associate_public_ip_address | Specifies whether to launch instances in your VPC with public IP addresses. | string | "false" |
no |
| autoscale_lower_bound | Minimum level of autoscale metric to remove an instance | string | "20" |
no |
| autoscale_lower_increment | How many Amazon EC2 instances to remove when performing a scaling activity. | string | "-1" |
no |
| autoscale_max | Maximum instances in charge | string | "3" |
no |
| autoscale_measure_name | Metric used for your Auto Scaling trigger | string | "CPUUtilization" |
no |
| autoscale_min | Minumum instances in charge | string | "2" |
no |
| autoscale_statistic | Statistic the trigger should use, such as Average | string | "Average" |
no |
| autoscale_unit | Unit for the trigger measurement, such as Bytes | string | "Percent" |
no |
| autoscale_upper_bound | Maximum level of autoscale metric to add an instance | string | "80" |
no |
| autoscale_upper_increment | How many Amazon EC2 instances to add when performing a scaling activity | string | "1" |
no |
| availability_zones | Choose the number of AZs for your instances | string | "Any 2" |
no |
| composer_options | Sets custom options to use when installing dependencies using Composer through composer.phar install. | string | "" |
no |
| config_document | A JSON document describing the environment and instance metrics to publish to CloudWatch. | string | "{ \"CloudWatchMetrics\": {}, \"Version\": 1}" |
no |
| config_source | S3 source for config | string | "" |
no |
| description | Short description of the Environment | string | "" |
no |
| display_errors | Specifies if error messages should be part of the output. | string | "Off" |
no |
| document_root | Specify the child directory of your project that is treated as the public-facing web root. | string | "/" |
no |
| enable_log_publication_control | Copy the log files for your application's Amazon EC2 instances to the Amazon S3 bucket associated with your application. | string | "false" |
no |
| enable_managed_actions | Enable managed platform updates. When you set this to true, you must also specify a PreferredStartTime and UpdateLevel |
string | "true" |
no |
| enable_stream_logs | Whether to create groups in CloudWatch Logs for proxy and deployment logs, and stream logs from each instance in your environment. | string | "false" |
no |
| enhanced_reporting_enabled | Whether to enable "enhanced" health reporting for this environment. If false, "basic" reporting is used. When you set this to false, you must also set enable_managed_actions to false |
string | "true" |
no |
| env_default_key | Default ENV variable key for Elastic Beanstalk aws:elasticbeanstalk:application:environment setting |
string | "DEFAULT_ENV_%d" |
no |
| env_default_value | Default ENV variable value for Elastic Beanstalk aws:elasticbeanstalk:application:environment setting |
string | "UNSET" |
no |
| env_vars | Map of custom ENV variables to be provided to the Jenkins application running on Elastic Beanstalk, e.g. env_vars = { JENKINS_USER = 'admin' JENKINS_PASS = 'xxxxxx' } |
map | <map> |
no |
| environment_type | Environment type, e.g. 'LoadBalanced' or 'SingleInstance'. If setting to 'SingleInstance', rolling_update_type must be set to 'Time', updating_min_in_service must be set to 0, and public_subnets will be unused (it applies to the ELB, which does not exist in SingleInstance environments) |
string | "LoadBalanced" |
no |
| health_streaming_delete_on_terminate | Whether to delete the log group when the environment is terminated. If false, the health data is kept RetentionInDays days. | string | "false" |
no |
| health_streaming_enabled | For environments with enhanced health reporting enabled, whether to create a group in CloudWatch Logs for environment health and archive Elastic Beanstalk environment health data. For information about enabling enhanced health, see aws:elasticbeanstalk:healthreporting:system. | string | "false" |
no |
| health_streaming_retention_in_days | The number of days to keep the archived health data before it expires. | string | "7" |
no |
| healthcheck_url | Application Health Check URL. Elastic Beanstalk will call this URL to check the health of the application running on EC2 instances | string | "/healthcheck" |
no |
| http_listener_enabled | Enable port 80 (http) | string | "false" |
no |
| instance_refresh_enabled | Enable weekly instance replacement. | string | "true" |
no |
| instance_subnets | List of subnets to place instances on | list | n/a | yes |
| instance_type | Instances type | string | "t3.micro" |
no |
| keypair | Name of SSH key that will be deployed on Elastic Beanstalk and DataPipeline instance. The key should be present in AWS | string | n/a | yes |
| logs_delete_on_terminate | Whether to delete the log groups when the environment is terminated. If false, the logs are kept RetentionInDays days. | string | "false" |
no |
| logs_retention_in_days | The number of days to keep log events before they expire. | string | "7" |
no |
| max_execution_time | Sets the maximum time, in seconds, a script is allowed to run before it is terminated by the environment. | string | "60" |
no |
| memory_limit | Amount of memory allocated to the PHP environment. | string | "256M" |
no |
| name | Solution name, e.g. 'app' or 'jenkins' | string | "app" |
no |
| notification_endpoint | Notification endpoint | string | "" |
no |
| notification_protocol | Notification protocol | string | "email" |
no |
| notification_topic_arn | Notification topic arn | string | "" |
no |
| notification_topic_name | Notification topic name | string | "" |
no |
| preferred_start_time | Configure a maintenance window for managed actions in UTC | string | "Sun:10:00" |
no |
| rolling_\update_enabled | Enable rolling updates | string | "true" | no |
| rolling_update_type | Set it to Immutable to apply the configuration change to a fresh group of instances | string | "Health" |
no |
| root_volume_size | The size of the EBS root volume | string | "8" |
no |
| root_volume_type | The type of the EBS root volume | string | "gp2" |
no |
| security_groups | List of security groups to be allowed to connect to the EC2 instances | list | <list> |
no |
| solution_stack_name | Elastic Beanstalk stack, e.g. Docker, Go, Node, Java, IIS. Read more | string | "" |
no |
| ssh_listener_enabled | Enable ssh port | string | "false" |
no |
| ssh_listener_port | SSH port | string | "22" |
no |
| ssh_source_restriction | Used to lock down SSH access to the EC2 instances. | string | "0.0.0.0/0" |
no |
| tags | Additional tags (e.g. map('BusinessUnit,XYZ) |
map | <map> |
no |
| tier | Elastic Beanstalk Environment tier, e.g. ('WebServer', 'Worker') | string | "WebServer" |
no |
| update_level | The highest level of update to apply with managed platform updates | string | "minor" |
no |
| updating_max_batch | Maximum count of instances up during update | string | "1" |
no |
| updating_min_in_service | Minimum count of instances up during update | string | "1" |
no |
| version_label | Elastic Beanstalk Application version to deploy | string | "" |
no |
| vpc_id | ID of the VPC in which to provision the AWS resources | string | n/a | yes |
| wait_for_ready_timeout | The maximum duration that Terraform should wait for an Elastic Beanstalk Environment to be in a ready state before timing out. | string | "20m" |
no |
| zlib_php_compression | Specifies whether or not PHP should use compression for output. | string | "Off" |
no |
| zone_id | Route53 parent zone ID. The module will create sub-domain DNS records in the parent zone for the EB environment | string | "" |
no |
| Name | Description |
|---|---|
| all_settings | List of all option settings configured in the environment. These are a combination of default settings and their overrides from setting in the configuration. |
| application | The Elastic Beanstalk Application specified for this environment. |
| autoscaling_groups | The autoscaling groups used by this environment. |
| cname | Fully qualified DNS name for the environment. |
| ec2_instance_profile_role_name | Instance IAM role name |
| elb_dns_name | ELB technical host |
| elb_load_balancers | Elastic Load Balancers in use by this environment. |
| elb_zone_id | ELB zone id |
| host | DNS hostname |
| id | ID of the Elastic Beanstalk environment. |
| instances | Instances used by this environment. |
| launch_configurations | Launch configurations in use by this environment. |
| load_balancers | Elastic Load Balancers in use by this environment. |
| name | Name |
| queues | SQS queues in use by this environment. |
| security_group_id | Security group id |
| setting | Settings specifically set for this environment. |
| tier | The environment tier specified. |
| triggers | Autoscaling triggers in use by this environment. |
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent