1. Packages
  2. ngrok
  3. API Docs
  4. Provider
ngrok v0.0.24 published on Friday, Sep 29, 2023 by Piers Karsenbarg

ngrok.Provider

Explore with Pulumi AI

The provider type for the ngrok package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Create Provider Resource

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

Constructor syntax

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

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             api_base_url: Optional[str] = None,
             api_key: Optional[str] = None)
func NewProvider(ctx *Context, name string, args ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs args, CustomResourceOptions? opts = null)
public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)
type: pulumi:providers:ngrok
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

ApiKey This property is required. string
ngrok API key used for authenticating to the API
ApiBaseUrl string
base URL for the ngrok API. only overridden for ngrok's internal testing purposes.
ApiKey This property is required. string
ngrok API key used for authenticating to the API
ApiBaseUrl string
base URL for the ngrok API. only overridden for ngrok's internal testing purposes.
apiKey This property is required. String
ngrok API key used for authenticating to the API
apiBaseUrl String
base URL for the ngrok API. only overridden for ngrok's internal testing purposes.
apiKey This property is required. string
ngrok API key used for authenticating to the API
apiBaseUrl string
base URL for the ngrok API. only overridden for ngrok's internal testing purposes.
api_key This property is required. str
ngrok API key used for authenticating to the API
api_base_url str
base URL for the ngrok API. only overridden for ngrok's internal testing purposes.
apiKey This property is required. String
ngrok API key used for authenticating to the API
apiBaseUrl String
base URL for the ngrok API. only overridden for ngrok's internal testing purposes.

Outputs

All input properties are implicitly available as output properties. Additionally, the Provider 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.

Package Details

Repository
ngrok pierskarsenbarg/pulumi-ngrok
License
Apache-2.0
Notes
This Pulumi package is based on the ngrok Terraform Provider.