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

ibm.getSmCustomCredentialsSecret

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. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. The data source can be defined by providing the secret ID or the secret and secret group names.

    Example Usage

    By secret id

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

const mySecret = ibm.getSmCustomCredentialsSecret({
    instanceId: ibm_resource_instance.sm_instance.guid,
    region: "us-south",
    secretId: "0b5571f7-21e6-42b7-91c5-3f5ac9793a46",
});

    import pulumi
import pulumi_ibm as ibm

my_secret = ibm.get_sm_custom_credentials_secret(instance_id=ibm_resource_instance["sm_instance"]["guid"],
    region="us-south",
    secret_id="0b5571f7-21e6-42b7-91c5-3f5ac9793a46")

    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.LookupSmCustomCredentialsSecret(ctx, &ibm.LookupSmCustomCredentialsSecretArgs{
			InstanceId: ibm_resource_instance.Sm_instance.Guid,
			Region:     pulumi.StringRef("us-south"),
			SecretId:   pulumi.StringRef("0b5571f7-21e6-42b7-91c5-3f5ac9793a46"),
		}, 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 mySecret = Ibm.GetSmCustomCredentialsSecret.Invoke(new()
    {
        InstanceId = ibm_resource_instance.Sm_instance.Guid,
        Region = "us-south",
        SecretId = "0b5571f7-21e6-42b7-91c5-3f5ac9793a46",
    });

});

    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.GetSmCustomCredentialsSecretArgs;
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 mySecret = IbmFunctions.getSmCustomCredentialsSecret(GetSmCustomCredentialsSecretArgs.builder()
            .instanceId(ibm_resource_instance.sm_instance().guid())
            .region("us-south")
            .secretId("0b5571f7-21e6-42b7-91c5-3f5ac9793a46")
            .build());

    }
}

    variables:
  mySecret:
    fn::invoke:
      function: ibm:getSmCustomCredentialsSecret
      arguments:
        instanceId: ${ibm_resource_instance.sm_instance.guid}
        region: us-south
        secretId: 0b5571f7-21e6-42b7-91c5-3f5ac9793a46

    By secret name and group name

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

const mySecret = ibm.getSmCustomCredentialsSecret({
    instanceId: ibm_resource_instance.sm_instance.guid,
    region: "us-south",
    name: "secret-name",
    secretGroupName: "group-name",
});

    import pulumi
import pulumi_ibm as ibm

my_secret = ibm.get_sm_custom_credentials_secret(instance_id=ibm_resource_instance["sm_instance"]["guid"],
    region="us-south",
    name="secret-name",
    secret_group_name="group-name")

    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.LookupSmCustomCredentialsSecret(ctx, &ibm.LookupSmCustomCredentialsSecretArgs{
			InstanceId:      ibm_resource_instance.Sm_instance.Guid,
			Region:          pulumi.StringRef("us-south"),
			Name:            pulumi.StringRef("secret-name"),
			SecretGroupName: pulumi.StringRef("group-name"),
		}, 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 mySecret = Ibm.GetSmCustomCredentialsSecret.Invoke(new()
    {
        InstanceId = ibm_resource_instance.Sm_instance.Guid,
        Region = "us-south",
        Name = "secret-name",
        SecretGroupName = "group-name",
    });

});

    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.GetSmCustomCredentialsSecretArgs;
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 mySecret = IbmFunctions.getSmCustomCredentialsSecret(GetSmCustomCredentialsSecretArgs.builder()
            .instanceId(ibm_resource_instance.sm_instance().guid())
            .region("us-south")
            .name("secret-name")
            .secretGroupName("group-name")
            .build());

    }
}

    variables:
  mySecret:
    fn::invoke:
      function: ibm:getSmCustomCredentialsSecret
      arguments:
        instanceId: ${ibm_resource_instance.sm_instance.guid}
        region: us-south
        name: secret-name
        secretGroupName: group-name

    Using getSmCustomCredentialsSecret

    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 getSmCustomCredentialsSecret(args: GetSmCustomCredentialsSecretArgs, opts?: InvokeOptions): Promise<GetSmCustomCredentialsSecretResult>
function getSmCustomCredentialsSecretOutput(args: GetSmCustomCredentialsSecretOutputArgs, opts?: InvokeOptions): Output<GetSmCustomCredentialsSecretResult>
    def get_sm_custom_credentials_secret(endpoint_type: Optional[str] = None,
                                     id: Optional[str] = None,
                                     instance_id: Optional[str] = None,
                                     name: Optional[str] = None,
                                     region: Optional[str] = None,
                                     secret_group_name: Optional[str] = None,
                                     secret_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetSmCustomCredentialsSecretResult
def get_sm_custom_credentials_secret_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,
                                     secret_group_name: Optional[pulumi.Input[str]] = None,
                                     secret_id: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetSmCustomCredentialsSecretResult]
    func LookupSmCustomCredentialsSecret(ctx *Context, args *LookupSmCustomCredentialsSecretArgs, opts ...InvokeOption) (*LookupSmCustomCredentialsSecretResult, error)
func LookupSmCustomCredentialsSecretOutput(ctx *Context, args *LookupSmCustomCredentialsSecretOutputArgs, opts ...InvokeOption) LookupSmCustomCredentialsSecretResultOutput

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

    public static class GetSmCustomCredentialsSecret 
{
    public static Task<GetSmCustomCredentialsSecretResult> InvokeAsync(GetSmCustomCredentialsSecretArgs args, InvokeOptions? opts = null)
    public static Output<GetSmCustomCredentialsSecretResult> Invoke(GetSmCustomCredentialsSecretInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSmCustomCredentialsSecretResult> getSmCustomCredentialsSecret(GetSmCustomCredentialsSecretArgs args, InvokeOptions options)
public static Output<GetSmCustomCredentialsSecretResult> getSmCustomCredentialsSecret(GetSmCustomCredentialsSecretArgs args, InvokeOptions options)

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

    The following arguments are supported:

    InstanceId string
    The GUID of the Secrets Manager instance.
    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
    Name string
    The human-readable name of your secret. To be used in combination with secret_group_name.

    • 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]+)*$.
    Region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    SecretGroupName string
    The name of your existing secret group. To be used in combination with name.

    • Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
    SecretId string
    The ID of the secret.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 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}/.
    InstanceId string
    The GUID of the Secrets Manager instance.
    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
    Name string
    The human-readable name of your secret. To be used in combination with secret_group_name.

    • 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]+)*$.
    Region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    SecretGroupName string
    The name of your existing secret group. To be used in combination with name.

    • Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
    SecretId string
    The ID of the secret.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 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}/.
    instanceId String
    The GUID of the Secrets Manager instance.
    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
    name String
    The human-readable name of your secret. To be used in combination with secret_group_name.

    • 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]+)*$.
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    secretGroupName String
    The name of your existing secret group. To be used in combination with name.

    • Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
    secretId String
    The ID of the secret.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 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}/.
    instanceId string
    The GUID of the Secrets Manager instance.
    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
    name string
    The human-readable name of your secret. To be used in combination with secret_group_name.

    • 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]+)*$.
    region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    secretGroupName string
    The name of your existing secret group. To be used in combination with name.

    • Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
    secretId string
    The ID of the secret.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 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}/.
    instance_id str
    The GUID of the Secrets Manager instance.
    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
    name str
    The human-readable name of your secret. To be used in combination with secret_group_name.

    • 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]+)*$.
    region str
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    secret_group_name str
    The name of your existing secret group. To be used in combination with name.

    • Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
    secret_id str
    The ID of the secret.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 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}/.
    instanceId String
    The GUID of the Secrets Manager instance.
    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
    name String
    The human-readable name of your secret. To be used in combination with secret_group_name.

    • 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]+)*$.
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    secretGroupName String
    The name of your existing secret group. To be used in combination with name.

    • Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
    secretId String
    The ID of the secret.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 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}/.

    getSmCustomCredentialsSecret Result

    The following output properties are available:

    Configuration string
    (String) The name of the Custom Credentials configuration.
    CreatedAt string
    (String) The date when the secret was created. The date format follows RFC 3339.
    CreatedBy string
    (String) The unique identifier that is associated with the entity that created the secret.
    CredentialsContents List<GetSmCustomCredentialsSecretCredentialsContent>
    (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.
    CustomMetadata Dictionary<string, string>
    (Map) The secret metadata that a user can customize.
    Description string
    (String) An extended description of your secret.
    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
    InstanceId string
    Labels List<string>
    (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
    LocksTotal double
    (Integer) The number of locks of the secret.
    Name string
    (String) The human-readable name of your secret.
    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 List<GetSmCustomCredentialsSecretParameter>
    (List) The parameters that were passed to the Code Engine job. Nested scheme for parameters:
    Region string
    Rotations List<GetSmCustomCredentialsSecretRotation>
    (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    SecretGroupId string
    (String) A UUID identifier, or default secret group.
    SecretId string
    SecretType string
    (String) The secret type.
    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
    (String) The time-to-live or lease duration (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).
    UpdatedAt string
    (String) The date when the secret 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.
    EndpointType string
    SecretGroupName string
    Configuration string
    (String) The name of the Custom Credentials configuration.
    CreatedAt string
    (String) The date when the secret was created. The date format follows RFC 3339.
    CreatedBy string
    (String) The unique identifier that is associated with the entity that created the secret.
    CredentialsContents []GetSmCustomCredentialsSecretCredentialsContent
    (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.
    CustomMetadata map[string]string
    (Map) The secret metadata that a user can customize.
    Description string
    (String) An extended description of your secret.
    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
    InstanceId string
    Labels []string
    (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
    LocksTotal float64
    (Integer) The number of locks of the secret.
    Name string
    (String) The human-readable name of your secret.
    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 []GetSmCustomCredentialsSecretParameter
    (List) The parameters that were passed to the Code Engine job. Nested scheme for parameters:
    Region string
    Rotations []GetSmCustomCredentialsSecretRotation
    (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    SecretGroupId string
    (String) A UUID identifier, or default secret group.
    SecretId string
    SecretType string
    (String) The secret type.
    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
    (String) The time-to-live or lease duration (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).
    UpdatedAt string
    (String) The date when the secret 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.
    EndpointType string
    SecretGroupName string
    configuration String
    (String) The name of the Custom Credentials configuration.
    createdAt String
    (String) The date when the secret was created. The date format follows RFC 3339.
    createdBy String
    (String) The unique identifier that is associated with the entity that created the secret.
    credentialsContents List<GetSmCustomCredentialsSecretCredentialsContent>
    (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.
    customMetadata Map<String,String>
    (Map) The secret metadata that a user can customize.
    description String
    (String) An extended description of your secret.
    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
    instanceId String
    labels List<String>
    (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
    locksTotal Double
    (Integer) The number of locks of the secret.
    name String
    (String) The human-readable name of your secret.
    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 List<GetSmCustomCredentialsSecretParameter>
    (List) The parameters that were passed to the Code Engine job. Nested scheme for parameters:
    region String
    rotations List<GetSmCustomCredentialsSecretRotation>
    (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    secretGroupId String
    (String) A UUID identifier, or default secret group.
    secretId String
    secretType String
    (String) The secret type.
    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
    (String) The time-to-live or lease duration (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).
    updatedAt String
    (String) The date when the secret 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.
    endpointType String
    secretGroupName String
    configuration string
    (String) The name of the Custom Credentials configuration.
    createdAt string
    (String) The date when the secret was created. The date format follows RFC 3339.
    createdBy string
    (String) The unique identifier that is associated with the entity that created the secret.
    credentialsContents GetSmCustomCredentialsSecretCredentialsContent[]
    (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.
    customMetadata {[key: string]: string}
    (Map) The secret metadata that a user can customize.
    description string
    (String) An extended description of your secret.
    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
    instanceId string
    labels string[]
    (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
    locksTotal number
    (Integer) The number of locks of the secret.
    name string
    (String) The human-readable name of your secret.
    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 GetSmCustomCredentialsSecretParameter[]
    (List) The parameters that were passed to the Code Engine job. Nested scheme for parameters:
    region string
    rotations GetSmCustomCredentialsSecretRotation[]
    (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    secretGroupId string
    (String) A UUID identifier, or default secret group.
    secretId string
    secretType string
    (String) The secret type.
    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
    (String) The time-to-live or lease duration (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).
    updatedAt string
    (String) The date when the secret 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.
    endpointType string
    secretGroupName string
    configuration str
    (String) The name of the Custom Credentials configuration.
    created_at str
    (String) The date when the secret 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.
    credentials_contents Sequence[GetSmCustomCredentialsSecretCredentialsContent]
    (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.
    custom_metadata Mapping[str, str]
    (Map) The secret metadata that a user can customize.
    description str
    (String) An extended description of your secret.
    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
    instance_id str
    labels Sequence[str]
    (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
    locks_total float
    (Integer) The number of locks of the secret.
    name str
    (String) The human-readable name of your secret.
    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 Sequence[GetSmCustomCredentialsSecretParameter]
    (List) The parameters that were passed to the Code Engine job. Nested scheme for parameters:
    region str
    rotations Sequence[GetSmCustomCredentialsSecretRotation]
    (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    secret_group_id str
    (String) A UUID identifier, or default secret group.
    secret_id str
    secret_type str
    (String) The secret type.
    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
    (String) The time-to-live or lease duration (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).
    updated_at str
    (String) The date when the secret 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.
    endpoint_type str
    secret_group_name str
    configuration String
    (String) The name of the Custom Credentials configuration.
    createdAt String
    (String) The date when the secret was created. The date format follows RFC 3339.
    createdBy String
    (String) The unique identifier that is associated with the entity that created the secret.
    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.
    customMetadata Map<String>
    (Map) The secret metadata that a user can customize.
    description String
    (String) An extended description of your secret.
    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
    instanceId String
    labels List<String>
    (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
    locksTotal Number
    (Integer) The number of locks of the secret.
    name String
    (String) The human-readable name of your secret.
    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 List<Property Map>
    (List) The parameters that were passed to the Code Engine job. Nested scheme for parameters:
    region String
    rotations List<Property Map>
    (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    secretGroupId String
    (String) A UUID identifier, or default secret group.
    secretId String
    secretType String
    (String) The secret type.
    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
    (String) The time-to-live or lease duration (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).
    updatedAt String
    (String) The date when the secret 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.
    endpointType String
    secretGroupName String

    Supporting Types

    GetSmCustomCredentialsSecretCredentialsContent

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

    GetSmCustomCredentialsSecretParameter

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

    GetSmCustomCredentialsSecretRotation

    AutoRotate bool
    (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
    (Integer) The length of the secret rotation time interval.

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

    • Constraints: Allowable values are: day, month.
    AutoRotate bool
    (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 float64
    (Integer) The length of the secret rotation time interval.

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

    • Constraints: Allowable values are: day, month.
    autoRotate Boolean
    (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
    (Integer) The length of the secret rotation time interval.

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

    • Constraints: Allowable values are: day, month.
    autoRotate boolean
    (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
    (Integer) The length of the secret rotation time interval.

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

    • Constraints: Allowable values are: day, month.
    auto_rotate bool
    (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 float
    (Integer) The length of the secret rotation time interval.

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

    • Constraints: Allowable values are: day, month.
    autoRotate Boolean
    (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
    (Integer) The length of the secret rotation time interval.

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

    • Constraints: Allowable values are: day, month.

    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