Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Planetscale Provider
  3. API Docs
  4. Provider
planetscale 0.4.1 published on Tuesday, Mar 11, 2025 by planetscale
planetscale/terraform-provider-planetscale

planetscale.Provider

Explore with Pulumi AI

planetscale 0.4.1 published on Tuesday, Mar 11, 2025 by planetscale
planetscale/terraform-provider-planetscale

The provider type for the planetscale 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,
             access_token: Optional[str] = None,
             endpoint: Optional[str] = None,
             service_token: Optional[str] = None,
             service_token_id: Optional[str] = None,
             service_token_name: 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:planetscale
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
The unique name of the resource.
args This property is required. 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:

AccessToken string
Name of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN_ID. Mutually exclusive with service_token_id and service_token.
Endpoint string
If set, points the API client to a different endpoint than https://api.planetscale.com/v1.
ServiceToken string
Value of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN. Mutually exclusive with access_token.
ServiceTokenId string
ID of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN_ID. Mutually exclusive with access_token.
ServiceTokenName string
Name of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN_NAME. Mutually exclusive with access_token. (Deprecated, use service_token_id instead)

Deprecated: Deprecated

AccessToken string
Name of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN_ID. Mutually exclusive with service_token_id and service_token.
Endpoint string
If set, points the API client to a different endpoint than https://api.planetscale.com/v1.
ServiceToken string
Value of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN. Mutually exclusive with access_token.
ServiceTokenId string
ID of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN_ID. Mutually exclusive with access_token.
ServiceTokenName string
Name of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN_NAME. Mutually exclusive with access_token. (Deprecated, use service_token_id instead)

Deprecated: Deprecated

accessToken String
Name of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN_ID. Mutually exclusive with service_token_id and service_token.
endpoint String
If set, points the API client to a different endpoint than https://api.planetscale.com/v1.
serviceToken String
Value of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN. Mutually exclusive with access_token.
serviceTokenId String
ID of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN_ID. Mutually exclusive with access_token.
serviceTokenName String
Name of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN_NAME. Mutually exclusive with access_token. (Deprecated, use service_token_id instead)

Deprecated: Deprecated

accessToken string
Name of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN_ID. Mutually exclusive with service_token_id and service_token.
endpoint string
If set, points the API client to a different endpoint than https://api.planetscale.com/v1.
serviceToken string
Value of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN. Mutually exclusive with access_token.
serviceTokenId string
ID of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN_ID. Mutually exclusive with access_token.
serviceTokenName string
Name of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN_NAME. Mutually exclusive with access_token. (Deprecated, use service_token_id instead)

Deprecated: Deprecated

access_token str
Name of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN_ID. Mutually exclusive with service_token_id and service_token.
endpoint str
If set, points the API client to a different endpoint than https://api.planetscale.com/v1.
service_token str
Value of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN. Mutually exclusive with access_token.
service_token_id str
ID of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN_ID. Mutually exclusive with access_token.
service_token_name str
Name of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN_NAME. Mutually exclusive with access_token. (Deprecated, use service_token_id instead)

Deprecated: Deprecated

accessToken String
Name of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN_ID. Mutually exclusive with service_token_id and service_token.
endpoint String
If set, points the API client to a different endpoint than https://api.planetscale.com/v1.
serviceToken String
Value of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN. Mutually exclusive with access_token.
serviceTokenId String
ID of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN_ID. Mutually exclusive with access_token.
serviceTokenName String
Name of the service token to use. Alternatively, use PLANETSCALE_SERVICE_TOKEN_NAME. Mutually exclusive with access_token. (Deprecated, use service_token_id instead)

Deprecated: Deprecated

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
planetscale planetscale/terraform-provider-planetscale
License
Notes
This Pulumi package is based on the planetscale Terraform Provider.
planetscale 0.4.1 published on Tuesday, Mar 11, 2025 by planetscale
planetscale/terraform-provider-planetscale