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

ngrok.AgentIngress

Explore with Pulumi AI

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

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = new Ngrok.AgentIngress("example", new()
    {
        Description = "acme devices",
        Domain = "connect.acme.com",
    });

});
Copy
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.NewAgentIngress(ctx, "example", &ngrok.AgentIngressArgs{
			Description: pulumi.String("acme devices"),
			Domain:      pulumi.String("connect.acme.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ngrok.AgentIngress;
import com.pulumi.ngrok.AgentIngressArgs;
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 AgentIngress("example", AgentIngressArgs.builder()        
            .description("acme devices")
            .domain("connect.acme.com")
            .build());

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

const example = new ngrok.AgentIngress("example", {
    description: "acme devices",
    domain: "connect.acme.com",
});
Copy
import pulumi
import pierskarsenbarg_pulumi_ngrok as ngrok

example = ngrok.AgentIngress("example",
    description="acme devices",
    domain="connect.acme.com")
Copy
resources:
  example:
    type: ngrok:AgentIngress
    properties:
      description: acme devices
      domain: connect.acme.com
Copy

Create AgentIngress Resource

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

Constructor syntax

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

@overload
def AgentIngress(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 domain: Optional[str] = None,
                 description: Optional[str] = None,
                 metadata: Optional[str] = None,
                 uri: Optional[str] = None)
func NewAgentIngress(ctx *Context, name string, args AgentIngressArgs, opts ...ResourceOption) (*AgentIngress, error)
public AgentIngress(string name, AgentIngressArgs args, CustomResourceOptions? opts = null)
public AgentIngress(String name, AgentIngressArgs args)
public AgentIngress(String name, AgentIngressArgs args, CustomResourceOptions options)

type: ngrok:AgentIngress
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. AgentIngressArgs
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. AgentIngressArgs
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. AgentIngressArgs
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. AgentIngressArgs
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. AgentIngressArgs
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 agentIngressResource = new Ngrok.AgentIngress("agentIngressResource", new()
{
    Domain = "string",
    Description = "string",
    Metadata = "string",
    Uri = "string",
});
Copy
example, err := ngrok.NewAgentIngress(ctx, "agentIngressResource", &ngrok.AgentIngressArgs{
	Domain:      pulumi.String("string"),
	Description: pulumi.String("string"),
	Metadata:    pulumi.String("string"),
	Uri:         pulumi.String("string"),
})
Copy
var agentIngressResource = new AgentIngress("agentIngressResource", AgentIngressArgs.builder()
    .domain("string")
    .description("string")
    .metadata("string")
    .uri("string")
    .build());
Copy
agent_ingress_resource = ngrok.AgentIngress("agentIngressResource",
    domain="string",
    description="string",
    metadata="string",
    uri="string")
Copy
const agentIngressResource = new ngrok.AgentIngress("agentIngressResource", {
    domain: "string",
    description: "string",
    metadata: "string",
    uri: "string",
});
Copy
type: ngrok:AgentIngress
properties:
    description: string
    domain: string
    metadata: string
    uri: string
Copy

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

Domain
This property is required.
Changes to this property will trigger replacement.
string
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
Description string
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
Metadata string
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
Uri Changes to this property will trigger replacement. string
URI to the API resource of this Agent ingress
Domain
This property is required.
Changes to this property will trigger replacement.
string
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
Description string
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
Metadata string
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
Uri Changes to this property will trigger replacement. string
URI to the API resource of this Agent ingress
domain
This property is required.
Changes to this property will trigger replacement.
String
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
description String
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
metadata String
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
uri Changes to this property will trigger replacement. String
URI to the API resource of this Agent ingress
domain
This property is required.
Changes to this property will trigger replacement.
string
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
description string
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
metadata string
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
uri Changes to this property will trigger replacement. string
URI to the API resource of this Agent ingress
domain
This property is required.
Changes to this property will trigger replacement.
str
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
description str
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
metadata str
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
uri Changes to this property will trigger replacement. str
URI to the API resource of this Agent ingress
domain
This property is required.
Changes to this property will trigger replacement.
String
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
description String
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
metadata String
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
uri Changes to this property will trigger replacement. String
URI to the API resource of this Agent ingress

Outputs

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

CreatedAt string
timestamp when the Agent Ingress was created, RFC 3339 format
Id string
The provider-assigned unique ID for this managed resource.
NsTargets List<string>
a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok
RegionDomains List<string>
a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions
CreatedAt string
timestamp when the Agent Ingress was created, RFC 3339 format
Id string
The provider-assigned unique ID for this managed resource.
NsTargets []string
a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok
RegionDomains []string
a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions
createdAt String
timestamp when the Agent Ingress was created, RFC 3339 format
id String
The provider-assigned unique ID for this managed resource.
nsTargets List<String>
a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok
regionDomains List<String>
a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions
createdAt string
timestamp when the Agent Ingress was created, RFC 3339 format
id string
The provider-assigned unique ID for this managed resource.
nsTargets string[]
a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok
regionDomains string[]
a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions
created_at str
timestamp when the Agent Ingress was created, RFC 3339 format
id str
The provider-assigned unique ID for this managed resource.
ns_targets Sequence[str]
a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok
region_domains Sequence[str]
a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions
createdAt String
timestamp when the Agent Ingress was created, RFC 3339 format
id String
The provider-assigned unique ID for this managed resource.
nsTargets List<String>
a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok
regionDomains List<String>
a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions

Look up Existing AgentIngress Resource

Get an existing AgentIngress 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?: AgentIngressState, opts?: CustomResourceOptions): AgentIngress
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        domain: Optional[str] = None,
        metadata: Optional[str] = None,
        ns_targets: Optional[Sequence[str]] = None,
        region_domains: Optional[Sequence[str]] = None,
        uri: Optional[str] = None) -> AgentIngress
func GetAgentIngress(ctx *Context, name string, id IDInput, state *AgentIngressState, opts ...ResourceOption) (*AgentIngress, error)
public static AgentIngress Get(string name, Input<string> id, AgentIngressState? state, CustomResourceOptions? opts = null)
public static AgentIngress get(String name, Output<String> id, AgentIngressState state, CustomResourceOptions options)
resources:  _:    type: ngrok:AgentIngress    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CreatedAt Changes to this property will trigger replacement. string
timestamp when the Agent Ingress was created, RFC 3339 format
Description string
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
Domain Changes to this property will trigger replacement. string
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
Metadata string
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
NsTargets Changes to this property will trigger replacement. List<string>
a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok
RegionDomains Changes to this property will trigger replacement. List<string>
a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions
Uri Changes to this property will trigger replacement. string
URI to the API resource of this Agent ingress
CreatedAt Changes to this property will trigger replacement. string
timestamp when the Agent Ingress was created, RFC 3339 format
Description string
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
Domain Changes to this property will trigger replacement. string
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
Metadata string
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
NsTargets Changes to this property will trigger replacement. []string
a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok
RegionDomains Changes to this property will trigger replacement. []string
a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions
Uri Changes to this property will trigger replacement. string
URI to the API resource of this Agent ingress
createdAt Changes to this property will trigger replacement. String
timestamp when the Agent Ingress was created, RFC 3339 format
description String
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
domain Changes to this property will trigger replacement. String
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
metadata String
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
nsTargets Changes to this property will trigger replacement. List<String>
a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok
regionDomains Changes to this property will trigger replacement. List<String>
a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions
uri Changes to this property will trigger replacement. String
URI to the API resource of this Agent ingress
createdAt Changes to this property will trigger replacement. string
timestamp when the Agent Ingress was created, RFC 3339 format
description string
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
domain Changes to this property will trigger replacement. string
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
metadata string
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
nsTargets Changes to this property will trigger replacement. string[]
a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok
regionDomains Changes to this property will trigger replacement. string[]
a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions
uri Changes to this property will trigger replacement. string
URI to the API resource of this Agent ingress
created_at Changes to this property will trigger replacement. str
timestamp when the Agent Ingress was created, RFC 3339 format
description str
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
domain Changes to this property will trigger replacement. str
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
metadata str
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
ns_targets Changes to this property will trigger replacement. Sequence[str]
a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok
region_domains Changes to this property will trigger replacement. Sequence[str]
a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions
uri Changes to this property will trigger replacement. str
URI to the API resource of this Agent ingress
createdAt Changes to this property will trigger replacement. String
timestamp when the Agent Ingress was created, RFC 3339 format
description String
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
domain Changes to this property will trigger replacement. String
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
metadata String
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
nsTargets Changes to this property will trigger replacement. List<String>
a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok
regionDomains Changes to this property will trigger replacement. List<String>
a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions
uri Changes to this property will trigger replacement. String
URI to the API resource of this Agent ingress

Package Details

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