Docs Packages
  1. Packages
  2. Twingate
  3. API Docs
  4. Provider
Twingate v3.0.6 published on Thursday, Jun 27, 2024 by Twingate
Twingate/pulumi-twingate

twingate.Provider

Explore with Pulumi AI

twingate logo
Twingate v3.0.6 published on Thursday, Jun 27, 2024 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,
             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

    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.
    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.
    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.
    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.
    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.
    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.
    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.

    Package Details

    Repository
    twingate Twingate/pulumi-twingate
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the twingate Terraform Provider.
    twingate logo
    Twingate v3.0.6 published on Thursday, Jun 27, 2024 by Twingate
    Twingate/pulumi-twingate