AWS ECS

@hashicorp

The AWS ECS plugin deploys an application image to an AWS ECS cluster. It also launches on-demand runners to do operations remotely.

Official
Built-in

Updated 10 months ago

GitHub
(opens in new tab)

AWS ECS Platform

Archive Notice

This integration relates to a legacy version of Waypoint and is no longer actively maintained.

Read the blog

Deploy the application into an ECS cluster on AWS.

Interface

Input: docker.Image
Output: ecs.Deployment

Examples

deploy {
  use "aws-ecs" {
    region = "us-east-1"
    memory = 512
  }
}

Parameters

Required only

57 Results

albRequiredcategory
Provides additional configuration for using an ALB with ECS
- alb.certificateOptionalstring
  the ARN of an AWS Certificate Manager cert to associate with the ALB
- alb.domain_nameOptionalstring
  Fully qualified domain name to set for the ALB set along with zone_id to have DNS automatically setup for the ALB. this value should include the full hostname and domain name, for instance app.example.com
- alb.ingress_portOptionalint64
  Internet-facing traffic port. Defaults to 80 if 'certificate' is unset, 443 if set. used to set the ALB listener port, and the ALB security group ingress port
- alb.internalOptionalbool
  Whether or not the created ALB should be internal used when listener_arn is not set. If set, the created ALB will have a scheme of internal, otherwise by default it has a scheme of internet-facing.
- alb.load_balancer_arnRequiredstring
  the ARN on an existing ALB to configure when this is set, Waypoint will use this ALB instead of creating its own. A target group will still be created for each deployment, and will be added to a listener on the configured ALB port (Waypoint will the listener if it doesn't exist). This allows users to configure their ALB outside Waypoint but still have Waypoint hook the application to that ALB
- alb.security_group_idsOptionallist of string
- alb.subnetsOptionallist of string
  the VPC subnets to use for the ALB
- alb.zone_idOptionalstring
  Route53 ZoneID to create a DNS record into set along with alb.domain_name to have DNS automatically setup for the ALB
architectureOptionalstring
the instruction set CPU architecture that the Amazon ECS supports. Valid values are: "x86_64", "arm64"
assign_public_ipOptionalbool
assign a public ip address to tasks. Defaults to true. Ignored if using an ec2 cluster. If this is set to false, deployments will fail unless tasks are able to egress to the container registry by some other means (i.e. a subnet default route to a NAT gateway).
clusterOptionalstring
the name of the ECS cluster to deploy into the ECS cluster that will run the application as a Service. if there is no ECS cluster with this name, the ECS cluster will be created and configured to use Fargate to run containers.
countOptionalint
how many instances of the application should run
cpuOptionalint
how many cpu shares the container running the application is allowed on Fargate, possible values for this are configured by the amount of memory the container is using. Here is a complete listing of possible values: 512MB: 256 1024MB: 256, 512 2048MB: 256, 512, 1024 3072MB: 512, 1024 4096MB: 512, 1024 5120MB: 1024 6144MB: 1024 7168MB: 1024 8192MB: 1024
disable_albOptionalbool
do not create a load balancer assigned to the service
ec2_clusterOptionalbool
indicate if the ECS cluster should be EC2 type rather than Fargate this controls if we should verify the ECS cluster in EC2 type. The cluster will not be created if it doesn't exist, only that there as existing cluster this is using EC2 and not Fargate
execution_role_nameOptionalstring
the name of the IAM role to use for ECS execution
health_checkOptionalcategory
Health check settings for the app.
- health_check.grpc_codeOptionalstring
- health_check.healthy_threshold_countOptionalint64
  The number of consecutive successful health checks required toconsider a target healthy.
- health_check.http_codeOptionalstring
- health_check.intervalOptionalint64
  The amount of time, in seconds, between health checks.
- health_check.matcherRequired
  The range of HTTP codes to use when checking for a successful response fromthe target.
- health_check.pathOptionalstring
  The destination of the ping path for the target health check.
- health_check.protocolOptionalstring
  The protocol for the health check to use.
- health_check.timeoutOptionalint64
  The amount of time, in seconds, for which no target response means a failure.
- health_check.unhealthy_threshold_countOptionalint64
  The number of consecutive failed health checks required to consider a target unhealthy.
log_groupOptionalstring
the CloudWatchLogs log group to store container logs into
loggingOptionalcategory
Provides additional configuration for logging flags for ECS Part of the ecs task definition. These configuration flags help control how the awslogs log driver is configured.
- logging.create_groupOptionalbool
  Enables creation of the aws logs group if not present
- logging.datetime_formatOptionalstring
  Defines the multiline start pattern in Python strftime format
- logging.max_buffer_sizeOptionalstring
  When using non-blocking logging mode, this is the buffer size for message storage
- logging.modeOptionalstring
  Delivery method for log messages, either 'blocking' or 'non-blocking'
- logging.multiline_patternOptionalstring
  Defines the multiline start pattern using a regular expression
- logging.regionRequired
  The region the logs are to be shipped to
- logging.stream_prefixOptionalstring
  Prefix for application in cloudwatch logs path
memoryRequiredint
how much memory to assign to the container running the application when running in Fargate, this must be one of a few values, specified in MB: 512, 1024, 2048, 3072, 4096, 5120, and up to 16384 in increments of 1024. The memory value also controls the possible values for cpu
memory_reservationOptionalint
regionRequiredstring
the AWS region for the ECS cluster
secretsOptionalmap of string to string
secret key/values to pass to the ECS container
security_group_idsOptionallist of string
Security Group IDs of existing security groups to use for the ECS service's network access list of existing group IDs to use for the ECS service's network access. If none are specified, waypoint will create one. If DisableALB is false (the default), waypoint will only allow ingress from the ALB's security group
service_portOptionalint64
the TCP port that the application is listening on
sidecarRequiredcategory
Additional container to run as a sidecar. This runs additional containers in addition to the main container that comes from the build phase.
- sidecar.container_portOptionalint
  The port number for the container
- sidecar.health_checkRequiredecs.HealthCheckConfig
- sidecar.host_portOptionalint
  The port number on the host to reserve for the container
- sidecar.imageRequiredstring
  Image of the sidecar container
- sidecar.memoryOptionalint
  The amount (in MiB) of memory to present to the container
- sidecar.memory_reservationOptionalint
  The soft limit (in MiB) of memory to reserve for the container
- sidecar.nameRequiredstring
  Name of the container
- sidecar.protocolOptionalstring
  The protocol used for port mapping.
- sidecar.secretsOptionalmap of string to string
  Secrets to expose to this container
- sidecar.static_environmentOptionalmap of string to string
  Environment variables to expose to this container
static_environmentOptionalmap of string to string
static environment variables to make available
subnetsOptionallist of string
the VPC subnets to use for the service you may set a list of private subnets here to prevent your tasks from being directly exposed publicly
task_role_nameOptionalstring
the name of the task IAM role to assign. If no role exists and a one or more task role policies are requested, a role with this name will be created.
task_role_policy_arnsOptionallist of string
IAM Policy arns for attaching to the task role. If no task role name is specified a task role with a default name will be created for this app, and these policies will be attached.

Outputs

8 Results

clusterstring
listener_arnstring
load_balancer_arnstring
resource_stateopaqueany.Any
service_arnstring
target_group_arnstring
task_arnstring
urlstring