published on Monday, Apr 13, 2026 by Twingate
published on Monday, Apr 13, 2026 by Twingate
Generates a Gateway configuration YAML from SSH and Kubernetes resources.
Create TwingateGatewayConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new TwingateGatewayConfig(name: string, args?: TwingateGatewayConfigArgs, opts?: CustomResourceOptions);@overload
def TwingateGatewayConfig(resource_name: str,
args: Optional[TwingateGatewayConfigArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def TwingateGatewayConfig(resource_name: str,
opts: Optional[ResourceOptions] = None,
kubernetes: Optional[TwingateGatewayConfigKubernetesArgs] = None,
metrics_port: Optional[int] = None,
port: Optional[int] = None,
ssh: Optional[TwingateGatewayConfigSshArgs] = None,
tls: Optional[TwingateGatewayConfigTlsArgs] = None)func NewTwingateGatewayConfig(ctx *Context, name string, args *TwingateGatewayConfigArgs, opts ...ResourceOption) (*TwingateGatewayConfig, error)public TwingateGatewayConfig(string name, TwingateGatewayConfigArgs? args = null, CustomResourceOptions? opts = null)
public TwingateGatewayConfig(String name, TwingateGatewayConfigArgs args)
public TwingateGatewayConfig(String name, TwingateGatewayConfigArgs args, CustomResourceOptions options)
type: twingate:TwingateGatewayConfig
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 TwingateGatewayConfigArgs
- 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 TwingateGatewayConfigArgs
- 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 TwingateGatewayConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TwingateGatewayConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TwingateGatewayConfigArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
TwingateGatewayConfig 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 TwingateGatewayConfig resource accepts the following input properties:
- Kubernetes
Twingate.
Twingate. Inputs. Twingate Gateway Config Kubernetes - Kubernetes configuration block containing resource settings.
- Metrics
Port int - Gateway metrics port. Default: 9090.
- Port int
- Gateway listen port. Default: 8443.
- Ssh
Twingate.
Twingate. Inputs. Twingate Gateway Config Ssh - SSH configuration block containing gateway, CA, and resource settings.
- Tls
Twingate.
Twingate. Inputs. Twingate Gateway Config Tls - TLS configuration for the gateway.
- Kubernetes
Twingate
Gateway Config Kubernetes Args - Kubernetes configuration block containing resource settings.
- Metrics
Port int - Gateway metrics port. Default: 9090.
- Port int
- Gateway listen port. Default: 8443.
- Ssh
Twingate
Gateway Config Ssh Args - SSH configuration block containing gateway, CA, and resource settings.
- Tls
Twingate
Gateway Config Tls Args - TLS configuration for the gateway.
- kubernetes
Twingate
Gateway Config Kubernetes - Kubernetes configuration block containing resource settings.
- metrics
Port Integer - Gateway metrics port. Default: 9090.
- port Integer
- Gateway listen port. Default: 8443.
- ssh
Twingate
Gateway Config Ssh - SSH configuration block containing gateway, CA, and resource settings.
- tls
Twingate
Gateway Config Tls - TLS configuration for the gateway.
- kubernetes
Twingate
Gateway Config Kubernetes - Kubernetes configuration block containing resource settings.
- metrics
Port number - Gateway metrics port. Default: 9090.
- port number
- Gateway listen port. Default: 8443.
- ssh
Twingate
Gateway Config Ssh - SSH configuration block containing gateway, CA, and resource settings.
- tls
Twingate
Gateway Config Tls - TLS configuration for the gateway.
- kubernetes
Twingate
Gateway Config Kubernetes Args - Kubernetes configuration block containing resource settings.
- metrics_
port int - Gateway metrics port. Default: 9090.
- port int
- Gateway listen port. Default: 8443.
- ssh
Twingate
Gateway Config Ssh Args - SSH configuration block containing gateway, CA, and resource settings.
- tls
Twingate
Gateway Config Tls Args - TLS configuration for the gateway.
- kubernetes Property Map
- Kubernetes configuration block containing resource settings.
- metrics
Port Number - Gateway metrics port. Default: 9090.
- port Number
- Gateway listen port. Default: 8443.
- ssh Property Map
- SSH configuration block containing gateway, CA, and resource settings.
- tls Property Map
- TLS configuration for the gateway.
Outputs
All input properties are implicitly available as output properties. Additionally, the TwingateGatewayConfig resource produces the following output properties:
Look up Existing TwingateGatewayConfig Resource
Get an existing TwingateGatewayConfig 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?: TwingateGatewayConfigState, opts?: CustomResourceOptions): TwingateGatewayConfig@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
content: Optional[str] = None,
kubernetes: Optional[TwingateGatewayConfigKubernetesArgs] = None,
metrics_port: Optional[int] = None,
port: Optional[int] = None,
ssh: Optional[TwingateGatewayConfigSshArgs] = None,
tls: Optional[TwingateGatewayConfigTlsArgs] = None) -> TwingateGatewayConfigfunc GetTwingateGatewayConfig(ctx *Context, name string, id IDInput, state *TwingateGatewayConfigState, opts ...ResourceOption) (*TwingateGatewayConfig, error)public static TwingateGatewayConfig Get(string name, Input<string> id, TwingateGatewayConfigState? state, CustomResourceOptions? opts = null)public static TwingateGatewayConfig get(String name, Output<String> id, TwingateGatewayConfigState state, CustomResourceOptions options)resources: _: type: twingate:TwingateGatewayConfig get: id: ${id}- 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.
- Content string
- The generated YAML configuration content.
- Kubernetes
Twingate.
Twingate. Inputs. Twingate Gateway Config Kubernetes - Kubernetes configuration block containing resource settings.
- Metrics
Port int - Gateway metrics port. Default: 9090.
- Port int
- Gateway listen port. Default: 8443.
- Ssh
Twingate.
Twingate. Inputs. Twingate Gateway Config Ssh - SSH configuration block containing gateway, CA, and resource settings.
- Tls
Twingate.
Twingate. Inputs. Twingate Gateway Config Tls - TLS configuration for the gateway.
- Content string
- The generated YAML configuration content.
- Kubernetes
Twingate
Gateway Config Kubernetes Args - Kubernetes configuration block containing resource settings.
- Metrics
Port int - Gateway metrics port. Default: 9090.
- Port int
- Gateway listen port. Default: 8443.
- Ssh
Twingate
Gateway Config Ssh Args - SSH configuration block containing gateway, CA, and resource settings.
- Tls
Twingate
Gateway Config Tls Args - TLS configuration for the gateway.
- content String
- The generated YAML configuration content.
- kubernetes
Twingate
Gateway Config Kubernetes - Kubernetes configuration block containing resource settings.
- metrics
Port Integer - Gateway metrics port. Default: 9090.
- port Integer
- Gateway listen port. Default: 8443.
- ssh
Twingate
Gateway Config Ssh - SSH configuration block containing gateway, CA, and resource settings.
- tls
Twingate
Gateway Config Tls - TLS configuration for the gateway.
- content string
- The generated YAML configuration content.
- kubernetes
Twingate
Gateway Config Kubernetes - Kubernetes configuration block containing resource settings.
- metrics
Port number - Gateway metrics port. Default: 9090.
- port number
- Gateway listen port. Default: 8443.
- ssh
Twingate
Gateway Config Ssh - SSH configuration block containing gateway, CA, and resource settings.
- tls
Twingate
Gateway Config Tls - TLS configuration for the gateway.
- content str
- The generated YAML configuration content.
- kubernetes
Twingate
Gateway Config Kubernetes Args - Kubernetes configuration block containing resource settings.
- metrics_
port int - Gateway metrics port. Default: 9090.
- port int
- Gateway listen port. Default: 8443.
- ssh
Twingate
Gateway Config Ssh Args - SSH configuration block containing gateway, CA, and resource settings.
- tls
Twingate
Gateway Config Tls Args - TLS configuration for the gateway.
- content String
- The generated YAML configuration content.
- kubernetes Property Map
- Kubernetes configuration block containing resource settings.
- metrics
Port Number - Gateway metrics port. Default: 9090.
- port Number
- Gateway listen port. Default: 8443.
- ssh Property Map
- SSH configuration block containing gateway, CA, and resource settings.
- tls Property Map
- TLS configuration for the gateway.
Supporting Types
TwingateGatewayConfigKubernetes, TwingateGatewayConfigKubernetesArgs
- Resources
List<Twingate.
Twingate. Inputs. Twingate Gateway Config Kubernetes Resource> - List of Kubernetes resources. Accepts full twingatekubernetesresource references.
- Resources
[]Twingate
Gateway Config Kubernetes Resource - List of Kubernetes resources. Accepts full twingatekubernetesresource references.
- resources
List<Twingate
Gateway Config Kubernetes Resource> - List of Kubernetes resources. Accepts full twingatekubernetesresource references.
- resources
Twingate
Gateway Config Kubernetes Resource[] - List of Kubernetes resources. Accepts full twingatekubernetesresource references.
- resources
Sequence[Twingate
Gateway Config Kubernetes Resource] - List of Kubernetes resources. Accepts full twingatekubernetesresource references.
- resources List<Property Map>
- List of Kubernetes resources. Accepts full twingatekubernetesresource references.
TwingateGatewayConfigKubernetesResource, TwingateGatewayConfigKubernetesResourceArgs
- address str
- in_
cluster bool - name str
TwingateGatewayConfigSsh, TwingateGatewayConfigSshArgs
- Ca
Twingate.
Twingate. Inputs. Twingate Gateway Config Ssh Ca - SSH CA configuration. Specify either vault.address or privatekeyfile, not both.
- Gateway
Twingate.
Twingate. Inputs. Twingate Gateway Config Ssh Gateway - SSH gateway settings. All fields are optional and fall back to built-in defaults.
- Resources
List<Twingate.
Twingate. Inputs. Twingate Gateway Config Ssh Resource> - List of SSH resources. Accepts full twingatesshresource references.
- Ca
Twingate
Gateway Config Ssh Ca - SSH CA configuration. Specify either vault.address or privatekeyfile, not both.
- Gateway
Twingate
Gateway Config Ssh Gateway - SSH gateway settings. All fields are optional and fall back to built-in defaults.
- Resources
[]Twingate
Gateway Config Ssh Resource - List of SSH resources. Accepts full twingatesshresource references.
- ca
Twingate
Gateway Config Ssh Ca - SSH CA configuration. Specify either vault.address or privatekeyfile, not both.
- gateway
Twingate
Gateway Config Ssh Gateway - SSH gateway settings. All fields are optional and fall back to built-in defaults.
- resources
List<Twingate
Gateway Config Ssh Resource> - List of SSH resources. Accepts full twingatesshresource references.
- ca
Twingate
Gateway Config Ssh Ca - SSH CA configuration. Specify either vault.address or privatekeyfile, not both.
- gateway
Twingate
Gateway Config Ssh Gateway - SSH gateway settings. All fields are optional and fall back to built-in defaults.
- resources
Twingate
Gateway Config Ssh Resource[] - List of SSH resources. Accepts full twingatesshresource references.
- ca
Twingate
Gateway Config Ssh Ca - SSH CA configuration. Specify either vault.address or privatekeyfile, not both.
- gateway
Twingate
Gateway Config Ssh Gateway - SSH gateway settings. All fields are optional and fall back to built-in defaults.
- resources
Sequence[Twingate
Gateway Config Ssh Resource] - List of SSH resources. Accepts full twingatesshresource references.
- ca Property Map
- SSH CA configuration. Specify either vault.address or privatekeyfile, not both.
- gateway Property Map
- SSH gateway settings. All fields are optional and fall back to built-in defaults.
- resources List<Property Map>
- List of SSH resources. Accepts full twingatesshresource references.
TwingateGatewayConfigSshCa, TwingateGatewayConfigSshCaArgs
- Private
Key stringFile - Path to the SSH CA private key file. Can't be used together with vault.address.
- Vault
Twingate.
Twingate. Inputs. Twingate Gateway Config Ssh Ca Vault - Vault SSH CA configuration.
- Private
Key stringFile - Path to the SSH CA private key file. Can't be used together with vault.address.
- Vault
Twingate
Gateway Config Ssh Ca Vault - Vault SSH CA configuration.
- private
Key StringFile - Path to the SSH CA private key file. Can't be used together with vault.address.
- vault
Twingate
Gateway Config Ssh Ca Vault - Vault SSH CA configuration.
- private
Key stringFile - Path to the SSH CA private key file. Can't be used together with vault.address.
- vault
Twingate
Gateway Config Ssh Ca Vault - Vault SSH CA configuration.
- private_
key_ strfile - Path to the SSH CA private key file. Can't be used together with vault.address.
- vault
Twingate
Gateway Config Ssh Ca Vault - Vault SSH CA configuration.
- private
Key StringFile - Path to the SSH CA private key file. Can't be used together with vault.address.
- vault Property Map
- Vault SSH CA configuration.
TwingateGatewayConfigSshCaVault, TwingateGatewayConfigSshCaVaultArgs
- Address string
- Vault server address. Can't be used together with ca.privatekeyfile.
- Auth
Twingate.
Twingate. Inputs. Twingate Gateway Config Ssh Ca Vault Auth - Vault authentication configuration.
- Ca
Bundle stringFile - Path to the Vault CA bundle file. Default: "/etc/ssl/vault-ca.crt".
- Mount string
- Vault SSH secrets engine mount path. Default: "ssh".
- Role string
- Vault role for signing certificates. Default: "gateway".
- Address string
- Vault server address. Can't be used together with ca.privatekeyfile.
- Auth
Twingate
Gateway Config Ssh Ca Vault Auth - Vault authentication configuration.
- Ca
Bundle stringFile - Path to the Vault CA bundle file. Default: "/etc/ssl/vault-ca.crt".
- Mount string
- Vault SSH secrets engine mount path. Default: "ssh".
- Role string
- Vault role for signing certificates. Default: "gateway".
- address String
- Vault server address. Can't be used together with ca.privatekeyfile.
- auth
Twingate
Gateway Config Ssh Ca Vault Auth - Vault authentication configuration.
- ca
Bundle StringFile - Path to the Vault CA bundle file. Default: "/etc/ssl/vault-ca.crt".
- mount String
- Vault SSH secrets engine mount path. Default: "ssh".
- role String
- Vault role for signing certificates. Default: "gateway".
- address string
- Vault server address. Can't be used together with ca.privatekeyfile.
- auth
Twingate
Gateway Config Ssh Ca Vault Auth - Vault authentication configuration.
- ca
Bundle stringFile - Path to the Vault CA bundle file. Default: "/etc/ssl/vault-ca.crt".
- mount string
- Vault SSH secrets engine mount path. Default: "ssh".
- role string
- Vault role for signing certificates. Default: "gateway".
- address str
- Vault server address. Can't be used together with ca.privatekeyfile.
- auth
Twingate
Gateway Config Ssh Ca Vault Auth - Vault authentication configuration.
- ca_
bundle_ strfile - Path to the Vault CA bundle file. Default: "/etc/ssl/vault-ca.crt".
- mount str
- Vault SSH secrets engine mount path. Default: "ssh".
- role str
- Vault role for signing certificates. Default: "gateway".
- address String
- Vault server address. Can't be used together with ca.privatekeyfile.
- auth Property Map
- Vault authentication configuration.
- ca
Bundle StringFile - Path to the Vault CA bundle file. Default: "/etc/ssl/vault-ca.crt".
- mount String
- Vault SSH secrets engine mount path. Default: "ssh".
- role String
- Vault role for signing certificates. Default: "gateway".
TwingateGatewayConfigSshCaVaultAuth, TwingateGatewayConfigSshCaVaultAuthArgs
- Gcp
Twingate.
Twingate. Inputs. Twingate Gateway Config Ssh Ca Vault Auth Gcp - GCP authentication for Vault. Can't be used together with token.
- Token string
- Vault token used for authentication. Can't be used together with gcp.
- Gcp
Twingate
Gateway Config Ssh Ca Vault Auth Gcp - GCP authentication for Vault. Can't be used together with token.
- Token string
- Vault token used for authentication. Can't be used together with gcp.
- gcp
Twingate
Gateway Config Ssh Ca Vault Auth Gcp - GCP authentication for Vault. Can't be used together with token.
- token String
- Vault token used for authentication. Can't be used together with gcp.
- gcp
Twingate
Gateway Config Ssh Ca Vault Auth Gcp - GCP authentication for Vault. Can't be used together with token.
- token string
- Vault token used for authentication. Can't be used together with gcp.
- gcp
Twingate
Gateway Config Ssh Ca Vault Auth Gcp - GCP authentication for Vault. Can't be used together with token.
- token str
- Vault token used for authentication. Can't be used together with gcp.
- gcp Property Map
- GCP authentication for Vault. Can't be used together with token.
- token String
- Vault token used for authentication. Can't be used together with gcp.
TwingateGatewayConfigSshCaVaultAuthGcp, TwingateGatewayConfigSshCaVaultAuthGcpArgs
- Mount string
- Vault GCP auth mount path. Default: "gcp".
- Role string
- GCP IAM role for Vault GCP authentication.
- Service
Account stringEmail - Service account email. Required when type is "iam".
- Type string
- GCP authentication type for Vault (e.g. "iam" or "gce"). When set to "iam", serviceaccountemail is required.
- Mount string
- Vault GCP auth mount path. Default: "gcp".
- Role string
- GCP IAM role for Vault GCP authentication.
- Service
Account stringEmail - Service account email. Required when type is "iam".
- Type string
- GCP authentication type for Vault (e.g. "iam" or "gce"). When set to "iam", serviceaccountemail is required.
- mount String
- Vault GCP auth mount path. Default: "gcp".
- role String
- GCP IAM role for Vault GCP authentication.
- service
Account StringEmail - Service account email. Required when type is "iam".
- type String
- GCP authentication type for Vault (e.g. "iam" or "gce"). When set to "iam", serviceaccountemail is required.
- mount string
- Vault GCP auth mount path. Default: "gcp".
- role string
- GCP IAM role for Vault GCP authentication.
- service
Account stringEmail - Service account email. Required when type is "iam".
- type string
- GCP authentication type for Vault (e.g. "iam" or "gce"). When set to "iam", serviceaccountemail is required.
- mount str
- Vault GCP auth mount path. Default: "gcp".
- role str
- GCP IAM role for Vault GCP authentication.
- service_
account_ stremail - Service account email. Required when type is "iam".
- type str
- GCP authentication type for Vault (e.g. "iam" or "gce"). When set to "iam", serviceaccountemail is required.
- mount String
- Vault GCP auth mount path. Default: "gcp".
- role String
- GCP IAM role for Vault GCP authentication.
- service
Account StringEmail - Service account email. Required when type is "iam".
- type String
- GCP authentication type for Vault (e.g. "iam" or "gce"). When set to "iam", serviceaccountemail is required.
TwingateGatewayConfigSshGateway, TwingateGatewayConfigSshGatewayArgs
- Host
Cert stringTtl - Host certificate TTL. Default: "24h".
- Key
Type string - SSH key type. Default: "ed25519".
- User
Cert stringTtl - User certificate TTL. Default: "5m".
- Username string
- SSH gateway username. Default: "gateway".
- Host
Cert stringTtl - Host certificate TTL. Default: "24h".
- Key
Type string - SSH key type. Default: "ed25519".
- User
Cert stringTtl - User certificate TTL. Default: "5m".
- Username string
- SSH gateway username. Default: "gateway".
- host
Cert StringTtl - Host certificate TTL. Default: "24h".
- key
Type String - SSH key type. Default: "ed25519".
- user
Cert StringTtl - User certificate TTL. Default: "5m".
- username String
- SSH gateway username. Default: "gateway".
- host
Cert stringTtl - Host certificate TTL. Default: "24h".
- key
Type string - SSH key type. Default: "ed25519".
- user
Cert stringTtl - User certificate TTL. Default: "5m".
- username string
- SSH gateway username. Default: "gateway".
- host_
cert_ strttl - Host certificate TTL. Default: "24h".
- key_
type str - SSH key type. Default: "ed25519".
- user_
cert_ strttl - User certificate TTL. Default: "5m".
- username str
- SSH gateway username. Default: "gateway".
- host
Cert StringTtl - Host certificate TTL. Default: "24h".
- key
Type String - SSH key type. Default: "ed25519".
- user
Cert StringTtl - User certificate TTL. Default: "5m".
- username String
- SSH gateway username. Default: "gateway".
TwingateGatewayConfigSshResource, TwingateGatewayConfigSshResourceArgs
TwingateGatewayConfigTls, TwingateGatewayConfigTlsArgs
- Certificate
File string - Path to the TLS certificate file. Default: "/etc/gateway/tls.crt".
- Private
Key stringFile - Path to the TLS private key file. Default: "/etc/gateway/tls.key".
- Certificate
File string - Path to the TLS certificate file. Default: "/etc/gateway/tls.crt".
- Private
Key stringFile - Path to the TLS private key file. Default: "/etc/gateway/tls.key".
- certificate
File String - Path to the TLS certificate file. Default: "/etc/gateway/tls.crt".
- private
Key StringFile - Path to the TLS private key file. Default: "/etc/gateway/tls.key".
- certificate
File string - Path to the TLS certificate file. Default: "/etc/gateway/tls.crt".
- private
Key stringFile - Path to the TLS private key file. Default: "/etc/gateway/tls.key".
- certificate_
file str - Path to the TLS certificate file. Default: "/etc/gateway/tls.crt".
- private_
key_ strfile - Path to the TLS private key file. Default: "/etc/gateway/tls.key".
- certificate
File String - Path to the TLS certificate file. Default: "/etc/gateway/tls.crt".
- private
Key StringFile - Path to the TLS private key file. Default: "/etc/gateway/tls.key".
Package Details
- Repository
- twingate Twingate/pulumi-twingate
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
twingateTerraform Provider.
published on Monday, Apr 13, 2026 by Twingate
