Endpoint

aptible 0.10.0, May 4 26

Viewing docs for aptible 0.10.0
published on Monday, May 4, 2026 by aptible

Schema (JSON)

aptible/terraform-provider-aptible

Viewing docs for aptible 0.10.0
published on Monday, May 4, 2026 by aptible

Schema (JSON)

aptible/terraform-provider-aptible

# Aptible Endpoint Resource

This resource is used to create and manage Endpoints for Apps and Databases running on Aptible.

Example Usage

Simple Default Domain Endpoint

import * as pulumi from "@pulumi/pulumi";
import * as aptible from "@pulumi/aptible";

const example = new aptible.Endpoint("example", {
    envId: exampleAptibleEnvironment.envId,
    resourceId: exampleAptibleApp.appId,
    containerPort: 3000,
    resourceType: "app",
    processType: "cmd",
    defaultDomain: true,
});

import pulumi
import pulumi_aptible as aptible

example = aptible.Endpoint("example",
    env_id=example_aptible_environment["envId"],
    resource_id=example_aptible_app["appId"],
    container_port=3000,
    resource_type="app",
    process_type="cmd",
    default_domain=True)

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/aptible/aptible"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aptible.NewEndpoint(ctx, "example", &aptible.EndpointArgs{
			EnvId:         pulumi.Any(exampleAptibleEnvironment.EnvId),
			ResourceId:    pulumi.Any(exampleAptibleApp.AppId),
			ContainerPort: pulumi.Float64(3000),
			ResourceType:  pulumi.String("app"),
			ProcessType:   pulumi.String("cmd"),
			DefaultDomain: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aptible = Pulumi.Aptible;

return await Deployment.RunAsync(() => 
{
    var example = new Aptible.Endpoint("example", new()
    {
        EnvId = exampleAptibleEnvironment.EnvId,
        ResourceId = exampleAptibleApp.AppId,
        ContainerPort = 3000,
        ResourceType = "app",
        ProcessType = "cmd",
        DefaultDomain = true,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aptible.Endpoint;
import com.pulumi.aptible.EndpointArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Endpoint("example", EndpointArgs.builder()
            .envId(exampleAptibleEnvironment.envId())
            .resourceId(exampleAptibleApp.appId())
            .containerPort(3000.0)
            .resourceType("app")
            .processType("cmd")
            .defaultDomain(true)
            .build());

    }
}

resources:
  example:
    type: aptible:Endpoint
    properties:
      envId: ${exampleAptibleEnvironment.envId}
      resourceId: ${exampleAptibleApp.appId}
      containerPort: 3000
      resourceType: app
      processType: cmd
      defaultDomain: true

Endpoint Settings Example

Use the individual settings attributes to configure endpoint-level options for an Application Endpoint. Supported settings vary by platform and endpoint type; refer to the Endpoint Documentation for the type of Endpoint you are managing.

import * as pulumi from "@pulumi/pulumi";
import * as aptible from "@pulumi/aptible";

const exampleSettings = new aptible.Endpoint("example_settings", {
    envId: example.envId,
    resourceId: exampleAptibleApp.appId,
    resourceType: "app",
    processType: "cmd",
    endpointType: "https",
    defaultDomain: true,
    platform: "alb",
    idleTimeout: 120,
    forceSsl: true,
    maintenancePageUrl: "https://example.com/maintenance",
});

import pulumi
import pulumi_aptible as aptible

example_settings = aptible.Endpoint("example_settings",
    env_id=example["envId"],
    resource_id=example_aptible_app["appId"],
    resource_type="app",
    process_type="cmd",
    endpoint_type="https",
    default_domain=True,
    platform="alb",
    idle_timeout=120,
    force_ssl=True,
    maintenance_page_url="https://example.com/maintenance")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/aptible/aptible"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aptible.NewEndpoint(ctx, "example_settings", &aptible.EndpointArgs{
			EnvId:              pulumi.Any(example.EnvId),
			ResourceId:         pulumi.Any(exampleAptibleApp.AppId),
			ResourceType:       pulumi.String("app"),
			ProcessType:        pulumi.String("cmd"),
			EndpointType:       pulumi.String("https"),
			DefaultDomain:      pulumi.Bool(true),
			Platform:           pulumi.String("alb"),
			IdleTimeout:        pulumi.Float64(120),
			ForceSsl:           pulumi.Bool(true),
			MaintenancePageUrl: pulumi.String("https://example.com/maintenance"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aptible = Pulumi.Aptible;

return await Deployment.RunAsync(() => 
{
    var exampleSettings = new Aptible.Endpoint("example_settings", new()
    {
        EnvId = example.EnvId,
        ResourceId = exampleAptibleApp.AppId,
        ResourceType = "app",
        ProcessType = "cmd",
        EndpointType = "https",
        DefaultDomain = true,
        Platform = "alb",
        IdleTimeout = 120,
        ForceSsl = true,
        MaintenancePageUrl = "https://example.com/maintenance",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aptible.Endpoint;
import com.pulumi.aptible.EndpointArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleSettings = new Endpoint("exampleSettings", EndpointArgs.builder()
            .envId(example.envId())
            .resourceId(exampleAptibleApp.appId())
            .resourceType("app")
            .processType("cmd")
            .endpointType("https")
            .defaultDomain(true)
            .platform("alb")
            .idleTimeout(120.0)
            .forceSsl(true)
            .maintenancePageUrl("https://example.com/maintenance")
            .build());

    }
}

resources:
  exampleSettings:
    type: aptible:Endpoint
    name: example_settings
    properties:
      envId: ${example.envId}
      resourceId: ${exampleAptibleApp.appId}
      resourceType: app
      processType: cmd
      endpointType: https
      defaultDomain: true
      platform: alb
      idleTimeout: 120
      forceSsl: true
      maintenancePageUrl: https://example.com/maintenance

Create Endpoint Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);

@overload
def Endpoint(resource_name: str,
             args: EndpointArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Endpoint(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             env_id: Optional[float] = None,
             resource_type: Optional[str] = None,
             resource_id: Optional[float] = None,
             endpoint_type: Optional[str] = None,
             managed: Optional[bool] = None,
             domain: Optional[str] = None,
             aptible_endpoint_id: Optional[str] = None,
             default_domain: Optional[bool] = None,
             force_ssl: Optional[bool] = None,
             idle_timeout: Optional[float] = None,
             internal: Optional[bool] = None,
             ip_filterings: Optional[Sequence[str]] = None,
             load_balancing_algorithm_type: Optional[str] = None,
             maintenance_page_url: Optional[str] = None,
             disable_weak_cipher_suites: Optional[bool] = None,
             platform: Optional[str] = None,
             process_type: Optional[str] = None,
             release_healthcheck_timeout: Optional[float] = None,
             container_ports: Optional[Sequence[float]] = None,
             container_port: Optional[float] = None,
             shared: Optional[bool] = None,
             show_elb_healthchecks: Optional[bool] = None,
             ssl_ciphers_override: Optional[str] = None,
             ssl_protocols_override: Optional[str] = None,
             strict_health_checks: Optional[bool] = None)

func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)

public Endpoint(string name, EndpointArgs args, CustomResourceOptions? opts = null)

public Endpoint(String name, EndpointArgs args)
public Endpoint(String name, EndpointArgs args, CustomResourceOptions options)

type: aptible:Endpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args EndpointArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var endpointResource = new Aptible.Endpoint("endpointResource", new()
{
    EnvId = 0,
    ResourceType = "string",
    ResourceId = 0,
    EndpointType = "string",
    Managed = false,
    Domain = "string",
    AptibleEndpointId = "string",
    DefaultDomain = false,
    ForceSsl = false,
    IdleTimeout = 0,
    Internal = false,
    IpFilterings = new[]
    {
        "string",
    },
    LoadBalancingAlgorithmType = "string",
    MaintenancePageUrl = "string",
    DisableWeakCipherSuites = false,
    Platform = "string",
    ProcessType = "string",
    ReleaseHealthcheckTimeout = 0,
    ContainerPorts = new[]
    {
        0,
    },
    ContainerPort = 0,
    Shared = false,
    ShowElbHealthchecks = false,
    SslCiphersOverride = "string",
    SslProtocolsOverride = "string",
    StrictHealthChecks = false,
});

example, err := aptible.NewEndpoint(ctx, "endpointResource", &aptible.EndpointArgs{
	EnvId:             pulumi.Float64(0),
	ResourceType:      pulumi.String("string"),
	ResourceId:        pulumi.Float64(0),
	EndpointType:      pulumi.String("string"),
	Managed:           pulumi.Bool(false),
	Domain:            pulumi.String("string"),
	AptibleEndpointId: pulumi.String("string"),
	DefaultDomain:     pulumi.Bool(false),
	ForceSsl:          pulumi.Bool(false),
	IdleTimeout:       pulumi.Float64(0),
	Internal:          pulumi.Bool(false),
	IpFilterings: pulumi.StringArray{
		pulumi.String("string"),
	},
	LoadBalancingAlgorithmType: pulumi.String("string"),
	MaintenancePageUrl:         pulumi.String("string"),
	DisableWeakCipherSuites:    pulumi.Bool(false),
	Platform:                   pulumi.String("string"),
	ProcessType:                pulumi.String("string"),
	ReleaseHealthcheckTimeout:  pulumi.Float64(0),
	ContainerPorts: pulumi.Float64Array{
		pulumi.Float64(0),
	},
	ContainerPort:        pulumi.Float64(0),
	Shared:               pulumi.Bool(false),
	ShowElbHealthchecks:  pulumi.Bool(false),
	SslCiphersOverride:   pulumi.String("string"),
	SslProtocolsOverride: pulumi.String("string"),
	StrictHealthChecks:   pulumi.Bool(false),
})

var endpointResource = new Endpoint("endpointResource", EndpointArgs.builder()
    .envId(0.0)
    .resourceType("string")
    .resourceId(0.0)
    .endpointType("string")
    .managed(false)
    .domain("string")
    .aptibleEndpointId("string")
    .defaultDomain(false)
    .forceSsl(false)
    .idleTimeout(0.0)
    .internal(false)
    .ipFilterings("string")
    .loadBalancingAlgorithmType("string")
    .maintenancePageUrl("string")
    .disableWeakCipherSuites(false)
    .platform("string")
    .processType("string")
    .releaseHealthcheckTimeout(0.0)
    .containerPorts(0.0)
    .containerPort(0.0)
    .shared(false)
    .showElbHealthchecks(false)
    .sslCiphersOverride("string")
    .sslProtocolsOverride("string")
    .strictHealthChecks(false)
    .build());

endpoint_resource = aptible.Endpoint("endpointResource",
    env_id=float(0),
    resource_type="string",
    resource_id=float(0),
    endpoint_type="string",
    managed=False,
    domain="string",
    aptible_endpoint_id="string",
    default_domain=False,
    force_ssl=False,
    idle_timeout=float(0),
    internal=False,
    ip_filterings=["string"],
    load_balancing_algorithm_type="string",
    maintenance_page_url="string",
    disable_weak_cipher_suites=False,
    platform="string",
    process_type="string",
    release_healthcheck_timeout=float(0),
    container_ports=[float(0)],
    container_port=float(0),
    shared=False,
    show_elb_healthchecks=False,
    ssl_ciphers_override="string",
    ssl_protocols_override="string",
    strict_health_checks=False)

const endpointResource = new aptible.Endpoint("endpointResource", {
    envId: 0,
    resourceType: "string",
    resourceId: 0,
    endpointType: "string",
    managed: false,
    domain: "string",
    aptibleEndpointId: "string",
    defaultDomain: false,
    forceSsl: false,
    idleTimeout: 0,
    internal: false,
    ipFilterings: ["string"],
    loadBalancingAlgorithmType: "string",
    maintenancePageUrl: "string",
    disableWeakCipherSuites: false,
    platform: "string",
    processType: "string",
    releaseHealthcheckTimeout: 0,
    containerPorts: [0],
    containerPort: 0,
    shared: false,
    showElbHealthchecks: false,
    sslCiphersOverride: "string",
    sslProtocolsOverride: "string",
    strictHealthChecks: false,
});

type: aptible:Endpoint
properties:
    aptibleEndpointId: string
    containerPort: 0
    containerPorts:
        - 0
    defaultDomain: false
    disableWeakCipherSuites: false
    domain: string
    endpointType: string
    envId: 0
    forceSsl: false
    idleTimeout: 0
    internal: false
    ipFilterings:
        - string
    loadBalancingAlgorithmType: string
    maintenancePageUrl: string
    managed: false
    platform: string
    processType: string
    releaseHealthcheckTimeout: 0
    resourceId: 0
    resourceType: string
    shared: false
    showElbHealthchecks: false
    sslCiphersOverride: string
    sslProtocolsOverride: string
    strictHealthChecks: false

Endpoint Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Endpoint resource accepts the following input properties:

EnvId double

The ID of the environment you would like to deploy your Endpoint in. See main provider documentation for more on how to determine what you should use for env_id.

ResourceId double

The ID of the resource you are adding the Endpoint to.

ResourceType string

The type of resource you are adding the Endpoint to. Valid options are app or database.

AptibleEndpointId string

ContainerPort double

The port on the container which the Endpoint should forward traffic to. Mutually exclusive from container_ports. You should use this for https endpoints.

ContainerPorts List<double>

The ports in array form on the container which the Endpoint should forward traffic to. Mutually exclusive from container_port. Multiple container ports are only allowed on a tcp or tls endpoint.

DefaultDomain bool

If the Endpoint should use the App's default on-aptible.com domain. Only one Endpoint per App can use the default domain. Cannot be used with managed.

DisableWeakCipherSuites bool

Domain string

Required when using Managed TLS (managed). The managed TLS Hostname the Endpoint should use.

EndpointType string

The type of Endpoint. Valid options are https, tls, or tcp. tcp should be used with resource_type of database.

ForceSsl bool

IdleTimeout double

Internal bool

If Endpoint should be available internally or externally . Changing this will force the resource to be recreated.

IpFilterings List<string>

The list of IPv4 CIDRs that the Endpoint will allow traffic from. If not provided, the Endpoint will not filter traffic. See the IP Filtering documentation for more details.

LoadBalancingAlgorithmType string

Determines which algorithm to use for request routing. Valid options are round_robin, least_outstanding_requests, and weighted_random. The default is round_robin.

MaintenancePageUrl string

Managed bool

If Aptible should manage the HTTPS certificate for the Endpoint using the custom_domain. Cannot be used with default_domain.

Platform string

What type of load balancer the Endpoint should use. Valid options for app endpoints are alb or elb. nlb is not supported for app endpoints in this provider release.

Database endpoints do not require platform. Aptible manages the database endpoint platform, so any configured value is ignored.

ProcessType string

The name of the service the Endpoint is for. See main provider documentation for more information on how to determine the service name.

ReleaseHealthcheckTimeout double

Shared bool

If set, use shared load balancer resources with other apps on the same stack. Shared endpoints can only be used if your clients support SNI (most modern clients do) and you either use a default domain or an exact (non-wildcard) custom domain.

ShowElbHealthchecks bool

SslCiphersOverride string

SslProtocolsOverride string

StrictHealthChecks bool

EnvId float64

The ID of the environment you would like to deploy your Endpoint in. See main provider documentation for more on how to determine what you should use for env_id.

ResourceId float64

The ID of the resource you are adding the Endpoint to.

ResourceType string

The type of resource you are adding the Endpoint to. Valid options are app or database.

AptibleEndpointId string

ContainerPort float64

The port on the container which the Endpoint should forward traffic to. Mutually exclusive from container_ports. You should use this for https endpoints.

ContainerPorts []float64

DefaultDomain bool

If the Endpoint should use the App's default on-aptible.com domain. Only one Endpoint per App can use the default domain. Cannot be used with managed.

DisableWeakCipherSuites bool

Domain string

Required when using Managed TLS (managed). The managed TLS Hostname the Endpoint should use.

EndpointType string

The type of Endpoint. Valid options are https, tls, or tcp. tcp should be used with resource_type of database.

ForceSsl bool

IdleTimeout float64

Internal bool

If Endpoint should be available internally or externally . Changing this will force the resource to be recreated.

IpFilterings []string

The list of IPv4 CIDRs that the Endpoint will allow traffic from. If not provided, the Endpoint will not filter traffic. See the IP Filtering documentation for more details.

LoadBalancingAlgorithmType string

Determines which algorithm to use for request routing. Valid options are round_robin, least_outstanding_requests, and weighted_random. The default is round_robin.

MaintenancePageUrl string

Managed bool

If Aptible should manage the HTTPS certificate for the Endpoint using the custom_domain. Cannot be used with default_domain.

Platform string

What type of load balancer the Endpoint should use. Valid options for app endpoints are alb or elb. nlb is not supported for app endpoints in this provider release.

Database endpoints do not require platform. Aptible manages the database endpoint platform, so any configured value is ignored.

ProcessType string

The name of the service the Endpoint is for. See main provider documentation for more information on how to determine the service name.

ReleaseHealthcheckTimeout float64

Shared bool

ShowElbHealthchecks bool

SslCiphersOverride string

SslProtocolsOverride string

StrictHealthChecks bool

envId Double

The ID of the environment you would like to deploy your Endpoint in. See main provider documentation for more on how to determine what you should use for env_id.

resourceId Double

The ID of the resource you are adding the Endpoint to.

resourceType String

The type of resource you are adding the Endpoint to. Valid options are app or database.

aptibleEndpointId String

containerPort Double

The port on the container which the Endpoint should forward traffic to. Mutually exclusive from container_ports. You should use this for https endpoints.

containerPorts List<Double>

defaultDomain Boolean

If the Endpoint should use the App's default on-aptible.com domain. Only one Endpoint per App can use the default domain. Cannot be used with managed.

disableWeakCipherSuites Boolean

domain String

Required when using Managed TLS (managed). The managed TLS Hostname the Endpoint should use.

endpointType String

The type of Endpoint. Valid options are https, tls, or tcp. tcp should be used with resource_type of database.

forceSsl Boolean

idleTimeout Double

internal Boolean

If Endpoint should be available internally or externally . Changing this will force the resource to be recreated.

ipFilterings List<String>

The list of IPv4 CIDRs that the Endpoint will allow traffic from. If not provided, the Endpoint will not filter traffic. See the IP Filtering documentation for more details.

loadBalancingAlgorithmType String

Determines which algorithm to use for request routing. Valid options are round_robin, least_outstanding_requests, and weighted_random. The default is round_robin.

maintenancePageUrl String

managed Boolean

If Aptible should manage the HTTPS certificate for the Endpoint using the custom_domain. Cannot be used with default_domain.

platform String

What type of load balancer the Endpoint should use. Valid options for app endpoints are alb or elb. nlb is not supported for app endpoints in this provider release.

Database endpoints do not require platform. Aptible manages the database endpoint platform, so any configured value is ignored.

processType String

The name of the service the Endpoint is for. See main provider documentation for more information on how to determine the service name.

releaseHealthcheckTimeout Double

shared Boolean

showElbHealthchecks Boolean

sslCiphersOverride String

sslProtocolsOverride String

strictHealthChecks Boolean

envId number

The ID of the environment you would like to deploy your Endpoint in. See main provider documentation for more on how to determine what you should use for env_id.

resourceId number

The ID of the resource you are adding the Endpoint to.

resourceType string

The type of resource you are adding the Endpoint to. Valid options are app or database.

aptibleEndpointId string

containerPort number

The port on the container which the Endpoint should forward traffic to. Mutually exclusive from container_ports. You should use this for https endpoints.

containerPorts number[]

defaultDomain boolean

If the Endpoint should use the App's default on-aptible.com domain. Only one Endpoint per App can use the default domain. Cannot be used with managed.

disableWeakCipherSuites boolean

domain string

Required when using Managed TLS (managed). The managed TLS Hostname the Endpoint should use.

endpointType string

The type of Endpoint. Valid options are https, tls, or tcp. tcp should be used with resource_type of database.

forceSsl boolean

idleTimeout number

internal boolean

If Endpoint should be available internally or externally . Changing this will force the resource to be recreated.

ipFilterings string[]

The list of IPv4 CIDRs that the Endpoint will allow traffic from. If not provided, the Endpoint will not filter traffic. See the IP Filtering documentation for more details.

loadBalancingAlgorithmType string

Determines which algorithm to use for request routing. Valid options are round_robin, least_outstanding_requests, and weighted_random. The default is round_robin.

maintenancePageUrl string

managed boolean

If Aptible should manage the HTTPS certificate for the Endpoint using the custom_domain. Cannot be used with default_domain.

platform string

What type of load balancer the Endpoint should use. Valid options for app endpoints are alb or elb. nlb is not supported for app endpoints in this provider release.

Database endpoints do not require platform. Aptible manages the database endpoint platform, so any configured value is ignored.

processType string

The name of the service the Endpoint is for. See main provider documentation for more information on how to determine the service name.

releaseHealthcheckTimeout number

shared boolean

showElbHealthchecks boolean

sslCiphersOverride string

sslProtocolsOverride string

strictHealthChecks boolean

env_id float

The ID of the environment you would like to deploy your Endpoint in. See main provider documentation for more on how to determine what you should use for env_id.

resource_id float

The ID of the resource you are adding the Endpoint to.

resource_type str

The type of resource you are adding the Endpoint to. Valid options are app or database.

aptible_endpoint_id str

container_port float

The port on the container which the Endpoint should forward traffic to. Mutually exclusive from container_ports. You should use this for https endpoints.

container_ports Sequence[float]

default_domain bool

If the Endpoint should use the App's default on-aptible.com domain. Only one Endpoint per App can use the default domain. Cannot be used with managed.

disable_weak_cipher_suites bool

domain str

Required when using Managed TLS (managed). The managed TLS Hostname the Endpoint should use.

endpoint_type str

The type of Endpoint. Valid options are https, tls, or tcp. tcp should be used with resource_type of database.

force_ssl bool

idle_timeout float

internal bool

If Endpoint should be available internally or externally . Changing this will force the resource to be recreated.

ip_filterings Sequence[str]

The list of IPv4 CIDRs that the Endpoint will allow traffic from. If not provided, the Endpoint will not filter traffic. See the IP Filtering documentation for more details.

load_balancing_algorithm_type str

Determines which algorithm to use for request routing. Valid options are round_robin, least_outstanding_requests, and weighted_random. The default is round_robin.

maintenance_page_url str

managed bool

If Aptible should manage the HTTPS certificate for the Endpoint using the custom_domain. Cannot be used with default_domain.

platform str

What type of load balancer the Endpoint should use. Valid options for app endpoints are alb or elb. nlb is not supported for app endpoints in this provider release.

Database endpoints do not require platform. Aptible manages the database endpoint platform, so any configured value is ignored.

process_type str

The name of the service the Endpoint is for. See main provider documentation for more information on how to determine the service name.

release_healthcheck_timeout float

shared bool

show_elb_healthchecks bool

ssl_ciphers_override str

ssl_protocols_override str

strict_health_checks bool

envId Number

The ID of the environment you would like to deploy your Endpoint in. See main provider documentation for more on how to determine what you should use for env_id.

resourceId Number

The ID of the resource you are adding the Endpoint to.

resourceType String

The type of resource you are adding the Endpoint to. Valid options are app or database.

aptibleEndpointId String

containerPort Number

The port on the container which the Endpoint should forward traffic to. Mutually exclusive from container_ports. You should use this for https endpoints.

containerPorts List<Number>

defaultDomain Boolean

If the Endpoint should use the App's default on-aptible.com domain. Only one Endpoint per App can use the default domain. Cannot be used with managed.

disableWeakCipherSuites Boolean

domain String

Required when using Managed TLS (managed). The managed TLS Hostname the Endpoint should use.

endpointType String

The type of Endpoint. Valid options are https, tls, or tcp. tcp should be used with resource_type of database.

forceSsl Boolean

idleTimeout Number

internal Boolean

If Endpoint should be available internally or externally . Changing this will force the resource to be recreated.

ipFilterings List<String>

The list of IPv4 CIDRs that the Endpoint will allow traffic from. If not provided, the Endpoint will not filter traffic. See the IP Filtering documentation for more details.

loadBalancingAlgorithmType String

Determines which algorithm to use for request routing. Valid options are round_robin, least_outstanding_requests, and weighted_random. The default is round_robin.

maintenancePageUrl String

managed Boolean

If Aptible should manage the HTTPS certificate for the Endpoint using the custom_domain. Cannot be used with default_domain.

platform String

What type of load balancer the Endpoint should use. Valid options for app endpoints are alb or elb. nlb is not supported for app endpoints in this provider release.

Database endpoints do not require platform. Aptible manages the database endpoint platform, so any configured value is ignored.

processType String

The name of the service the Endpoint is for. See main provider documentation for more information on how to determine the service name.

releaseHealthcheckTimeout Number

shared Boolean

showElbHealthchecks Boolean

sslCiphersOverride String

sslProtocolsOverride String

strictHealthChecks Boolean

Outputs

All input properties are implicitly available as output properties. Additionally, the Endpoint resource produces the following output properties:

DnsValidationRecord string: The CNAME record that needs to be created for Managed HTTPS to use dns-01 to verify ownership of the domain.
DnsValidationValue string: The domain name to which the CNAME record should point for Managed HTTPS to use dns-01 to verify ownership of the domain.
EndpointId double: The unique identifier for this Endpoint.
ExternalHostname string: The public hostname of the load balancer serving this Endpoint.
Id string: The provider-assigned unique ID for this managed resource.
VirtualDomain string: The public domain name that would correspond to the certificate served by this domain, if any.

DnsValidationRecord string: The CNAME record that needs to be created for Managed HTTPS to use dns-01 to verify ownership of the domain.
DnsValidationValue string: The domain name to which the CNAME record should point for Managed HTTPS to use dns-01 to verify ownership of the domain.
EndpointId float64: The unique identifier for this Endpoint.
ExternalHostname string: The public hostname of the load balancer serving this Endpoint.
Id string: The provider-assigned unique ID for this managed resource.
VirtualDomain string: The public domain name that would correspond to the certificate served by this domain, if any.

dnsValidationRecord String: The CNAME record that needs to be created for Managed HTTPS to use dns-01 to verify ownership of the domain.
dnsValidationValue String: The domain name to which the CNAME record should point for Managed HTTPS to use dns-01 to verify ownership of the domain.
endpointId Double: The unique identifier for this Endpoint.
externalHostname String: The public hostname of the load balancer serving this Endpoint.
id String: The provider-assigned unique ID for this managed resource.
virtualDomain String: The public domain name that would correspond to the certificate served by this domain, if any.

dnsValidationRecord string: The CNAME record that needs to be created for Managed HTTPS to use dns-01 to verify ownership of the domain.
dnsValidationValue string: The domain name to which the CNAME record should point for Managed HTTPS to use dns-01 to verify ownership of the domain.
endpointId number: The unique identifier for this Endpoint.
externalHostname string: The public hostname of the load balancer serving this Endpoint.
id string: The provider-assigned unique ID for this managed resource.
virtualDomain string: The public domain name that would correspond to the certificate served by this domain, if any.

dns_validation_record str: The CNAME record that needs to be created for Managed HTTPS to use dns-01 to verify ownership of the domain.
dns_validation_value str: The domain name to which the CNAME record should point for Managed HTTPS to use dns-01 to verify ownership of the domain.
endpoint_id float: The unique identifier for this Endpoint.
external_hostname str: The public hostname of the load balancer serving this Endpoint.
id str: The provider-assigned unique ID for this managed resource.
virtual_domain str: The public domain name that would correspond to the certificate served by this domain, if any.

dnsValidationRecord String: The CNAME record that needs to be created for Managed HTTPS to use dns-01 to verify ownership of the domain.
dnsValidationValue String: The domain name to which the CNAME record should point for Managed HTTPS to use dns-01 to verify ownership of the domain.
endpointId Number: The unique identifier for this Endpoint.
externalHostname String: The public hostname of the load balancer serving this Endpoint.
id String: The provider-assigned unique ID for this managed resource.
virtualDomain String: The public domain name that would correspond to the certificate served by this domain, if any.

Look up Existing Endpoint Resource

Get an existing Endpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EndpointState, opts?: CustomResourceOptions): Endpoint

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aptible_endpoint_id: Optional[str] = None,
        container_port: Optional[float] = None,
        container_ports: Optional[Sequence[float]] = None,
        default_domain: Optional[bool] = None,
        disable_weak_cipher_suites: Optional[bool] = None,
        dns_validation_record: Optional[str] = None,
        dns_validation_value: Optional[str] = None,
        domain: Optional[str] = None,
        endpoint_id: Optional[float] = None,
        endpoint_type: Optional[str] = None,
        env_id: Optional[float] = None,
        external_hostname: Optional[str] = None,
        force_ssl: Optional[bool] = None,
        idle_timeout: Optional[float] = None,
        internal: Optional[bool] = None,
        ip_filterings: Optional[Sequence[str]] = None,
        load_balancing_algorithm_type: Optional[str] = None,
        maintenance_page_url: Optional[str] = None,
        managed: Optional[bool] = None,
        platform: Optional[str] = None,
        process_type: Optional[str] = None,
        release_healthcheck_timeout: Optional[float] = None,
        resource_id: Optional[float] = None,
        resource_type: Optional[str] = None,
        shared: Optional[bool] = None,
        show_elb_healthchecks: Optional[bool] = None,
        ssl_ciphers_override: Optional[str] = None,
        ssl_protocols_override: Optional[str] = None,
        strict_health_checks: Optional[bool] = None,
        virtual_domain: Optional[str] = None) -> Endpoint

func GetEndpoint(ctx *Context, name string, id IDInput, state *EndpointState, opts ...ResourceOption) (*Endpoint, error)

public static Endpoint Get(string name, Input<string> id, EndpointState? state, CustomResourceOptions? opts = null)

public static Endpoint get(String name, Output<String> id, EndpointState state, CustomResourceOptions options)

resources:  _:    type: aptible:Endpoint    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AptibleEndpointId string

ContainerPort double

The port on the container which the Endpoint should forward traffic to. Mutually exclusive from container_ports. You should use this for https endpoints.

ContainerPorts List<double>

DefaultDomain bool

If the Endpoint should use the App's default on-aptible.com domain. Only one Endpoint per App can use the default domain. Cannot be used with managed.

DisableWeakCipherSuites bool

DnsValidationRecord string

The CNAME record that needs to be created for Managed HTTPS to use dns-01 to verify ownership of the domain.

DnsValidationValue string

The domain name to which the CNAME record should point for Managed HTTPS to use dns-01 to verify ownership of the domain.

Domain string

Required when using Managed TLS (managed). The managed TLS Hostname the Endpoint should use.

EndpointId double

The unique identifier for this Endpoint.

EndpointType string

The type of Endpoint. Valid options are https, tls, or tcp. tcp should be used with resource_type of database.

EnvId double

The ID of the environment you would like to deploy your Endpoint in. See main provider documentation for more on how to determine what you should use for env_id.

ExternalHostname string

The public hostname of the load balancer serving this Endpoint.

ForceSsl bool

IdleTimeout double

Internal bool

If Endpoint should be available internally or externally . Changing this will force the resource to be recreated.

IpFilterings List<string>

The list of IPv4 CIDRs that the Endpoint will allow traffic from. If not provided, the Endpoint will not filter traffic. See the IP Filtering documentation for more details.

LoadBalancingAlgorithmType string

Determines which algorithm to use for request routing. Valid options are round_robin, least_outstanding_requests, and weighted_random. The default is round_robin.

MaintenancePageUrl string

Managed bool

If Aptible should manage the HTTPS certificate for the Endpoint using the custom_domain. Cannot be used with default_domain.

Platform string

What type of load balancer the Endpoint should use. Valid options for app endpoints are alb or elb. nlb is not supported for app endpoints in this provider release.

Database endpoints do not require platform. Aptible manages the database endpoint platform, so any configured value is ignored.

ProcessType string

The name of the service the Endpoint is for. See main provider documentation for more information on how to determine the service name.

ReleaseHealthcheckTimeout double

ResourceId double

The ID of the resource you are adding the Endpoint to.

ResourceType string

The type of resource you are adding the Endpoint to. Valid options are app or database.

Shared bool

ShowElbHealthchecks bool

SslCiphersOverride string

SslProtocolsOverride string

StrictHealthChecks bool

VirtualDomain string

The public domain name that would correspond to the certificate served by this domain, if any.

AptibleEndpointId string

ContainerPort float64

The port on the container which the Endpoint should forward traffic to. Mutually exclusive from container_ports. You should use this for https endpoints.

ContainerPorts []float64

DefaultDomain bool

If the Endpoint should use the App's default on-aptible.com domain. Only one Endpoint per App can use the default domain. Cannot be used with managed.

DisableWeakCipherSuites bool

DnsValidationRecord string

The CNAME record that needs to be created for Managed HTTPS to use dns-01 to verify ownership of the domain.

DnsValidationValue string

The domain name to which the CNAME record should point for Managed HTTPS to use dns-01 to verify ownership of the domain.

Domain string

Required when using Managed TLS (managed). The managed TLS Hostname the Endpoint should use.

EndpointId float64

The unique identifier for this Endpoint.

EndpointType string

The type of Endpoint. Valid options are https, tls, or tcp. tcp should be used with resource_type of database.

EnvId float64

The ID of the environment you would like to deploy your Endpoint in. See main provider documentation for more on how to determine what you should use for env_id.

ExternalHostname string

The public hostname of the load balancer serving this Endpoint.

ForceSsl bool

IdleTimeout float64

Internal bool

If Endpoint should be available internally or externally . Changing this will force the resource to be recreated.

IpFilterings []string

The list of IPv4 CIDRs that the Endpoint will allow traffic from. If not provided, the Endpoint will not filter traffic. See the IP Filtering documentation for more details.

LoadBalancingAlgorithmType string

Determines which algorithm to use for request routing. Valid options are round_robin, least_outstanding_requests, and weighted_random. The default is round_robin.

MaintenancePageUrl string

Managed bool

If Aptible should manage the HTTPS certificate for the Endpoint using the custom_domain. Cannot be used with default_domain.

Platform string

What type of load balancer the Endpoint should use. Valid options for app endpoints are alb or elb. nlb is not supported for app endpoints in this provider release.

Database endpoints do not require platform. Aptible manages the database endpoint platform, so any configured value is ignored.

ProcessType string

The name of the service the Endpoint is for. See main provider documentation for more information on how to determine the service name.

ReleaseHealthcheckTimeout float64

ResourceId float64

The ID of the resource you are adding the Endpoint to.

ResourceType string

The type of resource you are adding the Endpoint to. Valid options are app or database.

Shared bool

ShowElbHealthchecks bool

SslCiphersOverride string

SslProtocolsOverride string

StrictHealthChecks bool

VirtualDomain string

The public domain name that would correspond to the certificate served by this domain, if any.

aptibleEndpointId String

containerPort Double

The port on the container which the Endpoint should forward traffic to. Mutually exclusive from container_ports. You should use this for https endpoints.

containerPorts List<Double>

defaultDomain Boolean

If the Endpoint should use the App's default on-aptible.com domain. Only one Endpoint per App can use the default domain. Cannot be used with managed.

disableWeakCipherSuites Boolean

dnsValidationRecord String

The CNAME record that needs to be created for Managed HTTPS to use dns-01 to verify ownership of the domain.

dnsValidationValue String

The domain name to which the CNAME record should point for Managed HTTPS to use dns-01 to verify ownership of the domain.

domain String

Required when using Managed TLS (managed). The managed TLS Hostname the Endpoint should use.

endpointId Double

The unique identifier for this Endpoint.

endpointType String

The type of Endpoint. Valid options are https, tls, or tcp. tcp should be used with resource_type of database.

envId Double

The ID of the environment you would like to deploy your Endpoint in. See main provider documentation for more on how to determine what you should use for env_id.

externalHostname String

The public hostname of the load balancer serving this Endpoint.

forceSsl Boolean

idleTimeout Double

internal Boolean

If Endpoint should be available internally or externally . Changing this will force the resource to be recreated.

ipFilterings List<String>

The list of IPv4 CIDRs that the Endpoint will allow traffic from. If not provided, the Endpoint will not filter traffic. See the IP Filtering documentation for more details.

loadBalancingAlgorithmType String

Determines which algorithm to use for request routing. Valid options are round_robin, least_outstanding_requests, and weighted_random. The default is round_robin.

maintenancePageUrl String

managed Boolean

If Aptible should manage the HTTPS certificate for the Endpoint using the custom_domain. Cannot be used with default_domain.

platform String

What type of load balancer the Endpoint should use. Valid options for app endpoints are alb or elb. nlb is not supported for app endpoints in this provider release.

Database endpoints do not require platform. Aptible manages the database endpoint platform, so any configured value is ignored.

processType String

The name of the service the Endpoint is for. See main provider documentation for more information on how to determine the service name.

releaseHealthcheckTimeout Double

resourceId Double

The ID of the resource you are adding the Endpoint to.

resourceType String

The type of resource you are adding the Endpoint to. Valid options are app or database.

shared Boolean

showElbHealthchecks Boolean

sslCiphersOverride String

sslProtocolsOverride String

strictHealthChecks Boolean

virtualDomain String

The public domain name that would correspond to the certificate served by this domain, if any.

aptibleEndpointId string

containerPort number

The port on the container which the Endpoint should forward traffic to. Mutually exclusive from container_ports. You should use this for https endpoints.

containerPorts number[]

defaultDomain boolean

If the Endpoint should use the App's default on-aptible.com domain. Only one Endpoint per App can use the default domain. Cannot be used with managed.

disableWeakCipherSuites boolean

dnsValidationRecord string

The CNAME record that needs to be created for Managed HTTPS to use dns-01 to verify ownership of the domain.

dnsValidationValue string

The domain name to which the CNAME record should point for Managed HTTPS to use dns-01 to verify ownership of the domain.

domain string

Required when using Managed TLS (managed). The managed TLS Hostname the Endpoint should use.

endpointId number

The unique identifier for this Endpoint.

endpointType string

The type of Endpoint. Valid options are https, tls, or tcp. tcp should be used with resource_type of database.

envId number

The ID of the environment you would like to deploy your Endpoint in. See main provider documentation for more on how to determine what you should use for env_id.

externalHostname string

The public hostname of the load balancer serving this Endpoint.

forceSsl boolean

idleTimeout number

internal boolean

If Endpoint should be available internally or externally . Changing this will force the resource to be recreated.

ipFilterings string[]

The list of IPv4 CIDRs that the Endpoint will allow traffic from. If not provided, the Endpoint will not filter traffic. See the IP Filtering documentation for more details.

loadBalancingAlgorithmType string

Determines which algorithm to use for request routing. Valid options are round_robin, least_outstanding_requests, and weighted_random. The default is round_robin.

maintenancePageUrl string

managed boolean

If Aptible should manage the HTTPS certificate for the Endpoint using the custom_domain. Cannot be used with default_domain.

platform string

What type of load balancer the Endpoint should use. Valid options for app endpoints are alb or elb. nlb is not supported for app endpoints in this provider release.

Database endpoints do not require platform. Aptible manages the database endpoint platform, so any configured value is ignored.

processType string

The name of the service the Endpoint is for. See main provider documentation for more information on how to determine the service name.

releaseHealthcheckTimeout number

resourceId number

The ID of the resource you are adding the Endpoint to.

resourceType string

The type of resource you are adding the Endpoint to. Valid options are app or database.

shared boolean

showElbHealthchecks boolean

sslCiphersOverride string

sslProtocolsOverride string

strictHealthChecks boolean

virtualDomain string

The public domain name that would correspond to the certificate served by this domain, if any.

aptible_endpoint_id str

container_port float

The port on the container which the Endpoint should forward traffic to. Mutually exclusive from container_ports. You should use this for https endpoints.

container_ports Sequence[float]

default_domain bool

If the Endpoint should use the App's default on-aptible.com domain. Only one Endpoint per App can use the default domain. Cannot be used with managed.

disable_weak_cipher_suites bool

dns_validation_record str

The CNAME record that needs to be created for Managed HTTPS to use dns-01 to verify ownership of the domain.

dns_validation_value str

The domain name to which the CNAME record should point for Managed HTTPS to use dns-01 to verify ownership of the domain.

domain str

Required when using Managed TLS (managed). The managed TLS Hostname the Endpoint should use.

endpoint_id float

The unique identifier for this Endpoint.

endpoint_type str

The type of Endpoint. Valid options are https, tls, or tcp. tcp should be used with resource_type of database.

env_id float

The ID of the environment you would like to deploy your Endpoint in. See main provider documentation for more on how to determine what you should use for env_id.

external_hostname str

The public hostname of the load balancer serving this Endpoint.

force_ssl bool

idle_timeout float

internal bool

If Endpoint should be available internally or externally . Changing this will force the resource to be recreated.

ip_filterings Sequence[str]

The list of IPv4 CIDRs that the Endpoint will allow traffic from. If not provided, the Endpoint will not filter traffic. See the IP Filtering documentation for more details.

load_balancing_algorithm_type str

Determines which algorithm to use for request routing. Valid options are round_robin, least_outstanding_requests, and weighted_random. The default is round_robin.

maintenance_page_url str

managed bool

If Aptible should manage the HTTPS certificate for the Endpoint using the custom_domain. Cannot be used with default_domain.

platform str

What type of load balancer the Endpoint should use. Valid options for app endpoints are alb or elb. nlb is not supported for app endpoints in this provider release.

Database endpoints do not require platform. Aptible manages the database endpoint platform, so any configured value is ignored.

process_type str

The name of the service the Endpoint is for. See main provider documentation for more information on how to determine the service name.

release_healthcheck_timeout float

resource_id float

The ID of the resource you are adding the Endpoint to.

resource_type str

The type of resource you are adding the Endpoint to. Valid options are app or database.

shared bool

show_elb_healthchecks bool

ssl_ciphers_override str

ssl_protocols_override str

strict_health_checks bool

virtual_domain str

The public domain name that would correspond to the certificate served by this domain, if any.

aptibleEndpointId String

containerPort Number

The port on the container which the Endpoint should forward traffic to. Mutually exclusive from container_ports. You should use this for https endpoints.

containerPorts List<Number>

defaultDomain Boolean

If the Endpoint should use the App's default on-aptible.com domain. Only one Endpoint per App can use the default domain. Cannot be used with managed.

disableWeakCipherSuites Boolean

dnsValidationRecord String

The CNAME record that needs to be created for Managed HTTPS to use dns-01 to verify ownership of the domain.

dnsValidationValue String

The domain name to which the CNAME record should point for Managed HTTPS to use dns-01 to verify ownership of the domain.

domain String

Required when using Managed TLS (managed). The managed TLS Hostname the Endpoint should use.

endpointId Number

The unique identifier for this Endpoint.

endpointType String

The type of Endpoint. Valid options are https, tls, or tcp. tcp should be used with resource_type of database.

envId Number

The ID of the environment you would like to deploy your Endpoint in. See main provider documentation for more on how to determine what you should use for env_id.

externalHostname String

The public hostname of the load balancer serving this Endpoint.

forceSsl Boolean

idleTimeout Number

internal Boolean

If Endpoint should be available internally or externally . Changing this will force the resource to be recreated.

ipFilterings List<String>

The list of IPv4 CIDRs that the Endpoint will allow traffic from. If not provided, the Endpoint will not filter traffic. See the IP Filtering documentation for more details.

loadBalancingAlgorithmType String

Determines which algorithm to use for request routing. Valid options are round_robin, least_outstanding_requests, and weighted_random. The default is round_robin.

maintenancePageUrl String

managed Boolean

If Aptible should manage the HTTPS certificate for the Endpoint using the custom_domain. Cannot be used with default_domain.

platform String

What type of load balancer the Endpoint should use. Valid options for app endpoints are alb or elb. nlb is not supported for app endpoints in this provider release.

Database endpoints do not require platform. Aptible manages the database endpoint platform, so any configured value is ignored.

processType String

The name of the service the Endpoint is for. See main provider documentation for more information on how to determine the service name.

releaseHealthcheckTimeout Number

resourceId Number

The ID of the resource you are adding the Endpoint to.

resourceType String

The type of resource you are adding the Endpoint to. Valid options are app or database.

shared Boolean

showElbHealthchecks Boolean

sslCiphersOverride String

sslProtocolsOverride String

strictHealthChecks Boolean

virtualDomain String

The public domain name that would correspond to the certificate served by this domain, if any.

Import

Existing Endpoints can be imported using the Endpoint ID. For example:

bash

$ pulumi import aptible:index/endpoint:Endpoint example-endpoint <ID>

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: aptible aptible/terraform-provider-aptible
License
Notes: This Pulumi package is based on the aptible Terraform Provider.

Viewing docs for aptible 0.10.0
published on Monday, May 4, 2026 by aptible

Schema (JSON)

aptible/terraform-provider-aptible

aptible.Endpoint

On this page

On this page

# Aptible Endpoint Resource

Example Usage

Simple Default Domain Endpoint

Endpoint Settings Example

Create Endpoint Resource

Constructor syntax

Parameters

Constructor example

Endpoint Resource Properties

Inputs

Outputs

Look up Existing Endpoint Resource

Import

Package Details

On this page

On this page