Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. OVH
  3. API Docs
  4. Okms
  5. getOkmsResource
OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud
ovh/pulumi-ovh

ovh.Okms.getOkmsResource

Explore with Pulumi AI

ovh logo
OVHCloud v2.1.1 published on Thursday, Apr 10, 2025 by OVHcloud
ovh/pulumi-ovh

    Use this data source to retrieve information about a KMS associated with this account

    Example Usage

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

const kms = ovh.Okms.getOkmsResource({
    id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
});

    import pulumi
import pulumi_ovh as ovh

kms = ovh.Okms.get_okms_resource(id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")

    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.GetOkmsResource(ctx, &okms.GetOkmsResourceArgs{
			Id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
		}, nil)
		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 kms = Ovh.Okms.GetOkmsResource.Invoke(new()
    {
        Id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.Okms.OkmsFunctions;
import com.pulumi.ovh.Okms.inputs.GetOkmsResourceArgs;
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) {
        final var kms = OkmsFunctions.getOkmsResource(GetOkmsResourceArgs.builder()
            .id("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
            .build());

    }
}

    variables:
  kms:
    fn::invoke:
      function: ovh:Okms:getOkmsResource
      arguments:
        id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

    Using getOkmsResource

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getOkmsResource(args: GetOkmsResourceArgs, opts?: InvokeOptions): Promise<GetOkmsResourceResult>
function getOkmsResourceOutput(args: GetOkmsResourceOutputArgs, opts?: InvokeOptions): Output<GetOkmsResourceResult>
    def get_okms_resource(id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetOkmsResourceResult
def get_okms_resource_output(id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetOkmsResourceResult]
    func GetOkmsResource(ctx *Context, args *GetOkmsResourceArgs, opts ...InvokeOption) (*GetOkmsResourceResult, error)
func GetOkmsResourceOutput(ctx *Context, args *GetOkmsResourceOutputArgs, opts ...InvokeOption) GetOkmsResourceResultOutput

    > Note: This function is named GetOkmsResource in the Go SDK.

    public static class GetOkmsResource 
{
    public static Task<GetOkmsResourceResult> InvokeAsync(GetOkmsResourceArgs args, InvokeOptions? opts = null)
    public static Output<GetOkmsResourceResult> Invoke(GetOkmsResourceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOkmsResourceResult> getOkmsResource(GetOkmsResourceArgs args, InvokeOptions options)
public static Output<GetOkmsResourceResult> getOkmsResource(GetOkmsResourceArgs args, InvokeOptions options)

    fn::invoke:
  function: ovh:Okms/getOkmsResource:getOkmsResource
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Should be set to the ID of your KMS
    Id string
    Should be set to the ID of your KMS
    id String
    Should be set to the ID of your KMS
    id string
    Should be set to the ID of your KMS
    id str
    Should be set to the ID of your KMS
    id String
    Should be set to the ID of your KMS

    getOkmsResource Result

    The following output properties are available:

    Iam GetOkmsResourceIam
    (Attributes) IAM resource metadata (see below for nested schema)
    Id string
    (String) Unique identifier of the resource
    KmipEndpoint string
    (String) KMS kmip API endpoint
    PublicCa string
    (String) KMS public CA (Certificate Authority)
    Region string
    (String) Region
    RestEndpoint string
    (String) KMS rest API endpoint
    SwaggerEndpoint string
    (String) KMS rest API swagger UI
    Iam GetOkmsResourceIam
    (Attributes) IAM resource metadata (see below for nested schema)
    Id string
    (String) Unique identifier of the resource
    KmipEndpoint string
    (String) KMS kmip API endpoint
    PublicCa string
    (String) KMS public CA (Certificate Authority)
    Region string
    (String) Region
    RestEndpoint string
    (String) KMS rest API endpoint
    SwaggerEndpoint string
    (String) KMS rest API swagger UI
    iam GetResourceIam
    (Attributes) IAM resource metadata (see below for nested schema)
    id String
    (String) Unique identifier of the resource
    kmipEndpoint String
    (String) KMS kmip API endpoint
    publicCa String
    (String) KMS public CA (Certificate Authority)
    region String
    (String) Region
    restEndpoint String
    (String) KMS rest API endpoint
    swaggerEndpoint String
    (String) KMS rest API swagger UI
    iam GetOkmsResourceIam
    (Attributes) IAM resource metadata (see below for nested schema)
    id string
    (String) Unique identifier of the resource
    kmipEndpoint string
    (String) KMS kmip API endpoint
    publicCa string
    (String) KMS public CA (Certificate Authority)
    region string
    (String) Region
    restEndpoint string
    (String) KMS rest API endpoint
    swaggerEndpoint string
    (String) KMS rest API swagger UI
    iam okms.GetOkmsResourceIam
    (Attributes) IAM resource metadata (see below for nested schema)
    id str
    (String) Unique identifier of the resource
    kmip_endpoint str
    (String) KMS kmip API endpoint
    public_ca str
    (String) KMS public CA (Certificate Authority)
    region str
    (String) Region
    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
    (String) Unique identifier of the resource
    kmipEndpoint String
    (String) KMS kmip API endpoint
    publicCa String
    (String) KMS public CA (Certificate Authority)
    region String
    (String) Region
    restEndpoint String
    (String) KMS rest API endpoint
    swaggerEndpoint String
    (String) KMS rest API swagger UI

    Supporting Types

    GetOkmsResourceIam

    DisplayName string
    (String) Resource display name
    Id string
    Should be set to the ID of your KMS
    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
    Should be set to the ID of your KMS
    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
    Should be set to the ID of your KMS
    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
    Should be set to the ID of your KMS
    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
    Should be set to the ID of your KMS
    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
    Should be set to the ID of your KMS
    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.1.1 published on Thursday, Apr 10, 2025 by OVHcloud
    ovh/pulumi-ovh