Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. SmCustomCredentialsSecret
ibm 1.79.2 published on Friday, Jun 13, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.SmCustomCredentialsSecret

Explore with Pulumi AI

ibm logo
ibm 1.79.2 published on Friday, Jun 13, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    A resource for a custom credentials secret. This allows a custom credentials secret to be created, updated and deleted. For more information, see the docs.

    Example Usage

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

const smCustomCredentialsSecret = new ibm.SmCustomCredentialsSecret("smCustomCredentialsSecret", {
    instanceId: ibm_resource_instance.sm_instance.guid,
    region: "us-south",
    secretGroupId: ibm_sm_secret_group.sm_secret_group.secret_group_id,
    customMetadata: {
        key: "value",
    },
    description: "Extended description for this secret.",
    labels: ["my-label"],
    configuration: "my_custom_credentials_configuration",
    parameters: {
        integerValues: {
            example_param_1: 17,
        },
        stringValues: {
            example_param_2: "str2",
            example_param_3: "str3",
        },
        booleanValues: {
            example_param_4: false,
        },
    },
    rotation: {
        autoRotate: true,
        interval: 3,
        unit: "day",
    },
    ttl: "864000",
});

    import pulumi
import pulumi_ibm as ibm

sm_custom_credentials_secret = ibm.SmCustomCredentialsSecret("smCustomCredentialsSecret",
    instance_id=ibm_resource_instance["sm_instance"]["guid"],
    region="us-south",
    secret_group_id=ibm_sm_secret_group["sm_secret_group"]["secret_group_id"],
    custom_metadata={
        "key": "value",
    },
    description="Extended description for this secret.",
    labels=["my-label"],
    configuration="my_custom_credentials_configuration",
    parameters={
        "integer_values": {
            "example_param_1": 17,
        },
        "string_values": {
            "example_param_2": "str2",
            "example_param_3": "str3",
        },
        "boolean_values": {
            "example_param_4": False,
        },
    },
    rotation={
        "auto_rotate": True,
        "interval": 3,
        "unit": "day",
    },
    ttl="864000")

    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.NewSmCustomCredentialsSecret(ctx, "smCustomCredentialsSecret", &ibm.SmCustomCredentialsSecretArgs{
			InstanceId:    pulumi.Any(ibm_resource_instance.Sm_instance.Guid),
			Region:        pulumi.String("us-south"),
			SecretGroupId: pulumi.Any(ibm_sm_secret_group.Sm_secret_group.Secret_group_id),
			CustomMetadata: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
			Description: pulumi.String("Extended description for this secret."),
			Labels: pulumi.StringArray{
				pulumi.String("my-label"),
			},
			Configuration: pulumi.String("my_custom_credentials_configuration"),
			Parameters: &ibm.SmCustomCredentialsSecretParametersArgs{
				IntegerValues: pulumi.Float64Map{
					"example_param_1": pulumi.Float64(17),
				},
				StringValues: pulumi.StringMap{
					"example_param_2": pulumi.String("str2"),
					"example_param_3": pulumi.String("str3"),
				},
				BooleanValues: pulumi.BoolMap{
					"example_param_4": pulumi.Bool(false),
				},
			},
			Rotation: &ibm.SmCustomCredentialsSecretRotationArgs{
				AutoRotate: pulumi.Bool(true),
				Interval:   pulumi.Float64(3),
				Unit:       pulumi.String("day"),
			},
			Ttl: pulumi.String("864000"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var smCustomCredentialsSecret = new Ibm.SmCustomCredentialsSecret("smCustomCredentialsSecret", new()
    {
        InstanceId = ibm_resource_instance.Sm_instance.Guid,
        Region = "us-south",
        SecretGroupId = ibm_sm_secret_group.Sm_secret_group.Secret_group_id,
        CustomMetadata = 
        {
            { "key", "value" },
        },
        Description = "Extended description for this secret.",
        Labels = new[]
        {
            "my-label",
        },
        Configuration = "my_custom_credentials_configuration",
        Parameters = new Ibm.Inputs.SmCustomCredentialsSecretParametersArgs
        {
            IntegerValues = 
            {
                { "example_param_1", 17 },
            },
            StringValues = 
            {
                { "example_param_2", "str2" },
                { "example_param_3", "str3" },
            },
            BooleanValues = 
            {
                { "example_param_4", false },
            },
        },
        Rotation = new Ibm.Inputs.SmCustomCredentialsSecretRotationArgs
        {
            AutoRotate = true,
            Interval = 3,
            Unit = "day",
        },
        Ttl = "864000",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SmCustomCredentialsSecret;
import com.pulumi.ibm.SmCustomCredentialsSecretArgs;
import com.pulumi.ibm.inputs.SmCustomCredentialsSecretParametersArgs;
import com.pulumi.ibm.inputs.SmCustomCredentialsSecretRotationArgs;
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 smCustomCredentialsSecret = new SmCustomCredentialsSecret("smCustomCredentialsSecret", SmCustomCredentialsSecretArgs.builder()
            .instanceId(ibm_resource_instance.sm_instance().guid())
            .region("us-south")
            .secretGroupId(ibm_sm_secret_group.sm_secret_group().secret_group_id())
            .customMetadata(Map.of("key", "value"))
            .description("Extended description for this secret.")
            .labels("my-label")
            .configuration("my_custom_credentials_configuration")
            .parameters(SmCustomCredentialsSecretParametersArgs.builder()
                .integerValues(Map.of("example_param_1", 17))
                .stringValues(Map.ofEntries(
                    Map.entry("example_param_2", "str2"),
                    Map.entry("example_param_3", "str3")
                ))
                .booleanValues(Map.of("example_param_4", false))
                .build())
            .rotation(SmCustomCredentialsSecretRotationArgs.builder()
                .autoRotate(true)
                .interval(3)
                .unit("day")
                .build())
            .ttl("864000")
            .build());

    }
}

    resources:
  smCustomCredentialsSecret:
    type: ibm:SmCustomCredentialsSecret
    properties:
      instanceId: ${ibm_resource_instance.sm_instance.guid}
      region: us-south
      secretGroupId: ${ibm_sm_secret_group.sm_secret_group.secret_group_id}
      customMetadata:
        key: value
      description: Extended description for this secret.
      labels:
        - my-label
      configuration: my_custom_credentials_configuration
      parameters:
        integerValues:
          example_param_1: 17
        stringValues:
          example_param_2: str2
          example_param_3: str3
        booleanValues:
          example_param_4: false
      rotation:
        autoRotate: true
        interval: 3
        unit: day
      ttl: '864000'

    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 SmCustomCredentialsSecret Resource

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

    Constructor syntax

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

@overload
def SmCustomCredentialsSecret(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              instance_id: Optional[str] = None,
                              configuration: Optional[str] = None,
                              name: Optional[str] = None,
                              endpoint_type: Optional[str] = None,
                              description: Optional[str] = None,
                              labels: Optional[Sequence[str]] = None,
                              custom_metadata: Optional[Mapping[str, str]] = None,
                              parameters: Optional[SmCustomCredentialsSecretParametersArgs] = None,
                              region: Optional[str] = None,
                              rotation: Optional[SmCustomCredentialsSecretRotationArgs] = None,
                              secret_group_id: Optional[str] = None,
                              sm_custom_credentials_secret_id: Optional[str] = None,
                              ttl: Optional[str] = None,
                              version_custom_metadata: Optional[Mapping[str, str]] = None)
    func NewSmCustomCredentialsSecret(ctx *Context, name string, args SmCustomCredentialsSecretArgs, opts ...ResourceOption) (*SmCustomCredentialsSecret, error)
    public SmCustomCredentialsSecret(string name, SmCustomCredentialsSecretArgs args, CustomResourceOptions? opts = null)
    public SmCustomCredentialsSecret(String name, SmCustomCredentialsSecretArgs args)
public SmCustomCredentialsSecret(String name, SmCustomCredentialsSecretArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args SmCustomCredentialsSecretArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SmCustomCredentialsSecretArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SmCustomCredentialsSecretArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SmCustomCredentialsSecretArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SmCustomCredentialsSecretArgs
    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 smCustomCredentialsSecretResource = new Ibm.SmCustomCredentialsSecret("smCustomCredentialsSecretResource", new()
{
    InstanceId = "string",
    Configuration = "string",
    Name = "string",
    EndpointType = "string",
    Description = "string",
    Labels = new[]
    {
        "string",
    },
    CustomMetadata = 
    {
        { "string", "string" },
    },
    Parameters = new Ibm.Inputs.SmCustomCredentialsSecretParametersArgs
    {
        BooleanValues = 
        {
            { "string", false },
        },
        IntegerValues = 
        {
            { "string", 0 },
        },
        StringValues = 
        {
            { "string", "string" },
        },
    },
    Region = "string",
    Rotation = new Ibm.Inputs.SmCustomCredentialsSecretRotationArgs
    {
        AutoRotate = false,
        Interval = 0,
        Unit = "string",
    },
    SecretGroupId = "string",
    SmCustomCredentialsSecretId = "string",
    Ttl = "string",
    VersionCustomMetadata = 
    {
        { "string", "string" },
    },
});

    example, err := ibm.NewSmCustomCredentialsSecret(ctx, "smCustomCredentialsSecretResource", &ibm.SmCustomCredentialsSecretArgs{
	InstanceId:    pulumi.String("string"),
	Configuration: pulumi.String("string"),
	Name:          pulumi.String("string"),
	EndpointType:  pulumi.String("string"),
	Description:   pulumi.String("string"),
	Labels: pulumi.StringArray{
		pulumi.String("string"),
	},
	CustomMetadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Parameters: &ibm.SmCustomCredentialsSecretParametersArgs{
		BooleanValues: pulumi.BoolMap{
			"string": pulumi.Bool(false),
		},
		IntegerValues: pulumi.Float64Map{
			"string": pulumi.Float64(0),
		},
		StringValues: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
	Region: pulumi.String("string"),
	Rotation: &ibm.SmCustomCredentialsSecretRotationArgs{
		AutoRotate: pulumi.Bool(false),
		Interval:   pulumi.Float64(0),
		Unit:       pulumi.String("string"),
	},
	SecretGroupId:               pulumi.String("string"),
	SmCustomCredentialsSecretId: pulumi.String("string"),
	Ttl:                         pulumi.String("string"),
	VersionCustomMetadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var smCustomCredentialsSecretResource = new SmCustomCredentialsSecret("smCustomCredentialsSecretResource", SmCustomCredentialsSecretArgs.builder()
    .instanceId("string")
    .configuration("string")
    .name("string")
    .endpointType("string")
    .description("string")
    .labels("string")
    .customMetadata(Map.of("string", "string"))
    .parameters(SmCustomCredentialsSecretParametersArgs.builder()
        .booleanValues(Map.of("string", false))
        .integerValues(Map.of("string", 0.0))
        .stringValues(Map.of("string", "string"))
        .build())
    .region("string")
    .rotation(SmCustomCredentialsSecretRotationArgs.builder()
        .autoRotate(false)
        .interval(0.0)
        .unit("string")
        .build())
    .secretGroupId("string")
    .smCustomCredentialsSecretId("string")
    .ttl("string")
    .versionCustomMetadata(Map.of("string", "string"))
    .build());

    sm_custom_credentials_secret_resource = ibm.SmCustomCredentialsSecret("smCustomCredentialsSecretResource",
    instance_id="string",
    configuration="string",
    name="string",
    endpoint_type="string",
    description="string",
    labels=["string"],
    custom_metadata={
        "string": "string",
    },
    parameters={
        "boolean_values": {
            "string": False,
        },
        "integer_values": {
            "string": 0,
        },
        "string_values": {
            "string": "string",
        },
    },
    region="string",
    rotation={
        "auto_rotate": False,
        "interval": 0,
        "unit": "string",
    },
    secret_group_id="string",
    sm_custom_credentials_secret_id="string",
    ttl="string",
    version_custom_metadata={
        "string": "string",
    })

    const smCustomCredentialsSecretResource = new ibm.SmCustomCredentialsSecret("smCustomCredentialsSecretResource", {
    instanceId: "string",
    configuration: "string",
    name: "string",
    endpointType: "string",
    description: "string",
    labels: ["string"],
    customMetadata: {
        string: "string",
    },
    parameters: {
        booleanValues: {
            string: false,
        },
        integerValues: {
            string: 0,
        },
        stringValues: {
            string: "string",
        },
    },
    region: "string",
    rotation: {
        autoRotate: false,
        interval: 0,
        unit: "string",
    },
    secretGroupId: "string",
    smCustomCredentialsSecretId: "string",
    ttl: "string",
    versionCustomMetadata: {
        string: "string",
    },
});

    type: ibm:SmCustomCredentialsSecret
properties:
    configuration: string
    customMetadata:
        string: string
    description: string
    endpointType: string
    instanceId: string
    labels:
        - string
    name: string
    parameters:
        booleanValues:
            string: false
        integerValues:
            string: 0
        stringValues:
            string: string
    region: string
    rotation:
        autoRotate: false
        interval: 0
        unit: string
    secretGroupId: string
    smCustomCredentialsSecretId: string
    ttl: string
    versionCustomMetadata:
        string: string

    SmCustomCredentialsSecret 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 SmCustomCredentialsSecret resource accepts the following input properties:

    Configuration string
    The name of the custom credentials secret configuration.
    InstanceId 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.
    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 maximum length is 30 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]+$.
    Parameters SmCustomCredentialsSecretParameters
    The parameters that are passed to the Code Engine job. Nested scheme for parameters:
    Region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    Rotation SmCustomCredentialsSecretRotation
    Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    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)$/.
    SmCustomCredentialsSecretId string
    Ttl string
    The time-to-live (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).

    • Constraints: Must represent an integer not less than 86400.
    VersionCustomMetadata Dictionary<string, string>
    (Map) The custom metadata of the current secret version.
    Configuration string
    The name of the custom credentials secret configuration.
    InstanceId 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.
    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 maximum length is 30 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]+$.
    Parameters SmCustomCredentialsSecretParametersArgs
    The parameters that are passed to the Code Engine job. Nested scheme for parameters:
    Region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    Rotation SmCustomCredentialsSecretRotationArgs
    Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    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)$/.
    SmCustomCredentialsSecretId string
    Ttl string
    The time-to-live (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).

    • Constraints: Must represent an integer not less than 86400.
    VersionCustomMetadata map[string]string
    (Map) The custom metadata of the current secret version.
    configuration String
    The name of the custom credentials secret configuration.
    instanceId 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.
    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 maximum length is 30 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]+$.
    parameters SmCustomCredentialsSecretParameters
    The parameters that are passed to the Code Engine job. Nested scheme for parameters:
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    rotation SmCustomCredentialsSecretRotation
    Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    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)$/.
    smCustomCredentialsSecretId String
    ttl String
    The time-to-live (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).

    • Constraints: Must represent an integer not less than 86400.
    versionCustomMetadata Map<String,String>
    (Map) The custom metadata of the current secret version.
    configuration string
    The name of the custom credentials secret configuration.
    instanceId 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.
    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 maximum length is 30 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]+$.
    parameters SmCustomCredentialsSecretParameters
    The parameters that are passed to the Code Engine job. Nested scheme for parameters:
    region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    rotation SmCustomCredentialsSecretRotation
    Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    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)$/.
    smCustomCredentialsSecretId string
    ttl string
    The time-to-live (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).

    • Constraints: Must represent an integer not less than 86400.
    versionCustomMetadata {[key: string]: string}
    (Map) The custom metadata of the current secret version.
    configuration str
    The name of the custom credentials secret configuration.
    instance_id 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.
    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 maximum length is 30 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]+$.
    parameters SmCustomCredentialsSecretParametersArgs
    The parameters that are passed to the Code Engine job. Nested scheme for parameters:
    region str
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    rotation SmCustomCredentialsSecretRotationArgs
    Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    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_custom_credentials_secret_id str
    ttl str
    The time-to-live (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).

    • Constraints: Must represent an integer not less than 86400.
    version_custom_metadata Mapping[str, str]
    (Map) The custom metadata of the current secret version.
    configuration String
    The name of the custom credentials secret configuration.
    instanceId 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.
    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 maximum length is 30 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]+$.
    parameters Property Map
    The parameters that are passed to the Code Engine job. Nested scheme for parameters:
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    rotation Property Map
    Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    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)$/.
    smCustomCredentialsSecretId String
    ttl String
    The time-to-live (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).

    • Constraints: Must represent an integer not less than 86400.
    versionCustomMetadata Map<String>
    (Map) The custom metadata of the current secret version.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SmCustomCredentialsSecret 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.
    CredentialsContents List<SmCustomCredentialsSecretCredentialsContent>
    (List) The credentials that were generated for this secret. Nested scheme for credentials_content:
    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.
    ExpirationDate string
    (String) The date a secret is expired. The date format follows RFC 3339.
    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.
    NextRotationDate string
    (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
    SecretId string
    The unique identifier of the secret.
    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.
    CredentialsContents []SmCustomCredentialsSecretCredentialsContent
    (List) The credentials that were generated for this secret. Nested scheme for credentials_content:
    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.
    ExpirationDate string
    (String) The date a secret is expired. The date format follows RFC 3339.
    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.
    NextRotationDate string
    (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
    SecretId string
    The unique identifier of the secret.
    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.
    credentialsContents List<SmCustomCredentialsSecretCredentialsContent>
    (List) The credentials that were generated for this secret. Nested scheme for credentials_content:
    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.
    expirationDate String
    (String) The date a secret is expired. The date format follows RFC 3339.
    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.
    nextRotationDate String
    (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
    secretId String
    The unique identifier of the secret.
    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.
    credentialsContents SmCustomCredentialsSecretCredentialsContent[]
    (List) The credentials that were generated for this secret. Nested scheme for credentials_content:
    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.
    expirationDate string
    (String) The date a secret is expired. The date format follows RFC 3339.
    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.
    nextRotationDate string
    (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
    secretId string
    The unique identifier of the secret.
    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.
    credentials_contents Sequence[SmCustomCredentialsSecretCredentialsContent]
    (List) The credentials that were generated for this secret. Nested scheme for credentials_content:
    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.
    expiration_date str
    (String) The date a secret is expired. The date format follows RFC 3339.
    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.
    next_rotation_date str
    (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
    secret_id str
    The unique identifier of the secret.
    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.
    credentialsContents List<Property Map>
    (List) The credentials that were generated for this secret. Nested scheme for credentials_content:
    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.
    expirationDate String
    (String) The date a secret is expired. The date format follows RFC 3339.
    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.
    nextRotationDate String
    (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
    secretId String
    The unique identifier of the secret.
    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 SmCustomCredentialsSecret Resource

    Get an existing SmCustomCredentialsSecret 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?: SmCustomCredentialsSecretState, opts?: CustomResourceOptions): SmCustomCredentialsSecret
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[str] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        credentials_contents: Optional[Sequence[SmCustomCredentialsSecretCredentialsContentArgs]] = None,
        crn: Optional[str] = None,
        custom_metadata: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        downloaded: Optional[bool] = None,
        endpoint_type: Optional[str] = None,
        expiration_date: Optional[str] = None,
        instance_id: Optional[str] = None,
        labels: Optional[Sequence[str]] = None,
        locks_total: Optional[float] = None,
        name: Optional[str] = None,
        next_rotation_date: Optional[str] = None,
        parameters: Optional[SmCustomCredentialsSecretParametersArgs] = None,
        region: Optional[str] = None,
        rotation: Optional[SmCustomCredentialsSecretRotationArgs] = None,
        secret_group_id: Optional[str] = None,
        secret_id: Optional[str] = None,
        sm_custom_credentials_secret_id: Optional[str] = None,
        state: Optional[float] = None,
        state_description: Optional[str] = None,
        ttl: Optional[str] = None,
        updated_at: Optional[str] = None,
        version_custom_metadata: Optional[Mapping[str, str]] = None,
        versions_total: Optional[float] = None) -> SmCustomCredentialsSecret
    func GetSmCustomCredentialsSecret(ctx *Context, name string, id IDInput, state *SmCustomCredentialsSecretState, opts ...ResourceOption) (*SmCustomCredentialsSecret, error)
    public static SmCustomCredentialsSecret Get(string name, Input<string> id, SmCustomCredentialsSecretState? state, CustomResourceOptions? opts = null)
    public static SmCustomCredentialsSecret get(String name, Output<String> id, SmCustomCredentialsSecretState state, CustomResourceOptions options)
    resources:  _:    type: ibm:SmCustomCredentialsSecret    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Configuration string
    The name of the custom credentials secret configuration.
    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.
    CredentialsContents List<SmCustomCredentialsSecretCredentialsContent>
    (List) The credentials that were generated for this secret. Nested scheme for credentials_content:
    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.
    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.
    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.
    ExpirationDate string
    (String) The date a secret is expired. The date format follows RFC 3339.
    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 maximum length is 30 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]+$.
    NextRotationDate string
    (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
    Parameters SmCustomCredentialsSecretParameters
    The parameters that are passed to the Code Engine job. Nested scheme for parameters:
    Region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    Rotation SmCustomCredentialsSecretRotation
    Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    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 secret.
    SmCustomCredentialsSecretId 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.
    Ttl string
    The time-to-live (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).

    • Constraints: Must represent an integer not less than 86400.
    UpdatedAt string
    (String) The date when a resource was recently modified. The date format follows RFC 3339.
    VersionCustomMetadata Dictionary<string, string>
    (Map) The custom metadata of the current secret version.
    VersionsTotal double
    (Integer) The number of versions of the secret.

    • Constraints: The maximum value is 50. The minimum value is 0.
    Configuration string
    The name of the custom credentials secret configuration.
    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.
    CredentialsContents []SmCustomCredentialsSecretCredentialsContentArgs
    (List) The credentials that were generated for this secret. Nested scheme for credentials_content:
    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.
    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.
    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.
    ExpirationDate string
    (String) The date a secret is expired. The date format follows RFC 3339.
    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 maximum length is 30 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]+$.
    NextRotationDate string
    (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
    Parameters SmCustomCredentialsSecretParametersArgs
    The parameters that are passed to the Code Engine job. Nested scheme for parameters:
    Region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    Rotation SmCustomCredentialsSecretRotationArgs
    Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    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 secret.
    SmCustomCredentialsSecretId 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.
    Ttl string
    The time-to-live (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).

    • Constraints: Must represent an integer not less than 86400.
    UpdatedAt string
    (String) The date when a resource was recently modified. The date format follows RFC 3339.
    VersionCustomMetadata map[string]string
    (Map) The custom metadata of the current secret version.
    VersionsTotal float64
    (Integer) The number of versions of the secret.

    • Constraints: The maximum value is 50. The minimum value is 0.
    configuration String
    The name of the custom credentials secret configuration.
    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.
    credentialsContents List<SmCustomCredentialsSecretCredentialsContent>
    (List) The credentials that were generated for this secret. Nested scheme for credentials_content:
    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.
    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.
    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.
    expirationDate String
    (String) The date a secret is expired. The date format follows RFC 3339.
    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 maximum length is 30 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]+$.
    nextRotationDate String
    (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
    parameters SmCustomCredentialsSecretParameters
    The parameters that are passed to the Code Engine job. Nested scheme for parameters:
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    rotation SmCustomCredentialsSecretRotation
    Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    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 secret.
    smCustomCredentialsSecretId 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.
    ttl String
    The time-to-live (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).

    • Constraints: Must represent an integer not less than 86400.
    updatedAt String
    (String) The date when a resource was recently modified. The date format follows RFC 3339.
    versionCustomMetadata Map<String,String>
    (Map) The custom metadata of the current secret version.
    versionsTotal Double
    (Integer) The number of versions of the secret.

    • Constraints: The maximum value is 50. The minimum value is 0.
    configuration string
    The name of the custom credentials secret configuration.
    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.
    credentialsContents SmCustomCredentialsSecretCredentialsContent[]
    (List) The credentials that were generated for this secret. Nested scheme for credentials_content:
    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.
    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.
    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.
    expirationDate string
    (String) The date a secret is expired. The date format follows RFC 3339.
    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 maximum length is 30 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]+$.
    nextRotationDate string
    (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
    parameters SmCustomCredentialsSecretParameters
    The parameters that are passed to the Code Engine job. Nested scheme for parameters:
    region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    rotation SmCustomCredentialsSecretRotation
    Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    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 secret.
    smCustomCredentialsSecretId 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.
    ttl string
    The time-to-live (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).

    • Constraints: Must represent an integer not less than 86400.
    updatedAt string
    (String) The date when a resource was recently modified. The date format follows RFC 3339.
    versionCustomMetadata {[key: string]: string}
    (Map) The custom metadata of the current secret version.
    versionsTotal number
    (Integer) The number of versions of the secret.

    • Constraints: The maximum value is 50. The minimum value is 0.
    configuration str
    The name of the custom credentials secret configuration.
    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.
    credentials_contents Sequence[SmCustomCredentialsSecretCredentialsContentArgs]
    (List) The credentials that were generated for this secret. Nested scheme for credentials_content:
    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.
    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.
    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.
    expiration_date str
    (String) The date a secret is expired. The date format follows RFC 3339.
    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 maximum length is 30 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]+$.
    next_rotation_date str
    (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
    parameters SmCustomCredentialsSecretParametersArgs
    The parameters that are passed to the Code Engine job. Nested scheme for parameters:
    region str
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    rotation SmCustomCredentialsSecretRotationArgs
    Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    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 secret.
    sm_custom_credentials_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.
    ttl str
    The time-to-live (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).

    • Constraints: Must represent an integer not less than 86400.
    updated_at str
    (String) The date when a resource was recently modified. The date format follows RFC 3339.
    version_custom_metadata Mapping[str, str]
    (Map) The custom metadata of the current secret version.
    versions_total float
    (Integer) The number of versions of the secret.

    • Constraints: The maximum value is 50. The minimum value is 0.
    configuration String
    The name of the custom credentials secret configuration.
    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.
    credentialsContents List<Property Map>
    (List) The credentials that were generated for this secret. Nested scheme for credentials_content:
    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.
    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.
    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.
    expirationDate String
    (String) The date a secret is expired. The date format follows RFC 3339.
    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 maximum length is 30 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]+$.
    nextRotationDate String
    (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
    parameters Property Map
    The parameters that are passed to the Code Engine job. Nested scheme for parameters:
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    rotation Property Map
    Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    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 secret.
    smCustomCredentialsSecretId 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.
    ttl String
    The time-to-live (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).

    • Constraints: Must represent an integer not less than 86400.
    updatedAt String
    (String) The date when a resource was recently modified. The date format follows RFC 3339.
    versionCustomMetadata Map<String>
    (Map) The custom metadata of the current secret version.
    versionsTotal Number
    (Integer) The number of versions of the secret.

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

    Supporting Types

    SmCustomCredentialsSecretCredentialsContent, SmCustomCredentialsSecretCredentialsContentArgs

    BooleanValues Dictionary<string, bool>
    (Map) Values of boolean credentials.
    IntegerValues Dictionary<string, double>
    (Map) Values of integer credentials.
    StringValues Dictionary<string, string>
    (Map) Values of string credentials.
    BooleanValues map[string]bool
    (Map) Values of boolean credentials.
    IntegerValues map[string]float64
    (Map) Values of integer credentials.
    StringValues map[string]string
    (Map) Values of string credentials.
    booleanValues Map<String,Boolean>
    (Map) Values of boolean credentials.
    integerValues Map<String,Double>
    (Map) Values of integer credentials.
    stringValues Map<String,String>
    (Map) Values of string credentials.
    booleanValues {[key: string]: boolean}
    (Map) Values of boolean credentials.
    integerValues {[key: string]: number}
    (Map) Values of integer credentials.
    stringValues {[key: string]: string}
    (Map) Values of string credentials.
    boolean_values Mapping[str, bool]
    (Map) Values of boolean credentials.
    integer_values Mapping[str, float]
    (Map) Values of integer credentials.
    string_values Mapping[str, str]
    (Map) Values of string credentials.
    booleanValues Map<Boolean>
    (Map) Values of boolean credentials.
    integerValues Map<Number>
    (Map) Values of integer credentials.
    stringValues Map<String>
    (Map) Values of string credentials.

    SmCustomCredentialsSecretParameters, SmCustomCredentialsSecretParametersArgs

    BooleanValues Dictionary<string, bool>
    Values of boolean parameters.
    IntegerValues Dictionary<string, double>
    Values of integer parameters.
    StringValues Dictionary<string, string>
    Values of string parameters.
    BooleanValues map[string]bool
    Values of boolean parameters.
    IntegerValues map[string]float64
    Values of integer parameters.
    StringValues map[string]string
    Values of string parameters.
    booleanValues Map<String,Boolean>
    Values of boolean parameters.
    integerValues Map<String,Double>
    Values of integer parameters.
    stringValues Map<String,String>
    Values of string parameters.
    booleanValues {[key: string]: boolean}
    Values of boolean parameters.
    integerValues {[key: string]: number}
    Values of integer parameters.
    stringValues {[key: string]: string}
    Values of string parameters.
    boolean_values Mapping[str, bool]
    Values of boolean parameters.
    integer_values Mapping[str, float]
    Values of integer parameters.
    string_values Mapping[str, str]
    Values of string parameters.
    booleanValues Map<Boolean>
    Values of boolean parameters.
    integerValues Map<Number>
    Values of integer parameters.
    stringValues Map<String>
    Values of string parameters.

    SmCustomCredentialsSecretRotation, SmCustomCredentialsSecretRotationArgs

    AutoRotate bool
    Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.
    Interval double
    The length of the secret rotation time interval.

    • Constraints: The minimum value is 1.
    Unit string
    The units for the secret rotation time interval.

    • Constraints: Allowable values are: day, month.
    AutoRotate bool
    Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.
    Interval float64
    The length of the secret rotation time interval.

    • Constraints: The minimum value is 1.
    Unit string
    The units for the secret rotation time interval.

    • Constraints: Allowable values are: day, month.
    autoRotate Boolean
    Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.
    interval Double
    The length of the secret rotation time interval.

    • Constraints: The minimum value is 1.
    unit String
    The units for the secret rotation time interval.

    • Constraints: Allowable values are: day, month.
    autoRotate boolean
    Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.
    interval number
    The length of the secret rotation time interval.

    • Constraints: The minimum value is 1.
    unit string
    The units for the secret rotation time interval.

    • Constraints: Allowable values are: day, month.
    auto_rotate bool
    Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.
    interval float
    The length of the secret rotation time interval.

    • Constraints: The minimum value is 1.
    unit str
    The units for the secret rotation time interval.

    • Constraints: Allowable values are: day, month.
    autoRotate Boolean
    Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.
    interval Number
    The length of the secret rotation time interval.

    • Constraints: The minimum value is 1.
    unit String
    The units for the secret rotation time interval.

    • Constraints: Allowable values are: day, month.

    Import

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

    For more information, see the documentation

    Syntax

    bash

    $ pulumi import ibm:index/smCustomCredentialsSecret:SmCustomCredentialsSecret sm_custom_credentials_secret <region>/<instance_id>/<secret_id>

    Example

    bash

    $ pulumi import ibm:index/smCustomCredentialsSecret:SmCustomCredentialsSecret sm_custom_credentials_secret us-east/6ebc4224-e983-496a-8a54-f40a0bfa9175/b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5

    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 logo
    ibm 1.79.2 published on Friday, Jun 13, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm