Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. OVH
  4. API Docs
  5. CloudKeyManagerSecretConsumer
Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

ovh.CloudKeyManagerSecretConsumer

ovh logo
Viewing docs for OVHCloud v2.17.0
published on Friday, Jul 17, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

    Registers a consumer on a Barbican Key Manager secret for a public cloud project. Consumers track which OpenStack resources (instances, load balancers, images) are using a given secret.

    All fields on this resource force replacement. Consumers cannot be updated in place.

    Example Usage

    Register a load balancer as a consumer of a secret:

    import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@ovhcloud/pulumi-ovh";

const consumer = new ovh.CloudKeyManagerSecretConsumer("consumer", {
    serviceName: "Public cloud project ID",
    secretId: "00000000-0000-0000-0000-000000000000",
    service: "LOADBALANCER",
    resourceType: "LOADBALANCER",
    resourceId: "11111111-1111-1111-1111-111111111111",
});

    import pulumi
import pulumi_ovh as ovh

consumer = ovh.CloudKeyManagerSecretConsumer("consumer",
    service_name="Public cloud project ID",
    secret_id="00000000-0000-0000-0000-000000000000",
    service="LOADBALANCER",
    resource_type="LOADBALANCER",
    resource_id="11111111-1111-1111-1111-111111111111")

    package main

import (
	"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ovh.NewCloudKeyManagerSecretConsumer(ctx, "consumer", &ovh.CloudKeyManagerSecretConsumerArgs{
			ServiceName:  pulumi.String("Public cloud project ID"),
			SecretId:     pulumi.String("00000000-0000-0000-0000-000000000000"),
			Service:      pulumi.String("LOADBALANCER"),
			ResourceType: pulumi.String("LOADBALANCER"),
			ResourceId:   pulumi.String("11111111-1111-1111-1111-111111111111"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ovh = Pulumi.Ovh;

return await Deployment.RunAsync(() => 
{
    var consumer = new Ovh.CloudKeyManagerSecretConsumer("consumer", new()
    {
        ServiceName = "Public cloud project ID",
        SecretId = "00000000-0000-0000-0000-000000000000",
        Service = "LOADBALANCER",
        ResourceType = "LOADBALANCER",
        ResourceId = "11111111-1111-1111-1111-111111111111",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.ovhcloud.pulumi.ovh.CloudKeyManagerSecretConsumer;
import com.ovhcloud.pulumi.ovh.CloudKeyManagerSecretConsumerArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var consumer = new CloudKeyManagerSecretConsumer("consumer", CloudKeyManagerSecretConsumerArgs.builder()
            .serviceName("Public cloud project ID")
            .secretId("00000000-0000-0000-0000-000000000000")
            .service("LOADBALANCER")
            .resourceType("LOADBALANCER")
            .resourceId("11111111-1111-1111-1111-111111111111")
            .build());

    }
}

    resources:
  consumer:
    type: ovh:CloudKeyManagerSecretConsumer
    properties:
      serviceName: Public cloud project ID
      secretId: 00000000-0000-0000-0000-000000000000
      service: LOADBALANCER
      resourceType: LOADBALANCER
      resourceId: 11111111-1111-1111-1111-111111111111

    Example coming soon!

    Create CloudKeyManagerSecretConsumer Resource

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

    Constructor syntax

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

@overload
def CloudKeyManagerSecretConsumer(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  resource_id: Optional[str] = None,
                                  resource_type: Optional[str] = None,
                                  secret_id: Optional[str] = None,
                                  service: Optional[str] = None,
                                  service_name: Optional[str] = None)
    func NewCloudKeyManagerSecretConsumer(ctx *Context, name string, args CloudKeyManagerSecretConsumerArgs, opts ...ResourceOption) (*CloudKeyManagerSecretConsumer, error)
    public CloudKeyManagerSecretConsumer(string name, CloudKeyManagerSecretConsumerArgs args, CustomResourceOptions? opts = null)
    public CloudKeyManagerSecretConsumer(String name, CloudKeyManagerSecretConsumerArgs args)
public CloudKeyManagerSecretConsumer(String name, CloudKeyManagerSecretConsumerArgs args, CustomResourceOptions options)

    type: ovh:CloudKeyManagerSecretConsumer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "ovh_cloud_key_manager_secret_consumer" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args CloudKeyManagerSecretConsumerArgs
    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 CloudKeyManagerSecretConsumerArgs
    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 CloudKeyManagerSecretConsumerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudKeyManagerSecretConsumerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudKeyManagerSecretConsumerArgs
    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 cloudKeyManagerSecretConsumerResource = new Ovh.CloudKeyManagerSecretConsumer("cloudKeyManagerSecretConsumerResource", new()
{
    ResourceId = "string",
    ResourceType = "string",
    SecretId = "string",
    Service = "string",
    ServiceName = "string",
});

    example, err := ovh.NewCloudKeyManagerSecretConsumer(ctx, "cloudKeyManagerSecretConsumerResource", &ovh.CloudKeyManagerSecretConsumerArgs{
	ResourceId:   pulumi.String("string"),
	ResourceType: pulumi.String("string"),
	SecretId:     pulumi.String("string"),
	Service:      pulumi.String("string"),
	ServiceName:  pulumi.String("string"),
})

    resource "ovh_cloud_key_manager_secret_consumer" "cloudKeyManagerSecretConsumerResource" {
  lifecycle {
    create_before_destroy = true
  }
  resource_id   = "string"
  resource_type = "string"
  secret_id     = "string"
  service       = "string"
  service_name  = "string"
}

    var cloudKeyManagerSecretConsumerResource = new CloudKeyManagerSecretConsumer("cloudKeyManagerSecretConsumerResource", CloudKeyManagerSecretConsumerArgs.builder()
    .resourceId("string")
    .resourceType("string")
    .secretId("string")
    .service("string")
    .serviceName("string")
    .build());

    cloud_key_manager_secret_consumer_resource = ovh.CloudKeyManagerSecretConsumer("cloudKeyManagerSecretConsumerResource",
    resource_id="string",
    resource_type="string",
    secret_id="string",
    service="string",
    service_name="string")

    const cloudKeyManagerSecretConsumerResource = new ovh.CloudKeyManagerSecretConsumer("cloudKeyManagerSecretConsumerResource", {
    resourceId: "string",
    resourceType: "string",
    secretId: "string",
    service: "string",
    serviceName: "string",
});

    type: ovh:CloudKeyManagerSecretConsumer
properties:
    resourceId: string
    resourceType: string
    secretId: string
    service: string
    serviceName: string

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

    ResourceId string
    UUID of the resource consuming the secret.
    ResourceType string
    Type of the resource consuming the secret. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    SecretId string
    UUID of the secret to register the consumer on.
    Service string
    OpenStack service type of the consumer. Possible values: COMPUTE, IMAGE, LOADBALANCER, NETWORK.
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    ResourceId string
    UUID of the resource consuming the secret.
    ResourceType string
    Type of the resource consuming the secret. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    SecretId string
    UUID of the secret to register the consumer on.
    Service string
    OpenStack service type of the consumer. Possible values: COMPUTE, IMAGE, LOADBALANCER, NETWORK.
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    resource_id string
    UUID of the resource consuming the secret.
    resource_type string
    Type of the resource consuming the secret. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    secret_id string
    UUID of the secret to register the consumer on.
    service string
    OpenStack service type of the consumer. Possible values: COMPUTE, IMAGE, LOADBALANCER, NETWORK.
    service_name string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    resourceId String
    UUID of the resource consuming the secret.
    resourceType String
    Type of the resource consuming the secret. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    secretId String
    UUID of the secret to register the consumer on.
    service String
    OpenStack service type of the consumer. Possible values: COMPUTE, IMAGE, LOADBALANCER, NETWORK.
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    resourceId string
    UUID of the resource consuming the secret.
    resourceType string
    Type of the resource consuming the secret. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    secretId string
    UUID of the secret to register the consumer on.
    service string
    OpenStack service type of the consumer. Possible values: COMPUTE, IMAGE, LOADBALANCER, NETWORK.
    serviceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    resource_id str
    UUID of the resource consuming the secret.
    resource_type str
    Type of the resource consuming the secret. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    secret_id str
    UUID of the secret to register the consumer on.
    service str
    OpenStack service type of the consumer. Possible values: COMPUTE, IMAGE, LOADBALANCER, NETWORK.
    service_name str
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    resourceId String
    UUID of the resource consuming the secret.
    resourceType String
    Type of the resource consuming the secret. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    secretId String
    UUID of the secret to register the consumer on.
    service String
    OpenStack service type of the consumer. Possible values: COMPUTE, IMAGE, LOADBALANCER, NETWORK.
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CloudKeyManagerSecretConsumer 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 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.

    Look up Existing CloudKeyManagerSecretConsumer Resource

    Get an existing CloudKeyManagerSecretConsumer 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?: CloudKeyManagerSecretConsumerState, opts?: CustomResourceOptions): CloudKeyManagerSecretConsumer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        resource_id: Optional[str] = None,
        resource_type: Optional[str] = None,
        secret_id: Optional[str] = None,
        service: Optional[str] = None,
        service_name: Optional[str] = None) -> CloudKeyManagerSecretConsumer
    func GetCloudKeyManagerSecretConsumer(ctx *Context, name string, id IDInput, state *CloudKeyManagerSecretConsumerState, opts ...ResourceOption) (*CloudKeyManagerSecretConsumer, error)
    public static CloudKeyManagerSecretConsumer Get(string name, Input<string> id, CloudKeyManagerSecretConsumerState? state, CustomResourceOptions? opts = null)
    public static CloudKeyManagerSecretConsumer get(String name, Output<String> id, CloudKeyManagerSecretConsumerState state, CustomResourceOptions options)
    resources:  _:    type: ovh:CloudKeyManagerSecretConsumer    get:      id: ${id}
    import {
  to = ovh_cloud_key_manager_secret_consumer.example
  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:
    ResourceId string
    UUID of the resource consuming the secret.
    ResourceType string
    Type of the resource consuming the secret. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    SecretId string
    UUID of the secret to register the consumer on.
    Service string
    OpenStack service type of the consumer. Possible values: COMPUTE, IMAGE, LOADBALANCER, NETWORK.
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    ResourceId string
    UUID of the resource consuming the secret.
    ResourceType string
    Type of the resource consuming the secret. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    SecretId string
    UUID of the secret to register the consumer on.
    Service string
    OpenStack service type of the consumer. Possible values: COMPUTE, IMAGE, LOADBALANCER, NETWORK.
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    resource_id string
    UUID of the resource consuming the secret.
    resource_type string
    Type of the resource consuming the secret. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    secret_id string
    UUID of the secret to register the consumer on.
    service string
    OpenStack service type of the consumer. Possible values: COMPUTE, IMAGE, LOADBALANCER, NETWORK.
    service_name string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    resourceId String
    UUID of the resource consuming the secret.
    resourceType String
    Type of the resource consuming the secret. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    secretId String
    UUID of the secret to register the consumer on.
    service String
    OpenStack service type of the consumer. Possible values: COMPUTE, IMAGE, LOADBALANCER, NETWORK.
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    resourceId string
    UUID of the resource consuming the secret.
    resourceType string
    Type of the resource consuming the secret. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    secretId string
    UUID of the secret to register the consumer on.
    service string
    OpenStack service type of the consumer. Possible values: COMPUTE, IMAGE, LOADBALANCER, NETWORK.
    serviceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    resource_id str
    UUID of the resource consuming the secret.
    resource_type str
    Type of the resource consuming the secret. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    secret_id str
    UUID of the secret to register the consumer on.
    service str
    OpenStack service type of the consumer. Possible values: COMPUTE, IMAGE, LOADBALANCER, NETWORK.
    service_name str
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.
    resourceId String
    UUID of the resource consuming the secret.
    resourceType String
    Type of the resource consuming the secret. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    secretId String
    UUID of the secret to register the consumer on.
    service String
    OpenStack service type of the consumer. Possible values: COMPUTE, IMAGE, LOADBALANCER, NETWORK.
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.

    Import

    A Key Manager secret consumer can be imported using a composite ID (note that this import format differs from the id attribute):

    bash

    $ pulumi import ovh:index/cloudKeyManagerSecretConsumer:CloudKeyManagerSecretConsumer my_consumer service_name/secret_id/service/resource_type/resource_id

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    Viewing docs for OVHCloud v2.17.0
    published on Friday, Jul 17, 2026 by OVHcloud
    Schema (JSON)
    ovh/pulumi-ovh

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial