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

ovh.CloudKeyManagerContainerConsumer

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 container for a public cloud project. Consumers track which OpenStack resources (instances, load balancers, images) are using a given container.

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

    Example Usage

    Register a load balancer as a consumer of a container:

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

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

    import pulumi
import pulumi_ovh as ovh

consumer = ovh.CloudKeyManagerContainerConsumer("consumer",
    service_name="Public cloud project ID",
    container_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.NewCloudKeyManagerContainerConsumer(ctx, "consumer", &ovh.CloudKeyManagerContainerConsumerArgs{
			ServiceName:  pulumi.String("Public cloud project ID"),
			ContainerId:  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.CloudKeyManagerContainerConsumer("consumer", new()
    {
        ServiceName = "Public cloud project ID",
        ContainerId = "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.CloudKeyManagerContainerConsumer;
import com.ovhcloud.pulumi.ovh.CloudKeyManagerContainerConsumerArgs;
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 CloudKeyManagerContainerConsumer("consumer", CloudKeyManagerContainerConsumerArgs.builder()
            .serviceName("Public cloud project ID")
            .containerId("00000000-0000-0000-0000-000000000000")
            .service("LOADBALANCER")
            .resourceType("LOADBALANCER")
            .resourceId("11111111-1111-1111-1111-111111111111")
            .build());

    }
}

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

    Example coming soon!

    Create CloudKeyManagerContainerConsumer Resource

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

    Constructor syntax

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

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

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


    resource "ovh_cloud_key_manager_container_consumer" "name" {
    # resource properties
}

    Parameters

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

    example, err := ovh.NewCloudKeyManagerContainerConsumer(ctx, "cloudKeyManagerContainerConsumerResource", &ovh.CloudKeyManagerContainerConsumerArgs{
	ContainerId:  pulumi.String("string"),
	ResourceId:   pulumi.String("string"),
	ResourceType: pulumi.String("string"),
	Service:      pulumi.String("string"),
	ServiceName:  pulumi.String("string"),
})

    resource "ovh_cloud_key_manager_container_consumer" "cloudKeyManagerContainerConsumerResource" {
  lifecycle {
    create_before_destroy = true
  }
  container_id  = "string"
  resource_id   = "string"
  resource_type = "string"
  service       = "string"
  service_name  = "string"
}

    var cloudKeyManagerContainerConsumerResource = new CloudKeyManagerContainerConsumer("cloudKeyManagerContainerConsumerResource", CloudKeyManagerContainerConsumerArgs.builder()
    .containerId("string")
    .resourceId("string")
    .resourceType("string")
    .service("string")
    .serviceName("string")
    .build());

    cloud_key_manager_container_consumer_resource = ovh.CloudKeyManagerContainerConsumer("cloudKeyManagerContainerConsumerResource",
    container_id="string",
    resource_id="string",
    resource_type="string",
    service="string",
    service_name="string")

    const cloudKeyManagerContainerConsumerResource = new ovh.CloudKeyManagerContainerConsumer("cloudKeyManagerContainerConsumerResource", {
    containerId: "string",
    resourceId: "string",
    resourceType: "string",
    service: "string",
    serviceName: "string",
});

    type: ovh:CloudKeyManagerContainerConsumer
properties:
    containerId: string
    resourceId: string
    resourceType: string
    service: string
    serviceName: string

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

    ContainerId string
    UUID of the container to register the consumer on.
    ResourceId string
    UUID of the resource consuming the container.
    ResourceType string
    Type of the resource consuming the container. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    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.
    ContainerId string
    UUID of the container to register the consumer on.
    ResourceId string
    UUID of the resource consuming the container.
    ResourceType string
    Type of the resource consuming the container. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    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.
    container_id string
    UUID of the container to register the consumer on.
    resource_id string
    UUID of the resource consuming the container.
    resource_type string
    Type of the resource consuming the container. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    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.
    containerId String
    UUID of the container to register the consumer on.
    resourceId String
    UUID of the resource consuming the container.
    resourceType String
    Type of the resource consuming the container. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    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.
    containerId string
    UUID of the container to register the consumer on.
    resourceId string
    UUID of the resource consuming the container.
    resourceType string
    Type of the resource consuming the container. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    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.
    container_id str
    UUID of the container to register the consumer on.
    resource_id str
    UUID of the resource consuming the container.
    resource_type str
    Type of the resource consuming the container. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    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.
    containerId String
    UUID of the container to register the consumer on.
    resourceId String
    UUID of the resource consuming the container.
    resourceType String
    Type of the resource consuming the container. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    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 CloudKeyManagerContainerConsumer 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 CloudKeyManagerContainerConsumer Resource

    Get an existing CloudKeyManagerContainerConsumer 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?: CloudKeyManagerContainerConsumerState, opts?: CustomResourceOptions): CloudKeyManagerContainerConsumer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        container_id: Optional[str] = None,
        resource_id: Optional[str] = None,
        resource_type: Optional[str] = None,
        service: Optional[str] = None,
        service_name: Optional[str] = None) -> CloudKeyManagerContainerConsumer
    func GetCloudKeyManagerContainerConsumer(ctx *Context, name string, id IDInput, state *CloudKeyManagerContainerConsumerState, opts ...ResourceOption) (*CloudKeyManagerContainerConsumer, error)
    public static CloudKeyManagerContainerConsumer Get(string name, Input<string> id, CloudKeyManagerContainerConsumerState? state, CustomResourceOptions? opts = null)
    public static CloudKeyManagerContainerConsumer get(String name, Output<String> id, CloudKeyManagerContainerConsumerState state, CustomResourceOptions options)
    resources:  _:    type: ovh:CloudKeyManagerContainerConsumer    get:      id: ${id}
    import {
  to = ovh_cloud_key_manager_container_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:
    ContainerId string
    UUID of the container to register the consumer on.
    ResourceId string
    UUID of the resource consuming the container.
    ResourceType string
    Type of the resource consuming the container. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    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.
    ContainerId string
    UUID of the container to register the consumer on.
    ResourceId string
    UUID of the resource consuming the container.
    ResourceType string
    Type of the resource consuming the container. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    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.
    container_id string
    UUID of the container to register the consumer on.
    resource_id string
    UUID of the resource consuming the container.
    resource_type string
    Type of the resource consuming the container. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    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.
    containerId String
    UUID of the container to register the consumer on.
    resourceId String
    UUID of the resource consuming the container.
    resourceType String
    Type of the resource consuming the container. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    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.
    containerId string
    UUID of the container to register the consumer on.
    resourceId string
    UUID of the resource consuming the container.
    resourceType string
    Type of the resource consuming the container. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    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.
    container_id str
    UUID of the container to register the consumer on.
    resource_id str
    UUID of the resource consuming the container.
    resource_type str
    Type of the resource consuming the container. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    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.
    containerId String
    UUID of the container to register the consumer on.
    resourceId String
    UUID of the resource consuming the container.
    resourceType String
    Type of the resource consuming the container. Possible values: IMAGE, INSTANCE, LOADBALANCER.
    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 container consumer can be imported using a composite ID (note that this import format differs from the id attribute):

    bash

    $ pulumi import ovh:index/cloudKeyManagerContainerConsumer:CloudKeyManagerContainerConsumer my_consumer service_name/container_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