getKmsKeyPolicies

ibm 1.85.0, Nov 9 25

ibm 1.85.0 published on Sunday, Nov 9, 2025 by ibm-cloud

Schema (JSON)

ibm-cloud/terraform-provider-ibm

ibm 1.85.0 published on Sunday, Nov 9, 2025 by ibm-cloud

Schema (JSON)

ibm-cloud/terraform-provider-ibm

Import the details of existing Key Protect and Hyper Protect Crypto Service (HPCS) keys policies as a read-only data source. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. Retreives a list of key policies from the hs-crypto or key-protect instance for the provided key id.

Using getKmsKeyPolicies

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 getKmsKeyPolicies(args: GetKmsKeyPoliciesArgs, opts?: InvokeOptions): Promise<GetKmsKeyPoliciesResult>
function getKmsKeyPoliciesOutput(args: GetKmsKeyPoliciesOutputArgs, opts?: InvokeOptions): Output<GetKmsKeyPoliciesResult>

def get_kms_key_policies(alias: Optional[str] = None,
                         endpoint_type: Optional[str] = None,
                         id: Optional[str] = None,
                         instance_id: Optional[str] = None,
                         key_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetKmsKeyPoliciesResult
def get_kms_key_policies_output(alias: Optional[pulumi.Input[str]] = None,
                         endpoint_type: Optional[pulumi.Input[str]] = None,
                         id: Optional[pulumi.Input[str]] = None,
                         instance_id: Optional[pulumi.Input[str]] = None,
                         key_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetKmsKeyPoliciesResult]

func LookupKmsKeyPolicies(ctx *Context, args *LookupKmsKeyPoliciesArgs, opts ...InvokeOption) (*LookupKmsKeyPoliciesResult, error)
func LookupKmsKeyPoliciesOutput(ctx *Context, args *LookupKmsKeyPoliciesOutputArgs, opts ...InvokeOption) LookupKmsKeyPoliciesResultOutput

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

public static class GetKmsKeyPolicies 
{
    public static Task<GetKmsKeyPoliciesResult> InvokeAsync(GetKmsKeyPoliciesArgs args, InvokeOptions? opts = null)
    public static Output<GetKmsKeyPoliciesResult> Invoke(GetKmsKeyPoliciesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetKmsKeyPoliciesResult> getKmsKeyPolicies(GetKmsKeyPoliciesArgs args, InvokeOptions options)
public static Output<GetKmsKeyPoliciesResult> getKmsKeyPolicies(GetKmsKeyPoliciesArgs args, InvokeOptions options)

fn::invoke:
  function: ibm:index/getKmsKeyPolicies:getKmsKeyPolicies
  arguments:
    # arguments dictionary

The following arguments are supported:

InstanceId string: The keyprotect instance guid.
Alias string: The alias of the key.
EndpointType string: The type of the public or private endpoint to be used for fetching keys.
Id string: (String) The v4 UUID used to uniquely identify the policy resource, as specified by RFC 4122.
KeyId string: The id of the key.

InstanceId string: The keyprotect instance guid.
Alias string: The alias of the key.
EndpointType string: The type of the public or private endpoint to be used for fetching keys.
Id string: (String) The v4 UUID used to uniquely identify the policy resource, as specified by RFC 4122.
KeyId string: The id of the key.

instanceId String: The keyprotect instance guid.
alias String: The alias of the key.
endpointType String: The type of the public or private endpoint to be used for fetching keys.
id String: (String) The v4 UUID used to uniquely identify the policy resource, as specified by RFC 4122.
keyId String: The id of the key.

instanceId string: The keyprotect instance guid.
alias string: The alias of the key.
endpointType string: The type of the public or private endpoint to be used for fetching keys.
id string: (String) The v4 UUID used to uniquely identify the policy resource, as specified by RFC 4122.
keyId string: The id of the key.

instance_id str: The keyprotect instance guid.
alias str: The alias of the key.
endpoint_type str: The type of the public or private endpoint to be used for fetching keys.
id str: (String) The v4 UUID used to uniquely identify the policy resource, as specified by RFC 4122.
key_id str: The id of the key.

instanceId String: The keyprotect instance guid.
alias String: The alias of the key.
endpointType String: The type of the public or private endpoint to be used for fetching keys.
id String: (String) The v4 UUID used to uniquely identify the policy resource, as specified by RFC 4122.
keyId String: The id of the key.