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

ovh.Okms.Okms

Explore with Pulumi AI

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

    Example Usage

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

const newKms = new ovh.okms.Okms("newKms", {
    displayName: "terraformed KMS",
    ovhSubsidiary: "FR",
    region: "eu-west-rbx",
});

    import pulumi
import pulumi_ovh as ovh

new_kms = ovh.okms.Okms("newKms",
    display_name="terraformed KMS",
    ovh_subsidiary="FR",
    region="eu-west-rbx")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okms.NewOkms(ctx, "newKms", &okms.OkmsArgs{
			DisplayName:   pulumi.String("terraformed KMS"),
			OvhSubsidiary: pulumi.String("FR"),
			Region:        pulumi.String("eu-west-rbx"),
		})
		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 newKms = new Ovh.Okms.Okms("newKms", new()
    {
        DisplayName = "terraformed KMS",
        OvhSubsidiary = "FR",
        Region = "eu-west-rbx",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.Okms.Okms;
import com.pulumi.ovh.Okms.OkmsArgs;
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 newKms = new Okms("newKms", OkmsArgs.builder()
            .displayName("terraformed KMS")
            .ovhSubsidiary("FR")
            .region("eu-west-rbx")
            .build());

    }
}

    resources:
  newKms:
    type: ovh:Okms:Okms
    properties:
      displayName: terraformed KMS
      ovhSubsidiary: FR
      region: eu-west-rbx

    Create Okms Resource

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

    Constructor syntax

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

@overload
def Okms(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         ovh_subsidiary: Optional[str] = None,
         region: Optional[str] = None,
         display_name: Optional[str] = None)
    func NewOkms(ctx *Context, name string, args OkmsArgs, opts ...ResourceOption) (*Okms, error)
    public Okms(string name, OkmsArgs args, CustomResourceOptions? opts = null)
    public Okms(String name, OkmsArgs args)
public Okms(String name, OkmsArgs args, CustomResourceOptions options)

    type: ovh:Okms:Okms
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 OkmsArgs
    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 OkmsArgs
    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 OkmsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OkmsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OkmsArgs
    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 okmsResource = new Ovh.Okms.Okms("okmsResource", new()
{
    OvhSubsidiary = "string",
    Region = "string",
    DisplayName = "string",
});

    example, err := Okms.NewOkms(ctx, "okmsResource", &Okms.OkmsArgs{
	OvhSubsidiary: pulumi.String("string"),
	Region:        pulumi.String("string"),
	DisplayName:   pulumi.String("string"),
})

    var okmsResource = new Okms("okmsResource", OkmsArgs.builder()
    .ovhSubsidiary("string")
    .region("string")
    .displayName("string")
    .build());

    okms_resource = ovh.okms.Okms("okmsResource",
    ovh_subsidiary="string",
    region="string",
    display_name="string")

    const okmsResource = new ovh.okms.Okms("okmsResource", {
    ovhSubsidiary: "string",
    region: "string",
    displayName: "string",
});

    type: ovh:Okms:Okms
properties:
    displayName: string
    ovhSubsidiary: string
    region: string

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

    OvhSubsidiary string
    OVH subsidiaries
    Region string
    KMS region
    DisplayName string
    (String) Resource display name
    OvhSubsidiary string
    OVH subsidiaries
    Region string
    KMS region
    DisplayName string
    (String) Resource display name
    ovhSubsidiary String
    OVH subsidiaries
    region String
    KMS region
    displayName String
    (String) Resource display name
    ovhSubsidiary string
    OVH subsidiaries
    region string
    KMS region
    displayName string
    (String) Resource display name
    ovh_subsidiary str
    OVH subsidiaries
    region str
    KMS region
    display_name str
    (String) Resource display name
    ovhSubsidiary String
    OVH subsidiaries
    region String
    KMS region
    displayName String
    (String) Resource display name

    Outputs

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

    Iam OkmsIam
    (Attributes) IAM resource metadata (see below for nested schema)
    Id string
    The provider-assigned unique ID for this managed resource.
    KmipEndpoint string
    (String) KMS kmip API endpoint
    PublicCa string
    (String) KMS public CA (Certificate Authority)
    RestEndpoint string
    (String) KMS rest API endpoint
    SwaggerEndpoint string
    (String) KMS rest API swagger UI
    Iam OkmsIam
    (Attributes) IAM resource metadata (see below for nested schema)
    Id string
    The provider-assigned unique ID for this managed resource.
    KmipEndpoint string
    (String) KMS kmip API endpoint
    PublicCa string
    (String) KMS public CA (Certificate Authority)
    RestEndpoint string
    (String) KMS rest API endpoint
    SwaggerEndpoint string
    (String) KMS rest API swagger UI
    iam Iam
    (Attributes) IAM resource metadata (see below for nested schema)
    id String
    The provider-assigned unique ID for this managed resource.
    kmipEndpoint String
    (String) KMS kmip API endpoint
    publicCa String
    (String) KMS public CA (Certificate Authority)
    restEndpoint String
    (String) KMS rest API endpoint
    swaggerEndpoint String
    (String) KMS rest API swagger UI
    iam OkmsIam
    (Attributes) IAM resource metadata (see below for nested schema)
    id string
    The provider-assigned unique ID for this managed resource.
    kmipEndpoint string
    (String) KMS kmip API endpoint
    publicCa string
    (String) KMS public CA (Certificate Authority)
    restEndpoint string
    (String) KMS rest API endpoint
    swaggerEndpoint string
    (String) KMS rest API swagger UI
    iam okms.OkmsIam
    (Attributes) IAM resource metadata (see below for nested schema)
    id str
    The provider-assigned unique ID for this managed resource.
    kmip_endpoint str
    (String) KMS kmip API endpoint
    public_ca str
    (String) KMS public CA (Certificate Authority)
    rest_endpoint str
    (String) KMS rest API endpoint
    swagger_endpoint str
    (String) KMS rest API swagger UI
    iam Property Map
    (Attributes) IAM resource metadata (see below for nested schema)
    id String
    The provider-assigned unique ID for this managed resource.
    kmipEndpoint String
    (String) KMS kmip API endpoint
    publicCa String
    (String) KMS public CA (Certificate Authority)
    restEndpoint String
    (String) KMS rest API endpoint
    swaggerEndpoint String
    (String) KMS rest API swagger UI

    Look up Existing Okms Resource

    Get an existing Okms 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?: OkmsState, opts?: CustomResourceOptions): Okms
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        display_name: Optional[str] = None,
        iam: Optional[_okms.OkmsIamArgs] = None,
        kmip_endpoint: Optional[str] = None,
        ovh_subsidiary: Optional[str] = None,
        public_ca: Optional[str] = None,
        region: Optional[str] = None,
        rest_endpoint: Optional[str] = None,
        swagger_endpoint: Optional[str] = None) -> Okms
    func GetOkms(ctx *Context, name string, id IDInput, state *OkmsState, opts ...ResourceOption) (*Okms, error)
    public static Okms Get(string name, Input<string> id, OkmsState? state, CustomResourceOptions? opts = null)
    public static Okms get(String name, Output<String> id, OkmsState state, CustomResourceOptions options)
    resources:  _:    type: ovh:Okms:Okms    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:
    DisplayName string
    (String) Resource display name
    Iam OkmsIam
    (Attributes) IAM resource metadata (see below for nested schema)
    KmipEndpoint string
    (String) KMS kmip API endpoint
    OvhSubsidiary string
    OVH subsidiaries
    PublicCa string
    (String) KMS public CA (Certificate Authority)
    Region string
    KMS region
    RestEndpoint string
    (String) KMS rest API endpoint
    SwaggerEndpoint string
    (String) KMS rest API swagger UI
    DisplayName string
    (String) Resource display name
    Iam OkmsIamArgs
    (Attributes) IAM resource metadata (see below for nested schema)
    KmipEndpoint string
    (String) KMS kmip API endpoint
    OvhSubsidiary string
    OVH subsidiaries
    PublicCa string
    (String) KMS public CA (Certificate Authority)
    Region string
    KMS region
    RestEndpoint string
    (String) KMS rest API endpoint
    SwaggerEndpoint string
    (String) KMS rest API swagger UI
    displayName String
    (String) Resource display name
    iam Iam
    (Attributes) IAM resource metadata (see below for nested schema)
    kmipEndpoint String
    (String) KMS kmip API endpoint
    ovhSubsidiary String
    OVH subsidiaries
    publicCa String
    (String) KMS public CA (Certificate Authority)
    region String
    KMS region
    restEndpoint String
    (String) KMS rest API endpoint
    swaggerEndpoint String
    (String) KMS rest API swagger UI
    displayName string
    (String) Resource display name
    iam OkmsIam
    (Attributes) IAM resource metadata (see below for nested schema)
    kmipEndpoint string
    (String) KMS kmip API endpoint
    ovhSubsidiary string
    OVH subsidiaries
    publicCa string
    (String) KMS public CA (Certificate Authority)
    region string
    KMS region
    restEndpoint string
    (String) KMS rest API endpoint
    swaggerEndpoint string
    (String) KMS rest API swagger UI
    display_name str
    (String) Resource display name
    iam okms.OkmsIamArgs
    (Attributes) IAM resource metadata (see below for nested schema)
    kmip_endpoint str
    (String) KMS kmip API endpoint
    ovh_subsidiary str
    OVH subsidiaries
    public_ca str
    (String) KMS public CA (Certificate Authority)
    region str
    KMS region
    rest_endpoint str
    (String) KMS rest API endpoint
    swagger_endpoint str
    (String) KMS rest API swagger UI
    displayName String
    (String) Resource display name
    iam Property Map
    (Attributes) IAM resource metadata (see below for nested schema)
    kmipEndpoint String
    (String) KMS kmip API endpoint
    ovhSubsidiary String
    OVH subsidiaries
    publicCa String
    (String) KMS public CA (Certificate Authority)
    region String
    KMS region
    restEndpoint String
    (String) KMS rest API endpoint
    swaggerEndpoint String
    (String) KMS rest API swagger UI

    Supporting Types

    OkmsIam, OkmsIamArgs

    DisplayName string
    (String) Resource display name
    Id string
    (String) Unique identifier of the resource
    Tags Dictionary<string, string>
    (Map of String) Resource tags. Tags that were internally computed are prefixed with ovh:
    Urn string
    (String) Unique resource name used in policies
    DisplayName string
    (String) Resource display name
    Id string
    (String) Unique identifier of the resource
    Tags map[string]string
    (Map of String) Resource tags. Tags that were internally computed are prefixed with ovh:
    Urn string
    (String) Unique resource name used in policies
    displayName String
    (String) Resource display name
    id String
    (String) Unique identifier of the resource
    tags Map<String,String>
    (Map of String) Resource tags. Tags that were internally computed are prefixed with ovh:
    urn String
    (String) Unique resource name used in policies
    displayName string
    (String) Resource display name
    id string
    (String) Unique identifier of the resource
    tags {[key: string]: string}
    (Map of String) Resource tags. Tags that were internally computed are prefixed with ovh:
    urn string
    (String) Unique resource name used in policies
    display_name str
    (String) Resource display name
    id str
    (String) Unique identifier of the resource
    tags Mapping[str, str]
    (Map of String) Resource tags. Tags that were internally computed are prefixed with ovh:
    urn str
    (String) Unique resource name used in policies
    displayName String
    (String) Resource display name
    id String
    (String) Unique identifier of the resource
    tags Map<String>
    (Map of String) Resource tags. Tags that were internally computed are prefixed with ovh:
    urn String
    (String) Unique resource name used in policies

    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