twingate.Provider
Explore with Pulumi AI
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:
- Api
Token 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. Provider Cache - Specifies the cache settings for the provider.
- Twingate.
Twingate. Inputs. Provider Default Tags - A default set of tags applied globally to all resources created by the provider.
- Http
Max intRetry - 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 string
- Your Twingate network ID for API operations. You can find it in the Admin Console URL, for example:
autoco.twingate.com
, whereautoco
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 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
Provider
Cache Args - Specifies the cache settings for the provider.
- Provider
Default Tags Args - A default set of tags applied globally to all resources created by the provider.
- Http
Max intRetry - 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 string
- Your Twingate network ID for API operations. You can find it in the Admin Console URL, for example:
autoco.twingate.com
, whereautoco
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 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
Provider
Cache - Specifies the cache settings for the provider.
- Provider
Default Tags - A default set of tags applied globally to all resources created by the provider.
- http
Max IntegerRetry - 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 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
, whereautoco
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 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
Provider
Cache - Specifies the cache settings for the provider.
- Provider
Default Tags - A default set of tags applied globally to all resources created by the provider.
- http
Max numberRetry - 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 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
, whereautoco
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
Provider
Cache Args - Specifies the cache settings for the provider.
- Provider
Default Tags Args - A default set of tags applied globally to all resources created by the provider.
- http_
max_ intretry - 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
, whereautoco
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.
- api
Token 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.
- Property Map
- A default set of tags applied globally to all resources created by the provider.
- http
Max NumberRetry - 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 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
, whereautoco
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
- Groups
Enabled bool - Specifies whether the provider should cache groups. The default value is
true
. - Resource
Enabled bool - Specifies whether the provider should cache resources. The default value is
true
.
- Groups
Enabled bool - Specifies whether the provider should cache groups. The default value is
true
. - Resource
Enabled bool - Specifies whether the provider should cache resources. The default value is
true
.
- groups
Enabled Boolean - Specifies whether the provider should cache groups. The default value is
true
. - resource
Enabled Boolean - Specifies whether the provider should cache resources. The default value is
true
.
- groups
Enabled boolean - Specifies whether the provider should cache groups. The default value is
true
. - resource
Enabled boolean - Specifies whether the provider should cache resources. The default value is
true
.
- groups_
enabled bool - Specifies whether the provider should cache groups. The default value is
true
. - resource_
enabled bool - Specifies whether the provider should cache resources. The default value is
true
.
- groups
Enabled Boolean - Specifies whether the provider should cache groups. The default value is
true
. - resource
Enabled Boolean - Specifies whether the provider should cache resources. The default value is
true
.
ProviderDefaultTags, ProviderDefaultTagsArgs
- Dictionary<string, string>
- A map of key-value pair tags to be set on all resources by default.
- map[string]string
- A map of key-value pair tags to be set on all resources by default.
- Map<String,String>
- A map of key-value pair tags to be set on all resources by default.
- {[key: string]: string}
- A map of key-value pair tags to be set on all resources by default.
- Mapping[str, str]
- A map of key-value pair tags to be set on all resources by default.
- 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.