Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aptible Provider
  3. API Docs
  4. Endpoint
aptible 0.9.12 published on Monday, Apr 14, 2025 by aptible
aptible/terraform-provider-aptible

aptible.Endpoint

Explore with Pulumi AI

aptible logo
aptible 0.9.12 published on Monday, Apr 14, 2025 by aptible
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: data.aptible_environment.example.env_id,
    resourceId: aptible_app.example.app_id,
    containerPort: 3000,
    resourceType: "app",
    processType: "cmd",
    defaultDomain: true,
});

    import pulumi
import pulumi_aptible as aptible

example = aptible.Endpoint("example",
    env_id=data["aptible_environment"]["example"]["env_id"],
    resource_id=aptible_app["example"]["app_id"],
    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(data.Aptible_environment.Example.Env_id),
			ResourceId:    pulumi.Any(aptible_app.Example.App_id),
			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 = data.Aptible_environment.Example.Env_id,
        ResourceId = aptible_app.Example.App_id,
        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(data.aptible_environment().example().env_id())
            .resourceId(aptible_app.example().app_id())
            .containerPort(3000)
            .resourceType("app")
            .processType("cmd")
            .defaultDomain(true)
            .build());

    }
}

    resources:
  example:
    type: aptible:Endpoint
    properties:
      envId: ${data.aptible_environment.example.env_id}
      resourceId: ${aptible_app.example.app_id}
      # alternatively, one could also set "container_ports = [3000,3001]"
      containerPort: 3000
      resourceType: app
      processType: cmd
      defaultDomain: true

    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,
             default_domain: Optional[bool] = None,
             domain: Optional[str] = None,
             endpoint_type: Optional[str] = None,
             aptible_endpoint_id: Optional[str] = None,
             internal: Optional[bool] = None,
             ip_filterings: Optional[Sequence[str]] = None,
             managed: Optional[bool] = None,
             platform: Optional[str] = None,
             process_type: Optional[str] = None,
             container_ports: Optional[Sequence[float]] = None,
             container_port: Optional[float] = 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,
    DefaultDomain = false,
    Domain = "string",
    EndpointType = "string",
    AptibleEndpointId = "string",
    Internal = false,
    IpFilterings = new[]
    {
        "string",
    },
    Managed = false,
    Platform = "string",
    ProcessType = "string",
    ContainerPorts = new[]
    {
        0,
    },
    ContainerPort = 0,
});

    example, err := aptible.NewEndpoint(ctx, "endpointResource", &aptible.EndpointArgs{
	EnvId:             pulumi.Float64(0),
	ResourceType:      pulumi.String("string"),
	ResourceId:        pulumi.Float64(0),
	DefaultDomain:     pulumi.Bool(false),
	Domain:            pulumi.String("string"),
	EndpointType:      pulumi.String("string"),
	AptibleEndpointId: pulumi.String("string"),
	Internal:          pulumi.Bool(false),
	IpFilterings: pulumi.StringArray{
		pulumi.String("string"),
	},
	Managed:     pulumi.Bool(false),
	Platform:    pulumi.String("string"),
	ProcessType: pulumi.String("string"),
	ContainerPorts: pulumi.Float64Array{
		pulumi.Float64(0),
	},
	ContainerPort: pulumi.Float64(0),
})

    var endpointResource = new Endpoint("endpointResource", EndpointArgs.builder()
    .envId(0)
    .resourceType("string")
    .resourceId(0)
    .defaultDomain(false)
    .domain("string")
    .endpointType("string")
    .aptibleEndpointId("string")
    .internal(false)
    .ipFilterings("string")
    .managed(false)
    .platform("string")
    .processType("string")
    .containerPorts(0)
    .containerPort(0)
    .build());

    endpoint_resource = aptible.Endpoint("endpointResource",
    env_id=0,
    resource_type="string",
    resource_id=0,
    default_domain=False,
    domain="string",
    endpoint_type="string",
    aptible_endpoint_id="string",
    internal=False,
    ip_filterings=["string"],
    managed=False,
    platform="string",
    process_type="string",
    container_ports=[0],
    container_port=0)

    const endpointResource = new aptible.Endpoint("endpointResource", {
    envId: 0,
    resourceType: "string",
    resourceId: 0,
    defaultDomain: false,
    domain: "string",
    endpointType: "string",
    aptibleEndpointId: "string",
    internal: false,
    ipFilterings: ["string"],
    managed: false,
    platform: "string",
    processType: "string",
    containerPorts: [0],
    containerPort: 0,
});

    type: aptible:Endpoint
properties:
    aptibleEndpointId: string
    containerPort: 0
    containerPorts:
        - 0
    defaultDomain: false
    domain: string
    endpointType: string
    envId: 0
    internal: false
    ipFilterings:
        - string
    managed: false
    platform: string
    processType: string
    resourceId: 0
    resourceType: string

    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.
    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.
    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.
    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 are alb or elb. resource_type of database should use elb.
    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.
    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
    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.
    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.
    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.
    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 are alb or elb. resource_type of database should use elb.
    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.
    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 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.
    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.
    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.
    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 are alb or elb. resource_type of database should use elb.
    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.
    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[]
    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 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.
    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.
    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.
    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 are alb or elb. resource_type of database should use elb.
    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.
    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]
    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.
    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.
    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.
    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.
    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 are alb or elb. resource_type of database should use elb.
    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.
    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>
    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 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.
    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.
    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.
    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 are alb or elb. resource_type of database should use elb.
    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.

    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,
        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,
        internal: Optional[bool] = None,
        ip_filterings: Optional[Sequence[str]] = None,
        managed: Optional[bool] = None,
        platform: Optional[str] = None,
        process_type: Optional[str] = None,
        resource_id: Optional[float] = None,
        resource_type: Optional[str] = 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>
    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.
    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.
    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.
    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 are alb or elb. resource_type of database should use elb.
    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.
    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.
    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
    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.
    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.
    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.
    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 are alb or elb. resource_type of database should use elb.
    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.
    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.
    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>
    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 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.
    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.
    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.
    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 are alb or elb. resource_type of database should use elb.
    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.
    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.
    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[]
    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 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.
    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.
    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.
    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 are alb or elb. resource_type of database should use elb.
    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.
    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.
    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]
    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.
    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.
    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.
    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.
    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 are alb or elb. resource_type of database should use elb.
    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.
    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.
    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>
    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 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.
    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.
    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.
    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 are alb or elb. resource_type of database should use elb.
    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.
    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.
    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.
    aptible logo
    aptible 0.9.12 published on Monday, Apr 14, 2025 by aptible
    aptible/terraform-provider-aptible