Oracle Cloud Infrastructure v2.11.0, Sep 19 24

Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

oci.Kms.getKey

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

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

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

const testKey = oci.Kms.getKey({
    keyId: testKeyOciKmsKey.id,
    managementEndpoint: keyManagementEndpoint,
});

import pulumi
import pulumi_oci as oci

test_key = oci.Kms.get_key(key_id=test_key_oci_kms_key["id"],
    management_endpoint=key_management_endpoint)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Kms.GetKey(ctx, &kms.GetKeyArgs{
			KeyId:              testKeyOciKmsKey.Id,
			ManagementEndpoint: keyManagementEndpoint,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testKey = Oci.Kms.GetKey.Invoke(new()
    {
        KeyId = testKeyOciKmsKey.Id,
        ManagementEndpoint = keyManagementEndpoint,
    });

});

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.GetKeyArgs;
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 testKey = KmsFunctions.getKey(GetKeyArgs.builder()
            .keyId(testKeyOciKmsKey.id())
            .managementEndpoint(keyManagementEndpoint)
            .build());

    }
}

variables:
  testKey:
    fn::invoke:
      Function: oci:Kms:getKey
      Arguments:
        keyId: ${testKeyOciKmsKey.id}
        managementEndpoint: ${keyManagementEndpoint}

Using getKey

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 getKey(args: GetKeyArgs, opts?: InvokeOptions): Promise<GetKeyResult>
function getKeyOutput(args: GetKeyOutputArgs, opts?: InvokeOptions): Output<GetKeyResult>

def get_key(key_id: Optional[str] = None,
            management_endpoint: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetKeyResult
def get_key_output(key_id: Optional[pulumi.Input[str]] = None,
            management_endpoint: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetKeyResult]

func GetKey(ctx *Context, args *GetKeyArgs, opts ...InvokeOption) (*GetKeyResult, error)
func GetKeyOutput(ctx *Context, args *GetKeyOutputArgs, opts ...InvokeOption) GetKeyResultOutput

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

public static class GetKey 
{
    public static Task<GetKeyResult> InvokeAsync(GetKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetKeyResult> Invoke(GetKeyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetKeyResult> getKey(GetKeyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:Kms/getKey:getKey
  arguments:
    # arguments dictionary

The following arguments are supported:

KeyId string: The OCID of the key.
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.
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.
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.
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.
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.
managementEndpoint String: The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint.

getKey Result

The following output properties are available:

AutoKeyRotationDetails List<GetKeyAutoKeyRotationDetail>: The details of auto rotation schedule for the Key being create updated or imported.
CompartmentId string: The OCID of the compartment that contains this master encryption key.
CurrentKeyVersion string: The OCID of the key version used in cryptographic operations. During key rotation, the service might be in a transitional state where this or a newer key version are used intermittently. The currentKeyVersion property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DesiredState string
DisplayName string: A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.
ExternalKeyReferenceDetails List<GetKeyExternalKeyReferenceDetail>: Key reference data to be returned to the customer as a response.
ExternalKeyReferences List<GetKeyExternalKeyReference>
FreeformTags Dictionary<string, string>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of the key.
IsAutoRotationEnabled bool: A parameter specifying whether the auto key rotation is enabled or not.
IsPrimary bool: A Boolean value that indicates whether the Key belongs to primary Vault or replica vault.
KeyId string
KeyShapes List<GetKeyKeyShape>: The cryptographic properties of a key.
ManagementEndpoint string
ProtectionMode string: The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A protection mode of HSM means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside the HSM. A protection mode of SOFTWARE means that the key persists on the server, protected by the vault's RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of SOFTWARE are performed on the server. By default, a key's protection mode is set to HSM. You can't change a key's protection mode after the key is created or imported. A protection mode of EXTERNAL mean that the key persists on the customer's external key manager which is hosted externally outside of oracle. Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of EXTERNAL are performed by external key manager.
ReplicaDetails List<GetKeyReplicaDetail>: Key replica details
RestoreFromFiles List<GetKeyRestoreFromFile>: Details where key was backed up.
RestoreFromObjectStores List<GetKeyRestoreFromObjectStore>: Details where key was backed up
RestoreTrigger bool: When flipped, triggers restore if restore options are provided. Values of 0 or 1 are supported.
RestoredFromKeyId string: The OCID of the key from which this key was restored.
State string: The key's current lifecycle state. Example: ENABLED
TimeCreated string: The date and time the key was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
TimeOfDeletion string: An optional property indicating when to delete the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z
VaultId string: The OCID of the vault that contains this key.

AutoKeyRotationDetails []GetKeyAutoKeyRotationDetail: The details of auto rotation schedule for the Key being create updated or imported.
CompartmentId string: The OCID of the compartment that contains this master encryption key.
CurrentKeyVersion string: The OCID of the key version used in cryptographic operations. During key rotation, the service might be in a transitional state where this or a newer key version are used intermittently. The currentKeyVersion property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DesiredState string
DisplayName string: A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.
ExternalKeyReferenceDetails []GetKeyExternalKeyReferenceDetail: Key reference data to be returned to the customer as a response.
ExternalKeyReferences []GetKeyExternalKeyReference
FreeformTags map[string]string: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of the key.
IsAutoRotationEnabled bool: A parameter specifying whether the auto key rotation is enabled or not.
IsPrimary bool: A Boolean value that indicates whether the Key belongs to primary Vault or replica vault.
KeyId string
KeyShapes []GetKeyKeyShape: The cryptographic properties of a key.
ManagementEndpoint string
ProtectionMode string: The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A protection mode of HSM means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside the HSM. A protection mode of SOFTWARE means that the key persists on the server, protected by the vault's RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of SOFTWARE are performed on the server. By default, a key's protection mode is set to HSM. You can't change a key's protection mode after the key is created or imported. A protection mode of EXTERNAL mean that the key persists on the customer's external key manager which is hosted externally outside of oracle. Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of EXTERNAL are performed by external key manager.
ReplicaDetails []GetKeyReplicaDetail: Key replica details
RestoreFromFiles []GetKeyRestoreFromFile: Details where key was backed up.
RestoreFromObjectStores []GetKeyRestoreFromObjectStore: Details where key was backed up
RestoreTrigger bool: When flipped, triggers restore if restore options are provided. Values of 0 or 1 are supported.
RestoredFromKeyId string: The OCID of the key from which this key was restored.
State string: The key's current lifecycle state. Example: ENABLED
TimeCreated string: The date and time the key was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
TimeOfDeletion string: An optional property indicating when to delete the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z
VaultId string: The OCID of the vault that contains this key.

autoKeyRotationDetails List<GetKeyAutoKeyRotationDetail>: The details of auto rotation schedule for the Key being create updated or imported.
compartmentId String: The OCID of the compartment that contains this master encryption key.
currentKeyVersion String: The OCID of the key version used in cryptographic operations. During key rotation, the service might be in a transitional state where this or a newer key version are used intermittently. The currentKeyVersion property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
desiredState String
displayName String: A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.
externalKeyReferenceDetails List<GetKeyExternalKeyReferenceDetail>: Key reference data to be returned to the customer as a response.
externalKeyReferences List<GetKeyExternalKeyReference>
freeformTags Map<String,String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of the key.
isAutoRotationEnabled Boolean: A parameter specifying whether the auto key rotation is enabled or not.
isPrimary Boolean: A Boolean value that indicates whether the Key belongs to primary Vault or replica vault.
keyId String
keyShapes List<GetKeyKeyShape>: The cryptographic properties of a key.
managementEndpoint String
protectionMode String: The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A protection mode of HSM means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside the HSM. A protection mode of SOFTWARE means that the key persists on the server, protected by the vault's RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of SOFTWARE are performed on the server. By default, a key's protection mode is set to HSM. You can't change a key's protection mode after the key is created or imported. A protection mode of EXTERNAL mean that the key persists on the customer's external key manager which is hosted externally outside of oracle. Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of EXTERNAL are performed by external key manager.
replicaDetails List<GetKeyReplicaDetail>: Key replica details
restoreFromFiles List<GetKeyRestoreFromFile>: Details where key was backed up.
restoreFromObjectStores List<GetKeyRestoreFromObjectStore>: Details where key was backed up
restoreTrigger Boolean: When flipped, triggers restore if restore options are provided. Values of 0 or 1 are supported.
restoredFromKeyId String: The OCID of the key from which this key was restored.
state String: The key's current lifecycle state. Example: ENABLED
timeCreated String: The date and time the key was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
timeOfDeletion String: An optional property indicating when to delete the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z
vaultId String: The OCID of the vault that contains this key.

autoKeyRotationDetails GetKeyAutoKeyRotationDetail[]: The details of auto rotation schedule for the Key being create updated or imported.
compartmentId string: The OCID of the compartment that contains this master encryption key.
currentKeyVersion string: The OCID of the key version used in cryptographic operations. During key rotation, the service might be in a transitional state where this or a newer key version are used intermittently. The currentKeyVersion property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
desiredState string
displayName string: A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.
externalKeyReferenceDetails GetKeyExternalKeyReferenceDetail[]: Key reference data to be returned to the customer as a response.
externalKeyReferences GetKeyExternalKeyReference[]
freeformTags {[key: string]: string}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id string: The OCID of the key.
isAutoRotationEnabled boolean: A parameter specifying whether the auto key rotation is enabled or not.
isPrimary boolean: A Boolean value that indicates whether the Key belongs to primary Vault or replica vault.
keyId string
keyShapes GetKeyKeyShape[]: The cryptographic properties of a key.
managementEndpoint string
protectionMode string: The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A protection mode of HSM means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside the HSM. A protection mode of SOFTWARE means that the key persists on the server, protected by the vault's RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of SOFTWARE are performed on the server. By default, a key's protection mode is set to HSM. You can't change a key's protection mode after the key is created or imported. A protection mode of EXTERNAL mean that the key persists on the customer's external key manager which is hosted externally outside of oracle. Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of EXTERNAL are performed by external key manager.
replicaDetails GetKeyReplicaDetail[]: Key replica details
restoreFromFiles GetKeyRestoreFromFile[]: Details where key was backed up.
restoreFromObjectStores GetKeyRestoreFromObjectStore[]: Details where key was backed up
restoreTrigger boolean: When flipped, triggers restore if restore options are provided. Values of 0 or 1 are supported.
restoredFromKeyId string: The OCID of the key from which this key was restored.
state string: The key's current lifecycle state. Example: ENABLED
timeCreated string: The date and time the key was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
timeOfDeletion string: An optional property indicating when to delete the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z
vaultId string: The OCID of the vault that contains this key.

auto_key_rotation_details Sequence[kms.GetKeyAutoKeyRotationDetail]: The details of auto rotation schedule for the Key being create updated or imported.
compartment_id str: The OCID of the compartment that contains this master encryption key.
current_key_version str: The OCID of the key version used in cryptographic operations. During key rotation, the service might be in a transitional state where this or a newer key version are used intermittently. The currentKeyVersion property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
desired_state str
display_name str: A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.
external_key_reference_details Sequence[kms.GetKeyExternalKeyReferenceDetail]: Key reference data to be returned to the customer as a response.
external_key_references Sequence[kms.GetKeyExternalKeyReference]
freeform_tags Mapping[str, str]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id str: The OCID of the key.
is_auto_rotation_enabled bool: A parameter specifying whether the auto key rotation is enabled or not.
is_primary bool: A Boolean value that indicates whether the Key belongs to primary Vault or replica vault.
key_id str
key_shapes Sequence[kms.GetKeyKeyShape]: The cryptographic properties of a key.
management_endpoint str
protection_mode str: The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A protection mode of HSM means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside the HSM. A protection mode of SOFTWARE means that the key persists on the server, protected by the vault's RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of SOFTWARE are performed on the server. By default, a key's protection mode is set to HSM. You can't change a key's protection mode after the key is created or imported. A protection mode of EXTERNAL mean that the key persists on the customer's external key manager which is hosted externally outside of oracle. Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of EXTERNAL are performed by external key manager.
replica_details Sequence[kms.GetKeyReplicaDetail]: Key replica details
restore_from_files Sequence[kms.GetKeyRestoreFromFile]: Details where key was backed up.
restore_from_object_stores Sequence[kms.GetKeyRestoreFromObjectStore]: Details where key was backed up
restore_trigger bool: When flipped, triggers restore if restore options are provided. Values of 0 or 1 are supported.
restored_from_key_id str: The OCID of the key from which this key was restored.
state str: The key's current lifecycle state. Example: ENABLED
time_created str: The date and time the key was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
time_of_deletion str: An optional property indicating when to delete the key, 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.

autoKeyRotationDetails List<Property Map>: The details of auto rotation schedule for the Key being create updated or imported.
compartmentId String: The OCID of the compartment that contains this master encryption key.
currentKeyVersion String: The OCID of the key version used in cryptographic operations. During key rotation, the service might be in a transitional state where this or a newer key version are used intermittently. The currentKeyVersion property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
desiredState String
displayName String: A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.
externalKeyReferenceDetails List<Property Map>: Key reference data to be returned to the customer as a response.
externalKeyReferences List<Property Map>
freeformTags Map<String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of the key.
isAutoRotationEnabled Boolean: A parameter specifying whether the auto key rotation is enabled or not.
isPrimary Boolean: A Boolean value that indicates whether the Key belongs to primary Vault or replica vault.
keyId String
keyShapes List<Property Map>: The cryptographic properties of a key.
managementEndpoint String
protectionMode String: The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A protection mode of HSM means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside the HSM. A protection mode of SOFTWARE means that the key persists on the server, protected by the vault's RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of SOFTWARE are performed on the server. By default, a key's protection mode is set to HSM. You can't change a key's protection mode after the key is created or imported. A protection mode of EXTERNAL mean that the key persists on the customer's external key manager which is hosted externally outside of oracle. Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of EXTERNAL are performed by external key manager.
replicaDetails List<Property Map>: Key replica details
restoreFromFiles List<Property Map>: Details where key was backed up.
restoreFromObjectStores List<Property Map>: Details where key was backed up
restoreTrigger Boolean: When flipped, triggers restore if restore options are provided. Values of 0 or 1 are supported.
restoredFromKeyId String: The OCID of the key from which this key was restored.
state String: The key's current lifecycle state. Example: ENABLED
timeCreated String: The date and time the key was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
timeOfDeletion String: An optional property indicating when to delete the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z
vaultId String: The OCID of the vault that contains this key.

Supporting Types

GetKeyAutoKeyRotationDetail

LastRotationMessage string: The last execution status message of auto key rotation.
LastRotationStatus string: The status of last execution of auto key rotation.
RotationIntervalInDays int: The interval of auto key rotation. For auto key rotation the interval should between 60 day and 365 days (1 year). Note: User must specify this parameter when creating a new schedule.
TimeOfLastRotation string: A property indicating Last rotation Date. Example: 2023-04-04T00:00:00Z.
TimeOfNextRotation string: A property indicating Next estimated scheduled Time, as per the interval, expressed as date YYYY-MM-DD String. Example: 2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z.
TimeOfScheduleStart string: A property indicating scheduled start date expressed as date YYYY-MM-DD String. Example: `2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z . Note : Today’s date will be used if not specified by customer.

LastRotationMessage string: The last execution status message of auto key rotation.
LastRotationStatus string: The status of last execution of auto key rotation.
RotationIntervalInDays int: The interval of auto key rotation. For auto key rotation the interval should between 60 day and 365 days (1 year). Note: User must specify this parameter when creating a new schedule.
TimeOfLastRotation string: A property indicating Last rotation Date. Example: 2023-04-04T00:00:00Z.
TimeOfNextRotation string: A property indicating Next estimated scheduled Time, as per the interval, expressed as date YYYY-MM-DD String. Example: 2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z.
TimeOfScheduleStart string: A property indicating scheduled start date expressed as date YYYY-MM-DD String. Example: `2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z . Note : Today’s date will be used if not specified by customer.

lastRotationMessage String: The last execution status message of auto key rotation.
lastRotationStatus String: The status of last execution of auto key rotation.
rotationIntervalInDays Integer: The interval of auto key rotation. For auto key rotation the interval should between 60 day and 365 days (1 year). Note: User must specify this parameter when creating a new schedule.
timeOfLastRotation String: A property indicating Last rotation Date. Example: 2023-04-04T00:00:00Z.
timeOfNextRotation String: A property indicating Next estimated scheduled Time, as per the interval, expressed as date YYYY-MM-DD String. Example: 2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z.
timeOfScheduleStart String: A property indicating scheduled start date expressed as date YYYY-MM-DD String. Example: `2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z . Note : Today’s date will be used if not specified by customer.

lastRotationMessage string: The last execution status message of auto key rotation.
lastRotationStatus string: The status of last execution of auto key rotation.
rotationIntervalInDays number: The interval of auto key rotation. For auto key rotation the interval should between 60 day and 365 days (1 year). Note: User must specify this parameter when creating a new schedule.
timeOfLastRotation string: A property indicating Last rotation Date. Example: 2023-04-04T00:00:00Z.
timeOfNextRotation string: A property indicating Next estimated scheduled Time, as per the interval, expressed as date YYYY-MM-DD String. Example: 2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z.
timeOfScheduleStart string: A property indicating scheduled start date expressed as date YYYY-MM-DD String. Example: `2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z . Note : Today’s date will be used if not specified by customer.

last_rotation_message str: The last execution status message of auto key rotation.
last_rotation_status str: The status of last execution of auto key rotation.
rotation_interval_in_days int: The interval of auto key rotation. For auto key rotation the interval should between 60 day and 365 days (1 year). Note: User must specify this parameter when creating a new schedule.
time_of_last_rotation str: A property indicating Last rotation Date. Example: 2023-04-04T00:00:00Z.
time_of_next_rotation str: A property indicating Next estimated scheduled Time, as per the interval, expressed as date YYYY-MM-DD String. Example: 2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z.
time_of_schedule_start str: A property indicating scheduled start date expressed as date YYYY-MM-DD String. Example: `2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z . Note : Today’s date will be used if not specified by customer.

lastRotationMessage String: The last execution status message of auto key rotation.
lastRotationStatus String: The status of last execution of auto key rotation.
rotationIntervalInDays Number: The interval of auto key rotation. For auto key rotation the interval should between 60 day and 365 days (1 year). Note: User must specify this parameter when creating a new schedule.
timeOfLastRotation String: A property indicating Last rotation Date. Example: 2023-04-04T00:00:00Z.
timeOfNextRotation String: A property indicating Next estimated scheduled Time, as per the interval, expressed as date YYYY-MM-DD String. Example: 2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z.
timeOfScheduleStart String: A property indicating scheduled start date expressed as date YYYY-MM-DD String. Example: `2023-04-04T00:00:00Z. The time has no significance when scheduling an auto key rotation as this can be done anytime approximately the scheduled day, KMS ignores the time and replaces it with 00:00, for example 2023-04-04T15:14:13Z will be used as 2023-04-04T00:00:00Z . Note : Today’s date will be used if not specified by customer.

GetKeyExternalKeyReference

ExternalKeyId string: ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM.

ExternalKeyId string: ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM.

externalKeyId String: ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM.

externalKeyId string: ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM.

external_key_id str: ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM.

externalKeyId String: ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM.

GetKeyExternalKeyReferenceDetail

ExternalKeyId string: ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM.
ExternalKeyVersionId string: Key version ID associated with the external key.

ExternalKeyId string: ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM.
ExternalKeyVersionId string: Key version ID associated with the external key.

externalKeyId String: ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM.
externalKeyVersionId String: Key version ID associated with the external key.

externalKeyId string: ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM.
externalKeyVersionId string: Key version ID associated with the external key.

external_key_id str: ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM.
external_key_version_id str: Key version ID associated with the external key.

externalKeyId String: ExternalKeyId refers to the globally unique key Id associated with the key created in external vault in CTM.
externalKeyVersionId String: Key version ID associated with the external key.

GetKeyKeyShape

Algorithm string

The algorithm used by a key's key versions to encrypt or decrypt. Only AES algorithm is supported for External keys.

CurveId string

Supported curve IDs for ECDSA keys.

Length int

The length of the key in bytes, expressed as an integer. Supported values include the following:

AES: 16, 24, or 32
RSA: 256, 384, or 512
ECDSA: 32, 48, or 66

Algorithm string

The algorithm used by a key's key versions to encrypt or decrypt. Only AES algorithm is supported for External keys.

CurveId string

Supported curve IDs for ECDSA keys.

Length int

The length of the key in bytes, expressed as an integer. Supported values include the following:

AES: 16, 24, or 32
RSA: 256, 384, or 512
ECDSA: 32, 48, or 66

algorithm String

The algorithm used by a key's key versions to encrypt or decrypt. Only AES algorithm is supported for External keys.

curveId String

Supported curve IDs for ECDSA keys.

length Integer

The length of the key in bytes, expressed as an integer. Supported values include the following:

AES: 16, 24, or 32
RSA: 256, 384, or 512
ECDSA: 32, 48, or 66

algorithm string

The algorithm used by a key's key versions to encrypt or decrypt. Only AES algorithm is supported for External keys.

curveId string

Supported curve IDs for ECDSA keys.

length number

The length of the key in bytes, expressed as an integer. Supported values include the following:

AES: 16, 24, or 32
RSA: 256, 384, or 512
ECDSA: 32, 48, or 66

algorithm str

The algorithm used by a key's key versions to encrypt or decrypt. Only AES algorithm is supported for External keys.

curve_id str

Supported curve IDs for ECDSA keys.

length int

The length of the key in bytes, expressed as an integer. Supported values include the following:

AES: 16, 24, or 32
RSA: 256, 384, or 512
ECDSA: 32, 48, or 66

algorithm String

The algorithm used by a key's key versions to encrypt or decrypt. Only AES algorithm is supported for External keys.

curveId String

Supported curve IDs for ECDSA keys.

length Number

The length of the key in bytes, expressed as an integer. Supported values include the following:

AES: 16, 24, or 32
RSA: 256, 384, or 512
ECDSA: 32, 48, or 66

GetKeyReplicaDetail

ReplicationId string: ReplicationId associated with a key operation

ReplicationId string: ReplicationId associated with a key operation

replicationId String: ReplicationId associated with a key operation

replicationId string: ReplicationId associated with a key operation

replication_id str: ReplicationId associated with a key operation

replicationId String: ReplicationId associated with a key operation

GetKeyRestoreFromFile

ContentLength string: content length of key's backup binary file
ContentMd5 string: content md5 hashed value of key's backup file
RestoreKeyFromFileDetails string: Key backup file content

ContentLength string: content length of key's backup binary file
ContentMd5 string: content md5 hashed value of key's backup file
RestoreKeyFromFileDetails string: Key backup file content

contentLength String: content length of key's backup binary file
contentMd5 String: content md5 hashed value of key's backup file
restoreKeyFromFileDetails String: Key backup file content

contentLength string: content length of key's backup binary file
contentMd5 string: content md5 hashed value of key's backup file
restoreKeyFromFileDetails string: Key backup file content

content_length str: content length of key's backup binary file
content_md5 str: content md5 hashed value of key's backup file
restore_key_from_file_details str: Key backup file content

contentLength String: content length of key's backup binary file
contentMd5 String: content md5 hashed value of key's backup file
restoreKeyFromFileDetails String: Key backup file content

GetKeyRestoreFromObjectStore

Bucket string: Name of the bucket where key was backed up
Destination string: Type of backup to restore from. Values of "BUCKET", "PRE_AUTHENTICATED_REQUEST_URI" are supported
Namespace string: Namespace of the bucket where key was backed up
Object string: Object containing the backup
Uri string: Pre-authenticated-request-uri of the backup

Bucket string: Name of the bucket where key was backed up
Destination string: Type of backup to restore from. Values of "BUCKET", "PRE_AUTHENTICATED_REQUEST_URI" are supported
Namespace string: Namespace of the bucket where key was backed up
Object string: Object containing the backup
Uri string: Pre-authenticated-request-uri of the backup

bucket String: Name of the bucket where key was backed up
destination String: Type of backup to restore from. Values of "BUCKET", "PRE_AUTHENTICATED_REQUEST_URI" are supported
namespace String: Namespace of the bucket where key was backed up
object String: Object containing the backup
uri String: Pre-authenticated-request-uri of the backup

bucket string: Name of the bucket where key was backed up
destination string: Type of backup to restore from. Values of "BUCKET", "PRE_AUTHENTICATED_REQUEST_URI" are supported
namespace string: Namespace of the bucket where key was backed up
object string: Object containing the backup
uri string: Pre-authenticated-request-uri of the backup

bucket str: Name of the bucket where key was backed up
destination str: Type of backup to restore from. Values of "BUCKET", "PRE_AUTHENTICATED_REQUEST_URI" are supported
namespace str: Namespace of the bucket where key was backed up
object str: Object containing the backup
uri str: Pre-authenticated-request-uri of the backup

bucket String: Name of the bucket where key was backed up
destination String: Type of backup to restore from. Values of "BUCKET", "PRE_AUTHENTICATED_REQUEST_URI" are supported
namespace String: Namespace of the bucket where key was backed up
object String: Object containing the backup
uri String: Pre-authenticated-request-uri of the backup

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

pulumi/pulumi-oci

oci.Kms.getKey

On this page

On this page

Example Usage

Using getKey

getKey Result

Supporting Types

GetKeyAutoKeyRotationDetail

GetKeyExternalKeyReference

GetKeyExternalKeyReferenceDetail

GetKeyKeyShape

GetKeyReplicaDetail

GetKeyRestoreFromFile

GetKeyRestoreFromObjectStore

Package Details

On this page

On this page