Interface Service

A persistent service running as part of the Pulumi Cloud application. A collection of container specifications are provided to define the compute that will run inside this service.

interface Service {
    defaultEndpoint: Output<Endpoint>;
    endpoints: Output<Endpoints>;
    name: string;
    getEndpoint(containerName?, containerPort?): Promise<Endpoint>;
}

Properties

defaultEndpoint endpoints name

Methods

getEndpoint

Properties

defaultEndpoint

defaultEndpoint: Output<Endpoint>

The primary endpoint exposed by the service. All endpoints (including this one) can also be retrieved by using the 'Service.endpoints' property. Note: this value may not be present if the service does not actually expose any endpoints.

endpoints

endpoints: Output<Endpoints>

The exposed hostname and port for connecting to the given containerName on the given containerPort.

name

name: string

Methods

getEndpoint

  • getEndpoint(containerName?, containerPort?): Promise<Endpoint>

  • The exposed hostname and port for connecting to the given containerName on the given containerPort. If containerName is not provided, the first container in the service is used. If containerPort is not provided, the first exposed port is used.

    Only usable on the inside.

    Parameters

    • Optional containerName: string
    • Optional containerPort: number

    Returns Promise<Endpoint>

Settings

Member Visibility

Theme

On This Page

defaultEndpointendpointsnamegetEndpoint

Generated using TypeDoc