create_express_gateway_service ¶

def create_express_gateway_service(
    self,
    infrastructure_role_arn: "capo_ecs.types.string.String",
    *,
    config_overrides: Optional[ECSClientConfig] = None,
    execution_role_arn: Optional["capo_ecs.types.string.String"] = None,
    service_name: Optional["capo_ecs.types.string.String"] = None,
    cluster: Optional["capo_ecs.types.string.String"] = None,
    health_check_path: Optional["capo_ecs.types.string.String"] = None,
    primary_container: Optional[
        "capo_ecs.types.express_gateway_container.ExpressGatewayContainer"
    ] = None,
    task_role_arn: Optional["capo_ecs.types.string.String"] = None,
    network_configuration: Optional[
        "capo_ecs.types.express_gateway_service_network_configuration.ExpressGatewayServiceNetworkConfiguration"
    ] = None,
    cpu: Optional["capo_ecs.types.string.String"] = None,
    memory: Optional["capo_ecs.types.string.String"] = None,
    cpu_architecture: Optional[
        "capo_ecs.types.express_cpu_architecture.ExpressCpuArchitecture"
    ] = None,
    scaling_target: Optional[
        "capo_ecs.types.express_gateway_scaling_target.ExpressGatewayScalingTarget"
    ] = None,
    tags: Optional["capo_ecs.types.tags.Tags"] = None,
    task_definition_arn: Optional["capo_ecs.types.string.String"] = None,
) -> "capo_ecs.types.create_express_gateway_service_response.CreateExpressGatewayServiceResponse":
    """<p>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.</p> <p>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.</p> <p>Provide an execution role for task operations and an infrastructure role for managing Amazon Web Services resources on your behalf.</p>

    Args:
        execution_role_arn: <p>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.</p> <p>The execution role must include the <code>AmazonECSTaskExecutionRolePolicy</code> managed policy or equivalent permissions. For Express services, this role is used during task startup and runtime for container management operations.</p>
        infrastructure_role_arn: <p>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.</p> <p>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.</p>
        service_name: <p>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.</p> <p>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.</p>
        cluster: <p>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 <code>default</code> cluster is assumed.</p>
        health_check_path: <p>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.</p> <p>If not specified, the default health check path is <code>/ping</code>. The health check path must start with a forward slash and can include query parameters. Examples: <code>/health</code>, <code>/api/status</code>, <code>/ping?format=json</code>.</p>
        primary_container: <p>The primary container configuration for the Express service. This defines the main application container that will receive traffic from the Application Load Balancer.</p> <p>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.</p>
        task_role_arn: <p>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.</p> <p>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.</p>
        network_configuration: <p>The network configuration for the Express service tasks. This specifies the VPC subnets and security groups for the tasks.</p> <p>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.</p>
        cpu: <p>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).</p>
        memory: <p>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.</p>
        cpu_architecture: <p>The CPU architecture that the task runs on. If you don't specify a value, the default is <code>X86_64</code>.</p> <p>Valid values:</p> <ul> <li> <p> <code>X86_64</code> - The x86 64-bit architecture.</p> </li> <li> <p> <code>ARM64</code> - The 64-bit ARM architecture.</p> </li> </ul> <p>Ensure that the container image you specify supports the architecture you choose. The operating system family for an Express service is always <code>LINUX</code>.</p> <p>You can't specify <code>cpuArchitecture</code> together with <code>taskDefinitionArn</code>.</p>
        scaling_target: <p>The auto-scaling configuration for the Express service. This defines how the service automatically adjusts the number of running tasks based on demand.</p> <p>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.</p>
        tags: <p>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.</p>
        task_definition_arn: <p>The Amazon Resource Name (ARN) of a task definition to use to create the Express Gateway service. This allows you to manage your own task definition, giving you more control over the service configuration such as adding sidecar containers.</p> <p>The task definition must have a container named <code>Main</code> with a single TCP port mapping that includes a container port and port name. The task definition must also have <code>FARGATE</code> compatibility.</p> <p>If you provide a task definition ARN, you cannot also specify <code>primaryContainer</code>, <code>executionRoleArn</code>, <code>taskRoleArn</code>, <code>cpu</code>, <code>memory</code>, or <code>cpuArchitecture</code>.</p>

    Raises:
        capo_ecs.errors.access_denied_exception.AccessDeniedException: <p>You don't have authorization to perform the requested action.</p>
        capo_ecs.errors.client_exception.ClientException: <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
        capo_ecs.errors.cluster_not_found_exception.ClusterNotFoundException: <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
        capo_ecs.errors.invalid_parameter_exception.InvalidParameterException: <p>The specified parameter isn't valid. Review the available parameters for the API request.</p> <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>. </p>
        capo_ecs.errors.platform_task_definition_incompatibility_exception.PlatformTaskDefinitionIncompatibilityException: <p>The specified platform version doesn't satisfy the required capabilities of the task definition.</p>
        capo_ecs.errors.platform_unknown_exception.PlatformUnknownException: <p>The specified platform version doesn't exist.</p>
        capo_ecs.errors.server_exception.ServerException: <p>These errors are usually caused by a server issue.</p>
        capo_ecs.errors.unsupported_feature_exception.UnsupportedFeatureException: <p>The specified task isn't supported in this Region.</p>
        capo_ecs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ecs.types.create_express_gateway_service_request.CreateExpressGatewayServiceRequest]",
    ) -> OperationResponse[
        "capo_ecs.types.create_express_gateway_service_response.CreateExpressGatewayServiceResponse"
    ]:
        import capo_ecs._operations.amazon_ec2_container_service_v20141113.create_express_gateway_service

        output, http_response = (
            capo_ecs._operations.amazon_ec2_container_service_v20141113.create_express_gateway_service.create_express_gateway_service(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_ecs.types.create_express_gateway_service_request.CreateExpressGatewayServiceRequest",
    ) -> dict[str, Any]:
        import capo_ecs.types.create_express_gateway_service_request

        return (
            capo_ecs.types.create_express_gateway_service_request.redact_sensitive(
                input_
            )
        )

    def _redact_output(
        output: "capo_ecs.types.create_express_gateway_service_response.CreateExpressGatewayServiceResponse",
    ) -> dict[str, Any]:
        import capo_ecs.types.create_express_gateway_service_response

        return (
            capo_ecs.types.create_express_gateway_service_response.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CreateExpressGatewayService",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_ecs.types.create_express_gateway_service_request.CreateExpressGatewayServiceRequest = {
        "infrastructure_role_arn": infrastructure_role_arn
    }
    if execution_role_arn is not None:
        input_["execution_role_arn"] = execution_role_arn
    if service_name is not None:
        input_["service_name"] = service_name
    if cluster is not None:
        input_["cluster"] = cluster
    if health_check_path is not None:
        input_["health_check_path"] = health_check_path
    if primary_container is not None:
        input_["primary_container"] = primary_container
    if task_role_arn is not None:
        input_["task_role_arn"] = task_role_arn
    if network_configuration is not None:
        input_["network_configuration"] = network_configuration
    if cpu is not None:
        input_["cpu"] = cpu
    if memory is not None:
        input_["memory"] = memory
    if cpu_architecture is not None:
        input_["cpu_architecture"] = cpu_architecture
    if scaling_target is not None:
        input_["scaling_target"] = scaling_target
    if tags is not None:
        input_["tags"] = tags
    if task_definition_arn is not None:
        input_["task_definition_arn"] = task_definition_arn

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output