1. Packages
  2. StrongDM
  3. API Docs
  4. Node
StrongDM v1.26.0 published on Friday, Mar 21, 2025 by Piers Karsenbarg

sdm.Node

Explore with Pulumi AI

Nodes make up the strongDM network, and allow your users to connect securely to your resources. There are two types of nodes:

  1. Relay: creates connectivity to your datasources, while maintaining the egress-only nature of your firewall
  2. Gateways: a relay that also listens for connections from strongDM clients

Example Usage

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

const gateway = new sdm.Node("gateway", {gateway: {
    bindAddress: "0.0.0.0:21222",
    listenAddress: "165.23.40.1:21222",
    name: "test-gateway",
    tags: {
        env: "dev",
        region: "us-west",
    },
}});
const relay = new sdm.Node("relay", {relay: {
    name: "test-relay",
    tags: {
        env: "dev",
        region: "us-west",
    },
}});
Copy
import pulumi
import pierskarsenbarg_pulumi_sdm as sdm

gateway = sdm.Node("gateway", gateway={
    "bind_address": "0.0.0.0:21222",
    "listen_address": "165.23.40.1:21222",
    "name": "test-gateway",
    "tags": {
        "env": "dev",
        "region": "us-west",
    },
})
relay = sdm.Node("relay", relay={
    "name": "test-relay",
    "tags": {
        "env": "dev",
        "region": "us-west",
    },
})
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sdm.NewNode(ctx, "gateway", &sdm.NodeArgs{
			Gateway: &sdm.NodeGatewayArgs{
				BindAddress:   pulumi.String("0.0.0.0:21222"),
				ListenAddress: pulumi.String("165.23.40.1:21222"),
				Name:          pulumi.String("test-gateway"),
				Tags: pulumi.StringMap{
					"env":    pulumi.String("dev"),
					"region": pulumi.String("us-west"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = sdm.NewNode(ctx, "relay", &sdm.NodeArgs{
			Relay: &sdm.NodeRelayArgs{
				Name: pulumi.String("test-relay"),
				Tags: pulumi.StringMap{
					"env":    pulumi.String("dev"),
					"region": pulumi.String("us-west"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sdm = PiersKarsenbarg.Sdm;

return await Deployment.RunAsync(() => 
{
    var gateway = new Sdm.Node("gateway", new()
    {
        Gateway = new Sdm.Inputs.NodeGatewayArgs
        {
            BindAddress = "0.0.0.0:21222",
            ListenAddress = "165.23.40.1:21222",
            Name = "test-gateway",
            Tags = 
            {
                { "env", "dev" },
                { "region", "us-west" },
            },
        },
    });

    var relay = new Sdm.Node("relay", new()
    {
        Relay = new Sdm.Inputs.NodeRelayArgs
        {
            Name = "test-relay",
            Tags = 
            {
                { "env", "dev" },
                { "region", "us-west" },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sdm.Node;
import com.pulumi.sdm.NodeArgs;
import com.pulumi.sdm.inputs.NodeGatewayArgs;
import com.pulumi.sdm.inputs.NodeRelayArgs;
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 gateway = new Node("gateway", NodeArgs.builder()
            .gateway(NodeGatewayArgs.builder()
                .bindAddress("0.0.0.0:21222")
                .listenAddress("165.23.40.1:21222")
                .name("test-gateway")
                .tags(Map.ofEntries(
                    Map.entry("env", "dev"),
                    Map.entry("region", "us-west")
                ))
                .build())
            .build());

        var relay = new Node("relay", NodeArgs.builder()
            .relay(NodeRelayArgs.builder()
                .name("test-relay")
                .tags(Map.ofEntries(
                    Map.entry("env", "dev"),
                    Map.entry("region", "us-west")
                ))
                .build())
            .build());

    }
}
Copy
resources:
  gateway:
    type: sdm:Node
    properties:
      gateway:
        bindAddress: 0.0.0.0:21222
        listenAddress: 165.23.40.1:21222
        name: test-gateway
        tags:
          env: dev
          region: us-west
  relay:
    type: sdm:Node
    properties:
      relay:
        name: test-relay
        tags:
          env: dev
          region: us-west
Copy

This resource can be imported using the import command.

Create Node Resource

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

Constructor syntax

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

@overload
def Node(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         gateway: Optional[NodeGatewayArgs] = None,
         proxy_cluster: Optional[NodeProxyClusterArgs] = None,
         relay: Optional[NodeRelayArgs] = None)
func NewNode(ctx *Context, name string, args *NodeArgs, opts ...ResourceOption) (*Node, error)
public Node(string name, NodeArgs? args = null, CustomResourceOptions? opts = null)
public Node(String name, NodeArgs args)
public Node(String name, NodeArgs args, CustomResourceOptions options)
type: sdm:Node
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 NodeArgs
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 NodeArgs
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 NodeArgs
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 NodeArgs
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. NodeArgs
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 nodeResource = new Sdm.Node("nodeResource", new()
{
    Gateway = new Sdm.Inputs.NodeGatewayArgs
    {
        ListenAddress = "string",
        BindAddress = "string",
        Device = "string",
        GatewayFilter = "string",
        Location = "string",
        MaintenanceWindows = new[]
        {
            new Sdm.Inputs.NodeGatewayMaintenanceWindowArgs
            {
                CronSchedule = "string",
                RequireIdleness = false,
            },
        },
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
        Token = "string",
        Version = "string",
    },
    ProxyCluster = new Sdm.Inputs.NodeProxyClusterArgs
    {
        Address = "string",
        MaintenanceWindows = new[]
        {
            new Sdm.Inputs.NodeProxyClusterMaintenanceWindowArgs
            {
                CronSchedule = "string",
                RequireIdleness = false,
            },
        },
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    },
    Relay = new Sdm.Inputs.NodeRelayArgs
    {
        Device = "string",
        GatewayFilter = "string",
        Location = "string",
        MaintenanceWindows = new[]
        {
            new Sdm.Inputs.NodeRelayMaintenanceWindowArgs
            {
                CronSchedule = "string",
                RequireIdleness = false,
            },
        },
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
        Token = "string",
        Version = "string",
    },
});
Copy
example, err := sdm.NewNode(ctx, "nodeResource", &sdm.NodeArgs{
	Gateway: &sdm.NodeGatewayArgs{
		ListenAddress: pulumi.String("string"),
		BindAddress:   pulumi.String("string"),
		Device:        pulumi.String("string"),
		GatewayFilter: pulumi.String("string"),
		Location:      pulumi.String("string"),
		MaintenanceWindows: sdm.NodeGatewayMaintenanceWindowArray{
			&sdm.NodeGatewayMaintenanceWindowArgs{
				CronSchedule:    pulumi.String("string"),
				RequireIdleness: pulumi.Bool(false),
			},
		},
		Name: pulumi.String("string"),
		Tags: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		Token:   pulumi.String("string"),
		Version: pulumi.String("string"),
	},
	ProxyCluster: &sdm.NodeProxyClusterArgs{
		Address: pulumi.String("string"),
		MaintenanceWindows: sdm.NodeProxyClusterMaintenanceWindowArray{
			&sdm.NodeProxyClusterMaintenanceWindowArgs{
				CronSchedule:    pulumi.String("string"),
				RequireIdleness: pulumi.Bool(false),
			},
		},
		Name: pulumi.String("string"),
		Tags: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
	Relay: &sdm.NodeRelayArgs{
		Device:        pulumi.String("string"),
		GatewayFilter: pulumi.String("string"),
		Location:      pulumi.String("string"),
		MaintenanceWindows: sdm.NodeRelayMaintenanceWindowArray{
			&sdm.NodeRelayMaintenanceWindowArgs{
				CronSchedule:    pulumi.String("string"),
				RequireIdleness: pulumi.Bool(false),
			},
		},
		Name: pulumi.String("string"),
		Tags: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		Token:   pulumi.String("string"),
		Version: pulumi.String("string"),
	},
})
Copy
var nodeResource = new Node("nodeResource", NodeArgs.builder()
    .gateway(NodeGatewayArgs.builder()
        .listenAddress("string")
        .bindAddress("string")
        .device("string")
        .gatewayFilter("string")
        .location("string")
        .maintenanceWindows(NodeGatewayMaintenanceWindowArgs.builder()
            .cronSchedule("string")
            .requireIdleness(false)
            .build())
        .name("string")
        .tags(Map.of("string", "string"))
        .token("string")
        .version("string")
        .build())
    .proxyCluster(NodeProxyClusterArgs.builder()
        .address("string")
        .maintenanceWindows(NodeProxyClusterMaintenanceWindowArgs.builder()
            .cronSchedule("string")
            .requireIdleness(false)
            .build())
        .name("string")
        .tags(Map.of("string", "string"))
        .build())
    .relay(NodeRelayArgs.builder()
        .device("string")
        .gatewayFilter("string")
        .location("string")
        .maintenanceWindows(NodeRelayMaintenanceWindowArgs.builder()
            .cronSchedule("string")
            .requireIdleness(false)
            .build())
        .name("string")
        .tags(Map.of("string", "string"))
        .token("string")
        .version("string")
        .build())
    .build());
Copy
node_resource = sdm.Node("nodeResource",
    gateway={
        "listen_address": "string",
        "bind_address": "string",
        "device": "string",
        "gateway_filter": "string",
        "location": "string",
        "maintenance_windows": [{
            "cron_schedule": "string",
            "require_idleness": False,
        }],
        "name": "string",
        "tags": {
            "string": "string",
        },
        "token": "string",
        "version": "string",
    },
    proxy_cluster={
        "address": "string",
        "maintenance_windows": [{
            "cron_schedule": "string",
            "require_idleness": False,
        }],
        "name": "string",
        "tags": {
            "string": "string",
        },
    },
    relay={
        "device": "string",
        "gateway_filter": "string",
        "location": "string",
        "maintenance_windows": [{
            "cron_schedule": "string",
            "require_idleness": False,
        }],
        "name": "string",
        "tags": {
            "string": "string",
        },
        "token": "string",
        "version": "string",
    })
Copy
const nodeResource = new sdm.Node("nodeResource", {
    gateway: {
        listenAddress: "string",
        bindAddress: "string",
        device: "string",
        gatewayFilter: "string",
        location: "string",
        maintenanceWindows: [{
            cronSchedule: "string",
            requireIdleness: false,
        }],
        name: "string",
        tags: {
            string: "string",
        },
        token: "string",
        version: "string",
    },
    proxyCluster: {
        address: "string",
        maintenanceWindows: [{
            cronSchedule: "string",
            requireIdleness: false,
        }],
        name: "string",
        tags: {
            string: "string",
        },
    },
    relay: {
        device: "string",
        gatewayFilter: "string",
        location: "string",
        maintenanceWindows: [{
            cronSchedule: "string",
            requireIdleness: false,
        }],
        name: "string",
        tags: {
            string: "string",
        },
        token: "string",
        version: "string",
    },
});
Copy
type: sdm:Node
properties:
    gateway:
        bindAddress: string
        device: string
        gatewayFilter: string
        listenAddress: string
        location: string
        maintenanceWindows:
            - cronSchedule: string
              requireIdleness: false
        name: string
        tags:
            string: string
        token: string
        version: string
    proxyCluster:
        address: string
        maintenanceWindows:
            - cronSchedule: string
              requireIdleness: false
        name: string
        tags:
            string: string
    relay:
        device: string
        gatewayFilter: string
        location: string
        maintenanceWindows:
            - cronSchedule: string
              requireIdleness: false
        name: string
        tags:
            string: string
        token: string
        version: string
Copy

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

Gateway PiersKarsenbarg.Sdm.Inputs.NodeGateway
Gateway represents a StrongDM CLI installation running in gateway mode.
ProxyCluster PiersKarsenbarg.Sdm.Inputs.NodeProxyCluster
ProxyCluster represents a cluster of StrongDM proxies.
Relay PiersKarsenbarg.Sdm.Inputs.NodeRelay
Relay represents a StrongDM CLI installation running in relay mode.
Gateway NodeGatewayArgs
Gateway represents a StrongDM CLI installation running in gateway mode.
ProxyCluster NodeProxyClusterArgs
ProxyCluster represents a cluster of StrongDM proxies.
Relay NodeRelayArgs
Relay represents a StrongDM CLI installation running in relay mode.
gateway NodeGateway
Gateway represents a StrongDM CLI installation running in gateway mode.
proxyCluster NodeProxyCluster
ProxyCluster represents a cluster of StrongDM proxies.
relay NodeRelay
Relay represents a StrongDM CLI installation running in relay mode.
gateway NodeGateway
Gateway represents a StrongDM CLI installation running in gateway mode.
proxyCluster NodeProxyCluster
ProxyCluster represents a cluster of StrongDM proxies.
relay NodeRelay
Relay represents a StrongDM CLI installation running in relay mode.
gateway NodeGatewayArgs
Gateway represents a StrongDM CLI installation running in gateway mode.
proxy_cluster NodeProxyClusterArgs
ProxyCluster represents a cluster of StrongDM proxies.
relay NodeRelayArgs
Relay represents a StrongDM CLI installation running in relay mode.
gateway Property Map
Gateway represents a StrongDM CLI installation running in gateway mode.
proxyCluster Property Map
ProxyCluster represents a cluster of StrongDM proxies.
relay Property Map
Relay represents a StrongDM CLI installation running in relay mode.

Outputs

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

Get an existing Node 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?: NodeState, opts?: CustomResourceOptions): Node
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        gateway: Optional[NodeGatewayArgs] = None,
        proxy_cluster: Optional[NodeProxyClusterArgs] = None,
        relay: Optional[NodeRelayArgs] = None) -> Node
func GetNode(ctx *Context, name string, id IDInput, state *NodeState, opts ...ResourceOption) (*Node, error)
public static Node Get(string name, Input<string> id, NodeState? state, CustomResourceOptions? opts = null)
public static Node get(String name, Output<String> id, NodeState state, CustomResourceOptions options)
resources:  _:    type: sdm:Node    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:
Gateway PiersKarsenbarg.Sdm.Inputs.NodeGateway
Gateway represents a StrongDM CLI installation running in gateway mode.
ProxyCluster PiersKarsenbarg.Sdm.Inputs.NodeProxyCluster
ProxyCluster represents a cluster of StrongDM proxies.
Relay PiersKarsenbarg.Sdm.Inputs.NodeRelay
Relay represents a StrongDM CLI installation running in relay mode.
Gateway NodeGatewayArgs
Gateway represents a StrongDM CLI installation running in gateway mode.
ProxyCluster NodeProxyClusterArgs
ProxyCluster represents a cluster of StrongDM proxies.
Relay NodeRelayArgs
Relay represents a StrongDM CLI installation running in relay mode.
gateway NodeGateway
Gateway represents a StrongDM CLI installation running in gateway mode.
proxyCluster NodeProxyCluster
ProxyCluster represents a cluster of StrongDM proxies.
relay NodeRelay
Relay represents a StrongDM CLI installation running in relay mode.
gateway NodeGateway
Gateway represents a StrongDM CLI installation running in gateway mode.
proxyCluster NodeProxyCluster
ProxyCluster represents a cluster of StrongDM proxies.
relay NodeRelay
Relay represents a StrongDM CLI installation running in relay mode.
gateway NodeGatewayArgs
Gateway represents a StrongDM CLI installation running in gateway mode.
proxy_cluster NodeProxyClusterArgs
ProxyCluster represents a cluster of StrongDM proxies.
relay NodeRelayArgs
Relay represents a StrongDM CLI installation running in relay mode.
gateway Property Map
Gateway represents a StrongDM CLI installation running in gateway mode.
proxyCluster Property Map
ProxyCluster represents a cluster of StrongDM proxies.
relay Property Map
Relay represents a StrongDM CLI installation running in relay mode.

Supporting Types

NodeGateway
, NodeGatewayArgs

ListenAddress
This property is required.
Changes to this property will trigger replacement.
string
The public hostname/port tuple at which the gateway will be accessible to clients.
BindAddress Changes to this property will trigger replacement. string
The hostname/port tuple which the gateway daemon will bind to. If not provided on create, set to "0.0.0.0:listen_address_port".
Device string
Device is a read only device name uploaded by the gateway process when it comes online.
GatewayFilter string
GatewayFilter can be used to restrict the peering between relays and gateways. Deprecated.
Location string
Location is a read only network location uploaded by the gateway process when it comes online.
MaintenanceWindows List<PiersKarsenbarg.Sdm.Inputs.NodeGatewayMaintenanceWindow>
Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.
Name string
Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
Tags Dictionary<string, string>
Tags is a map of key, value pairs.
Token string
Version string
Version is a read only sdm binary version uploaded by the gateway process when it comes online.
ListenAddress
This property is required.
Changes to this property will trigger replacement.
string
The public hostname/port tuple at which the gateway will be accessible to clients.
BindAddress Changes to this property will trigger replacement. string
The hostname/port tuple which the gateway daemon will bind to. If not provided on create, set to "0.0.0.0:listen_address_port".
Device string
Device is a read only device name uploaded by the gateway process when it comes online.
GatewayFilter string
GatewayFilter can be used to restrict the peering between relays and gateways. Deprecated.
Location string
Location is a read only network location uploaded by the gateway process when it comes online.
MaintenanceWindows []NodeGatewayMaintenanceWindow
Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.
Name string
Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
Tags map[string]string
Tags is a map of key, value pairs.
Token string
Version string
Version is a read only sdm binary version uploaded by the gateway process when it comes online.
listenAddress
This property is required.
Changes to this property will trigger replacement.
String
The public hostname/port tuple at which the gateway will be accessible to clients.
bindAddress Changes to this property will trigger replacement. String
The hostname/port tuple which the gateway daemon will bind to. If not provided on create, set to "0.0.0.0:listen_address_port".
device String
Device is a read only device name uploaded by the gateway process when it comes online.
gatewayFilter String
GatewayFilter can be used to restrict the peering between relays and gateways. Deprecated.
location String
Location is a read only network location uploaded by the gateway process when it comes online.
maintenanceWindows List<NodeGatewayMaintenanceWindow>
Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.
name String
Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
tags Map<String,String>
Tags is a map of key, value pairs.
token String
version String
Version is a read only sdm binary version uploaded by the gateway process when it comes online.
listenAddress
This property is required.
Changes to this property will trigger replacement.
string
The public hostname/port tuple at which the gateway will be accessible to clients.
bindAddress Changes to this property will trigger replacement. string
The hostname/port tuple which the gateway daemon will bind to. If not provided on create, set to "0.0.0.0:listen_address_port".
device string
Device is a read only device name uploaded by the gateway process when it comes online.
gatewayFilter string
GatewayFilter can be used to restrict the peering between relays and gateways. Deprecated.
location string
Location is a read only network location uploaded by the gateway process when it comes online.
maintenanceWindows NodeGatewayMaintenanceWindow[]
Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.
name string
Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
tags {[key: string]: string}
Tags is a map of key, value pairs.
token string
version string
Version is a read only sdm binary version uploaded by the gateway process when it comes online.
listen_address
This property is required.
Changes to this property will trigger replacement.
str
The public hostname/port tuple at which the gateway will be accessible to clients.
bind_address Changes to this property will trigger replacement. str
The hostname/port tuple which the gateway daemon will bind to. If not provided on create, set to "0.0.0.0:listen_address_port".
device str
Device is a read only device name uploaded by the gateway process when it comes online.
gateway_filter str
GatewayFilter can be used to restrict the peering between relays and gateways. Deprecated.
location str
Location is a read only network location uploaded by the gateway process when it comes online.
maintenance_windows Sequence[NodeGatewayMaintenanceWindow]
Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.
name str
Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
tags Mapping[str, str]
Tags is a map of key, value pairs.
token str
version str
Version is a read only sdm binary version uploaded by the gateway process when it comes online.
listenAddress
This property is required.
Changes to this property will trigger replacement.
String
The public hostname/port tuple at which the gateway will be accessible to clients.
bindAddress Changes to this property will trigger replacement. String
The hostname/port tuple which the gateway daemon will bind to. If not provided on create, set to "0.0.0.0:listen_address_port".
device String
Device is a read only device name uploaded by the gateway process when it comes online.
gatewayFilter String
GatewayFilter can be used to restrict the peering between relays and gateways. Deprecated.
location String
Location is a read only network location uploaded by the gateway process when it comes online.
maintenanceWindows List<Property Map>
Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.
name String
Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
tags Map<String>
Tags is a map of key, value pairs.
token String
version String
Version is a read only sdm binary version uploaded by the gateway process when it comes online.

NodeGatewayMaintenanceWindow
, NodeGatewayMaintenanceWindowArgs

CronSchedule This property is required. string
RequireIdleness This property is required. bool
CronSchedule This property is required. string
RequireIdleness This property is required. bool
cronSchedule This property is required. String
requireIdleness This property is required. Boolean
cronSchedule This property is required. string
requireIdleness This property is required. boolean
cron_schedule This property is required. str
require_idleness This property is required. bool
cronSchedule This property is required. String
requireIdleness This property is required. Boolean

NodeProxyCluster
, NodeProxyClusterArgs

Address This property is required. string
The public hostname/port tuple at which the proxy cluster will be accessible to clients.
MaintenanceWindows List<PiersKarsenbarg.Sdm.Inputs.NodeProxyClusterMaintenanceWindow>
Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.
Name string
Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
Tags Dictionary<string, string>
Tags is a map of key, value pairs.
Address This property is required. string
The public hostname/port tuple at which the proxy cluster will be accessible to clients.
MaintenanceWindows []NodeProxyClusterMaintenanceWindow
Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.
Name string
Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
Tags map[string]string
Tags is a map of key, value pairs.
address This property is required. String
The public hostname/port tuple at which the proxy cluster will be accessible to clients.
maintenanceWindows List<NodeProxyClusterMaintenanceWindow>
Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.
name String
Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
tags Map<String,String>
Tags is a map of key, value pairs.
address This property is required. string
The public hostname/port tuple at which the proxy cluster will be accessible to clients.
maintenanceWindows NodeProxyClusterMaintenanceWindow[]
Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.
name string
Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
tags {[key: string]: string}
Tags is a map of key, value pairs.
address This property is required. str
The public hostname/port tuple at which the proxy cluster will be accessible to clients.
maintenance_windows Sequence[NodeProxyClusterMaintenanceWindow]
Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.
name str
Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
tags Mapping[str, str]
Tags is a map of key, value pairs.
address This property is required. String
The public hostname/port tuple at which the proxy cluster will be accessible to clients.
maintenanceWindows List<Property Map>
Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.
name String
Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
tags Map<String>
Tags is a map of key, value pairs.

NodeProxyClusterMaintenanceWindow
, NodeProxyClusterMaintenanceWindowArgs

CronSchedule This property is required. string
RequireIdleness This property is required. bool
CronSchedule This property is required. string
RequireIdleness This property is required. bool
cronSchedule This property is required. String
requireIdleness This property is required. Boolean
cronSchedule This property is required. string
requireIdleness This property is required. boolean
cron_schedule This property is required. str
require_idleness This property is required. bool
cronSchedule This property is required. String
requireIdleness This property is required. Boolean

NodeRelay
, NodeRelayArgs

Device string
Device is a read only device name uploaded by the gateway process when it comes online.
GatewayFilter string
GatewayFilter can be used to restrict the peering between relays and gateways. Deprecated.
Location string
Location is a read only network location uploaded by the gateway process when it comes online.
MaintenanceWindows List<PiersKarsenbarg.Sdm.Inputs.NodeRelayMaintenanceWindow>
Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.
Name string
Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
Tags Dictionary<string, string>
Tags is a map of key, value pairs.
Token string
Version string
Version is a read only sdm binary version uploaded by the gateway process when it comes online.
Device string
Device is a read only device name uploaded by the gateway process when it comes online.
GatewayFilter string
GatewayFilter can be used to restrict the peering between relays and gateways. Deprecated.
Location string
Location is a read only network location uploaded by the gateway process when it comes online.
MaintenanceWindows []NodeRelayMaintenanceWindow
Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.
Name string
Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
Tags map[string]string
Tags is a map of key, value pairs.
Token string
Version string
Version is a read only sdm binary version uploaded by the gateway process when it comes online.
device String
Device is a read only device name uploaded by the gateway process when it comes online.
gatewayFilter String
GatewayFilter can be used to restrict the peering between relays and gateways. Deprecated.
location String
Location is a read only network location uploaded by the gateway process when it comes online.
maintenanceWindows List<NodeRelayMaintenanceWindow>
Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.
name String
Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
tags Map<String,String>
Tags is a map of key, value pairs.
token String
version String
Version is a read only sdm binary version uploaded by the gateway process when it comes online.
device string
Device is a read only device name uploaded by the gateway process when it comes online.
gatewayFilter string
GatewayFilter can be used to restrict the peering between relays and gateways. Deprecated.
location string
Location is a read only network location uploaded by the gateway process when it comes online.
maintenanceWindows NodeRelayMaintenanceWindow[]
Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.
name string
Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
tags {[key: string]: string}
Tags is a map of key, value pairs.
token string
version string
Version is a read only sdm binary version uploaded by the gateway process when it comes online.
device str
Device is a read only device name uploaded by the gateway process when it comes online.
gateway_filter str
GatewayFilter can be used to restrict the peering between relays and gateways. Deprecated.
location str
Location is a read only network location uploaded by the gateway process when it comes online.
maintenance_windows Sequence[NodeRelayMaintenanceWindow]
Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.
name str
Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
tags Mapping[str, str]
Tags is a map of key, value pairs.
token str
version str
Version is a read only sdm binary version uploaded by the gateway process when it comes online.
device String
Device is a read only device name uploaded by the gateway process when it comes online.
gatewayFilter String
GatewayFilter can be used to restrict the peering between relays and gateways. Deprecated.
location String
Location is a read only network location uploaded by the gateway process when it comes online.
maintenanceWindows List<Property Map>
Maintenance Windows define when this node is allowed to restart. If a node is requested to restart, it will check each window to determine if any of them permit it to restart, and if any do, it will. This check is repeated per window until the restart is successfully completed. If not set here, may be set on the command line or via an environment variable on the process itself; any server setting will take precedence over local settings. This setting is ineffective for nodes below version 38.44.0. If this setting is not applied via this remote configuration or via local configuration, the default setting is used: always allow restarts if serving no connections, and allow a restart even if serving connections between 7-8 UTC, any day.
name String
Unique human-readable name of the Relay. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.
tags Map<String>
Tags is a map of key, value pairs.
token String
version String
Version is a read only sdm binary version uploaded by the gateway process when it comes online.

NodeRelayMaintenanceWindow
, NodeRelayMaintenanceWindowArgs

CronSchedule This property is required. string
RequireIdleness This property is required. bool
CronSchedule This property is required. string
RequireIdleness This property is required. bool
cronSchedule This property is required. String
requireIdleness This property is required. Boolean
cronSchedule This property is required. string
requireIdleness This property is required. boolean
cron_schedule This property is required. str
require_idleness This property is required. bool
cronSchedule This property is required. String
requireIdleness This property is required. Boolean

Import

A Node can be imported using the id, e.g.,

$ pulumi import sdm:index/node:Node example n-12345678
Copy

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

Package Details

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