Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Twingate
  3. API Docs
  4. Provider
Twingate v3.5.0 published on Monday, Sep 22, 2025 by Twingate
twingate/pulumi-twingate

twingate.Provider

Explore with Pulumi AI

twingate logo
Twingate v3.5.0 published on Monday, Sep 22, 2025 by Twingate
twingate/pulumi-twingate

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

    Create Provider Resource

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

    Constructor syntax

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

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             api_token: Optional[str] = None,
             cache: Optional[ProviderCacheArgs] = None,
             default_tags: Optional[ProviderDefaultTagsArgs] = None,
             http_max_retry: Optional[int] = None,
             http_timeout: Optional[int] = None,
             network: Optional[str] = None,
             url: Optional[str] = None)
    func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

    type: pulumi:providers:twingate
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 ProviderArgs
    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 ProviderArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Provider Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Provider resource accepts the following input properties:

    ApiToken string
    The access key for API operations. You can retrieve this from the Twingate Admin Console (documentation). Alternatively, this can be specified using the TWINGATE_API_TOKEN environment variable.
    Cache Twingate.Twingate.Inputs.ProviderCache
    Specifies the cache settings for the provider.
    DefaultTags Twingate.Twingate.Inputs.ProviderDefaultTags
    A default set of tags applied globally to all resources created by the provider.
    HttpMaxRetry int
    Specifies a retry limit for the http requests made. The default value is 10. Alternatively, this can be specified using the TWINGATE_HTTP_MAX_RETRY environment variable
    HttpTimeout int
    Specifies a time limit in seconds for the http requests made. The default value is 35 seconds. Alternatively, this can be specified using the TWINGATE_HTTP_TIMEOUT environment variable
    Network string
    Your Twingate network ID for API operations. You can find it in the Admin Console URL, for example: autoco.twingate.com, where autoco is your network ID Alternatively, this can be specified using the TWINGATE_NETWORK environment variable.
    Url string
    The default is 'twingate.com' This is optional and shouldn't be changed under normal circumstances.
    ApiToken string
    The access key for API operations. You can retrieve this from the Twingate Admin Console (documentation). Alternatively, this can be specified using the TWINGATE_API_TOKEN environment variable.
    Cache ProviderCacheArgs
    Specifies the cache settings for the provider.
    DefaultTags ProviderDefaultTagsArgs
    A default set of tags applied globally to all resources created by the provider.
    HttpMaxRetry int
    Specifies a retry limit for the http requests made. The default value is 10. Alternatively, this can be specified using the TWINGATE_HTTP_MAX_RETRY environment variable
    HttpTimeout int
    Specifies a time limit in seconds for the http requests made. The default value is 35 seconds. Alternatively, this can be specified using the TWINGATE_HTTP_TIMEOUT environment variable
    Network string
    Your Twingate network ID for API operations. You can find it in the Admin Console URL, for example: autoco.twingate.com, where autoco is your network ID Alternatively, this can be specified using the TWINGATE_NETWORK environment variable.
    Url string
    The default is 'twingate.com' This is optional and shouldn't be changed under normal circumstances.
    apiToken String
    The access key for API operations. You can retrieve this from the Twingate Admin Console (documentation). Alternatively, this can be specified using the TWINGATE_API_TOKEN environment variable.
    cache ProviderCache
    Specifies the cache settings for the provider.
    defaultTags ProviderDefaultTags
    A default set of tags applied globally to all resources created by the provider.
    httpMaxRetry Integer
    Specifies a retry limit for the http requests made. The default value is 10. Alternatively, this can be specified using the TWINGATE_HTTP_MAX_RETRY environment variable
    httpTimeout Integer
    Specifies a time limit in seconds for the http requests made. The default value is 35 seconds. Alternatively, this can be specified using the TWINGATE_HTTP_TIMEOUT environment variable
    network String
    Your Twingate network ID for API operations. You can find it in the Admin Console URL, for example: autoco.twingate.com, where autoco is your network ID Alternatively, this can be specified using the TWINGATE_NETWORK environment variable.
    url String
    The default is 'twingate.com' This is optional and shouldn't be changed under normal circumstances.
    apiToken string
    The access key for API operations. You can retrieve this from the Twingate Admin Console (documentation). Alternatively, this can be specified using the TWINGATE_API_TOKEN environment variable.
    cache ProviderCache
    Specifies the cache settings for the provider.
    defaultTags ProviderDefaultTags
    A default set of tags applied globally to all resources created by the provider.
    httpMaxRetry number
    Specifies a retry limit for the http requests made. The default value is 10. Alternatively, this can be specified using the TWINGATE_HTTP_MAX_RETRY environment variable
    httpTimeout number
    Specifies a time limit in seconds for the http requests made. The default value is 35 seconds. Alternatively, this can be specified using the TWINGATE_HTTP_TIMEOUT environment variable
    network string
    Your Twingate network ID for API operations. You can find it in the Admin Console URL, for example: autoco.twingate.com, where autoco is your network ID Alternatively, this can be specified using the TWINGATE_NETWORK environment variable.
    url string
    The default is 'twingate.com' This is optional and shouldn't be changed under normal circumstances.
    api_token str
    The access key for API operations. You can retrieve this from the Twingate Admin Console (documentation). Alternatively, this can be specified using the TWINGATE_API_TOKEN environment variable.
    cache ProviderCacheArgs
    Specifies the cache settings for the provider.
    default_tags ProviderDefaultTagsArgs
    A default set of tags applied globally to all resources created by the provider.
    http_max_retry int
    Specifies a retry limit for the http requests made. The default value is 10. Alternatively, this can be specified using the TWINGATE_HTTP_MAX_RETRY environment variable
    http_timeout int
    Specifies a time limit in seconds for the http requests made. The default value is 35 seconds. Alternatively, this can be specified using the TWINGATE_HTTP_TIMEOUT environment variable
    network str
    Your Twingate network ID for API operations. You can find it in the Admin Console URL, for example: autoco.twingate.com, where autoco is your network ID Alternatively, this can be specified using the TWINGATE_NETWORK environment variable.
    url str
    The default is 'twingate.com' This is optional and shouldn't be changed under normal circumstances.
    apiToken String
    The access key for API operations. You can retrieve this from the Twingate Admin Console (documentation). Alternatively, this can be specified using the TWINGATE_API_TOKEN environment variable.
    cache Property Map
    Specifies the cache settings for the provider.
    defaultTags Property Map
    A default set of tags applied globally to all resources created by the provider.
    httpMaxRetry Number
    Specifies a retry limit for the http requests made. The default value is 10. Alternatively, this can be specified using the TWINGATE_HTTP_MAX_RETRY environment variable
    httpTimeout Number
    Specifies a time limit in seconds for the http requests made. The default value is 35 seconds. Alternatively, this can be specified using the TWINGATE_HTTP_TIMEOUT environment variable
    network String
    Your Twingate network ID for API operations. You can find it in the Admin Console URL, for example: autoco.twingate.com, where autoco is your network ID Alternatively, this can be specified using the TWINGATE_NETWORK environment variable.
    url String
    The default is 'twingate.com' This is optional and shouldn't be changed under normal circumstances.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Provider Resource Methods

    TerraformConfig Method

    This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.

    Using TerraformConfig

    terraformConfig(): Output<Provider.TerraformConfigResult>
    def terraform_config() -> Output[Provider.Terraform_configResult]
    func (r *Provider) TerraformConfig() (ProviderTerraformConfigResultOutput, error)
    public Output<Provider.TerraformConfigResult> TerraformConfig()

    TerraformConfig Result

    Result Dictionary<string, object>
    Result map[string]interface{}
    result Map<String,Object>
    result {[key: string]: any}
    result Mapping[str, Any]
    result Map<Any>

    Supporting Types

    ProviderCache, ProviderCacheArgs

    GroupsEnabled bool
    Specifies whether the provider should cache groups. The default value is true.
    GroupsFilter Twingate.Twingate.Inputs.ProviderCacheGroupsFilter
    Specifies the filter for the groups to be cached.
    ResourceEnabled bool
    Specifies whether the provider should cache resources. The default value is true.
    ResourcesFilter Twingate.Twingate.Inputs.ProviderCacheResourcesFilter
    Specifies the filter for the resources to be cached.
    GroupsEnabled bool
    Specifies whether the provider should cache groups. The default value is true.
    GroupsFilter ProviderCacheGroupsFilter
    Specifies the filter for the groups to be cached.
    ResourceEnabled bool
    Specifies whether the provider should cache resources. The default value is true.
    ResourcesFilter ProviderCacheResourcesFilter
    Specifies the filter for the resources to be cached.
    groupsEnabled Boolean
    Specifies whether the provider should cache groups. The default value is true.
    groupsFilter ProviderCacheGroupsFilter
    Specifies the filter for the groups to be cached.
    resourceEnabled Boolean
    Specifies whether the provider should cache resources. The default value is true.
    resourcesFilter ProviderCacheResourcesFilter
    Specifies the filter for the resources to be cached.
    groupsEnabled boolean
    Specifies whether the provider should cache groups. The default value is true.
    groupsFilter ProviderCacheGroupsFilter
    Specifies the filter for the groups to be cached.
    resourceEnabled boolean
    Specifies whether the provider should cache resources. The default value is true.
    resourcesFilter ProviderCacheResourcesFilter
    Specifies the filter for the resources to be cached.
    groups_enabled bool
    Specifies whether the provider should cache groups. The default value is true.
    groups_filter ProviderCacheGroupsFilter
    Specifies the filter for the groups to be cached.
    resource_enabled bool
    Specifies whether the provider should cache resources. The default value is true.
    resources_filter ProviderCacheResourcesFilter
    Specifies the filter for the resources to be cached.
    groupsEnabled Boolean
    Specifies whether the provider should cache groups. The default value is true.
    groupsFilter Property Map
    Specifies the filter for the groups to be cached.
    resourceEnabled Boolean
    Specifies whether the provider should cache resources. The default value is true.
    resourcesFilter Property Map
    Specifies the filter for the resources to be cached.

    ProviderCacheGroupsFilter, ProviderCacheGroupsFilterArgs

    IsActive bool
    Returns only Groups matching the specified state.
    Name string
    Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
    NameContains string
    Match when the value exist in the name of the group.
    NameExclude string
    Match when the exact value does not exist in the name of the group.
    NamePrefix string
    The name of the group must start with the value.
    NameRegexp string
    The regular expression match of the name of the group.
    NameSuffix string
    The name of the group must end with the value.
    Types List<string>
    Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.
    IsActive bool
    Returns only Groups matching the specified state.
    Name string
    Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
    NameContains string
    Match when the value exist in the name of the group.
    NameExclude string
    Match when the exact value does not exist in the name of the group.
    NamePrefix string
    The name of the group must start with the value.
    NameRegexp string
    The regular expression match of the name of the group.
    NameSuffix string
    The name of the group must end with the value.
    Types []string
    Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.
    isActive Boolean
    Returns only Groups matching the specified state.
    name String
    Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
    nameContains String
    Match when the value exist in the name of the group.
    nameExclude String
    Match when the exact value does not exist in the name of the group.
    namePrefix String
    The name of the group must start with the value.
    nameRegexp String
    The regular expression match of the name of the group.
    nameSuffix String
    The name of the group must end with the value.
    types List<String>
    Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.
    isActive boolean
    Returns only Groups matching the specified state.
    name string
    Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
    nameContains string
    Match when the value exist in the name of the group.
    nameExclude string
    Match when the exact value does not exist in the name of the group.
    namePrefix string
    The name of the group must start with the value.
    nameRegexp string
    The regular expression match of the name of the group.
    nameSuffix string
    The name of the group must end with the value.
    types string[]
    Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.
    is_active bool
    Returns only Groups matching the specified state.
    name str
    Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
    name_contains str
    Match when the value exist in the name of the group.
    name_exclude str
    Match when the exact value does not exist in the name of the group.
    name_prefix str
    The name of the group must start with the value.
    name_regexp str
    The regular expression match of the name of the group.
    name_suffix str
    The name of the group must end with the value.
    types Sequence[str]
    Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.
    isActive Boolean
    Returns only Groups matching the specified state.
    name String
    Returns only groups that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
    nameContains String
    Match when the value exist in the name of the group.
    nameExclude String
    Match when the exact value does not exist in the name of the group.
    namePrefix String
    The name of the group must start with the value.
    nameRegexp String
    The regular expression match of the name of the group.
    nameSuffix String
    The name of the group must end with the value.
    types List<String>
    Returns groups that match a list of types. valid types: MANUAL, SYNCED, SYSTEM.

    ProviderCacheResourcesFilter, ProviderCacheResourcesFilterArgs

    Name string
    Returns only resources that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
    NameContains string
    Match when the value exist in the name of the resource.
    NameExclude string
    Match when the exact value does not exist in the name of the resource.
    NamePrefix string
    The name of the resource must start with the value.
    NameRegexp string
    The regular expression match of the name of the resource.
    NameSuffix string
    The name of the resource must end with the value.
    Tags Dictionary<string, string>
    Returns only resources that exactly match the given tags.
    Name string
    Returns only resources that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
    NameContains string
    Match when the value exist in the name of the resource.
    NameExclude string
    Match when the exact value does not exist in the name of the resource.
    NamePrefix string
    The name of the resource must start with the value.
    NameRegexp string
    The regular expression match of the name of the resource.
    NameSuffix string
    The name of the resource must end with the value.
    Tags map[string]string
    Returns only resources that exactly match the given tags.
    name String
    Returns only resources that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
    nameContains String
    Match when the value exist in the name of the resource.
    nameExclude String
    Match when the exact value does not exist in the name of the resource.
    namePrefix String
    The name of the resource must start with the value.
    nameRegexp String
    The regular expression match of the name of the resource.
    nameSuffix String
    The name of the resource must end with the value.
    tags Map<String,String>
    Returns only resources that exactly match the given tags.
    name string
    Returns only resources that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
    nameContains string
    Match when the value exist in the name of the resource.
    nameExclude string
    Match when the exact value does not exist in the name of the resource.
    namePrefix string
    The name of the resource must start with the value.
    nameRegexp string
    The regular expression match of the name of the resource.
    nameSuffix string
    The name of the resource must end with the value.
    tags {[key: string]: string}
    Returns only resources that exactly match the given tags.
    name str
    Returns only resources that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
    name_contains str
    Match when the value exist in the name of the resource.
    name_exclude str
    Match when the exact value does not exist in the name of the resource.
    name_prefix str
    The name of the resource must start with the value.
    name_regexp str
    The regular expression match of the name of the resource.
    name_suffix str
    The name of the resource must end with the value.
    tags Mapping[str, str]
    Returns only resources that exactly match the given tags.
    name String
    Returns only resources that exactly match this name. If no options are passed it will return all resources. Only one option can be used at a time.
    nameContains String
    Match when the value exist in the name of the resource.
    nameExclude String
    Match when the exact value does not exist in the name of the resource.
    namePrefix String
    The name of the resource must start with the value.
    nameRegexp String
    The regular expression match of the name of the resource.
    nameSuffix String
    The name of the resource must end with the value.
    tags Map<String>
    Returns only resources that exactly match the given tags.

    ProviderDefaultTags, ProviderDefaultTagsArgs

    Tags Dictionary<string, string>
    A map of key-value pair tags to be set on all resources by default.
    Tags map[string]string
    A map of key-value pair tags to be set on all resources by default.
    tags Map<String,String>
    A map of key-value pair tags to be set on all resources by default.
    tags {[key: string]: string}
    A map of key-value pair tags to be set on all resources by default.
    tags Mapping[str, str]
    A map of key-value pair tags to be set on all resources by default.
    tags Map<String>
    A map of key-value pair tags to be set on all resources by default.

    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.5.0 published on Monday, Sep 22, 2025 by Twingate
    twingate/pulumi-twingate