Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getKeyVersion

This data source provides details about a specific Key Version resource in Oracle Cloud Infrastructure Kms service.

Gets information about the specified key version.

As a management operation, this call is subject to a Key Management limit that applies to the total number of requests across all management read operations. Key Management might throttle this call to reject an otherwise valid request when the total rate of management read operations exceeds 10 requests per second for a given tenancy.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testKeyVersion = Oci.Kms.GetKeyVersion.Invoke(new()
    {
        KeyId = oci_kms_key.Test_key.Id,
        KeyVersionId = oci_kms_key_version.Test_key_version.Id,
        ManagementEndpoint = @var.Key_version_management_endpoint,
    });

});
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/Kms"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Kms.GetKeyVersion(ctx, &kms.GetKeyVersionArgs{
			KeyId:              oci_kms_key.Test_key.Id,
			KeyVersionId:       oci_kms_key_version.Test_key_version.Id,
			ManagementEndpoint: _var.Key_version_management_endpoint,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Kms.KmsFunctions;
import com.pulumi.oci.Kms.inputs.GetKeyVersionArgs;
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 testKeyVersion = KmsFunctions.getKeyVersion(GetKeyVersionArgs.builder()
            .keyId(oci_kms_key.test_key().id())
            .keyVersionId(oci_kms_key_version.test_key_version().id())
            .managementEndpoint(var_.key_version_management_endpoint())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_key_version = oci.Kms.get_key_version(key_id=oci_kms_key["test_key"]["id"],
    key_version_id=oci_kms_key_version["test_key_version"]["id"],
    management_endpoint=var["key_version_management_endpoint"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testKeyVersion = oci.Kms.getKeyVersion({
    keyId: oci_kms_key.test_key.id,
    keyVersionId: oci_kms_key_version.test_key_version.id,
    managementEndpoint: _var.key_version_management_endpoint,
});
variables:
  testKeyVersion:
    Fn::Invoke:
      Function: oci:Kms:getKeyVersion
      Arguments:
        keyId: ${oci_kms_key.test_key.id}
        keyVersionId: ${oci_kms_key_version.test_key_version.id}
        managementEndpoint: ${var.key_version_management_endpoint}

Using getKeyVersion

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 getKeyVersion(args: GetKeyVersionArgs, opts?: InvokeOptions): Promise<GetKeyVersionResult>
function getKeyVersionOutput(args: GetKeyVersionOutputArgs, opts?: InvokeOptions): Output<GetKeyVersionResult>
def get_key_version(key_id: Optional[str] = None,
                    key_version_id: Optional[str] = None,
                    management_endpoint: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetKeyVersionResult
def get_key_version_output(key_id: Optional[pulumi.Input[str]] = None,
                    key_version_id: Optional[pulumi.Input[str]] = None,
                    management_endpoint: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetKeyVersionResult]
func GetKeyVersion(ctx *Context, args *GetKeyVersionArgs, opts ...InvokeOption) (*GetKeyVersionResult, error)
func GetKeyVersionOutput(ctx *Context, args *GetKeyVersionOutputArgs, opts ...InvokeOption) GetKeyVersionResultOutput

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

public static class GetKeyVersion 
{
    public static Task<GetKeyVersionResult> InvokeAsync(GetKeyVersionArgs args, InvokeOptions? opts = null)
    public static Output<GetKeyVersionResult> Invoke(GetKeyVersionInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetKeyVersionResult> getKeyVersion(GetKeyVersionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:Kms/getKeyVersion:getKeyVersion
  arguments:
    # arguments dictionary

The following arguments are supported:

KeyId string

The OCID of the key.

KeyVersionId string

The OCID of the key version.

ManagementEndpoint string

The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint.

KeyId string

The OCID of the key.

KeyVersionId string

The OCID of the key version.

ManagementEndpoint string

The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint.

keyId String

The OCID of the key.

keyVersionId String

The OCID of the key version.

managementEndpoint String

The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint.

keyId string

The OCID of the key.

keyVersionId string

The OCID of the key version.

managementEndpoint string

The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint.

key_id str

The OCID of the key.

key_version_id str

The OCID of the key version.

management_endpoint str

The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint.

keyId String

The OCID of the key.

keyVersionId String

The OCID of the key version.

managementEndpoint String

The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint.

getKeyVersion Result

The following output properties are available:

CompartmentId string

The OCID of the compartment that contains this key version.

Id string

The OCID of the key version.

IsPrimary bool

A boolean that will be true when key version is primary, and will be false when key version is a replica from a primary key version.

KeyId string

The OCID of the master encryption key associated with this key version.

KeyVersionId string

The OCID of the key version.

ManagementEndpoint string
PublicKey string

The public key in PEM format. (This value pertains only to RSA and ECDSA keys.)

ReplicaDetails List<GetKeyVersionReplicaDetail>

KeyVersion replica details

RestoredFromKeyId string
RestoredFromKeyVersionId string

The OCID of the key version from which this key version was restored.

State string

The key version's current lifecycle state. Example: ENABLED

TimeCreated string

The date and time this key version was created, expressed in RFC 3339 timestamp format. Example: "2018-04-03T21:10:29.600Z"

TimeOfDeletion string

An optional property to indicate when to delete the key version, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

VaultId string

The OCID of the vault that contains this key version.

CompartmentId string

The OCID of the compartment that contains this key version.

Id string

The OCID of the key version.

IsPrimary bool

A boolean that will be true when key version is primary, and will be false when key version is a replica from a primary key version.

KeyId string

The OCID of the master encryption key associated with this key version.

KeyVersionId string

The OCID of the key version.

ManagementEndpoint string
PublicKey string

The public key in PEM format. (This value pertains only to RSA and ECDSA keys.)

ReplicaDetails []GetKeyVersionReplicaDetail

KeyVersion replica details

RestoredFromKeyId string
RestoredFromKeyVersionId string

The OCID of the key version from which this key version was restored.

State string

The key version's current lifecycle state. Example: ENABLED

TimeCreated string

The date and time this key version was created, expressed in RFC 3339 timestamp format. Example: "2018-04-03T21:10:29.600Z"

TimeOfDeletion string

An optional property to indicate when to delete the key version, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

VaultId string

The OCID of the vault that contains this key version.

compartmentId String

The OCID of the compartment that contains this key version.

id String

The OCID of the key version.

isPrimary Boolean

A boolean that will be true when key version is primary, and will be false when key version is a replica from a primary key version.

keyId String

The OCID of the master encryption key associated with this key version.

keyVersionId String

The OCID of the key version.

managementEndpoint String
publicKey String

The public key in PEM format. (This value pertains only to RSA and ECDSA keys.)

replicaDetails List<GetKeyVersionReplicaDetail>

KeyVersion replica details

restoredFromKeyId String
restoredFromKeyVersionId String

The OCID of the key version from which this key version was restored.

state String

The key version's current lifecycle state. Example: ENABLED

timeCreated String

The date and time this key version was created, expressed in RFC 3339 timestamp format. Example: "2018-04-03T21:10:29.600Z"

timeOfDeletion String

An optional property to indicate when to delete the key version, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

vaultId String

The OCID of the vault that contains this key version.

compartmentId string

The OCID of the compartment that contains this key version.

id string

The OCID of the key version.

isPrimary boolean

A boolean that will be true when key version is primary, and will be false when key version is a replica from a primary key version.

keyId string

The OCID of the master encryption key associated with this key version.

keyVersionId string

The OCID of the key version.

managementEndpoint string
publicKey string

The public key in PEM format. (This value pertains only to RSA and ECDSA keys.)

replicaDetails GetKeyVersionReplicaDetail[]

KeyVersion replica details

restoredFromKeyId string
restoredFromKeyVersionId string

The OCID of the key version from which this key version was restored.

state string

The key version's current lifecycle state. Example: ENABLED

timeCreated string

The date and time this key version was created, expressed in RFC 3339 timestamp format. Example: "2018-04-03T21:10:29.600Z"

timeOfDeletion string

An optional property to indicate when to delete the key version, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

vaultId string

The OCID of the vault that contains this key version.

compartment_id str

The OCID of the compartment that contains this key version.

id str

The OCID of the key version.

is_primary bool

A boolean that will be true when key version is primary, and will be false when key version is a replica from a primary key version.

key_id str

The OCID of the master encryption key associated with this key version.

key_version_id str

The OCID of the key version.

management_endpoint str
public_key str

The public key in PEM format. (This value pertains only to RSA and ECDSA keys.)

replica_details GetKeyVersionReplicaDetail]

KeyVersion replica details

restored_from_key_id str
restored_from_key_version_id str

The OCID of the key version from which this key version was restored.

state str

The key version's current lifecycle state. Example: ENABLED

time_created str

The date and time this key version was created, expressed in RFC 3339 timestamp format. Example: "2018-04-03T21:10:29.600Z"

time_of_deletion str

An optional property to indicate when to delete the key version, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

vault_id str

The OCID of the vault that contains this key version.

compartmentId String

The OCID of the compartment that contains this key version.

id String

The OCID of the key version.

isPrimary Boolean

A boolean that will be true when key version is primary, and will be false when key version is a replica from a primary key version.

keyId String

The OCID of the master encryption key associated with this key version.

keyVersionId String

The OCID of the key version.

managementEndpoint String
publicKey String

The public key in PEM format. (This value pertains only to RSA and ECDSA keys.)

replicaDetails List<Property Map>

KeyVersion replica details

restoredFromKeyId String
restoredFromKeyVersionId String

The OCID of the key version from which this key version was restored.

state String

The key version's current lifecycle state. Example: ENABLED

timeCreated String

The date and time this key version was created, expressed in RFC 3339 timestamp format. Example: "2018-04-03T21:10:29.600Z"

timeOfDeletion String

An optional property to indicate when to delete the key version, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

vaultId String

The OCID of the vault that contains this key version.

Supporting Types

GetKeyVersionReplicaDetail

ReplicationId string

ReplicationId associated with a key version operation

ReplicationId string

ReplicationId associated with a key version operation

replicationId String

ReplicationId associated with a key version operation

replicationId string

ReplicationId associated with a key version operation

replication_id str

ReplicationId associated with a key version operation

replicationId String

ReplicationId associated with a key version operation

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.