Create Express Gateway Service

ecs_create_express_gateway_service

R Documentation

Creates an Express service that simplifies deploying containerized web applications on Amazon ECS with managed Amazon Web Services infrastructure¶

Description¶

Creates an Express service that simplifies deploying containerized web applications on Amazon ECS with managed Amazon Web Services infrastructure. This operation provisions and configures Application Load Balancers, target groups, security groups, and auto-scaling policies automatically.

Specify a primary container configuration with your application image and basic settings. Amazon ECS creates the necessary Amazon Web Services resources for traffic distribution, health monitoring, network access control, and capacity management.

Provide an execution role for task operations and an infrastructure role for managing Amazon Web Services resources on your behalf.

Usage¶

ecs_create_express_gateway_service(executionRoleArn,
  infrastructureRoleArn, serviceName, cluster, healthCheckPath,
  primaryContainer, taskRoleArn, networkConfiguration, cpu, memory,
  scalingTarget, tags)

Arguments¶

executionRoleArn

[required] The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make Amazon Web Services API calls on your behalf. This role is required for Amazon ECS to pull container images from Amazon ECR, send container logs to Amazon CloudWatch Logs, and retrieve sensitive data from Amazon Web Services Systems Manager Parameter Store or Amazon Web Services Secrets Manager.

The execution role must include the AmazonECSTaskExecutionRolePolicy managed policy or equivalent permissions. For Express services, this role is used during task startup and runtime for container management operations.

infrastructureRoleArn

[required] The Amazon Resource Name (ARN) of the infrastructure role that grants Amazon ECS permission to create and manage Amazon Web Services resources on your behalf for the Express service. This role is used to provision and manage Application Load Balancers, target groups, security groups, auto-scaling policies, and other Amazon Web Services infrastructure components.

The infrastructure role must include permissions for Elastic Load Balancing, Application Auto Scaling, Amazon EC2 (for security groups), and other services required for managed infrastructure. This role is only used during Express service creation, updates, and deletion operations.

serviceName

The name of the Express service. This name must be unique within the specified cluster and can contain up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens. The name is used to identify the service in the Amazon ECS console and API operations.

If you don't specify a service name, Amazon ECS generates a unique name for the service. The service name becomes part of the service ARN and cannot be changed after the service is created.

cluster

The short name or full Amazon Resource Name (ARN) of the cluster on which to create the Express service. If you do not specify a cluster, the default cluster is assumed.

healthCheckPath

The path on the container that the Application Load Balancer uses for health checks. This should be a valid HTTP endpoint that returns a successful response (HTTP 200) when the application is healthy.

If not specified, the default health check path is ⁠/ping⁠. The health check path must start with a forward slash and can include query parameters. Examples: ⁠/health⁠, ⁠/api/status⁠, ⁠/ping?format=json⁠.

primaryContainer

[required] The primary container configuration for the Express service. This defines the main application container that will receive traffic from the Application Load Balancer.

The primary container must specify at minimum a container image. You can also configure the container port (defaults to 80), logging configuration, environment variables, secrets, and startup commands. The container image can be from Amazon ECR, Docker Hub, or any other container registry accessible to your execution role.

taskRoleArn

The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. This role allows your application code to access other Amazon Web Services services securely.

The task role is different from the execution role. While the execution role is used by the Amazon ECS agent to set up the task, the task role is used by your application code running inside the container to make Amazon Web Services API calls. If your application doesn't need to access Amazon Web Services services, you can omit this parameter.

networkConfiguration

The network configuration for the Express service tasks. This specifies the VPC subnets and security groups for the tasks.

For Express services, you can specify custom security groups and subnets. If not provided, Amazon ECS will use the default VPC configuration and create appropriate security groups automatically. The network configuration determines how your service integrates with your VPC and what network access it has.

cpu

The number of CPU units used by the task. This parameter determines the CPU allocation for each task in the Express service. The default value for an Express service is 256 (.25 vCPU).

memory

The amount of memory (in MiB) used by the task. This parameter determines the memory allocation for each task in the Express service. The default value for an express service is 512 MiB.

scalingTarget

The auto-scaling configuration for the Express service. This defines how the service automatically adjusts the number of running tasks based on demand.

You can specify the minimum and maximum number of tasks, the scaling metric (CPU utilization, memory utilization, or request count per target), and the target value for the metric. If not specified, the default target value for an Express service is 60.

tags

The metadata that you apply to the Express service to help categorize and organize it. Each tag consists of a key and an optional value. You can apply up to 50 tags to a service.

Value¶

A list with the following syntax:

list(
  service = list(
    cluster = "string",
    serviceName = "string",
    serviceArn = "string",
    infrastructureRoleArn = "string",
    status = list(
      statusCode = "ACTIVE"|"DRAINING"|"INACTIVE",
      statusReason = "string"
    ),
    currentDeployment = "string",
    activeConfigurations = list(
      list(
        serviceRevisionArn = "string",
        executionRoleArn = "string",
        taskRoleArn = "string",
        cpu = "string",
        memory = "string",
        networkConfiguration = list(
          securityGroups = list(
            "string"
          ),
          subnets = list(
            "string"
          )
        ),
        healthCheckPath = "string",
        primaryContainer = list(
          image = "string",
          containerPort = 123,
          awsLogsConfiguration = list(
            logGroup = "string",
            logStreamPrefix = "string"
          ),
          repositoryCredentials = list(
            credentialsParameter = "string"
          ),
          command = list(
            "string"
          ),
          environment = list(
            list(
              name = "string",
              value = "string"
            )
          ),
          secrets = list(
            list(
              name = "string",
              valueFrom = "string"
            )
          )
        ),
        scalingTarget = list(
          minTaskCount = 123,
          maxTaskCount = 123,
          autoScalingMetric = "AVERAGE_CPU"|"AVERAGE_MEMORY"|"REQUEST_COUNT_PER_TARGET",
          autoScalingTargetValue = 123
        ),
        ingressPaths = list(
          list(
            accessType = "PUBLIC"|"PRIVATE",
            endpoint = "string"
          )
        ),
        createdAt = as.POSIXct(
          "2015-01-01"
        )
      )
    ),
    tags = list(
      list(
        key = "string",
        value = "string"
      )
    ),
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    updatedAt = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax¶

svc$create_express_gateway_service(
  executionRoleArn = "string",
  infrastructureRoleArn = "string",
  serviceName = "string",
  cluster = "string",
  healthCheckPath = "string",
  primaryContainer = list(
    image = "string",
    containerPort = 123,
    awsLogsConfiguration = list(
      logGroup = "string",
      logStreamPrefix = "string"
    ),
    repositoryCredentials = list(
      credentialsParameter = "string"
    ),
    command = list(
      "string"
    ),
    environment = list(
      list(
        name = "string",
        value = "string"
      )
    ),
    secrets = list(
      list(
        name = "string",
        valueFrom = "string"
      )
    )
  ),
  taskRoleArn = "string",
  networkConfiguration = list(
    securityGroups = list(
      "string"
    ),
    subnets = list(
      "string"
    )
  ),
  cpu = "string",
  memory = "string",
  scalingTarget = list(
    minTaskCount = 123,
    maxTaskCount = 123,
    autoScalingMetric = "AVERAGE_CPU"|"AVERAGE_MEMORY"|"REQUEST_COUNT_PER_TARGET",
    autoScalingTargetValue = 123
  ),
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  )
)