Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. OVH
  3. API Docs
  4. CloudProjectDatabase
  5. Prometheus
OVHCloud v2.0.7 published on Wednesday, Mar 19, 2025 by OVHcloud
ovh/pulumi-ovh

ovh.CloudProjectDatabase.Prometheus

Explore with Pulumi AI

ovh logo
OVHCloud v2.0.7 published on Wednesday, Mar 19, 2025 by OVHcloud
ovh/pulumi-ovh

    Import

    OVHcloud Managed database clusters prometheus can be imported using the service_name, engine and cluster_id, separated by “/” E.g.,

    bash

    $ pulumi import ovh:CloudProjectDatabase/prometheus:Prometheus my_prometheus service_name/engine/cluster_id

    Create Prometheus Resource

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

    Constructor syntax

    new Prometheus(name: string, args: PrometheusArgs, opts?: CustomResourceOptions);
    @overload
def Prometheus(resource_name: str,
               args: PrometheusArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Prometheus(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               cluster_id: Optional[str] = None,
               engine: Optional[str] = None,
               service_name: Optional[str] = None,
               password_reset: Optional[str] = None)
    func NewPrometheus(ctx *Context, name string, args PrometheusArgs, opts ...ResourceOption) (*Prometheus, error)
    public Prometheus(string name, PrometheusArgs args, CustomResourceOptions? opts = null)
    public Prometheus(String name, PrometheusArgs args)
public Prometheus(String name, PrometheusArgs args, CustomResourceOptions options)

    type: ovh:CloudProjectDatabase:Prometheus
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 PrometheusArgs
    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 PrometheusArgs
    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 PrometheusArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrometheusArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrometheusArgs
    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 prometheusResource = new Ovh.CloudProjectDatabase.Prometheus("prometheusResource", new()
{
    ClusterId = "string",
    Engine = "string",
    ServiceName = "string",
    PasswordReset = "string",
});

    example, err := CloudProjectDatabase.NewPrometheus(ctx, "prometheusResource", &CloudProjectDatabase.PrometheusArgs{
	ClusterId:     pulumi.String("string"),
	Engine:        pulumi.String("string"),
	ServiceName:   pulumi.String("string"),
	PasswordReset: pulumi.String("string"),
})

    var prometheusResource = new Prometheus("prometheusResource", PrometheusArgs.builder()
    .clusterId("string")
    .engine("string")
    .serviceName("string")
    .passwordReset("string")
    .build());

    prometheus_resource = ovh.cloud_project_database.Prometheus("prometheusResource",
    cluster_id="string",
    engine="string",
    service_name="string",
    password_reset="string")

    const prometheusResource = new ovh.cloudprojectdatabase.Prometheus("prometheusResource", {
    clusterId: "string",
    engine: "string",
    serviceName: "string",
    passwordReset: "string",
});

    type: ovh:CloudProjectDatabase:Prometheus
properties:
    clusterId: string
    engine: string
    passwordReset: string
    serviceName: string

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

    ClusterId string
    Cluster ID.
    Engine string
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    ClusterId string
    Cluster ID.
    Engine string
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    clusterId String
    Cluster ID.
    engine String
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    passwordReset String
    Arbitrary string to change to trigger a password update
    clusterId string
    Cluster ID.
    engine string
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    serviceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    passwordReset string
    Arbitrary string to change to trigger a password update
    cluster_id str
    Cluster ID.
    engine str
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    service_name str
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    password_reset str
    Arbitrary string to change to trigger a password update
    clusterId String
    Cluster ID.
    engine String
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    passwordReset String
    Arbitrary string to change to trigger a password update

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    (Sensitive) Password of the user.
    Targets List<PrometheusTarget>
    List of all endpoint targets.

    • Host - Host of the endpoint.
    • Port - Connection port for the endpoint.
    Username string
    name of the prometheus user.
    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    (Sensitive) Password of the user.
    Targets []PrometheusTarget
    List of all endpoint targets.

    • Host - Host of the endpoint.
    • Port - Connection port for the endpoint.
    Username string
    name of the prometheus user.
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    (Sensitive) Password of the user.
    targets List<PrometheusTarget>
    List of all endpoint targets.

    • Host - Host of the endpoint.
    • Port - Connection port for the endpoint.
    username String
    name of the prometheus user.
    id string
    The provider-assigned unique ID for this managed resource.
    password string
    (Sensitive) Password of the user.
    targets PrometheusTarget[]
    List of all endpoint targets.

    • Host - Host of the endpoint.
    • Port - Connection port for the endpoint.
    username string
    name of the prometheus user.
    id str
    The provider-assigned unique ID for this managed resource.
    password str
    (Sensitive) Password of the user.
    targets Sequence[cloudprojectdatabase.PrometheusTarget]
    List of all endpoint targets.

    • Host - Host of the endpoint.
    • Port - Connection port for the endpoint.
    username str
    name of the prometheus user.
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    (Sensitive) Password of the user.
    targets List<Property Map>
    List of all endpoint targets.

    • Host - Host of the endpoint.
    • Port - Connection port for the endpoint.
    username String
    name of the prometheus user.

    Look up Existing Prometheus Resource

    Get an existing Prometheus 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?: PrometheusState, opts?: CustomResourceOptions): Prometheus
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        engine: Optional[str] = None,
        password: Optional[str] = None,
        password_reset: Optional[str] = None,
        service_name: Optional[str] = None,
        targets: Optional[Sequence[_cloudprojectdatabase.PrometheusTargetArgs]] = None,
        username: Optional[str] = None) -> Prometheus
    func GetPrometheus(ctx *Context, name string, id IDInput, state *PrometheusState, opts ...ResourceOption) (*Prometheus, error)
    public static Prometheus Get(string name, Input<string> id, PrometheusState? state, CustomResourceOptions? opts = null)
    public static Prometheus get(String name, Output<String> id, PrometheusState state, CustomResourceOptions options)
    resources:  _:    type: ovh:CloudProjectDatabase:Prometheus    get:      id: ${id}
    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.
    Engine string
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    Password string
    (Sensitive) Password of the user.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    Targets List<PrometheusTarget>
    List of all endpoint targets.

    • Host - Host of the endpoint.
    • Port - Connection port for the endpoint.
    Username string
    name of the prometheus user.
    ClusterId string
    Cluster ID.
    Engine string
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    Password string
    (Sensitive) Password of the user.
    PasswordReset string
    Arbitrary string to change to trigger a password update
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    Targets []PrometheusTargetArgs
    List of all endpoint targets.

    • Host - Host of the endpoint.
    • Port - Connection port for the endpoint.
    Username string
    name of the prometheus user.
    clusterId String
    Cluster ID.
    engine String
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    password String
    (Sensitive) Password of the user.
    passwordReset String
    Arbitrary string to change to trigger a password update
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    targets List<PrometheusTarget>
    List of all endpoint targets.

    • Host - Host of the endpoint.
    • Port - Connection port for the endpoint.
    username String
    name of the prometheus user.
    clusterId string
    Cluster ID.
    engine string
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    password string
    (Sensitive) Password of the user.
    passwordReset string
    Arbitrary string to change to trigger a password update
    serviceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    targets PrometheusTarget[]
    List of all endpoint targets.

    • Host - Host of the endpoint.
    • Port - Connection port for the endpoint.
    username string
    name of the prometheus user.
    cluster_id str
    Cluster ID.
    engine str
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    password str
    (Sensitive) Password of the user.
    password_reset str
    Arbitrary string to change to trigger a password update
    service_name str
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    targets Sequence[cloudprojectdatabase.PrometheusTargetArgs]
    List of all endpoint targets.

    • Host - Host of the endpoint.
    • Port - Connection port for the endpoint.
    username str
    name of the prometheus user.
    clusterId String
    Cluster ID.
    engine String
    The engine of the database cluster you want to add. You can find the complete list of available engine in the public documentation. Available engines:
    password String
    (Sensitive) Password of the user.
    passwordReset String
    Arbitrary string to change to trigger a password update
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    targets List<Property Map>
    List of all endpoint targets.

    • Host - Host of the endpoint.
    • Port - Connection port for the endpoint.
    username String
    name of the prometheus user.

    Supporting Types

    PrometheusTarget, PrometheusTargetArgs

    Host string
    Host of the endpoint
    Port int
    Connection port for the endpoint
    Host string
    Host of the endpoint
    Port int
    Connection port for the endpoint
    host String
    Host of the endpoint
    port Integer
    Connection port for the endpoint
    host string
    Host of the endpoint
    port number
    Connection port for the endpoint
    host str
    Host of the endpoint
    port int
    Connection port for the endpoint
    host String
    Host of the endpoint
    port Number
    Connection port for the endpoint

    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 v2.0.7 published on Wednesday, Mar 19, 2025 by OVHcloud
    ovh/pulumi-ovh