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

ibm.getSmCustomCredentialsConfiguration

Explore with Pulumi AI

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

    Provides a read-only data source for a custom credentials secret configuration. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax.

    Example Usage

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

const smCustomCredentialsConfigurationInstance = ibm.getSmCustomCredentialsConfiguration({
    instanceId: ibm_resource_instance.sm_instance.guid,
    region: "us-south",
    name: "example-custom-credentials-config",
});

    import pulumi
import pulumi_ibm as ibm

sm_custom_credentials_configuration_instance = ibm.get_sm_custom_credentials_configuration(instance_id=ibm_resource_instance["sm_instance"]["guid"],
    region="us-south",
    name="example-custom-credentials-config")

    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.LookupSmCustomCredentialsConfiguration(ctx, &ibm.LookupSmCustomCredentialsConfigurationArgs{
			InstanceId: ibm_resource_instance.Sm_instance.Guid,
			Region:     pulumi.StringRef("us-south"),
			Name:       "example-custom-credentials-config",
		}, nil)
		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 = Ibm.GetSmCustomCredentialsConfiguration.Invoke(new()
    {
        InstanceId = ibm_resource_instance.Sm_instance.Guid,
        Region = "us-south",
        Name = "example-custom-credentials-config",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetSmCustomCredentialsConfigurationArgs;
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) {
        final var smCustomCredentialsConfigurationInstance = IbmFunctions.getSmCustomCredentialsConfiguration(GetSmCustomCredentialsConfigurationArgs.builder()
            .instanceId(ibm_resource_instance.sm_instance().guid())
            .region("us-south")
            .name("example-custom-credentials-config")
            .build());

    }
}

    variables:
  smCustomCredentialsConfigurationInstance:
    fn::invoke:
      function: ibm:getSmCustomCredentialsConfiguration
      arguments:
        instanceId: ${ibm_resource_instance.sm_instance.guid}
        region: us-south
        name: example-custom-credentials-config

    Using getSmCustomCredentialsConfiguration

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSmCustomCredentialsConfiguration(args: GetSmCustomCredentialsConfigurationArgs, opts?: InvokeOptions): Promise<GetSmCustomCredentialsConfigurationResult>
function getSmCustomCredentialsConfigurationOutput(args: GetSmCustomCredentialsConfigurationOutputArgs, opts?: InvokeOptions): Output<GetSmCustomCredentialsConfigurationResult>
    def get_sm_custom_credentials_configuration(endpoint_type: Optional[str] = None,
                                            id: Optional[str] = None,
                                            instance_id: Optional[str] = None,
                                            name: Optional[str] = None,
                                            region: Optional[str] = None,
                                            opts: Optional[InvokeOptions] = None) -> GetSmCustomCredentialsConfigurationResult
def get_sm_custom_credentials_configuration_output(endpoint_type: Optional[pulumi.Input[str]] = None,
                                            id: Optional[pulumi.Input[str]] = None,
                                            instance_id: Optional[pulumi.Input[str]] = None,
                                            name: Optional[pulumi.Input[str]] = None,
                                            region: Optional[pulumi.Input[str]] = None,
                                            opts: Optional[InvokeOptions] = None) -> Output[GetSmCustomCredentialsConfigurationResult]
    func LookupSmCustomCredentialsConfiguration(ctx *Context, args *LookupSmCustomCredentialsConfigurationArgs, opts ...InvokeOption) (*LookupSmCustomCredentialsConfigurationResult, error)
func LookupSmCustomCredentialsConfigurationOutput(ctx *Context, args *LookupSmCustomCredentialsConfigurationOutputArgs, opts ...InvokeOption) LookupSmCustomCredentialsConfigurationResultOutput

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

    public static class GetSmCustomCredentialsConfiguration 
{
    public static Task<GetSmCustomCredentialsConfigurationResult> InvokeAsync(GetSmCustomCredentialsConfigurationArgs args, InvokeOptions? opts = null)
    public static Output<GetSmCustomCredentialsConfigurationResult> Invoke(GetSmCustomCredentialsConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSmCustomCredentialsConfigurationResult> getSmCustomCredentialsConfiguration(GetSmCustomCredentialsConfigurationArgs args, InvokeOptions options)
public static Output<GetSmCustomCredentialsConfigurationResult> getSmCustomCredentialsConfiguration(GetSmCustomCredentialsConfigurationArgs args, InvokeOptions options)

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

    The following arguments are supported:

    InstanceId string
    The GUID of the Secrets Manager instance.
    Name string
    The name of the custom credentials 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.
    Id string
    The unique identifier of this data source.
    Region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    InstanceId string
    The GUID of the Secrets Manager instance.
    Name string
    The name of the custom credentials 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.
    Id string
    The unique identifier of this data source.
    Region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    instanceId String
    The GUID of the Secrets Manager instance.
    name String
    The name of the custom credentials 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.
    id String
    The unique identifier of this data source.
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    instanceId string
    The GUID of the Secrets Manager instance.
    name string
    The name of the custom credentials 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.
    id string
    The unique identifier of this data source.
    region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    instance_id str
    The GUID of the Secrets Manager instance.
    name str
    The name of the custom credentials 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.
    id str
    The unique identifier of this data source.
    region str
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    instanceId String
    The GUID of the Secrets Manager instance.
    name String
    The name of the custom credentials 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.
    id String
    The unique identifier of this data source.
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

    getSmCustomCredentialsConfiguration Result

    The following output properties are available:

    ApiKeyRef string
    (String) The IAM credentials secret ID that is used for setting up a custom credentials secret configuration.
    CodeEngineKeyRef string
    (String) The IAM API key used by the credentials system to access this Secrets Manager instance..
    CodeEngines List<GetSmCustomCredentialsConfigurationCodeEngine>
    (List) The parameters required to configure Code Engine. Nested scheme for code_engine:
    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 unique identifier of this data source.
    InstanceId string
    Name string
    (String) The name of the credential.
    Region string
    (String) The region of the Code Engine project.
    Schemas List<GetSmCustomCredentialsConfigurationSchema>
    (List) The schema that defines the format of the input and output parameters (the credentials) of the Code Engine job. Nested scheme for schema:
    TaskTimeout string
    (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.
    EndpointType string
    ApiKeyRef string
    (String) The IAM credentials secret ID that is used for setting up a custom credentials secret configuration.
    CodeEngineKeyRef string
    (String) The IAM API key used by the credentials system to access this Secrets Manager instance..
    CodeEngines []GetSmCustomCredentialsConfigurationCodeEngine
    (List) The parameters required to configure Code Engine. Nested scheme for code_engine:
    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 unique identifier of this data source.
    InstanceId string
    Name string
    (String) The name of the credential.
    Region string
    (String) The region of the Code Engine project.
    Schemas []GetSmCustomCredentialsConfigurationSchema
    (List) The schema that defines the format of the input and output parameters (the credentials) of the Code Engine job. Nested scheme for schema:
    TaskTimeout string
    (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.
    EndpointType string
    apiKeyRef String
    (String) The IAM credentials secret ID that is used for setting up a custom credentials secret configuration.
    codeEngineKeyRef String
    (String) The IAM API key used by the credentials system to access this Secrets Manager instance..
    codeEngines List<GetSmCustomCredentialsConfigurationCodeEngine>
    (List) The parameters required to configure Code Engine. Nested scheme for code_engine:
    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 unique identifier of this data source.
    instanceId String
    name String
    (String) The name of the credential.
    region String
    (String) The region of the Code Engine project.
    schemas List<GetSmCustomCredentialsConfigurationSchema>
    (List) The schema that defines the format of the input and output parameters (the credentials) of the Code Engine job. Nested scheme for schema:
    taskTimeout String
    (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.
    endpointType String
    apiKeyRef string
    (String) The IAM credentials secret ID that is used for setting up a custom credentials secret configuration.
    codeEngineKeyRef string
    (String) The IAM API key used by the credentials system to access this Secrets Manager instance..
    codeEngines GetSmCustomCredentialsConfigurationCodeEngine[]
    (List) The parameters required to configure Code Engine. Nested scheme for code_engine:
    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 unique identifier of this data source.
    instanceId string
    name string
    (String) The name of the credential.
    region string
    (String) The region of the Code Engine project.
    schemas GetSmCustomCredentialsConfigurationSchema[]
    (List) The schema that defines the format of the input and output parameters (the credentials) of the Code Engine job. Nested scheme for schema:
    taskTimeout string
    (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.
    endpointType string
    api_key_ref str
    (String) The IAM credentials secret ID that is used for setting up a custom credentials secret configuration.
    code_engine_key_ref str
    (String) The IAM API key used by the credentials system to access this Secrets Manager instance..
    code_engines Sequence[GetSmCustomCredentialsConfigurationCodeEngine]
    (List) The parameters required to configure Code Engine. Nested scheme for code_engine:
    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 unique identifier of this data source.
    instance_id str
    name str
    (String) The name of the credential.
    region str
    (String) The region of the Code Engine project.
    schemas Sequence[GetSmCustomCredentialsConfigurationSchema]
    (List) The schema that defines the format of the input and output parameters (the credentials) of the Code Engine job. Nested scheme for schema:
    task_timeout str
    (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).
    updated_at str
    (String) The date when the configuration was modified. The date format follows RFC 3339.
    endpoint_type str
    apiKeyRef String
    (String) The IAM credentials secret ID that is used for setting up a custom credentials secret configuration.
    codeEngineKeyRef String
    (String) The IAM API key used by the credentials system to access this Secrets Manager instance..
    codeEngines List<Property Map>
    (List) The parameters required to configure Code Engine. Nested scheme for code_engine:
    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 unique identifier of this data source.
    instanceId String
    name String
    (String) The name of the credential.
    region String
    (String) The region of the Code Engine project.
    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:
    taskTimeout String
    (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.
    endpointType String

    Supporting Types

    GetSmCustomCredentialsConfigurationCodeEngine

    JobName string
    (String) The Code Engine job name used by this custom credentials configuration.
    ProjectId string
    (String) The Project ID of your Code Engine project used by this 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.
    JobName string
    (String) The Code Engine job name used by this custom credentials configuration.
    ProjectId string
    (String) The Project ID of your Code Engine project used by this 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.
    jobName String
    (String) The Code Engine job name used by this custom credentials configuration.
    projectId String
    (String) The Project ID of your Code Engine project used by this 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.
    jobName string
    (String) The Code Engine job name used by this custom credentials configuration.
    projectId string
    (String) The Project ID of your Code Engine project used by this 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.
    job_name str
    (String) The Code Engine job name used by this custom credentials configuration.
    project_id str
    (String) The Project ID of your Code Engine project used by this 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.
    jobName String
    (String) The Code Engine job name used by this custom credentials configuration.
    projectId String
    (String) The Project ID of your Code Engine project used by this 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.

    GetSmCustomCredentialsConfigurationSchema

    Credentials List<GetSmCustomCredentialsConfigurationSchemaCredential>
    (List) The schema of the credentials. Nested scheme for credentials:
    Parameters List<GetSmCustomCredentialsConfigurationSchemaParameter>
    (List) The schema of the input parameters. Nested scheme for parameters:
    Credentials []GetSmCustomCredentialsConfigurationSchemaCredential
    (List) The schema of the credentials. Nested scheme for credentials:
    Parameters []GetSmCustomCredentialsConfigurationSchemaParameter
    (List) The schema of the input parameters. Nested scheme for parameters:
    credentials List<GetSmCustomCredentialsConfigurationSchemaCredential>
    (List) The schema of the credentials. Nested scheme for credentials:
    parameters List<GetSmCustomCredentialsConfigurationSchemaParameter>
    (List) The schema of the input parameters. Nested scheme for parameters:
    credentials GetSmCustomCredentialsConfigurationSchemaCredential[]
    (List) The schema of the credentials. Nested scheme for credentials:
    parameters GetSmCustomCredentialsConfigurationSchemaParameter[]
    (List) The schema of the input parameters. Nested scheme for parameters:
    credentials Sequence[GetSmCustomCredentialsConfigurationSchemaCredential]
    (List) The schema of the credentials. Nested scheme for credentials:
    parameters Sequence[GetSmCustomCredentialsConfigurationSchemaParameter]
    (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:

    GetSmCustomCredentialsConfigurationSchemaCredential

    Format string
    (String) The format of the credential, for example 'required:true, type:string'.
    Name string
    The name of the custom credentials configuration.
    Format string
    (String) The format of the credential, for example 'required:true, type:string'.
    Name string
    The name of the custom credentials configuration.
    format String
    (String) The format of the credential, for example 'required:true, type:string'.
    name String
    The name of the custom credentials configuration.
    format string
    (String) The format of the credential, for example 'required:true, type:string'.
    name string
    The name of the custom credentials configuration.
    format str
    (String) The format of the credential, for example 'required:true, type:string'.
    name str
    The name of the custom credentials configuration.
    format String
    (String) The format of the credential, for example 'required:true, type:string'.
    name String
    The name of the custom credentials configuration.

    GetSmCustomCredentialsConfigurationSchemaParameter

    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
    The name of the 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
    The name of the 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
    The name of the 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
    The name of the 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
    The name of the 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
    The name of the custom credentials configuration.

    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