1. Packages
  2. OVH
  3. API Docs
  4. CloudProjectDatabase
  5. PostgresSqlConnectionPool
OVHCloud v0.45.0 published on Tuesday, Jun 4, 2024 by OVHcloud

ovh.CloudProjectDatabase.PostgresSqlConnectionPool

Explore with Pulumi AI

ovh logo
OVHCloud v0.45.0 published on Tuesday, Jun 4, 2024 by OVHcloud

    Import

    OVHcloud Managed PostgreSQL clusters connection pools can be imported using the service_name, cluster_id and id of the connection pool, separated by “/” E.g.,

    bash

    $ pulumi import ovh:CloudProjectDatabase/postgresSqlConnectionPool:PostgresSqlConnectionPool my_connection_pool service_name/cluster_id/id
    

    Create PostgresSqlConnectionPool Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PostgresSqlConnectionPool(name: string, args: PostgresSqlConnectionPoolArgs, opts?: CustomResourceOptions);
    @overload
    def PostgresSqlConnectionPool(resource_name: str,
                                  args: PostgresSqlConnectionPoolArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def PostgresSqlConnectionPool(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  cluster_id: Optional[str] = None,
                                  database_id: Optional[str] = None,
                                  mode: Optional[str] = None,
                                  service_name: Optional[str] = None,
                                  size: Optional[int] = None,
                                  name: Optional[str] = None,
                                  user_id: Optional[str] = None)
    func NewPostgresSqlConnectionPool(ctx *Context, name string, args PostgresSqlConnectionPoolArgs, opts ...ResourceOption) (*PostgresSqlConnectionPool, error)
    public PostgresSqlConnectionPool(string name, PostgresSqlConnectionPoolArgs args, CustomResourceOptions? opts = null)
    public PostgresSqlConnectionPool(String name, PostgresSqlConnectionPoolArgs args)
    public PostgresSqlConnectionPool(String name, PostgresSqlConnectionPoolArgs args, CustomResourceOptions options)
    
    type: ovh:CloudProjectDatabase:PostgresSqlConnectionPool
    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 PostgresSqlConnectionPoolArgs
    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 PostgresSqlConnectionPoolArgs
    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 PostgresSqlConnectionPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PostgresSqlConnectionPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PostgresSqlConnectionPoolArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var postgresSqlConnectionPoolResource = new Ovh.CloudProjectDatabase.PostgresSqlConnectionPool("postgresSqlConnectionPoolResource", new()
    {
        ClusterId = "string",
        DatabaseId = "string",
        Mode = "string",
        ServiceName = "string",
        Size = 0,
        Name = "string",
        UserId = "string",
    });
    
    example, err := CloudProjectDatabase.NewPostgresSqlConnectionPool(ctx, "postgresSqlConnectionPoolResource", &CloudProjectDatabase.PostgresSqlConnectionPoolArgs{
    	ClusterId:   pulumi.String("string"),
    	DatabaseId:  pulumi.String("string"),
    	Mode:        pulumi.String("string"),
    	ServiceName: pulumi.String("string"),
    	Size:        pulumi.Int(0),
    	Name:        pulumi.String("string"),
    	UserId:      pulumi.String("string"),
    })
    
    var postgresSqlConnectionPoolResource = new PostgresSqlConnectionPool("postgresSqlConnectionPoolResource", PostgresSqlConnectionPoolArgs.builder()
        .clusterId("string")
        .databaseId("string")
        .mode("string")
        .serviceName("string")
        .size(0)
        .name("string")
        .userId("string")
        .build());
    
    postgres_sql_connection_pool_resource = ovh.cloud_project_database.PostgresSqlConnectionPool("postgresSqlConnectionPoolResource",
        cluster_id="string",
        database_id="string",
        mode="string",
        service_name="string",
        size=0,
        name="string",
        user_id="string")
    
    const postgresSqlConnectionPoolResource = new ovh.cloudprojectdatabase.PostgresSqlConnectionPool("postgresSqlConnectionPoolResource", {
        clusterId: "string",
        databaseId: "string",
        mode: "string",
        serviceName: "string",
        size: 0,
        name: "string",
        userId: "string",
    });
    
    type: ovh:CloudProjectDatabase:PostgresSqlConnectionPool
    properties:
        clusterId: string
        databaseId: string
        mode: string
        name: string
        serviceName: string
        size: 0
        userId: string
    

    PostgresSqlConnectionPool 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 PostgresSqlConnectionPool resource accepts the following input properties:

    ClusterId string
    Cluster ID.
    DatabaseId string
    Database ID for a database that belongs to the Database cluster given above.
    Mode string
    Connection mode to the connection pool Available modes:
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    Size int
    Size of the connection pool.
    Name string
    Name of the connection pool.
    UserId string
    Database user authorized to connect to the pool, if none all the users are allowed.
    ClusterId string
    Cluster ID.
    DatabaseId string
    Database ID for a database that belongs to the Database cluster given above.
    Mode string
    Connection mode to the connection pool Available modes:
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    Size int
    Size of the connection pool.
    Name string
    Name of the connection pool.
    UserId string
    Database user authorized to connect to the pool, if none all the users are allowed.
    clusterId String
    Cluster ID.
    databaseId String
    Database ID for a database that belongs to the Database cluster given above.
    mode String
    Connection mode to the connection pool Available modes:
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    size Integer
    Size of the connection pool.
    name String
    Name of the connection pool.
    userId String
    Database user authorized to connect to the pool, if none all the users are allowed.
    clusterId string
    Cluster ID.
    databaseId string
    Database ID for a database that belongs to the Database cluster given above.
    mode string
    Connection mode to the connection pool Available modes:
    serviceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    size number
    Size of the connection pool.
    name string
    Name of the connection pool.
    userId string
    Database user authorized to connect to the pool, if none all the users are allowed.
    cluster_id str
    Cluster ID.
    database_id str
    Database ID for a database that belongs to the Database cluster given above.
    mode str
    Connection mode to the connection pool Available modes:
    service_name str
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    size int
    Size of the connection pool.
    name str
    Name of the connection pool.
    user_id str
    Database user authorized to connect to the pool, if none all the users are allowed.
    clusterId String
    Cluster ID.
    databaseId String
    Database ID for a database that belongs to the Database cluster given above.
    mode String
    Connection mode to the connection pool Available modes:
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    size Number
    Size of the connection pool.
    name String
    Name of the connection pool.
    userId String
    Database user authorized to connect to the pool, if none all the users are allowed.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PostgresSqlConnectionPool resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Port int
    Port of the connection pool.
    SslMode string
    Ssl connection mode for the pool.
    Uri string
    Connection URI to the pool.
    Id string
    The provider-assigned unique ID for this managed resource.
    Port int
    Port of the connection pool.
    SslMode string
    Ssl connection mode for the pool.
    Uri string
    Connection URI to the pool.
    id String
    The provider-assigned unique ID for this managed resource.
    port Integer
    Port of the connection pool.
    sslMode String
    Ssl connection mode for the pool.
    uri String
    Connection URI to the pool.
    id string
    The provider-assigned unique ID for this managed resource.
    port number
    Port of the connection pool.
    sslMode string
    Ssl connection mode for the pool.
    uri string
    Connection URI to the pool.
    id str
    The provider-assigned unique ID for this managed resource.
    port int
    Port of the connection pool.
    ssl_mode str
    Ssl connection mode for the pool.
    uri str
    Connection URI to the pool.
    id String
    The provider-assigned unique ID for this managed resource.
    port Number
    Port of the connection pool.
    sslMode String
    Ssl connection mode for the pool.
    uri String
    Connection URI to the pool.

    Look up Existing PostgresSqlConnectionPool Resource

    Get an existing PostgresSqlConnectionPool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PostgresSqlConnectionPoolState, opts?: CustomResourceOptions): PostgresSqlConnectionPool
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cluster_id: Optional[str] = None,
            database_id: Optional[str] = None,
            mode: Optional[str] = None,
            name: Optional[str] = None,
            port: Optional[int] = None,
            service_name: Optional[str] = None,
            size: Optional[int] = None,
            ssl_mode: Optional[str] = None,
            uri: Optional[str] = None,
            user_id: Optional[str] = None) -> PostgresSqlConnectionPool
    func GetPostgresSqlConnectionPool(ctx *Context, name string, id IDInput, state *PostgresSqlConnectionPoolState, opts ...ResourceOption) (*PostgresSqlConnectionPool, error)
    public static PostgresSqlConnectionPool Get(string name, Input<string> id, PostgresSqlConnectionPoolState? state, CustomResourceOptions? opts = null)
    public static PostgresSqlConnectionPool get(String name, Output<String> id, PostgresSqlConnectionPoolState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ClusterId string
    Cluster ID.
    DatabaseId string
    Database ID for a database that belongs to the Database cluster given above.
    Mode string
    Connection mode to the connection pool Available modes:
    Name string
    Name of the connection pool.
    Port int
    Port of the connection pool.
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    Size int
    Size of the connection pool.
    SslMode string
    Ssl connection mode for the pool.
    Uri string
    Connection URI to the pool.
    UserId string
    Database user authorized to connect to the pool, if none all the users are allowed.
    ClusterId string
    Cluster ID.
    DatabaseId string
    Database ID for a database that belongs to the Database cluster given above.
    Mode string
    Connection mode to the connection pool Available modes:
    Name string
    Name of the connection pool.
    Port int
    Port of the connection pool.
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    Size int
    Size of the connection pool.
    SslMode string
    Ssl connection mode for the pool.
    Uri string
    Connection URI to the pool.
    UserId string
    Database user authorized to connect to the pool, if none all the users are allowed.
    clusterId String
    Cluster ID.
    databaseId String
    Database ID for a database that belongs to the Database cluster given above.
    mode String
    Connection mode to the connection pool Available modes:
    name String
    Name of the connection pool.
    port Integer
    Port of the connection pool.
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    size Integer
    Size of the connection pool.
    sslMode String
    Ssl connection mode for the pool.
    uri String
    Connection URI to the pool.
    userId String
    Database user authorized to connect to the pool, if none all the users are allowed.
    clusterId string
    Cluster ID.
    databaseId string
    Database ID for a database that belongs to the Database cluster given above.
    mode string
    Connection mode to the connection pool Available modes:
    name string
    Name of the connection pool.
    port number
    Port of the connection pool.
    serviceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    size number
    Size of the connection pool.
    sslMode string
    Ssl connection mode for the pool.
    uri string
    Connection URI to the pool.
    userId string
    Database user authorized to connect to the pool, if none all the users are allowed.
    cluster_id str
    Cluster ID.
    database_id str
    Database ID for a database that belongs to the Database cluster given above.
    mode str
    Connection mode to the connection pool Available modes:
    name str
    Name of the connection pool.
    port int
    Port of the connection pool.
    service_name str
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    size int
    Size of the connection pool.
    ssl_mode str
    Ssl connection mode for the pool.
    uri str
    Connection URI to the pool.
    user_id str
    Database user authorized to connect to the pool, if none all the users are allowed.
    clusterId String
    Cluster ID.
    databaseId String
    Database ID for a database that belongs to the Database cluster given above.
    mode String
    Connection mode to the connection pool Available modes:
    name String
    Name of the connection pool.
    port Number
    Port of the connection pool.
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    size Number
    Size of the connection pool.
    sslMode String
    Ssl connection mode for the pool.
    uri String
    Connection URI to the pool.
    userId String
    Database user authorized to connect to the pool, if none all the users are allowed.

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    OVHCloud v0.45.0 published on Tuesday, Jun 4, 2024 by OVHcloud