equinix.Provider
Explore with Pulumi AI
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,
             token: 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
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_CLIENTIDshell environment variable.
- ClientSecret string
- API Consumer secret available under "My Apps" in developer portal. This argument can also be specified with the
EQUINIX_API_CLIENTSECRETshell environment variable.
- Endpoint string
- The Equinix API base URL to point out desired environment. This argument can also be specified with the
EQUINIX_API_ENDPOINTshell environment variable. (Defaults tohttps://api.equinix.com)
- MaxRetries int
- Maximum number of retries in case of network failure.
- MaxRetry intWait Seconds 
- 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)
- ResponseMax intPage Size 
- The maximum number of records in a single response for REST queries that produce paginated responses. (Default is client specific)
- Token string
- API tokens are generated from API Consumer clients using the OAuth2
API.
This argument can also be specified with the EQUINIX_API_TOKENshell environment variable.
- 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_CLIENTIDshell environment variable.
- ClientSecret string
- API Consumer secret available under "My Apps" in developer portal. This argument can also be specified with the
EQUINIX_API_CLIENTSECRETshell environment variable.
- Endpoint string
- The Equinix API base URL to point out desired environment. This argument can also be specified with the
EQUINIX_API_ENDPOINTshell environment variable. (Defaults tohttps://api.equinix.com)
- MaxRetries int
- Maximum number of retries in case of network failure.
- MaxRetry intWait Seconds 
- 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)
- ResponseMax intPage Size 
- The maximum number of records in a single response for REST queries that produce paginated responses. (Default is client specific)
- Token string
- API tokens are generated from API Consumer clients using the OAuth2
API.
This argument can also be specified with the EQUINIX_API_TOKENshell environment variable.
- 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_CLIENTIDshell environment variable.
- clientSecret String
- API Consumer secret available under "My Apps" in developer portal. This argument can also be specified with the
EQUINIX_API_CLIENTSECRETshell environment variable.
- endpoint String
- The Equinix API base URL to point out desired environment. This argument can also be specified with the
EQUINIX_API_ENDPOINTshell environment variable. (Defaults tohttps://api.equinix.com)
- maxRetries Integer
- Maximum number of retries in case of network failure.
- maxRetry IntegerWait Seconds 
- 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)
- responseMax IntegerPage Size 
- The maximum number of records in a single response for REST queries that produce paginated responses. (Default is client specific)
- token String
- API tokens are generated from API Consumer clients using the OAuth2
API.
This argument can also be specified with the EQUINIX_API_TOKENshell environment variable.
- 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_CLIENTIDshell environment variable.
- clientSecret string
- API Consumer secret available under "My Apps" in developer portal. This argument can also be specified with the
EQUINIX_API_CLIENTSECRETshell environment variable.
- endpoint string
- The Equinix API base URL to point out desired environment. This argument can also be specified with the
EQUINIX_API_ENDPOINTshell environment variable. (Defaults tohttps://api.equinix.com)
- maxRetries number
- Maximum number of retries in case of network failure.
- maxRetry numberWait Seconds 
- 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)
- responseMax numberPage Size 
- The maximum number of records in a single response for REST queries that produce paginated responses. (Default is client specific)
- token string
- API tokens are generated from API Consumer clients using the OAuth2
API.
This argument can also be specified with the EQUINIX_API_TOKENshell environment variable.
- 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_CLIENTIDshell 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_CLIENTSECRETshell environment variable.
- endpoint str
- The Equinix API base URL to point out desired environment. This argument can also be specified with the
EQUINIX_API_ENDPOINTshell environment variable. (Defaults tohttps://api.equinix.com)
- max_retries int
- Maximum number of retries in case of network failure.
- max_retry_ intwait_ seconds 
- 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_ intpage_ size 
- The maximum number of records in a single response for REST queries that produce paginated responses. (Default is client specific)
- token str
- API tokens are generated from API Consumer clients using the OAuth2
API.
This argument can also be specified with the EQUINIX_API_TOKENshell environment variable.
- 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_CLIENTIDshell environment variable.
- clientSecret String
- API Consumer secret available under "My Apps" in developer portal. This argument can also be specified with the
EQUINIX_API_CLIENTSECRETshell environment variable.
- endpoint String
- The Equinix API base URL to point out desired environment. This argument can also be specified with the
EQUINIX_API_ENDPOINTshell environment variable. (Defaults tohttps://api.equinix.com)
- maxRetries Number
- Maximum number of retries in case of network failure.
- maxRetry NumberWait Seconds 
- 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)
- responseMax NumberPage Size 
- The maximum number of records in a single response for REST queries that produce paginated responses. (Default is client specific)
- token String
- API tokens are generated from API Consumer clients using the OAuth2
API.
This argument can also be specified with the EQUINIX_API_TOKENshell environment variable.
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 equinixTerraform Provider.
