Docs
Packagesngrok.ReservedAddress
Explore with Pulumi AI
Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ngrok = PiersKarsenbarg.Ngrok;
return await Deployment.RunAsync(() =>
{
var example = new Ngrok.ReservedAddress("example", new()
{
Description = "SSH for device #001",
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.NewReservedAddress(ctx, "example", &ngrok.ReservedAddressArgs{
Description: pulumi.String("SSH for device #001"),
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.ReservedAddress;
import com.pulumi.ngrok.ReservedAddressArgs;
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 ReservedAddress("example", ReservedAddressArgs.builder()
.description("SSH for device #001")
.region("us")
.build());
}
}
import pulumi
import pierskarsenbarg_pulumi_ngrok as ngrok
example = ngrok.ReservedAddress("example",
description="SSH for device #001",
region="us")
import * as pulumi from "@pulumi/pulumi";
import * as ngrok from "@pierskarsenbarg/ngrok";
const example = new ngrok.ReservedAddress("example", {
description: "SSH for device #001",
region: "us",
});
resources:
example:
type: ngrok:ReservedAddress
properties:
description: 'SSH for device #001'
region: us
Create ReservedAddress Resource
new ReservedAddress(name: string, args?: ReservedAddressArgs, opts?: CustomResourceOptions);@overload
def ReservedAddress(resource_name: str,
opts: Optional[ResourceOptions] = None,
addr: Optional[str] = None,
description: Optional[str] = None,
endpoint_configuration_id: Optional[str] = None,
metadata: Optional[str] = None,
region: Optional[str] = None)
@overload
def ReservedAddress(resource_name: str,
args: Optional[ReservedAddressArgs] = None,
opts: Optional[ResourceOptions] = None)func NewReservedAddress(ctx *Context, name string, args *ReservedAddressArgs, opts ...ResourceOption) (*ReservedAddress, error)public ReservedAddress(string name, ReservedAddressArgs? args = null, CustomResourceOptions? opts = null)
public ReservedAddress(String name, ReservedAddressArgs args)
public ReservedAddress(String name, ReservedAddressArgs args, CustomResourceOptions options)
type: ngrok:ReservedAddress
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ReservedAddressArgs
- 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 ReservedAddressArgs
- 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 ReservedAddressArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ReservedAddressArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ReservedAddressArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ReservedAddress Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The ReservedAddress resource accepts the following input properties:
- Addr string
hostname:port of the reserved address that was assigned at creation time
- Description string
human-readable description of what this reserved address will be used for
- Endpoint
Configuration stringId ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
- Metadata string
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
- Region string
reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
- Addr string
hostname:port of the reserved address that was assigned at creation time
- Description string
human-readable description of what this reserved address will be used for
- Endpoint
Configuration stringId ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
- Metadata string
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
- Region string
reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
- addr String
hostname:port of the reserved address that was assigned at creation time
- description String
human-readable description of what this reserved address will be used for
- endpoint
Configuration StringId ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
- metadata String
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
- region String
reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
- addr string
hostname:port of the reserved address that was assigned at creation time
- description string
human-readable description of what this reserved address will be used for
- endpoint
Configuration stringId ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
- metadata string
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
- region string
reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
- addr str
hostname:port of the reserved address that was assigned at creation time
- description str
human-readable description of what this reserved address will be used for
- endpoint_
configuration_ strid ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
- metadata str
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
- region str
reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
- addr String
hostname:port of the reserved address that was assigned at creation time
- description String
human-readable description of what this reserved address will be used for
- endpoint
Configuration StringId ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
- metadata String
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
- region String
reserve the address 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 ReservedAddress resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing ReservedAddress Resource
Get an existing ReservedAddress 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?: ReservedAddressState, opts?: CustomResourceOptions): ReservedAddress@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
addr: Optional[str] = None,
description: Optional[str] = None,
endpoint_configuration_id: Optional[str] = None,
metadata: Optional[str] = None,
region: Optional[str] = None) -> ReservedAddressfunc GetReservedAddress(ctx *Context, name string, id IDInput, state *ReservedAddressState, opts ...ResourceOption) (*ReservedAddress, error)public static ReservedAddress Get(string name, Input<string> id, ReservedAddressState? state, CustomResourceOptions? opts = null)public static ReservedAddress get(String name, Output<String> id, ReservedAddressState state, CustomResourceOptions options)Resource lookup is not supported in YAML- 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.
- Addr string
hostname:port of the reserved address that was assigned at creation time
- Description string
human-readable description of what this reserved address will be used for
- Endpoint
Configuration stringId ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
- Metadata string
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
- Region string
reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
- Addr string
hostname:port of the reserved address that was assigned at creation time
- Description string
human-readable description of what this reserved address will be used for
- Endpoint
Configuration stringId ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
- Metadata string
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
- Region string
reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
- addr String
hostname:port of the reserved address that was assigned at creation time
- description String
human-readable description of what this reserved address will be used for
- endpoint
Configuration StringId ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
- metadata String
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
- region String
reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
- addr string
hostname:port of the reserved address that was assigned at creation time
- description string
human-readable description of what this reserved address will be used for
- endpoint
Configuration stringId ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
- metadata string
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
- region string
reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
- addr str
hostname:port of the reserved address that was assigned at creation time
- description str
human-readable description of what this reserved address will be used for
- endpoint_
configuration_ strid ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
- metadata str
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
- region str
reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
- addr String
hostname:port of the reserved address that was assigned at creation time
- description String
human-readable description of what this reserved address will be used for
- endpoint
Configuration StringId ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address
- metadata String
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
- region String
reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
Package Details
- Repository
- ngrok pierskarsenbarg/pulumi-ngrok
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
ngrokTerraform Provider.