Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. ngrok
  3. API Docs
  4. ReservedDomain
ngrok v0.0.24 published on Friday, Sep 29, 2023 by Piers Karsenbarg
pierskarsenbarg/pulumi-ngrok

ngrok.ReservedDomain

Explore with Pulumi AI

ngrok logo
ngrok v0.0.24 published on Friday, Sep 29, 2023 by Piers Karsenbarg
pierskarsenbarg/pulumi-ngrok

    Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok’s edge servers.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ngrok = PiersKarsenbarg.Ngrok;

return await Deployment.RunAsync(() => 
{
    var example = new Ngrok.ReservedDomain("example", new()
    {
        CertificateId = "cert_25auGELSEngiae3wzmLLesiZn8h",
        Region = "us",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-ngrok/sdk/go/ngrok"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ngrok.NewReservedDomain(ctx, "example", &ngrok.ReservedDomainArgs{
			CertificateId: pulumi.String("cert_25auGELSEngiae3wzmLLesiZn8h"),
			Region:        pulumi.String("us"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ngrok.ReservedDomain;
import com.pulumi.ngrok.ReservedDomainArgs;
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 ReservedDomain("example", ReservedDomainArgs.builder()        
            .certificateId("cert_25auGELSEngiae3wzmLLesiZn8h")
            .region("us")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as ngrok from "@pierskarsenbarg/ngrok";

const example = new ngrok.ReservedDomain("example", {
    certificateId: "cert_25auGELSEngiae3wzmLLesiZn8h",
    region: "us",
});

    import pulumi
import pierskarsenbarg_pulumi_ngrok as ngrok

example = ngrok.ReservedDomain("example",
    certificate_id="cert_25auGELSEngiae3wzmLLesiZn8h",
    region="us")

    resources:
  example:
    type: ngrok:ReservedDomain
    properties:
      certificateId: cert_25auGELSEngiae3wzmLLesiZn8h
      region: us

    Create ReservedDomain Resource

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

    Constructor syntax

    new ReservedDomain(name: string, args?: ReservedDomainArgs, opts?: CustomResourceOptions);
    @overload
def ReservedDomain(resource_name: str,
                   args: Optional[ReservedDomainArgs] = None,
                   opts: Optional[ResourceOptions] = None)

@overload
def ReservedDomain(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   acme_challenge_cname_target: Optional[str] = None,
                   certificate_id: Optional[str] = None,
                   certificate_management_policies: Optional[Sequence[ReservedDomainCertificateManagementPolicyArgs]] = None,
                   cname_target: Optional[str] = None,
                   description: Optional[str] = None,
                   http_endpoint_configuration_id: Optional[str] = None,
                   https_endpoint_configuration_id: Optional[str] = None,
                   metadata: Optional[str] = None,
                   name: Optional[str] = None,
                   region: Optional[str] = None)
    func NewReservedDomain(ctx *Context, name string, args *ReservedDomainArgs, opts ...ResourceOption) (*ReservedDomain, error)
    public ReservedDomain(string name, ReservedDomainArgs? args = null, CustomResourceOptions? opts = null)
    public ReservedDomain(String name, ReservedDomainArgs args)
public ReservedDomain(String name, ReservedDomainArgs args, CustomResourceOptions options)

    type: ngrok:ReservedDomain
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 ReservedDomainArgs
    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 ReservedDomainArgs
    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 ReservedDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReservedDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReservedDomainArgs
    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 reservedDomainResource = new Ngrok.ReservedDomain("reservedDomainResource", new()
{
    AcmeChallengeCnameTarget = "string",
    CertificateId = "string",
    CertificateManagementPolicies = new[]
    {
        new Ngrok.Inputs.ReservedDomainCertificateManagementPolicyArgs
        {
            Authority = "string",
            PrivateKeyType = "string",
        },
    },
    CnameTarget = "string",
    Description = "string",
    HttpEndpointConfigurationId = "string",
    HttpsEndpointConfigurationId = "string",
    Metadata = "string",
    Name = "string",
    Region = "string",
});

    example, err := ngrok.NewReservedDomain(ctx, "reservedDomainResource", &ngrok.ReservedDomainArgs{
	AcmeChallengeCnameTarget: pulumi.String("string"),
	CertificateId:            pulumi.String("string"),
	CertificateManagementPolicies: ngrok.ReservedDomainCertificateManagementPolicyArray{
		&ngrok.ReservedDomainCertificateManagementPolicyArgs{
			Authority:      pulumi.String("string"),
			PrivateKeyType: pulumi.String("string"),
		},
	},
	CnameTarget:                  pulumi.String("string"),
	Description:                  pulumi.String("string"),
	HttpEndpointConfigurationId:  pulumi.String("string"),
	HttpsEndpointConfigurationId: pulumi.String("string"),
	Metadata:                     pulumi.String("string"),
	Name:                         pulumi.String("string"),
	Region:                       pulumi.String("string"),
})

    var reservedDomainResource = new ReservedDomain("reservedDomainResource", ReservedDomainArgs.builder()
    .acmeChallengeCnameTarget("string")
    .certificateId("string")
    .certificateManagementPolicies(ReservedDomainCertificateManagementPolicyArgs.builder()
        .authority("string")
        .privateKeyType("string")
        .build())
    .cnameTarget("string")
    .description("string")
    .httpEndpointConfigurationId("string")
    .httpsEndpointConfigurationId("string")
    .metadata("string")
    .name("string")
    .region("string")
    .build());

    reserved_domain_resource = ngrok.ReservedDomain("reservedDomainResource",
    acme_challenge_cname_target="string",
    certificate_id="string",
    certificate_management_policies=[{
        "authority": "string",
        "private_key_type": "string",
    }],
    cname_target="string",
    description="string",
    http_endpoint_configuration_id="string",
    https_endpoint_configuration_id="string",
    metadata="string",
    name="string",
    region="string")

    const reservedDomainResource = new ngrok.ReservedDomain("reservedDomainResource", {
    acmeChallengeCnameTarget: "string",
    certificateId: "string",
    certificateManagementPolicies: [{
        authority: "string",
        privateKeyType: "string",
    }],
    cnameTarget: "string",
    description: "string",
    httpEndpointConfigurationId: "string",
    httpsEndpointConfigurationId: "string",
    metadata: "string",
    name: "string",
    region: "string",
});

    type: ngrok:ReservedDomain
properties:
    acmeChallengeCnameTarget: string
    certificateId: string
    certificateManagementPolicies:
        - authority: string
          privateKeyType: string
    cnameTarget: string
    description: string
    httpEndpointConfigurationId: string
    httpsEndpointConfigurationId: string
    metadata: string
    name: string
    region: string

    ReservedDomain 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 ReservedDomain resource accepts the following input properties:

    AcmeChallengeCnameTarget string
    DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
    CertificateId string
    ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
    CertificateManagementPolicies List<PiersKarsenbarg.Ngrok.Inputs.ReservedDomainCertificateManagementPolicy>
    configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
    CnameTarget string
    DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io
    Description string
    human-readable description of what this reserved domain will be used for
    HttpEndpointConfigurationId string
    ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
    HttpsEndpointConfigurationId string
    ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
    Metadata string
    arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
    Name string
    the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
    Region string
    reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
    AcmeChallengeCnameTarget string
    DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
    CertificateId string
    ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
    CertificateManagementPolicies []ReservedDomainCertificateManagementPolicyArgs
    configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
    CnameTarget string
    DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io
    Description string
    human-readable description of what this reserved domain will be used for
    HttpEndpointConfigurationId string
    ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
    HttpsEndpointConfigurationId string
    ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
    Metadata string
    arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
    Name string
    the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
    Region string
    reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
    acmeChallengeCnameTarget String
    DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
    certificateId String
    ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
    certificateManagementPolicies List<ReservedDomainCertificateManagementPolicy>
    configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
    cnameTarget String
    DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io
    description String
    human-readable description of what this reserved domain will be used for
    httpEndpointConfigurationId String
    ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
    httpsEndpointConfigurationId String
    ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
    metadata String
    arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
    name String
    the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
    region String
    reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
    acmeChallengeCnameTarget string
    DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
    certificateId string
    ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
    certificateManagementPolicies ReservedDomainCertificateManagementPolicy[]
    configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
    cnameTarget string
    DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io
    description string
    human-readable description of what this reserved domain will be used for
    httpEndpointConfigurationId string
    ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
    httpsEndpointConfigurationId string
    ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
    metadata string
    arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
    name string
    the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
    region string
    reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
    acme_challenge_cname_target str
    DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
    certificate_id str
    ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
    certificate_management_policies Sequence[ReservedDomainCertificateManagementPolicyArgs]
    configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
    cname_target str
    DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io
    description str
    human-readable description of what this reserved domain will be used for
    http_endpoint_configuration_id str
    ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
    https_endpoint_configuration_id str
    ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
    metadata str
    arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
    name str
    the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
    region str
    reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
    acmeChallengeCnameTarget String
    DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
    certificateId String
    ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
    certificateManagementPolicies List<Property Map>
    configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
    cnameTarget String
    DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io
    description String
    human-readable description of what this reserved domain will be used for
    httpEndpointConfigurationId String
    ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
    httpsEndpointConfigurationId String
    ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
    metadata String
    arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
    name String
    the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
    region String
    reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)

    Outputs

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

    Domain string
    hostname of the reserved domain
    Id string
    The provider-assigned unique ID for this managed resource.
    Domain string
    hostname of the reserved domain
    Id string
    The provider-assigned unique ID for this managed resource.
    domain String
    hostname of the reserved domain
    id String
    The provider-assigned unique ID for this managed resource.
    domain string
    hostname of the reserved domain
    id string
    The provider-assigned unique ID for this managed resource.
    domain str
    hostname of the reserved domain
    id str
    The provider-assigned unique ID for this managed resource.
    domain String
    hostname of the reserved domain
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ReservedDomain Resource

    Get an existing ReservedDomain 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?: ReservedDomainState, opts?: CustomResourceOptions): ReservedDomain
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        acme_challenge_cname_target: Optional[str] = None,
        certificate_id: Optional[str] = None,
        certificate_management_policies: Optional[Sequence[ReservedDomainCertificateManagementPolicyArgs]] = None,
        cname_target: Optional[str] = None,
        description: Optional[str] = None,
        domain: Optional[str] = None,
        http_endpoint_configuration_id: Optional[str] = None,
        https_endpoint_configuration_id: Optional[str] = None,
        metadata: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None) -> ReservedDomain
    func GetReservedDomain(ctx *Context, name string, id IDInput, state *ReservedDomainState, opts ...ResourceOption) (*ReservedDomain, error)
    public static ReservedDomain Get(string name, Input<string> id, ReservedDomainState? state, CustomResourceOptions? opts = null)
    public static ReservedDomain get(String name, Output<String> id, ReservedDomainState state, CustomResourceOptions options)
    resources:  _:    type: ngrok:ReservedDomain    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:
    AcmeChallengeCnameTarget string
    DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
    CertificateId string
    ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
    CertificateManagementPolicies List<PiersKarsenbarg.Ngrok.Inputs.ReservedDomainCertificateManagementPolicy>
    configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
    CnameTarget string
    DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io
    Description string
    human-readable description of what this reserved domain will be used for
    Domain string
    hostname of the reserved domain
    HttpEndpointConfigurationId string
    ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
    HttpsEndpointConfigurationId string
    ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
    Metadata string
    arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
    Name string
    the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
    Region string
    reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
    AcmeChallengeCnameTarget string
    DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
    CertificateId string
    ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
    CertificateManagementPolicies []ReservedDomainCertificateManagementPolicyArgs
    configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
    CnameTarget string
    DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io
    Description string
    human-readable description of what this reserved domain will be used for
    Domain string
    hostname of the reserved domain
    HttpEndpointConfigurationId string
    ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
    HttpsEndpointConfigurationId string
    ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
    Metadata string
    arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
    Name string
    the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
    Region string
    reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
    acmeChallengeCnameTarget String
    DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
    certificateId String
    ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
    certificateManagementPolicies List<ReservedDomainCertificateManagementPolicy>
    configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
    cnameTarget String
    DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io
    description String
    human-readable description of what this reserved domain will be used for
    domain String
    hostname of the reserved domain
    httpEndpointConfigurationId String
    ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
    httpsEndpointConfigurationId String
    ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
    metadata String
    arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
    name String
    the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
    region String
    reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
    acmeChallengeCnameTarget string
    DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
    certificateId string
    ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
    certificateManagementPolicies ReservedDomainCertificateManagementPolicy[]
    configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
    cnameTarget string
    DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io
    description string
    human-readable description of what this reserved domain will be used for
    domain string
    hostname of the reserved domain
    httpEndpointConfigurationId string
    ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
    httpsEndpointConfigurationId string
    ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
    metadata string
    arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
    name string
    the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
    region string
    reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
    acme_challenge_cname_target str
    DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
    certificate_id str
    ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
    certificate_management_policies Sequence[ReservedDomainCertificateManagementPolicyArgs]
    configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
    cname_target str
    DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io
    description str
    human-readable description of what this reserved domain will be used for
    domain str
    hostname of the reserved domain
    http_endpoint_configuration_id str
    ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
    https_endpoint_configuration_id str
    ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
    metadata str
    arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
    name str
    the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
    region str
    reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
    acmeChallengeCnameTarget String
    DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
    certificateId String
    ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
    certificateManagementPolicies List<Property Map>
    configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
    cnameTarget String
    DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io
    description String
    human-readable description of what this reserved domain will be used for
    domain String
    hostname of the reserved domain
    httpEndpointConfigurationId String
    ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain
    httpsEndpointConfigurationId String
    ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain
    metadata String
    arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
    name String
    the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
    region String
    reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)

    Supporting Types

    ReservedDomainCertificateManagementPolicy, ReservedDomainCertificateManagementPolicyArgs

    Authority string
    certificate authority to request certificates from. The only supported value is letsencrypt.
    PrivateKeyType string
    type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.
    Authority string
    certificate authority to request certificates from. The only supported value is letsencrypt.
    PrivateKeyType string
    type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.
    authority String
    certificate authority to request certificates from. The only supported value is letsencrypt.
    privateKeyType String
    type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.
    authority string
    certificate authority to request certificates from. The only supported value is letsencrypt.
    privateKeyType string
    type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.
    authority str
    certificate authority to request certificates from. The only supported value is letsencrypt.
    private_key_type str
    type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.
    authority String
    certificate authority to request certificates from. The only supported value is letsencrypt.
    privateKeyType String
    type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.

    Package Details

    Repository
    ngrok pierskarsenbarg/pulumi-ngrok
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ngrok Terraform Provider.
    ngrok logo
    ngrok v0.0.24 published on Friday, Sep 29, 2023 by Piers Karsenbarg
    pierskarsenbarg/pulumi-ngrok