Interface MEHTTPEndpointProps

Represents the properties required to configure an OSML (OversightML) HTTP endpoint within an AWS ECS (Elastic Container Service) cluster.

MEHTTPEndpointProps

interface MEHTTPEndpointProps {
    account: OSMLAccount;
    clusterName: string;
    containerEnv?: {
        [key: string]: string;
    };
    containerPort: number;
    cpu: number;
    healthcheckPath: string;
    hostPort: number;
    image: ContainerImage;
    loadBalancerName: string;
    memory: number;
    osmlVpc: OSMLVpc;
    role: IRole;
    securityGroupId?: string;
}

Properties

account clusterName containerEnv? containerPort cpu healthcheckPath hostPort image loadBalancerName memory osmlVpc role securityGroupId?

Properties

Readonly account

account: OSMLAccount

The OSML (OversightML) account to associate with the endpoint.

Readonly clusterName

clusterName: string

The name of the ECS cluster where the endpoint will be deployed.

Optional Readonly containerEnv

containerEnv?: {
    [key: string]: string;
}

Optional environment variables to be set within the container.

Type declaration

  • [key: string]: string

Readonly containerPort

containerPort: number

The port within the container where the application will listen for incoming traffic.

Readonly cpu

cpu: number

The number of CPU units to allocate to the container.

Readonly healthcheckPath

healthcheckPath: string

The path for the health check endpoint used by the load balancer.

Readonly hostPort

hostPort: number

The host port on which the container will listen for incoming traffic.

Readonly image

image: ContainerImage

The Docker container image to be used for the endpoint.

Readonly loadBalancerName

loadBalancerName: string

The name of the load balancer associated with the endpoint.

Readonly memory

memory: number

The amount of memory to allocate to the container in megabytes (MB).

Readonly osmlVpc

osmlVpc: OSMLVpc

The OSML VPC (Virtual Private Cloud) configuration for the endpoint.

Readonly role

role: IRole

The IAM (Identity and Access Management) role used by the endpoint's task definition.

Optional Readonly securityGroupId

securityGroupId?: string

The ID of the security group to associate with the ECS task.

Settings

Member Visibility

Theme

On This Page

accountclusterNamecontainerEnvcontainerPortcpuhealthcheckPathhostPortimageloadBalancerNamememoryosmlVpcrolesecurityGroupId

Generated using TypeDoc