sql.Provider
Explore with Pulumi AI
The provider type for the sql 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,
max_idle_conns: Optional[float] = None,
max_open_conns: Optional[float] = 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:sql
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:
- Max
Idle doubleConns - Sets the maximum number of connections in the idle connection pool. Default is
2
. See Go's documentation on DB.SetMaxIdleConns. - Max
Open doubleConns - Sets the maximum number of open connections to the database. Default is
0
(unlimited). See Go's documentation on DB.SetMaxOpenConns. - Url string
- Database connection strings are specified via URLs. The URL format is driver dependent but generally has the form:
dbdriver://username:password@host:port/dbname?param1=true¶m2=false
. You can optionally set theSQL_URL
environment variable instead.
- Max
Idle float64Conns - Sets the maximum number of connections in the idle connection pool. Default is
2
. See Go's documentation on DB.SetMaxIdleConns. - Max
Open float64Conns - Sets the maximum number of open connections to the database. Default is
0
(unlimited). See Go's documentation on DB.SetMaxOpenConns. - Url string
- Database connection strings are specified via URLs. The URL format is driver dependent but generally has the form:
dbdriver://username:password@host:port/dbname?param1=true¶m2=false
. You can optionally set theSQL_URL
environment variable instead.
- max
Idle DoubleConns - Sets the maximum number of connections in the idle connection pool. Default is
2
. See Go's documentation on DB.SetMaxIdleConns. - max
Open DoubleConns - Sets the maximum number of open connections to the database. Default is
0
(unlimited). See Go's documentation on DB.SetMaxOpenConns. - url String
- Database connection strings are specified via URLs. The URL format is driver dependent but generally has the form:
dbdriver://username:password@host:port/dbname?param1=true¶m2=false
. You can optionally set theSQL_URL
environment variable instead.
- max
Idle numberConns - Sets the maximum number of connections in the idle connection pool. Default is
2
. See Go's documentation on DB.SetMaxIdleConns. - max
Open numberConns - Sets the maximum number of open connections to the database. Default is
0
(unlimited). See Go's documentation on DB.SetMaxOpenConns. - url string
- Database connection strings are specified via URLs. The URL format is driver dependent but generally has the form:
dbdriver://username:password@host:port/dbname?param1=true¶m2=false
. You can optionally set theSQL_URL
environment variable instead.
- max_
idle_ floatconns - Sets the maximum number of connections in the idle connection pool. Default is
2
. See Go's documentation on DB.SetMaxIdleConns. - max_
open_ floatconns - Sets the maximum number of open connections to the database. Default is
0
(unlimited). See Go's documentation on DB.SetMaxOpenConns. - url str
- Database connection strings are specified via URLs. The URL format is driver dependent but generally has the form:
dbdriver://username:password@host:port/dbname?param1=true¶m2=false
. You can optionally set theSQL_URL
environment variable instead.
- max
Idle NumberConns - Sets the maximum number of connections in the idle connection pool. Default is
2
. See Go's documentation on DB.SetMaxIdleConns. - max
Open NumberConns - Sets the maximum number of open connections to the database. Default is
0
(unlimited). See Go's documentation on DB.SetMaxOpenConns. - url String
- Database connection strings are specified via URLs. The URL format is driver dependent but generally has the form:
dbdriver://username:password@host:port/dbname?param1=true¶m2=false
. You can optionally set theSQL_URL
environment variable instead.
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
- sql paultyng/terraform-provider-sql
- License
- Notes
- This Pulumi package is based on the
sql
Terraform Provider.