Skip to content
Navigation Menu

IBM Cloud

  • CatalogCatalog
  • Cost EstimatorCost Estimator
    • HelpHelp
      • Docs
  • Log in
  • Sign up
  • Catalog
  • Cost Estimator
  • Help
    • Docs

  • Navigation settings

Error

Change theme

This feature is in early stage, some parts of the platform might not fully support different themes yet.

Themes
  1. Catalog

Key Protect module

Terraform module to create and work with IBM Key Protect

  • Date of last update: 05/26/2025
  • Docs
  • Readme file
warning icon
This product is deprecated
Key Protect module will not be available after 08/24/2025. You can install the product until then.

Module overview

Use this module to provision and configure an IBM Key Protect instance.

You can configure the following aspects of your instance:

  • Key Protect instance
  • Rotation policy
  • Dual authorization policy
  • Metrics policy
  • Key create and import access policy

Usage

module "key_protect_module" {
  # Replace "X.X.X" with a release version to lock into a specific release
  source  = "https://cm.globalcatalog.cloud.ibm.com/api/v1-beta/offering/source?archive=tgz&kind=terraform&name=terraform-ibm-key-protect&version=X.X.X"
  key_protect_name  = "my-key-protect-instance"
  resource_group_id = "xxXXxxXXxXxXXXXxxXxxxXXXXxXXXXX"
  region            = "us-south"
}

Features and capabilities

Create a Key Protect instance

Create an IBM Key Protect instance.

Configure a rotation policy

Configure a rotation policy for the Key Protect instance.

Configure a dual authorization policy

Configure a dual authorization policy for the Key Protect instance.

Configure a metrics policy

Configure a metrics policy for the Key Protect instance.

Configure a key create and import access policy

Configure a key create and import access policy for the Key Protect instance.

Attach resource tags

Attach resource tags to the Key Protect instance.

Attach access tags

Attach access tags to the Key Protect instance.

    Version last updated: 11/22/2023
    Example

      Details

      • Docs
      • Content source 

      Details

      Type
      • Terraform
      Provider
      • Community
      Category
      • Developer tools
      Last updated
      • 05/26/2025
      Product version
      • v2.4.1
      Example
      • Basic
      Copy
      Copy
      Copy
      Copy
      Copy
      Copy

      Current weekly downloads

      Count: 0

      Basic example

      A simple example that shows how to provision a basic Key Protect instance.

      The following resources are provisioned by this example:

      • A new resource group, if an existing one is not passed in.
      • A new Key Protect instance in the given resource group and region.

      Basic example

      Focus sentinel
      Close

      Basic example

      Focus sentinel

      A simple example that shows how to provision a basic Key Protect instance.

      Follow these steps to download the code and configure it. Then, run the example on your local machine. Learn more.
      1. Download the source file for this example, and then extract the .tar.gz file.
      2. Change to the extracted
        Copy to clipboard
        directory.
      3. If any module in the example comes from a private catalog, run the
        Copy to clipboard
        CLI command as a user who has account access to the private catalog.
      4. Run the following Terraform commands in the same terminal instance.
        $ terraform init
        Copy to clipboard
        $ terraform plan
        Copy to clipboard
        $ terraform apply
        Copy to clipboard