Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. SmKvSecret
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.SmKvSecret

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Provides a resource for KVSecret. This allows KVSecret to be created, updated and deleted.

Example Usage

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

const smKvSecret = new ibm.SmKvSecret("smKvSecret", {
    instanceId: ibm_resource_instance.sm_instance.guid,
    region: "us-south",
    customMetadata: {
        key: "value",
    },
    data: {
        key: "value",
    },
    description: "Extended description for this secret.",
    labels: ["my-label"],
    secretGroupId: ibm_sm_secret_group.sm_secret_group.secret_group_id,
});
Copy
import pulumi
import pulumi_ibm as ibm

sm_kv_secret = ibm.SmKvSecret("smKvSecret",
    instance_id=ibm_resource_instance["sm_instance"]["guid"],
    region="us-south",
    custom_metadata={
        "key": "value",
    },
    data={
        "key": "value",
    },
    description="Extended description for this secret.",
    labels=["my-label"],
    secret_group_id=ibm_sm_secret_group["sm_secret_group"]["secret_group_id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewSmKvSecret(ctx, "smKvSecret", &ibm.SmKvSecretArgs{
			InstanceId: pulumi.Any(ibm_resource_instance.Sm_instance.Guid),
			Region:     pulumi.String("us-south"),
			CustomMetadata: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
			Data: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
			Description: pulumi.String("Extended description for this secret."),
			Labels: pulumi.StringArray{
				pulumi.String("my-label"),
			},
			SecretGroupId: pulumi.Any(ibm_sm_secret_group.Sm_secret_group.Secret_group_id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var smKvSecret = new Ibm.SmKvSecret("smKvSecret", new()
    {
        InstanceId = ibm_resource_instance.Sm_instance.Guid,
        Region = "us-south",
        CustomMetadata = 
        {
            { "key", "value" },
        },
        Data = 
        {
            { "key", "value" },
        },
        Description = "Extended description for this secret.",
        Labels = new[]
        {
            "my-label",
        },
        SecretGroupId = ibm_sm_secret_group.Sm_secret_group.Secret_group_id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SmKvSecret;
import com.pulumi.ibm.SmKvSecretArgs;
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) {
        var smKvSecret = new SmKvSecret("smKvSecret", SmKvSecretArgs.builder()
            .instanceId(ibm_resource_instance.sm_instance().guid())
            .region("us-south")
            .customMetadata(Map.of("key", "value"))
            .data(Map.of("key", "value"))
            .description("Extended description for this secret.")
            .labels("my-label")
            .secretGroupId(ibm_sm_secret_group.sm_secret_group().secret_group_id())
            .build());

    }
}
Copy
resources:
  smKvSecret:
    type: ibm:SmKvSecret
    properties:
      instanceId: ${ibm_resource_instance.sm_instance.guid}
      region: us-south
      customMetadata:
        key: value
      data:
        key: value
      description: Extended description for this secret.
      labels:
        - my-label
      secretGroupId: ${ibm_sm_secret_group.sm_secret_group.secret_group_id}
Copy

Provider Configuration

The IBM Cloud provider offers a flexible means of providing credentials for authentication. The following methods are supported, in this order, and explained below:

  • Static credentials
  • Environment variables

To find which credentials are required for this resource, see the service table here.

Static credentials

You can provide your static credentials by adding the ibmcloud_api_key, iaas_classic_username, and iaas_classic_api_key arguments in the IBM Cloud provider block.

Usage:

provider "ibm" {
    ibmcloud_api_key = ""
    iaas_classic_username = ""
    iaas_classic_api_key = ""
}

Environment variables

You can provide your credentials by exporting the IC_API_KEY, IAAS_CLASSIC_USERNAME, and IAAS_CLASSIC_API_KEY environment variables, representing your IBM Cloud platform API key, IBM Cloud Classic Infrastructure (SoftLayer) user name, and IBM Cloud infrastructure API key, respectively.

provider "ibm" {}

Usage:

export IC_API_KEY="ibmcloud_api_key"
export IAAS_CLASSIC_USERNAME="iaas_classic_username"
export IAAS_CLASSIC_API_KEY="iaas_classic_api_key"
pulumi preview

Note:

  1. Create or find your ibmcloud_api_key and iaas_classic_api_key here.
  • Select My IBM Cloud API Keys option from view dropdown for ibmcloud_api_key
  • Select Classic Infrastructure API Keys option from view dropdown for iaas_classic_api_key
  1. For iaas_classic_username
  • Go to Users
  • Click on user.
  • Find user name in the VPN password section under User Details tab

For more informaton, see here.

Create SmKvSecret Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SmKvSecret(name: string, args: SmKvSecretArgs, opts?: CustomResourceOptions);
@overload
def SmKvSecret(resource_name: str,
               args: SmKvSecretArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def SmKvSecret(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               data: Optional[Mapping[str, str]] = None,
               instance_id: Optional[str] = None,
               custom_metadata: Optional[Mapping[str, str]] = None,
               description: Optional[str] = None,
               endpoint_type: Optional[str] = None,
               labels: Optional[Sequence[str]] = None,
               name: Optional[str] = None,
               region: Optional[str] = None,
               secret_group_id: Optional[str] = None,
               sm_kv_secret_id: Optional[str] = None,
               version_custom_metadata: Optional[Mapping[str, str]] = None)
func NewSmKvSecret(ctx *Context, name string, args SmKvSecretArgs, opts ...ResourceOption) (*SmKvSecret, error)
public SmKvSecret(string name, SmKvSecretArgs args, CustomResourceOptions? opts = null)
public SmKvSecret(String name, SmKvSecretArgs args)
public SmKvSecret(String name, SmKvSecretArgs args, CustomResourceOptions options)

type: ibm:SmKvSecret
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SmKvSecretArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SmKvSecretArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SmKvSecretArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SmKvSecretArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SmKvSecretArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var smKvSecretResource = new Ibm.SmKvSecret("smKvSecretResource", new()
{
    Data = 
    {
        { "string", "string" },
    },
    InstanceId = "string",
    CustomMetadata = 
    {
        { "string", "string" },
    },
    Description = "string",
    EndpointType = "string",
    Labels = new[]
    {
        "string",
    },
    Name = "string",
    Region = "string",
    SecretGroupId = "string",
    SmKvSecretId = "string",
    VersionCustomMetadata = 
    {
        { "string", "string" },
    },
});
Copy
example, err := ibm.NewSmKvSecret(ctx, "smKvSecretResource", &ibm.SmKvSecretArgs{
Data: pulumi.StringMap{
"string": pulumi.String("string"),
},
InstanceId: pulumi.String("string"),
CustomMetadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.String("string"),
EndpointType: pulumi.String("string"),
Labels: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
Region: pulumi.String("string"),
SecretGroupId: pulumi.String("string"),
SmKvSecretId: pulumi.String("string"),
VersionCustomMetadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
Copy
var smKvSecretResource = new SmKvSecret("smKvSecretResource", SmKvSecretArgs.builder()
    .data(Map.of("string", "string"))
    .instanceId("string")
    .customMetadata(Map.of("string", "string"))
    .description("string")
    .endpointType("string")
    .labels("string")
    .name("string")
    .region("string")
    .secretGroupId("string")
    .smKvSecretId("string")
    .versionCustomMetadata(Map.of("string", "string"))
    .build());
Copy
sm_kv_secret_resource = ibm.SmKvSecret("smKvSecretResource",
    data={
        "string": "string",
    },
    instance_id="string",
    custom_metadata={
        "string": "string",
    },
    description="string",
    endpoint_type="string",
    labels=["string"],
    name="string",
    region="string",
    secret_group_id="string",
    sm_kv_secret_id="string",
    version_custom_metadata={
        "string": "string",
    })
Copy
const smKvSecretResource = new ibm.SmKvSecret("smKvSecretResource", {
    data: {
        string: "string",
    },
    instanceId: "string",
    customMetadata: {
        string: "string",
    },
    description: "string",
    endpointType: "string",
    labels: ["string"],
    name: "string",
    region: "string",
    secretGroupId: "string",
    smKvSecretId: "string",
    versionCustomMetadata: {
        string: "string",
    },
});
Copy
type: ibm:SmKvSecret
properties:
    customMetadata:
        string: string
    data:
        string: string
    description: string
    endpointType: string
    instanceId: string
    labels:
        - string
    name: string
    region: string
    secretGroupId: string
    smKvSecretId: string
    versionCustomMetadata:
        string: string
Copy

SmKvSecret Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SmKvSecret resource accepts the following input properties:

Data This property is required. Dictionary<string, string>
The payload data of a key-value secret. You can manually rotate the secret by modifying this argument. Modifying the payload creates a new version of the secret.

  • Constraints: The minimum length is 1 item.
InstanceId This property is required. string
The GUID of the Secrets Manager instance.
CustomMetadata Dictionary<string, string>
The secret metadata that a user can customize.
Description string
An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

  • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
EndpointType string
The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

  • Constraints: Allowable values are: private, public.
Labels List<string>
Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

  • Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.
Name string
The human-readable name of your secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.
Region string
The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
SecretGroupId string
A UUID identifier, or default secret group.

  • Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.
SmKvSecretId string
VersionCustomMetadata Dictionary<string, string>
The secret version metadata that a user can customize.
Data This property is required. map[string]string
The payload data of a key-value secret. You can manually rotate the secret by modifying this argument. Modifying the payload creates a new version of the secret.

  • Constraints: The minimum length is 1 item.
InstanceId This property is required. string
The GUID of the Secrets Manager instance.
CustomMetadata map[string]string
The secret metadata that a user can customize.
Description string
An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

  • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
EndpointType string
The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

  • Constraints: Allowable values are: private, public.
Labels []string
Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

  • Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.
Name string
The human-readable name of your secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.
Region string
The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
SecretGroupId string
A UUID identifier, or default secret group.

  • Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.
SmKvSecretId string
VersionCustomMetadata map[string]string
The secret version metadata that a user can customize.
data This property is required. Map<String,String>
The payload data of a key-value secret. You can manually rotate the secret by modifying this argument. Modifying the payload creates a new version of the secret.

  • Constraints: The minimum length is 1 item.
instanceId This property is required. String
The GUID of the Secrets Manager instance.
customMetadata Map<String,String>
The secret metadata that a user can customize.
description String
An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

  • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
endpointType String
The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

  • Constraints: Allowable values are: private, public.
labels List<String>
Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

  • Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.
name String
The human-readable name of your secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.
region String
The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
secretGroupId String
A UUID identifier, or default secret group.

  • Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.
smKvSecretId String
versionCustomMetadata Map<String,String>
The secret version metadata that a user can customize.
data This property is required. {[key: string]: string}
The payload data of a key-value secret. You can manually rotate the secret by modifying this argument. Modifying the payload creates a new version of the secret.

  • Constraints: The minimum length is 1 item.
instanceId This property is required. string
The GUID of the Secrets Manager instance.
customMetadata {[key: string]: string}
The secret metadata that a user can customize.
description string
An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

  • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
endpointType string
The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

  • Constraints: Allowable values are: private, public.
labels string[]
Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

  • Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.
name string
The human-readable name of your secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.
region string
The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
secretGroupId string
A UUID identifier, or default secret group.

  • Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.
smKvSecretId string
versionCustomMetadata {[key: string]: string}
The secret version metadata that a user can customize.
data This property is required. Mapping[str, str]
The payload data of a key-value secret. You can manually rotate the secret by modifying this argument. Modifying the payload creates a new version of the secret.

  • Constraints: The minimum length is 1 item.
instance_id This property is required. str
The GUID of the Secrets Manager instance.
custom_metadata Mapping[str, str]
The secret metadata that a user can customize.
description str
An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

  • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
endpoint_type str
The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

  • Constraints: Allowable values are: private, public.
labels Sequence[str]
Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

  • Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.
name str
The human-readable name of your secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.
region str
The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
secret_group_id str
A UUID identifier, or default secret group.

  • Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.
sm_kv_secret_id str
version_custom_metadata Mapping[str, str]
The secret version metadata that a user can customize.
data This property is required. Map<String>
The payload data of a key-value secret. You can manually rotate the secret by modifying this argument. Modifying the payload creates a new version of the secret.

  • Constraints: The minimum length is 1 item.
instanceId This property is required. String
The GUID of the Secrets Manager instance.
customMetadata Map<String>
The secret metadata that a user can customize.
description String
An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

  • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
endpointType String
The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

  • Constraints: Allowable values are: private, public.
labels List<String>
Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

  • Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.
name String
The human-readable name of your secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.
region String
The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
secretGroupId String
A UUID identifier, or default secret group.

  • Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.
smKvSecretId String
versionCustomMetadata Map<String>
The secret version metadata that a user can customize.

Outputs

All input properties are implicitly available as output properties. Additionally, the SmKvSecret resource produces the following output properties:

CreatedAt string
(String) The date when a resource was created. The date format follows RFC 3339.
CreatedBy string
(String) The unique identifier that is associated with the entity that created the secret.

  • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
Crn string
(String) A CRN that uniquely identifies an IBM Cloud resource.

  • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
Downloaded bool
(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
Id string
The provider-assigned unique ID for this managed resource.
LocksTotal double
(Integer) The number of locks of the secret.

  • Constraints: The maximum value is 1000. The minimum value is 0.
SecretId string
The unique identifier of the KVSecret.
SecretType string
(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

  • Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.
State double
(Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

  • Constraints: Allowable values are: 0, 1, 2, 3, 5.
StateDescription string
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
UpdatedAt string
(String) The date when a resource was recently modified. The date format follows RFC 3339.
VersionsTotal double
(Integer) The number of versions of the secret.

  • Constraints: The maximum value is 50. The minimum value is 0.
CreatedAt string
(String) The date when a resource was created. The date format follows RFC 3339.
CreatedBy string
(String) The unique identifier that is associated with the entity that created the secret.

  • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
Crn string
(String) A CRN that uniquely identifies an IBM Cloud resource.

  • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
Downloaded bool
(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
Id string
The provider-assigned unique ID for this managed resource.
LocksTotal float64
(Integer) The number of locks of the secret.

  • Constraints: The maximum value is 1000. The minimum value is 0.
SecretId string
The unique identifier of the KVSecret.
SecretType string
(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

  • Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.
State float64
(Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

  • Constraints: Allowable values are: 0, 1, 2, 3, 5.
StateDescription string
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
UpdatedAt string
(String) The date when a resource was recently modified. The date format follows RFC 3339.
VersionsTotal float64
(Integer) The number of versions of the secret.

  • Constraints: The maximum value is 50. The minimum value is 0.
createdAt String
(String) The date when a resource was created. The date format follows RFC 3339.
createdBy String
(String) The unique identifier that is associated with the entity that created the secret.

  • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
crn String
(String) A CRN that uniquely identifies an IBM Cloud resource.

  • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
downloaded Boolean
(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
id String
The provider-assigned unique ID for this managed resource.
locksTotal Double
(Integer) The number of locks of the secret.

  • Constraints: The maximum value is 1000. The minimum value is 0.
secretId String
The unique identifier of the KVSecret.
secretType String
(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

  • Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.
state Double
(Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

  • Constraints: Allowable values are: 0, 1, 2, 3, 5.
stateDescription String
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
updatedAt String
(String) The date when a resource was recently modified. The date format follows RFC 3339.
versionsTotal Double
(Integer) The number of versions of the secret.

  • Constraints: The maximum value is 50. The minimum value is 0.
createdAt string
(String) The date when a resource was created. The date format follows RFC 3339.
createdBy string
(String) The unique identifier that is associated with the entity that created the secret.

  • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
crn string
(String) A CRN that uniquely identifies an IBM Cloud resource.

  • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
downloaded boolean
(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
id string
The provider-assigned unique ID for this managed resource.
locksTotal number
(Integer) The number of locks of the secret.

  • Constraints: The maximum value is 1000. The minimum value is 0.
secretId string
The unique identifier of the KVSecret.
secretType string
(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

  • Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.
state number
(Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

  • Constraints: Allowable values are: 0, 1, 2, 3, 5.
stateDescription string
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
updatedAt string
(String) The date when a resource was recently modified. The date format follows RFC 3339.
versionsTotal number
(Integer) The number of versions of the secret.

  • Constraints: The maximum value is 50. The minimum value is 0.
created_at str
(String) The date when a resource was created. The date format follows RFC 3339.
created_by str
(String) The unique identifier that is associated with the entity that created the secret.

  • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
crn str
(String) A CRN that uniquely identifies an IBM Cloud resource.

  • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
downloaded bool
(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
id str
The provider-assigned unique ID for this managed resource.
locks_total float
(Integer) The number of locks of the secret.

  • Constraints: The maximum value is 1000. The minimum value is 0.
secret_id str
The unique identifier of the KVSecret.
secret_type str
(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

  • Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.
state float
(Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

  • Constraints: Allowable values are: 0, 1, 2, 3, 5.
state_description str
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
updated_at str
(String) The date when a resource was recently modified. The date format follows RFC 3339.
versions_total float
(Integer) The number of versions of the secret.

  • Constraints: The maximum value is 50. The minimum value is 0.
createdAt String
(String) The date when a resource was created. The date format follows RFC 3339.
createdBy String
(String) The unique identifier that is associated with the entity that created the secret.

  • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
crn String
(String) A CRN that uniquely identifies an IBM Cloud resource.

  • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
downloaded Boolean
(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
id String
The provider-assigned unique ID for this managed resource.
locksTotal Number
(Integer) The number of locks of the secret.

  • Constraints: The maximum value is 1000. The minimum value is 0.
secretId String
The unique identifier of the KVSecret.
secretType String
(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

  • Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.
state Number
(Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

  • Constraints: Allowable values are: 0, 1, 2, 3, 5.
stateDescription String
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
updatedAt String
(String) The date when a resource was recently modified. The date format follows RFC 3339.
versionsTotal Number
(Integer) The number of versions of the secret.

  • Constraints: The maximum value is 50. The minimum value is 0.

Look up Existing SmKvSecret Resource

Get an existing SmKvSecret resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SmKvSecretState, opts?: CustomResourceOptions): SmKvSecret
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        crn: Optional[str] = None,
        custom_metadata: Optional[Mapping[str, str]] = None,
        data: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        downloaded: Optional[bool] = None,
        endpoint_type: Optional[str] = None,
        instance_id: Optional[str] = None,
        labels: Optional[Sequence[str]] = None,
        locks_total: Optional[float] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        secret_group_id: Optional[str] = None,
        secret_id: Optional[str] = None,
        secret_type: Optional[str] = None,
        sm_kv_secret_id: Optional[str] = None,
        state: Optional[float] = None,
        state_description: Optional[str] = None,
        updated_at: Optional[str] = None,
        version_custom_metadata: Optional[Mapping[str, str]] = None,
        versions_total: Optional[float] = None) -> SmKvSecret
func GetSmKvSecret(ctx *Context, name string, id IDInput, state *SmKvSecretState, opts ...ResourceOption) (*SmKvSecret, error)
public static SmKvSecret Get(string name, Input<string> id, SmKvSecretState? state, CustomResourceOptions? opts = null)
public static SmKvSecret get(String name, Output<String> id, SmKvSecretState state, CustomResourceOptions options)
resources:  _:    type: ibm:SmKvSecret    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CreatedAt string
(String) The date when a resource was created. The date format follows RFC 3339.
CreatedBy string
(String) The unique identifier that is associated with the entity that created the secret.

  • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
Crn string
(String) A CRN that uniquely identifies an IBM Cloud resource.

  • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
CustomMetadata Dictionary<string, string>
The secret metadata that a user can customize.
Data Dictionary<string, string>
The payload data of a key-value secret. You can manually rotate the secret by modifying this argument. Modifying the payload creates a new version of the secret.

  • Constraints: The minimum length is 1 item.
Description string
An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

  • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
Downloaded bool
(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
EndpointType string
The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

  • Constraints: Allowable values are: private, public.
InstanceId string
The GUID of the Secrets Manager instance.
Labels List<string>
Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

  • Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.
LocksTotal double
(Integer) The number of locks of the secret.

  • Constraints: The maximum value is 1000. The minimum value is 0.
Name string
The human-readable name of your secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.
Region string
The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
SecretGroupId string
A UUID identifier, or default secret group.

  • Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.
SecretId string
The unique identifier of the KVSecret.
SecretType string
(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

  • Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.
SmKvSecretId string
State double
(Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

  • Constraints: Allowable values are: 0, 1, 2, 3, 5.
StateDescription string
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
UpdatedAt string
(String) The date when a resource was recently modified. The date format follows RFC 3339.
VersionCustomMetadata Dictionary<string, string>
The secret version metadata that a user can customize.
VersionsTotal double
(Integer) The number of versions of the secret.

  • Constraints: The maximum value is 50. The minimum value is 0.
CreatedAt string
(String) The date when a resource was created. The date format follows RFC 3339.
CreatedBy string
(String) The unique identifier that is associated with the entity that created the secret.

  • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
Crn string
(String) A CRN that uniquely identifies an IBM Cloud resource.

  • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
CustomMetadata map[string]string
The secret metadata that a user can customize.
Data map[string]string
The payload data of a key-value secret. You can manually rotate the secret by modifying this argument. Modifying the payload creates a new version of the secret.

  • Constraints: The minimum length is 1 item.
Description string
An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

  • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
Downloaded bool
(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
EndpointType string
The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

  • Constraints: Allowable values are: private, public.
InstanceId string
The GUID of the Secrets Manager instance.
Labels []string
Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

  • Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.
LocksTotal float64
(Integer) The number of locks of the secret.

  • Constraints: The maximum value is 1000. The minimum value is 0.
Name string
The human-readable name of your secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.
Region string
The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
SecretGroupId string
A UUID identifier, or default secret group.

  • Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.
SecretId string
The unique identifier of the KVSecret.
SecretType string
(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

  • Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.
SmKvSecretId string
State float64
(Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

  • Constraints: Allowable values are: 0, 1, 2, 3, 5.
StateDescription string
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
UpdatedAt string
(String) The date when a resource was recently modified. The date format follows RFC 3339.
VersionCustomMetadata map[string]string
The secret version metadata that a user can customize.
VersionsTotal float64
(Integer) The number of versions of the secret.

  • Constraints: The maximum value is 50. The minimum value is 0.
createdAt String
(String) The date when a resource was created. The date format follows RFC 3339.
createdBy String
(String) The unique identifier that is associated with the entity that created the secret.

  • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
crn String
(String) A CRN that uniquely identifies an IBM Cloud resource.

  • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
customMetadata Map<String,String>
The secret metadata that a user can customize.
data Map<String,String>
The payload data of a key-value secret. You can manually rotate the secret by modifying this argument. Modifying the payload creates a new version of the secret.

  • Constraints: The minimum length is 1 item.
description String
An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

  • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
downloaded Boolean
(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
endpointType String
The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

  • Constraints: Allowable values are: private, public.
instanceId String
The GUID of the Secrets Manager instance.
labels List<String>
Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

  • Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.
locksTotal Double
(Integer) The number of locks of the secret.

  • Constraints: The maximum value is 1000. The minimum value is 0.
name String
The human-readable name of your secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.
region String
The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
secretGroupId String
A UUID identifier, or default secret group.

  • Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.
secretId String
The unique identifier of the KVSecret.
secretType String
(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

  • Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.
smKvSecretId String
state Double
(Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

  • Constraints: Allowable values are: 0, 1, 2, 3, 5.
stateDescription String
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
updatedAt String
(String) The date when a resource was recently modified. The date format follows RFC 3339.
versionCustomMetadata Map<String,String>
The secret version metadata that a user can customize.
versionsTotal Double
(Integer) The number of versions of the secret.

  • Constraints: The maximum value is 50. The minimum value is 0.
createdAt string
(String) The date when a resource was created. The date format follows RFC 3339.
createdBy string
(String) The unique identifier that is associated with the entity that created the secret.

  • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
crn string
(String) A CRN that uniquely identifies an IBM Cloud resource.

  • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
customMetadata {[key: string]: string}
The secret metadata that a user can customize.
data {[key: string]: string}
The payload data of a key-value secret. You can manually rotate the secret by modifying this argument. Modifying the payload creates a new version of the secret.

  • Constraints: The minimum length is 1 item.
description string
An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

  • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
downloaded boolean
(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
endpointType string
The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

  • Constraints: Allowable values are: private, public.
instanceId string
The GUID of the Secrets Manager instance.
labels string[]
Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

  • Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.
locksTotal number
(Integer) The number of locks of the secret.

  • Constraints: The maximum value is 1000. The minimum value is 0.
name string
The human-readable name of your secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.
region string
The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
secretGroupId string
A UUID identifier, or default secret group.

  • Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.
secretId string
The unique identifier of the KVSecret.
secretType string
(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

  • Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.
smKvSecretId string
state number
(Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

  • Constraints: Allowable values are: 0, 1, 2, 3, 5.
stateDescription string
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
updatedAt string
(String) The date when a resource was recently modified. The date format follows RFC 3339.
versionCustomMetadata {[key: string]: string}
The secret version metadata that a user can customize.
versionsTotal number
(Integer) The number of versions of the secret.

  • Constraints: The maximum value is 50. The minimum value is 0.
created_at str
(String) The date when a resource was created. The date format follows RFC 3339.
created_by str
(String) The unique identifier that is associated with the entity that created the secret.

  • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
crn str
(String) A CRN that uniquely identifies an IBM Cloud resource.

  • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
custom_metadata Mapping[str, str]
The secret metadata that a user can customize.
data Mapping[str, str]
The payload data of a key-value secret. You can manually rotate the secret by modifying this argument. Modifying the payload creates a new version of the secret.

  • Constraints: The minimum length is 1 item.
description str
An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

  • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
downloaded bool
(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
endpoint_type str
The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

  • Constraints: Allowable values are: private, public.
instance_id str
The GUID of the Secrets Manager instance.
labels Sequence[str]
Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

  • Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.
locks_total float
(Integer) The number of locks of the secret.

  • Constraints: The maximum value is 1000. The minimum value is 0.
name str
The human-readable name of your secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.
region str
The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
secret_group_id str
A UUID identifier, or default secret group.

  • Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.
secret_id str
The unique identifier of the KVSecret.
secret_type str
(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

  • Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.
sm_kv_secret_id str
state float
(Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

  • Constraints: Allowable values are: 0, 1, 2, 3, 5.
state_description str
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
updated_at str
(String) The date when a resource was recently modified. The date format follows RFC 3339.
version_custom_metadata Mapping[str, str]
The secret version metadata that a user can customize.
versions_total float
(Integer) The number of versions of the secret.

  • Constraints: The maximum value is 50. The minimum value is 0.
createdAt String
(String) The date when a resource was created. The date format follows RFC 3339.
createdBy String
(String) The unique identifier that is associated with the entity that created the secret.

  • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
crn String
(String) A CRN that uniquely identifies an IBM Cloud resource.

  • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
customMetadata Map<String>
The secret metadata that a user can customize.
data Map<String>
The payload data of a key-value secret. You can manually rotate the secret by modifying this argument. Modifying the payload creates a new version of the secret.

  • Constraints: The minimum length is 1 item.
description String
An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

  • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
downloaded Boolean
(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
endpointType String
The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

  • Constraints: Allowable values are: private, public.
instanceId String
The GUID of the Secrets Manager instance.
labels List<String>
Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

  • Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.
locksTotal Number
(Integer) The number of locks of the secret.

  • Constraints: The maximum value is 1000. The minimum value is 0.
name String
The human-readable name of your secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.
region String
The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
secretGroupId String
A UUID identifier, or default secret group.

  • Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.
secretId String
The unique identifier of the KVSecret.
secretType String
(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

  • Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.
smKvSecretId String
state Number
(Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

  • Constraints: Allowable values are: 0, 1, 2, 3, 5.
stateDescription String
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
updatedAt String
(String) The date when a resource was recently modified. The date format follows RFC 3339.
versionCustomMetadata Map<String>
The secret version metadata that a user can customize.
versionsTotal Number
(Integer) The number of versions of the secret.

  • Constraints: The maximum value is 50. The minimum value is 0.

Import

You can import the ibm_sm_kv_secret resource by using region, instance_id, and secret_id.

For more information, see the documentation

Syntax

bash

$ pulumi import ibm:index/smKvSecret:SmKvSecret sm_kv_secret <region>/<instance_id>/<secret_id>
Copy

Example

bash

$ pulumi import ibm:index/smKvSecret:SmKvSecret sm_kv_secret us-east/6ebc4224-e983-496a-8a54-f40a0bfa9175/b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm