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

ibm.SmCustomCredentialsConfiguration

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 configuration. This allows custom credentials secret configuration 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 smCustomCredentialsConfigurationInstance = new ibm.SmCustomCredentialsConfiguration("smCustomCredentialsConfigurationInstance", {
    instanceId: ibm_resource_instance.sm_instance.guid,
    region: "us-south",
    apiKeyRef: ibm_sm_iam_credentials_secret.my_secret_for_custom_credentials.secret_id,
    codeEngine: {
        projectId: ibm_code_engine_project.my_code_engine_project.project_id,
        jobName: "my_code_engine_job",
        region: "us-south",
    },
    taskTimeout: "10m",
});

    import pulumi
import pulumi_ibm as ibm

sm_custom_credentials_configuration_instance = ibm.SmCustomCredentialsConfiguration("smCustomCredentialsConfigurationInstance",
    instance_id=ibm_resource_instance["sm_instance"]["guid"],
    region="us-south",
    api_key_ref=ibm_sm_iam_credentials_secret["my_secret_for_custom_credentials"]["secret_id"],
    code_engine={
        "project_id": ibm_code_engine_project["my_code_engine_project"]["project_id"],
        "job_name": "my_code_engine_job",
        "region": "us-south",
    },
    task_timeout="10m")

    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.NewSmCustomCredentialsConfiguration(ctx, "smCustomCredentialsConfigurationInstance", &ibm.SmCustomCredentialsConfigurationArgs{
			InstanceId: pulumi.Any(ibm_resource_instance.Sm_instance.Guid),
			Region:     pulumi.String("us-south"),
			ApiKeyRef:  pulumi.Any(ibm_sm_iam_credentials_secret.My_secret_for_custom_credentials.Secret_id),
			CodeEngine: &ibm.SmCustomCredentialsConfigurationCodeEngineArgs{
				ProjectId: pulumi.Any(ibm_code_engine_project.My_code_engine_project.Project_id),
				JobName:   pulumi.String("my_code_engine_job"),
				Region:    pulumi.String("us-south"),
			},
			TaskTimeout: pulumi.String("10m"),
		})
		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 smCustomCredentialsConfigurationInstance = new Ibm.SmCustomCredentialsConfiguration("smCustomCredentialsConfigurationInstance", new()
    {
        InstanceId = ibm_resource_instance.Sm_instance.Guid,
        Region = "us-south",
        ApiKeyRef = ibm_sm_iam_credentials_secret.My_secret_for_custom_credentials.Secret_id,
        CodeEngine = new Ibm.Inputs.SmCustomCredentialsConfigurationCodeEngineArgs
        {
            ProjectId = ibm_code_engine_project.My_code_engine_project.Project_id,
            JobName = "my_code_engine_job",
            Region = "us-south",
        },
        TaskTimeout = "10m",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SmCustomCredentialsConfiguration;
import com.pulumi.ibm.SmCustomCredentialsConfigurationArgs;
import com.pulumi.ibm.inputs.SmCustomCredentialsConfigurationCodeEngineArgs;
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 smCustomCredentialsConfigurationInstance = new SmCustomCredentialsConfiguration("smCustomCredentialsConfigurationInstance", SmCustomCredentialsConfigurationArgs.builder()
            .instanceId(ibm_resource_instance.sm_instance().guid())
            .region("us-south")
            .apiKeyRef(ibm_sm_iam_credentials_secret.my_secret_for_custom_credentials().secret_id())
            .codeEngine(SmCustomCredentialsConfigurationCodeEngineArgs.builder()
                .projectId(ibm_code_engine_project.my_code_engine_project().project_id())
                .jobName("my_code_engine_job")
                .region("us-south")
                .build())
            .taskTimeout("10m")
            .build());

    }
}

    resources:
  smCustomCredentialsConfigurationInstance:
    type: ibm:SmCustomCredentialsConfiguration
    properties:
      instanceId: ${ibm_resource_instance.sm_instance.guid}
      region: us-south
      apiKeyRef: ${ibm_sm_iam_credentials_secret.my_secret_for_custom_credentials.secret_id}
      codeEngine:
        projectId: ${ibm_code_engine_project.my_code_engine_project.project_id}
        jobName: my_code_engine_job
        region: us-south
      taskTimeout: 10m

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

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

    Constructor syntax

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

@overload
def SmCustomCredentialsConfiguration(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     code_engine: Optional[SmCustomCredentialsConfigurationCodeEngineArgs] = None,
                                     instance_id: Optional[str] = None,
                                     api_key_ref: Optional[str] = None,
                                     endpoint_type: Optional[str] = None,
                                     name: Optional[str] = None,
                                     region: Optional[str] = None,
                                     sm_custom_credentials_configuration_id: Optional[str] = None,
                                     task_timeout: Optional[str] = None)
    func NewSmCustomCredentialsConfiguration(ctx *Context, name string, args SmCustomCredentialsConfigurationArgs, opts ...ResourceOption) (*SmCustomCredentialsConfiguration, error)
    public SmCustomCredentialsConfiguration(string name, SmCustomCredentialsConfigurationArgs args, CustomResourceOptions? opts = null)
    public SmCustomCredentialsConfiguration(String name, SmCustomCredentialsConfigurationArgs args)
public SmCustomCredentialsConfiguration(String name, SmCustomCredentialsConfigurationArgs args, CustomResourceOptions options)

    type: ibm:SmCustomCredentialsConfiguration
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 SmCustomCredentialsConfigurationArgs
    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 SmCustomCredentialsConfigurationArgs
    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 SmCustomCredentialsConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SmCustomCredentialsConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SmCustomCredentialsConfigurationArgs
    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 smCustomCredentialsConfigurationResource = new Ibm.SmCustomCredentialsConfiguration("smCustomCredentialsConfigurationResource", new()
{
    CodeEngine = new Ibm.Inputs.SmCustomCredentialsConfigurationCodeEngineArgs
    {
        JobName = "string",
        ProjectId = "string",
        Region = "string",
    },
    InstanceId = "string",
    ApiKeyRef = "string",
    EndpointType = "string",
    Name = "string",
    Region = "string",
    SmCustomCredentialsConfigurationId = "string",
    TaskTimeout = "string",
});

    example, err := ibm.NewSmCustomCredentialsConfiguration(ctx, "smCustomCredentialsConfigurationResource", &ibm.SmCustomCredentialsConfigurationArgs{
	CodeEngine: &ibm.SmCustomCredentialsConfigurationCodeEngineArgs{
		JobName:   pulumi.String("string"),
		ProjectId: pulumi.String("string"),
		Region:    pulumi.String("string"),
	},
	InstanceId:                         pulumi.String("string"),
	ApiKeyRef:                          pulumi.String("string"),
	EndpointType:                       pulumi.String("string"),
	Name:                               pulumi.String("string"),
	Region:                             pulumi.String("string"),
	SmCustomCredentialsConfigurationId: pulumi.String("string"),
	TaskTimeout:                        pulumi.String("string"),
})

    var smCustomCredentialsConfigurationResource = new SmCustomCredentialsConfiguration("smCustomCredentialsConfigurationResource", SmCustomCredentialsConfigurationArgs.builder()
    .codeEngine(SmCustomCredentialsConfigurationCodeEngineArgs.builder()
        .jobName("string")
        .projectId("string")
        .region("string")
        .build())
    .instanceId("string")
    .apiKeyRef("string")
    .endpointType("string")
    .name("string")
    .region("string")
    .smCustomCredentialsConfigurationId("string")
    .taskTimeout("string")
    .build());

    sm_custom_credentials_configuration_resource = ibm.SmCustomCredentialsConfiguration("smCustomCredentialsConfigurationResource",
    code_engine={
        "job_name": "string",
        "project_id": "string",
        "region": "string",
    },
    instance_id="string",
    api_key_ref="string",
    endpoint_type="string",
    name="string",
    region="string",
    sm_custom_credentials_configuration_id="string",
    task_timeout="string")

    const smCustomCredentialsConfigurationResource = new ibm.SmCustomCredentialsConfiguration("smCustomCredentialsConfigurationResource", {
    codeEngine: {
        jobName: "string",
        projectId: "string",
        region: "string",
    },
    instanceId: "string",
    apiKeyRef: "string",
    endpointType: "string",
    name: "string",
    region: "string",
    smCustomCredentialsConfigurationId: "string",
    taskTimeout: "string",
});

    type: ibm:SmCustomCredentialsConfiguration
properties:
    apiKeyRef: string
    codeEngine:
        jobName: string
        projectId: string
        region: string
    endpointType: string
    instanceId: string
    name: string
    region: string
    smCustomCredentialsConfigurationId: string
    taskTimeout: string

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

    CodeEngine SmCustomCredentialsConfigurationCodeEngine
    The parameters required to configure Code Engine. Nested scheme for code_engine:
    InstanceId string
    The GUID of the Secrets Manager instance.
    ApiKeyRef string
    The IAM credentials secret ID that is used for setting up a custom credentials secret configuration.
    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.
    Name string
    A human-readable unique name to assign to your custom credentials configuration.
    Region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    SmCustomCredentialsConfigurationId string
    The unique identifier of this resource.
    TaskTimeout string
    Specifies the maximum allowed time for a Code Engine task to be completed. Consists of a number followed by a time unit, for example "3m". Supported time units are s (seconds), m (minutes) and 'h' (hours).
    CodeEngine SmCustomCredentialsConfigurationCodeEngineArgs
    The parameters required to configure Code Engine. Nested scheme for code_engine:
    InstanceId string
    The GUID of the Secrets Manager instance.
    ApiKeyRef string
    The IAM credentials secret ID that is used for setting up a custom credentials secret configuration.
    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.
    Name string
    A human-readable unique name to assign to your custom credentials configuration.
    Region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    SmCustomCredentialsConfigurationId string
    The unique identifier of this resource.
    TaskTimeout string
    Specifies the maximum allowed time for a Code Engine task to be completed. Consists of a number followed by a time unit, for example "3m". Supported time units are s (seconds), m (minutes) and 'h' (hours).
    codeEngine SmCustomCredentialsConfigurationCodeEngine
    The parameters required to configure Code Engine. Nested scheme for code_engine:
    instanceId String
    The GUID of the Secrets Manager instance.
    apiKeyRef String
    The IAM credentials secret ID that is used for setting up a custom credentials secret configuration.
    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.
    name String
    A human-readable unique name to assign to your custom credentials configuration.
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    smCustomCredentialsConfigurationId String
    The unique identifier of this resource.
    taskTimeout String
    Specifies the maximum allowed time for a Code Engine task to be completed. Consists of a number followed by a time unit, for example "3m". Supported time units are s (seconds), m (minutes) and 'h' (hours).
    codeEngine SmCustomCredentialsConfigurationCodeEngine
    The parameters required to configure Code Engine. Nested scheme for code_engine:
    instanceId string
    The GUID of the Secrets Manager instance.
    apiKeyRef string
    The IAM credentials secret ID that is used for setting up a custom credentials secret configuration.
    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.
    name string
    A human-readable unique name to assign to your custom credentials configuration.
    region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    smCustomCredentialsConfigurationId string
    The unique identifier of this resource.
    taskTimeout string
    Specifies the maximum allowed time for a Code Engine task to be completed. Consists of a number followed by a time unit, for example "3m". Supported time units are s (seconds), m (minutes) and 'h' (hours).
    code_engine SmCustomCredentialsConfigurationCodeEngineArgs
    The parameters required to configure Code Engine. Nested scheme for code_engine:
    instance_id str
    The GUID of the Secrets Manager instance.
    api_key_ref str
    The IAM credentials secret ID that is used for setting up a custom credentials secret configuration.
    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.
    name str
    A human-readable unique name to assign to your custom credentials configuration.
    region str
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    sm_custom_credentials_configuration_id str
    The unique identifier of this resource.
    task_timeout str
    Specifies the maximum allowed time for a Code Engine task to be completed. Consists of a number followed by a time unit, for example "3m". Supported time units are s (seconds), m (minutes) and 'h' (hours).
    codeEngine Property Map
    The parameters required to configure Code Engine. Nested scheme for code_engine:
    instanceId String
    The GUID of the Secrets Manager instance.
    apiKeyRef String
    The IAM credentials secret ID that is used for setting up a custom credentials secret configuration.
    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.
    name String
    A human-readable unique name to assign to your custom credentials configuration.
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    smCustomCredentialsConfigurationId String
    The unique identifier of this resource.
    taskTimeout String
    Specifies the maximum allowed time for a Code Engine task to be completed. Consists of a number followed by a time unit, for example "3m". Supported time units are s (seconds), m (minutes) and 'h' (hours).

    Outputs

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

    CodeEngineKeyRef string
    (String) The IAM API key used by the credentials system to access this Secrets Manager instance..
    CreatedAt string
    (String) The date when the configuration was created. The date format follows RFC 3339.
    CreatedBy string
    (String) The unique identifier that is associated with the entity that created the configuration.

    • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
    Id string
    The provider-assigned unique ID for this managed resource.
    Schemas List<SmCustomCredentialsConfigurationSchema>
    (List) The schema that defines the format of the input and output parameters (the credentials) of the Code Engine job. Nested scheme for schema:
    UpdatedAt string
    (String) The date when the configuration was modified. The date format follows RFC 3339.
    CodeEngineKeyRef string
    (String) The IAM API key used by the credentials system to access this Secrets Manager instance..
    CreatedAt string
    (String) The date when the configuration was created. The date format follows RFC 3339.
    CreatedBy string
    (String) The unique identifier that is associated with the entity that created the configuration.

    • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
    Id string
    The provider-assigned unique ID for this managed resource.
    Schemas []SmCustomCredentialsConfigurationSchema
    (List) The schema that defines the format of the input and output parameters (the credentials) of the Code Engine job. Nested scheme for schema:
    UpdatedAt string
    (String) The date when the configuration was modified. The date format follows RFC 3339.
    codeEngineKeyRef String
    (String) The IAM API key used by the credentials system to access this Secrets Manager instance..
    createdAt String
    (String) The date when the configuration was created. The date format follows RFC 3339.
    createdBy String
    (String) The unique identifier that is associated with the entity that created the configuration.

    • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
    id String
    The provider-assigned unique ID for this managed resource.
    schemas List<SmCustomCredentialsConfigurationSchema>
    (List) The schema that defines the format of the input and output parameters (the credentials) of the Code Engine job. Nested scheme for schema:
    updatedAt String
    (String) The date when the configuration was modified. The date format follows RFC 3339.
    codeEngineKeyRef string
    (String) The IAM API key used by the credentials system to access this Secrets Manager instance..
    createdAt string
    (String) The date when the configuration was created. The date format follows RFC 3339.
    createdBy string
    (String) The unique identifier that is associated with the entity that created the configuration.

    • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
    id string
    The provider-assigned unique ID for this managed resource.
    schemas SmCustomCredentialsConfigurationSchema[]
    (List) The schema that defines the format of the input and output parameters (the credentials) of the Code Engine job. Nested scheme for schema:
    updatedAt string
    (String) The date when the configuration was modified. The date format follows RFC 3339.
    code_engine_key_ref str
    (String) The IAM API key used by the credentials system to access this Secrets Manager instance..
    created_at str
    (String) The date when the configuration was created. The date format follows RFC 3339.
    created_by str
    (String) The unique identifier that is associated with the entity that created the configuration.

    • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
    id str
    The provider-assigned unique ID for this managed resource.
    schemas Sequence[SmCustomCredentialsConfigurationSchema]
    (List) The schema that defines the format of the input and output parameters (the credentials) of the Code Engine job. Nested scheme for schema:
    updated_at str
    (String) The date when the configuration was modified. The date format follows RFC 3339.
    codeEngineKeyRef String
    (String) The IAM API key used by the credentials system to access this Secrets Manager instance..
    createdAt String
    (String) The date when the configuration was created. The date format follows RFC 3339.
    createdBy String
    (String) The unique identifier that is associated with the entity that created the configuration.

    • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
    id String
    The provider-assigned unique ID for this managed resource.
    schemas List<Property Map>
    (List) The schema that defines the format of the input and output parameters (the credentials) of the Code Engine job. Nested scheme for schema:
    updatedAt String
    (String) The date when the configuration was modified. The date format follows RFC 3339.

    Look up Existing SmCustomCredentialsConfiguration Resource

    Get an existing SmCustomCredentialsConfiguration 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?: SmCustomCredentialsConfigurationState, opts?: CustomResourceOptions): SmCustomCredentialsConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_key_ref: Optional[str] = None,
        code_engine: Optional[SmCustomCredentialsConfigurationCodeEngineArgs] = None,
        code_engine_key_ref: Optional[str] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        endpoint_type: Optional[str] = None,
        instance_id: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        schemas: Optional[Sequence[SmCustomCredentialsConfigurationSchemaArgs]] = None,
        sm_custom_credentials_configuration_id: Optional[str] = None,
        task_timeout: Optional[str] = None,
        updated_at: Optional[str] = None) -> SmCustomCredentialsConfiguration
    func GetSmCustomCredentialsConfiguration(ctx *Context, name string, id IDInput, state *SmCustomCredentialsConfigurationState, opts ...ResourceOption) (*SmCustomCredentialsConfiguration, error)
    public static SmCustomCredentialsConfiguration Get(string name, Input<string> id, SmCustomCredentialsConfigurationState? state, CustomResourceOptions? opts = null)
    public static SmCustomCredentialsConfiguration get(String name, Output<String> id, SmCustomCredentialsConfigurationState state, CustomResourceOptions options)
    resources:  _:    type: ibm:SmCustomCredentialsConfiguration    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:
    ApiKeyRef string
    The IAM credentials secret ID that is used for setting up a custom credentials secret configuration.
    CodeEngine SmCustomCredentialsConfigurationCodeEngine
    The parameters required to configure Code Engine. Nested scheme for code_engine:
    CodeEngineKeyRef string
    (String) The IAM API key used by the credentials system to access this Secrets Manager instance..
    CreatedAt string
    (String) The date when the configuration was created. The date format follows RFC 3339.
    CreatedBy string
    (String) The unique identifier that is associated with the entity that created the configuration.

    • Constraints: The maximum length is 128 characters. The minimum length is 4 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.
    InstanceId string
    The GUID of the Secrets Manager instance.
    Name string
    A human-readable unique name to assign to your custom credentials configuration.
    Region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    Schemas List<SmCustomCredentialsConfigurationSchema>
    (List) The schema that defines the format of the input and output parameters (the credentials) of the Code Engine job. Nested scheme for schema:
    SmCustomCredentialsConfigurationId string
    The unique identifier of this resource.
    TaskTimeout string
    Specifies the maximum allowed time for a Code Engine task to be completed. Consists of a number followed by a time unit, for example "3m". Supported time units are s (seconds), m (minutes) and 'h' (hours).
    UpdatedAt string
    (String) The date when the configuration was modified. The date format follows RFC 3339.
    ApiKeyRef string
    The IAM credentials secret ID that is used for setting up a custom credentials secret configuration.
    CodeEngine SmCustomCredentialsConfigurationCodeEngineArgs
    The parameters required to configure Code Engine. Nested scheme for code_engine:
    CodeEngineKeyRef string
    (String) The IAM API key used by the credentials system to access this Secrets Manager instance..
    CreatedAt string
    (String) The date when the configuration was created. The date format follows RFC 3339.
    CreatedBy string
    (String) The unique identifier that is associated with the entity that created the configuration.

    • Constraints: The maximum length is 128 characters. The minimum length is 4 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.
    InstanceId string
    The GUID of the Secrets Manager instance.
    Name string
    A human-readable unique name to assign to your custom credentials configuration.
    Region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    Schemas []SmCustomCredentialsConfigurationSchemaArgs
    (List) The schema that defines the format of the input and output parameters (the credentials) of the Code Engine job. Nested scheme for schema:
    SmCustomCredentialsConfigurationId string
    The unique identifier of this resource.
    TaskTimeout string
    Specifies the maximum allowed time for a Code Engine task to be completed. Consists of a number followed by a time unit, for example "3m". Supported time units are s (seconds), m (minutes) and 'h' (hours).
    UpdatedAt string
    (String) The date when the configuration was modified. The date format follows RFC 3339.
    apiKeyRef String
    The IAM credentials secret ID that is used for setting up a custom credentials secret configuration.
    codeEngine SmCustomCredentialsConfigurationCodeEngine
    The parameters required to configure Code Engine. Nested scheme for code_engine:
    codeEngineKeyRef String
    (String) The IAM API key used by the credentials system to access this Secrets Manager instance..
    createdAt String
    (String) The date when the configuration was created. The date format follows RFC 3339.
    createdBy String
    (String) The unique identifier that is associated with the entity that created the configuration.

    • Constraints: The maximum length is 128 characters. The minimum length is 4 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.
    instanceId String
    The GUID of the Secrets Manager instance.
    name String
    A human-readable unique name to assign to your custom credentials configuration.
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    schemas List<SmCustomCredentialsConfigurationSchema>
    (List) The schema that defines the format of the input and output parameters (the credentials) of the Code Engine job. Nested scheme for schema:
    smCustomCredentialsConfigurationId String
    The unique identifier of this resource.
    taskTimeout String
    Specifies the maximum allowed time for a Code Engine task to be completed. Consists of a number followed by a time unit, for example "3m". Supported time units are s (seconds), m (minutes) and 'h' (hours).
    updatedAt String
    (String) The date when the configuration was modified. The date format follows RFC 3339.
    apiKeyRef string
    The IAM credentials secret ID that is used for setting up a custom credentials secret configuration.
    codeEngine SmCustomCredentialsConfigurationCodeEngine
    The parameters required to configure Code Engine. Nested scheme for code_engine:
    codeEngineKeyRef string
    (String) The IAM API key used by the credentials system to access this Secrets Manager instance..
    createdAt string
    (String) The date when the configuration was created. The date format follows RFC 3339.
    createdBy string
    (String) The unique identifier that is associated with the entity that created the configuration.

    • Constraints: The maximum length is 128 characters. The minimum length is 4 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.
    instanceId string
    The GUID of the Secrets Manager instance.
    name string
    A human-readable unique name to assign to your custom credentials configuration.
    region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    schemas SmCustomCredentialsConfigurationSchema[]
    (List) The schema that defines the format of the input and output parameters (the credentials) of the Code Engine job. Nested scheme for schema:
    smCustomCredentialsConfigurationId string
    The unique identifier of this resource.
    taskTimeout string
    Specifies the maximum allowed time for a Code Engine task to be completed. Consists of a number followed by a time unit, for example "3m". Supported time units are s (seconds), m (minutes) and 'h' (hours).
    updatedAt string
    (String) The date when the configuration was modified. The date format follows RFC 3339.
    api_key_ref str
    The IAM credentials secret ID that is used for setting up a custom credentials secret configuration.
    code_engine SmCustomCredentialsConfigurationCodeEngineArgs
    The parameters required to configure Code Engine. Nested scheme for code_engine:
    code_engine_key_ref str
    (String) The IAM API key used by the credentials system to access this Secrets Manager instance..
    created_at str
    (String) The date when the configuration was created. The date format follows RFC 3339.
    created_by str
    (String) The unique identifier that is associated with the entity that created the configuration.

    • Constraints: The maximum length is 128 characters. The minimum length is 4 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.
    instance_id str
    The GUID of the Secrets Manager instance.
    name str
    A human-readable unique name to assign to your custom credentials configuration.
    region str
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    schemas Sequence[SmCustomCredentialsConfigurationSchemaArgs]
    (List) The schema that defines the format of the input and output parameters (the credentials) of the Code Engine job. Nested scheme for schema:
    sm_custom_credentials_configuration_id str
    The unique identifier of this resource.
    task_timeout str
    Specifies the maximum allowed time for a Code Engine task to be completed. Consists of a number followed by a time unit, for example "3m". Supported time units are s (seconds), m (minutes) and 'h' (hours).
    updated_at str
    (String) The date when the configuration was modified. The date format follows RFC 3339.
    apiKeyRef String
    The IAM credentials secret ID that is used for setting up a custom credentials secret configuration.
    codeEngine Property Map
    The parameters required to configure Code Engine. Nested scheme for code_engine:
    codeEngineKeyRef String
    (String) The IAM API key used by the credentials system to access this Secrets Manager instance..
    createdAt String
    (String) The date when the configuration was created. The date format follows RFC 3339.
    createdBy String
    (String) The unique identifier that is associated with the entity that created the configuration.

    • Constraints: The maximum length is 128 characters. The minimum length is 4 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.
    instanceId String
    The GUID of the Secrets Manager instance.
    name String
    A human-readable unique name to assign to your custom credentials configuration.
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    schemas List<Property Map>
    (List) The schema that defines the format of the input and output parameters (the credentials) of the Code Engine job. Nested scheme for schema:
    smCustomCredentialsConfigurationId String
    The unique identifier of this resource.
    taskTimeout String
    Specifies the maximum allowed time for a Code Engine task to be completed. Consists of a number followed by a time unit, for example "3m". Supported time units are s (seconds), m (minutes) and 'h' (hours).
    updatedAt String
    (String) The date when the configuration was modified. The date format follows RFC 3339.

    Supporting Types

    SmCustomCredentialsConfigurationCodeEngine, SmCustomCredentialsConfigurationCodeEngineArgs

    JobName string
    The Code Engine job name used by this custom credentials configuration.
    ProjectId string
    The Project ID of your Code Engine project used by this custom credentials configuration.
    Region string
    The region of the Code Engine project.
    JobName string
    The Code Engine job name used by this custom credentials configuration.
    ProjectId string
    The Project ID of your Code Engine project used by this custom credentials configuration.
    Region string
    The region of the Code Engine project.
    jobName String
    The Code Engine job name used by this custom credentials configuration.
    projectId String
    The Project ID of your Code Engine project used by this custom credentials configuration.
    region String
    The region of the Code Engine project.
    jobName string
    The Code Engine job name used by this custom credentials configuration.
    projectId string
    The Project ID of your Code Engine project used by this custom credentials configuration.
    region string
    The region of the Code Engine project.
    job_name str
    The Code Engine job name used by this custom credentials configuration.
    project_id str
    The Project ID of your Code Engine project used by this custom credentials configuration.
    region str
    The region of the Code Engine project.
    jobName String
    The Code Engine job name used by this custom credentials configuration.
    projectId String
    The Project ID of your Code Engine project used by this custom credentials configuration.
    region String
    The region of the Code Engine project.

    SmCustomCredentialsConfigurationSchema, SmCustomCredentialsConfigurationSchemaArgs

    Credentials List<SmCustomCredentialsConfigurationSchemaCredential>
    (List) The schema of the credentials. Nested scheme for credentials:
    Parameters List<SmCustomCredentialsConfigurationSchemaParameter>
    (List) The schema of the input parameters. Nested scheme for parameters:
    Credentials []SmCustomCredentialsConfigurationSchemaCredential
    (List) The schema of the credentials. Nested scheme for credentials:
    Parameters []SmCustomCredentialsConfigurationSchemaParameter
    (List) The schema of the input parameters. Nested scheme for parameters:
    credentials List<SmCustomCredentialsConfigurationSchemaCredential>
    (List) The schema of the credentials. Nested scheme for credentials:
    parameters List<SmCustomCredentialsConfigurationSchemaParameter>
    (List) The schema of the input parameters. Nested scheme for parameters:
    credentials SmCustomCredentialsConfigurationSchemaCredential[]
    (List) The schema of the credentials. Nested scheme for credentials:
    parameters SmCustomCredentialsConfigurationSchemaParameter[]
    (List) The schema of the input parameters. Nested scheme for parameters:
    credentials Sequence[SmCustomCredentialsConfigurationSchemaCredential]
    (List) The schema of the credentials. Nested scheme for credentials:
    parameters Sequence[SmCustomCredentialsConfigurationSchemaParameter]
    (List) The schema of the input parameters. Nested scheme for parameters:
    credentials List<Property Map>
    (List) The schema of the credentials. Nested scheme for credentials:
    parameters List<Property Map>
    (List) The schema of the input parameters. Nested scheme for parameters:

    SmCustomCredentialsConfigurationSchemaCredential, SmCustomCredentialsConfigurationSchemaCredentialArgs

    Format string
    (String) The format of the credential, for example 'required:true, type:string'.
    Name string
    A human-readable unique name to assign to your custom credentials configuration.
    Format string
    (String) The format of the credential, for example 'required:true, type:string'.
    Name string
    A human-readable unique name to assign to your custom credentials configuration.
    format String
    (String) The format of the credential, for example 'required:true, type:string'.
    name String
    A human-readable unique name to assign to your custom credentials configuration.
    format string
    (String) The format of the credential, for example 'required:true, type:string'.
    name string
    A human-readable unique name to assign to your custom credentials configuration.
    format str
    (String) The format of the credential, for example 'required:true, type:string'.
    name str
    A human-readable unique name to assign to your custom credentials configuration.
    format String
    (String) The format of the credential, for example 'required:true, type:string'.
    name String
    A human-readable unique name to assign to your custom credentials configuration.

    SmCustomCredentialsConfigurationSchemaParameter, SmCustomCredentialsConfigurationSchemaParameterArgs

    EnvVariableName string
    (String) The name of the environment variable associated with the configuration schema parameter.
    Format string
    (String) The format of the credential, for example 'required:true, type:string'.
    Name string
    A human-readable unique name to assign to your custom credentials configuration.
    EnvVariableName string
    (String) The name of the environment variable associated with the configuration schema parameter.
    Format string
    (String) The format of the credential, for example 'required:true, type:string'.
    Name string
    A human-readable unique name to assign to your custom credentials configuration.
    envVariableName String
    (String) The name of the environment variable associated with the configuration schema parameter.
    format String
    (String) The format of the credential, for example 'required:true, type:string'.
    name String
    A human-readable unique name to assign to your custom credentials configuration.
    envVariableName string
    (String) The name of the environment variable associated with the configuration schema parameter.
    format string
    (String) The format of the credential, for example 'required:true, type:string'.
    name string
    A human-readable unique name to assign to your custom credentials configuration.
    env_variable_name str
    (String) The name of the environment variable associated with the configuration schema parameter.
    format str
    (String) The format of the credential, for example 'required:true, type:string'.
    name str
    A human-readable unique name to assign to your custom credentials configuration.
    envVariableName String
    (String) The name of the environment variable associated with the configuration schema parameter.
    format String
    (String) The format of the credential, for example 'required:true, type:string'.
    name String
    A human-readable unique name to assign to your custom credentials configuration.

    Import

    You can import the ibm_sm_custom_credentials_configuration resource by using region, instance_id, and name.

    For more information, see the documentation

    Syntax

    bash

    $ pulumi import ibm:index/smCustomCredentialsConfiguration:SmCustomCredentialsConfiguration sm_custom_credentials_configuration <region>/<instance_id>/<name>

    Example

    bash

    $ pulumi import ibm:index/smCustomCredentialsConfiguration:SmCustomCredentialsConfiguration my_config us-east/6ebc4224-e983-496a-8a54-f40a0bfa9175/example-custom-credentials-config

    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