Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Twingate
  3. API Docs
  4. TwingateRemoteNetwork
Twingate v3.0.12 published on Tuesday, Nov 5, 2024 by Twingate
Twingate/pulumi-twingate

twingate.TwingateRemoteNetwork

Explore with Pulumi AI

twingate logo
Twingate v3.0.12 published on Tuesday, Nov 5, 2024 by Twingate
Twingate/pulumi-twingate

    A Remote Network represents a single private network in Twingate that can have one or more Connectors and Resources assigned to it. You must create a Remote Network before creating Resources and Connectors that belong to it. For more information, see Twingate’s documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as twingate from "@twingate/pulumi-twingate";

const awsNetwork = new twingate.TwingateRemoteNetwork("awsNetwork", {});

    import pulumi
import pulumi_twingate as twingate

aws_network = twingate.TwingateRemoteNetwork("awsNetwork")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := twingate.NewTwingateRemoteNetwork(ctx, "awsNetwork", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Twingate = Twingate.Twingate;

return await Deployment.RunAsync(() => 
{
    var awsNetwork = new Twingate.TwingateRemoteNetwork("awsNetwork");

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.twingate.TwingateRemoteNetwork;
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 awsNetwork = new TwingateRemoteNetwork("awsNetwork");

    }
}

    resources:
  awsNetwork:
    type: twingate:TwingateRemoteNetwork

    Create TwingateRemoteNetwork Resource

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

    Constructor syntax

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

@overload
def TwingateRemoteNetwork(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          location: Optional[str] = None,
                          name: Optional[str] = None)
    func NewTwingateRemoteNetwork(ctx *Context, name string, args *TwingateRemoteNetworkArgs, opts ...ResourceOption) (*TwingateRemoteNetwork, error)
    public TwingateRemoteNetwork(string name, TwingateRemoteNetworkArgs? args = null, CustomResourceOptions? opts = null)
    public TwingateRemoteNetwork(String name, TwingateRemoteNetworkArgs args)
public TwingateRemoteNetwork(String name, TwingateRemoteNetworkArgs args, CustomResourceOptions options)

    type: twingate:TwingateRemoteNetwork
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 TwingateRemoteNetworkArgs
    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 TwingateRemoteNetworkArgs
    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 TwingateRemoteNetworkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TwingateRemoteNetworkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TwingateRemoteNetworkArgs
    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 twingateRemoteNetworkResource = new Twingate.TwingateRemoteNetwork("twingateRemoteNetworkResource", new()
{
    Location = "string",
    Name = "string",
});

    example, err := twingate.NewTwingateRemoteNetwork(ctx, "twingateRemoteNetworkResource", &twingate.TwingateRemoteNetworkArgs{
	Location: pulumi.String("string"),
	Name:     pulumi.String("string"),
})

    var twingateRemoteNetworkResource = new TwingateRemoteNetwork("twingateRemoteNetworkResource", TwingateRemoteNetworkArgs.builder()
    .location("string")
    .name("string")
    .build());

    twingate_remote_network_resource = twingate.TwingateRemoteNetwork("twingateRemoteNetworkResource",
    location="string",
    name="string")

    const twingateRemoteNetworkResource = new twingate.TwingateRemoteNetwork("twingateRemoteNetworkResource", {
    location: "string",
    name: "string",
});

    type: twingate:TwingateRemoteNetwork
properties:
    location: string
    name: string

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

    Location string
    The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
    Name string
    The name of the Remote Network
    Location string
    The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
    Name string
    The name of the Remote Network
    location String
    The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
    name String
    The name of the Remote Network
    location string
    The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
    name string
    The name of the Remote Network
    location str
    The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
    name str
    The name of the Remote Network
    location String
    The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
    name String
    The name of the Remote Network

    Outputs

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

    Get an existing TwingateRemoteNetwork 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?: TwingateRemoteNetworkState, opts?: CustomResourceOptions): TwingateRemoteNetwork
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        location: Optional[str] = None,
        name: Optional[str] = None) -> TwingateRemoteNetwork
    func GetTwingateRemoteNetwork(ctx *Context, name string, id IDInput, state *TwingateRemoteNetworkState, opts ...ResourceOption) (*TwingateRemoteNetwork, error)
    public static TwingateRemoteNetwork Get(string name, Input<string> id, TwingateRemoteNetworkState? state, CustomResourceOptions? opts = null)
    public static TwingateRemoteNetwork get(String name, Output<String> id, TwingateRemoteNetworkState 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.
    The following state arguments are supported:
    Location string
    The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
    Name string
    The name of the Remote Network
    Location string
    The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
    Name string
    The name of the Remote Network
    location String
    The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
    name String
    The name of the Remote Network
    location string
    The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
    name string
    The name of the Remote Network
    location str
    The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
    name str
    The name of the Remote Network
    location String
    The location of the Remote Network. Must be one of the following: AWS, AZURE, GOOGLECLOUD, ONPREMISE, OTHER.
    name String
    The name of the Remote Network

    Import

    $ pulumi import twingate:index/twingateRemoteNetwork:TwingateRemoteNetwork network UmVtb3RlTmV0d29zaipgMKIkNg==

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    twingate Twingate/pulumi-twingate
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the twingate Terraform Provider.
    twingate logo
    Twingate v3.0.12 published on Tuesday, Nov 5, 2024 by Twingate
    Twingate/pulumi-twingate