1. Packages
  2. Equinix
  3. API Docs
  4. Provider
Viewing docs for Equinix v0.29.1
published on Tuesday, Mar 17, 2026 by Equinix
Schema (JSON)
equinix/pulumi-equinix

equinix.Provider

equinix logo
Viewing docs for Equinix v0.29.1
published on Tuesday, Mar 17, 2026 by Equinix
Schema (JSON)
equinix/pulumi-equinix

    The provider type for the equinix 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,
             auth_token: Optional[str] = None,
             client_id: Optional[str] = None,
             client_secret: Optional[str] = None,
             endpoint: Optional[str] = None,
             max_retries: Optional[int] = None,
             max_retry_wait_seconds: Optional[int] = None,
             request_timeout: Optional[int] = None,
             response_max_page_size: Optional[int] = None,
             sts_endpoint: Optional[str] = None,
             token: Optional[str] = None,
             token_exchange_scope: Optional[str] = None,
             token_exchange_subject_token: Optional[str] = None,
             token_exchange_subject_token_env_var: 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:equinix
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:

    AuthToken string
    The Equinix Metal API auth key for API operations
    ClientId string
    API Consumer Key available under "My Apps" in developer portal. This argument can also be specified with the EQUINIX_API_CLIENTID shell environment variable.
    ClientSecret string
    API Consumer secret available under "My Apps" in developer portal. This argument can also be specified with the EQUINIX_API_CLIENTSECRET shell environment variable.
    Endpoint string
    The Equinix API base URL to point out desired environment. This argument can also be specified with the EQUINIX_API_ENDPOINT shell environment variable. (Defaults to https://api.equinix.com)
    MaxRetries int
    Maximum number of retries in case of network failure.
    MaxRetryWaitSeconds int
    Maximum number of seconds to wait before retrying a request.
    RequestTimeout int
    The duration of time, in seconds, that the Equinix Platform API Client should wait before canceling an API request. Canceled requests may still result in provisioned resources. (Defaults to 30)
    ResponseMaxPageSize int
    The maximum number of records in a single response for REST queries that produce paginated responses. (Default is client specific)
    StsEndpoint string
    The STS API base URL to point to the desired environment. This argument can also be specified with the EQUINIX_STS_ENDPOINT shell environment variable. (Defaults to https://sts.eqix.equinix.com). Please note that STS is an alpha feature and not available for all users.
    Token string
    API tokens are generated from API Consumer clients using the OAuth2 API. This argument can also be specified with the EQUINIX_API_TOKEN shell environment variable.
    TokenExchangeScope string
    The scope of the authentication token. Must be an access policy ERN or a string of the form roleassignments:<org_id>. This argument can also be specified with the EQUINIX_TOKEN_EXCHANGE_SCOPE shell environment variable. Please note that token exchange is an alpha feature and not available for all users.
    TokenExchangeSubjectToken string
    The subject token to use for token exchange authentication. Must be an OIDC ID token issued by an OIDC provider trusted by Equinix STS. If not set, the provider will use the environment variable specified in token_exchange_subject_token_env_var. Please note that token exchange is an alpha feature and not available for all users.
    TokenExchangeSubjectTokenEnvVar string
    The name of the environment variable containing the subject token for token exchange. This argument can also be specified with the EQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN_ENV_VAR shell environment variable. (Defaults to EQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN). Please note that token exchange is an alpha feature and not available for all users.
    AuthToken string
    The Equinix Metal API auth key for API operations
    ClientId string
    API Consumer Key available under "My Apps" in developer portal. This argument can also be specified with the EQUINIX_API_CLIENTID shell environment variable.
    ClientSecret string
    API Consumer secret available under "My Apps" in developer portal. This argument can also be specified with the EQUINIX_API_CLIENTSECRET shell environment variable.
    Endpoint string
    The Equinix API base URL to point out desired environment. This argument can also be specified with the EQUINIX_API_ENDPOINT shell environment variable. (Defaults to https://api.equinix.com)
    MaxRetries int
    Maximum number of retries in case of network failure.
    MaxRetryWaitSeconds int
    Maximum number of seconds to wait before retrying a request.
    RequestTimeout int
    The duration of time, in seconds, that the Equinix Platform API Client should wait before canceling an API request. Canceled requests may still result in provisioned resources. (Defaults to 30)
    ResponseMaxPageSize int
    The maximum number of records in a single response for REST queries that produce paginated responses. (Default is client specific)
    StsEndpoint string
    The STS API base URL to point to the desired environment. This argument can also be specified with the EQUINIX_STS_ENDPOINT shell environment variable. (Defaults to https://sts.eqix.equinix.com). Please note that STS is an alpha feature and not available for all users.
    Token string
    API tokens are generated from API Consumer clients using the OAuth2 API. This argument can also be specified with the EQUINIX_API_TOKEN shell environment variable.
    TokenExchangeScope string
    The scope of the authentication token. Must be an access policy ERN or a string of the form roleassignments:<org_id>. This argument can also be specified with the EQUINIX_TOKEN_EXCHANGE_SCOPE shell environment variable. Please note that token exchange is an alpha feature and not available for all users.
    TokenExchangeSubjectToken string
    The subject token to use for token exchange authentication. Must be an OIDC ID token issued by an OIDC provider trusted by Equinix STS. If not set, the provider will use the environment variable specified in token_exchange_subject_token_env_var. Please note that token exchange is an alpha feature and not available for all users.
    TokenExchangeSubjectTokenEnvVar string
    The name of the environment variable containing the subject token for token exchange. This argument can also be specified with the EQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN_ENV_VAR shell environment variable. (Defaults to EQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN). Please note that token exchange is an alpha feature and not available for all users.
    authToken String
    The Equinix Metal API auth key for API operations
    clientId String
    API Consumer Key available under "My Apps" in developer portal. This argument can also be specified with the EQUINIX_API_CLIENTID shell environment variable.
    clientSecret String
    API Consumer secret available under "My Apps" in developer portal. This argument can also be specified with the EQUINIX_API_CLIENTSECRET shell environment variable.
    endpoint String
    The Equinix API base URL to point out desired environment. This argument can also be specified with the EQUINIX_API_ENDPOINT shell environment variable. (Defaults to https://api.equinix.com)
    maxRetries Integer
    Maximum number of retries in case of network failure.
    maxRetryWaitSeconds Integer
    Maximum number of seconds to wait before retrying a request.
    requestTimeout Integer
    The duration of time, in seconds, that the Equinix Platform API Client should wait before canceling an API request. Canceled requests may still result in provisioned resources. (Defaults to 30)
    responseMaxPageSize Integer
    The maximum number of records in a single response for REST queries that produce paginated responses. (Default is client specific)
    stsEndpoint String
    The STS API base URL to point to the desired environment. This argument can also be specified with the EQUINIX_STS_ENDPOINT shell environment variable. (Defaults to https://sts.eqix.equinix.com). Please note that STS is an alpha feature and not available for all users.
    token String
    API tokens are generated from API Consumer clients using the OAuth2 API. This argument can also be specified with the EQUINIX_API_TOKEN shell environment variable.
    tokenExchangeScope String
    The scope of the authentication token. Must be an access policy ERN or a string of the form roleassignments:<org_id>. This argument can also be specified with the EQUINIX_TOKEN_EXCHANGE_SCOPE shell environment variable. Please note that token exchange is an alpha feature and not available for all users.
    tokenExchangeSubjectToken String
    The subject token to use for token exchange authentication. Must be an OIDC ID token issued by an OIDC provider trusted by Equinix STS. If not set, the provider will use the environment variable specified in token_exchange_subject_token_env_var. Please note that token exchange is an alpha feature and not available for all users.
    tokenExchangeSubjectTokenEnvVar String
    The name of the environment variable containing the subject token for token exchange. This argument can also be specified with the EQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN_ENV_VAR shell environment variable. (Defaults to EQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN). Please note that token exchange is an alpha feature and not available for all users.
    authToken string
    The Equinix Metal API auth key for API operations
    clientId string
    API Consumer Key available under "My Apps" in developer portal. This argument can also be specified with the EQUINIX_API_CLIENTID shell environment variable.
    clientSecret string
    API Consumer secret available under "My Apps" in developer portal. This argument can also be specified with the EQUINIX_API_CLIENTSECRET shell environment variable.
    endpoint string
    The Equinix API base URL to point out desired environment. This argument can also be specified with the EQUINIX_API_ENDPOINT shell environment variable. (Defaults to https://api.equinix.com)
    maxRetries number
    Maximum number of retries in case of network failure.
    maxRetryWaitSeconds number
    Maximum number of seconds to wait before retrying a request.
    requestTimeout number
    The duration of time, in seconds, that the Equinix Platform API Client should wait before canceling an API request. Canceled requests may still result in provisioned resources. (Defaults to 30)
    responseMaxPageSize number
    The maximum number of records in a single response for REST queries that produce paginated responses. (Default is client specific)
    stsEndpoint string
    The STS API base URL to point to the desired environment. This argument can also be specified with the EQUINIX_STS_ENDPOINT shell environment variable. (Defaults to https://sts.eqix.equinix.com). Please note that STS is an alpha feature and not available for all users.
    token string
    API tokens are generated from API Consumer clients using the OAuth2 API. This argument can also be specified with the EQUINIX_API_TOKEN shell environment variable.
    tokenExchangeScope string
    The scope of the authentication token. Must be an access policy ERN or a string of the form roleassignments:<org_id>. This argument can also be specified with the EQUINIX_TOKEN_EXCHANGE_SCOPE shell environment variable. Please note that token exchange is an alpha feature and not available for all users.
    tokenExchangeSubjectToken string
    The subject token to use for token exchange authentication. Must be an OIDC ID token issued by an OIDC provider trusted by Equinix STS. If not set, the provider will use the environment variable specified in token_exchange_subject_token_env_var. Please note that token exchange is an alpha feature and not available for all users.
    tokenExchangeSubjectTokenEnvVar string
    The name of the environment variable containing the subject token for token exchange. This argument can also be specified with the EQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN_ENV_VAR shell environment variable. (Defaults to EQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN). Please note that token exchange is an alpha feature and not available for all users.
    auth_token str
    The Equinix Metal API auth key for API operations
    client_id str
    API Consumer Key available under "My Apps" in developer portal. This argument can also be specified with the EQUINIX_API_CLIENTID shell environment variable.
    client_secret str
    API Consumer secret available under "My Apps" in developer portal. This argument can also be specified with the EQUINIX_API_CLIENTSECRET shell environment variable.
    endpoint str
    The Equinix API base URL to point out desired environment. This argument can also be specified with the EQUINIX_API_ENDPOINT shell environment variable. (Defaults to https://api.equinix.com)
    max_retries int
    Maximum number of retries in case of network failure.
    max_retry_wait_seconds int
    Maximum number of seconds to wait before retrying a request.
    request_timeout int
    The duration of time, in seconds, that the Equinix Platform API Client should wait before canceling an API request. Canceled requests may still result in provisioned resources. (Defaults to 30)
    response_max_page_size int
    The maximum number of records in a single response for REST queries that produce paginated responses. (Default is client specific)
    sts_endpoint str
    The STS API base URL to point to the desired environment. This argument can also be specified with the EQUINIX_STS_ENDPOINT shell environment variable. (Defaults to https://sts.eqix.equinix.com). Please note that STS is an alpha feature and not available for all users.
    token str
    API tokens are generated from API Consumer clients using the OAuth2 API. This argument can also be specified with the EQUINIX_API_TOKEN shell environment variable.
    token_exchange_scope str
    The scope of the authentication token. Must be an access policy ERN or a string of the form roleassignments:<org_id>. This argument can also be specified with the EQUINIX_TOKEN_EXCHANGE_SCOPE shell environment variable. Please note that token exchange is an alpha feature and not available for all users.
    token_exchange_subject_token str
    The subject token to use for token exchange authentication. Must be an OIDC ID token issued by an OIDC provider trusted by Equinix STS. If not set, the provider will use the environment variable specified in token_exchange_subject_token_env_var. Please note that token exchange is an alpha feature and not available for all users.
    token_exchange_subject_token_env_var str
    The name of the environment variable containing the subject token for token exchange. This argument can also be specified with the EQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN_ENV_VAR shell environment variable. (Defaults to EQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN). Please note that token exchange is an alpha feature and not available for all users.
    authToken String
    The Equinix Metal API auth key for API operations
    clientId String
    API Consumer Key available under "My Apps" in developer portal. This argument can also be specified with the EQUINIX_API_CLIENTID shell environment variable.
    clientSecret String
    API Consumer secret available under "My Apps" in developer portal. This argument can also be specified with the EQUINIX_API_CLIENTSECRET shell environment variable.
    endpoint String
    The Equinix API base URL to point out desired environment. This argument can also be specified with the EQUINIX_API_ENDPOINT shell environment variable. (Defaults to https://api.equinix.com)
    maxRetries Number
    Maximum number of retries in case of network failure.
    maxRetryWaitSeconds Number
    Maximum number of seconds to wait before retrying a request.
    requestTimeout Number
    The duration of time, in seconds, that the Equinix Platform API Client should wait before canceling an API request. Canceled requests may still result in provisioned resources. (Defaults to 30)
    responseMaxPageSize Number
    The maximum number of records in a single response for REST queries that produce paginated responses. (Default is client specific)
    stsEndpoint String
    The STS API base URL to point to the desired environment. This argument can also be specified with the EQUINIX_STS_ENDPOINT shell environment variable. (Defaults to https://sts.eqix.equinix.com). Please note that STS is an alpha feature and not available for all users.
    token String
    API tokens are generated from API Consumer clients using the OAuth2 API. This argument can also be specified with the EQUINIX_API_TOKEN shell environment variable.
    tokenExchangeScope String
    The scope of the authentication token. Must be an access policy ERN or a string of the form roleassignments:<org_id>. This argument can also be specified with the EQUINIX_TOKEN_EXCHANGE_SCOPE shell environment variable. Please note that token exchange is an alpha feature and not available for all users.
    tokenExchangeSubjectToken String
    The subject token to use for token exchange authentication. Must be an OIDC ID token issued by an OIDC provider trusted by Equinix STS. If not set, the provider will use the environment variable specified in token_exchange_subject_token_env_var. Please note that token exchange is an alpha feature and not available for all users.
    tokenExchangeSubjectTokenEnvVar String
    The name of the environment variable containing the subject token for token exchange. This argument can also be specified with the EQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN_ENV_VAR shell environment variable. (Defaults to EQUINIX_TOKEN_EXCHANGE_SUBJECT_TOKEN). Please note that token exchange is an alpha feature and not available for all users.

    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
    equinix equinix/pulumi-equinix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the equinix Terraform Provider.
    equinix logo
    Viewing docs for Equinix v0.29.1
    published on Tuesday, Mar 17, 2026 by Equinix
    Schema (JSON)
    equinix/pulumi-equinix
      Try Pulumi Cloud free. Your team will thank you.