1. Registry
  2. Packages
  3. Ibm Provider
  4. API Docs
  5. getSmDestination
Viewing docs for ibm 2.9.0
published on Thursday, Nov 5, 2026 by ibm-cloud
ibm
Viewing docs for ibm 2.9.0
published on Thursday, Nov 5, 2026 by ibm-cloud

    Provides a read-only data source to retrieve information about a sm_destination. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const smDestination = ibm.getSmDestination({
        destinationId: smDestinationInstance.destinationId,
        instanceId: smDestinationInstance.instanceId,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    sm_destination = ibm.get_sm_destination(destination_id=sm_destination_instance["destinationId"],
        instance_id=sm_destination_instance["instanceId"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/v2/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.LookupSmDestination(ctx, &ibm.LookupSmDestinationArgs{
    			DestinationId: smDestinationInstance.DestinationId,
    			InstanceId:    smDestinationInstance.InstanceId,
    		}, 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 smDestination = Ibm.GetSmDestination.Invoke(new()
        {
            DestinationId = smDestinationInstance.DestinationId,
            InstanceId = smDestinationInstance.InstanceId,
        });
    
    });
    
    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.GetSmDestinationArgs;
    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 smDestination = IbmFunctions.getSmDestination(GetSmDestinationArgs.builder()
                .destinationId(smDestinationInstance.destinationId())
                .instanceId(smDestinationInstance.instanceId())
                .build());
    
        }
    }
    
    variables:
      smDestination:
        fn::invoke:
          function: ibm:getSmDestination
          arguments:
            destinationId: ${smDestinationInstance.destinationId}
            instanceId: ${smDestinationInstance.instanceId}
    
    Example coming soon!
    

    Using getSmDestination

    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 getSmDestination(args: GetSmDestinationArgs, opts?: InvokeOptions): Promise<GetSmDestinationResult>
    function getSmDestinationOutput(args: GetSmDestinationOutputArgs, opts?: InvokeOutputOptions): Output<GetSmDestinationResult>
    def get_sm_destination(destination_id: Optional[str] = None,
                           id: Optional[str] = None,
                           instance_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetSmDestinationResult
    def get_sm_destination_output(destination_id: pulumi.Input[Optional[str]] = None,
                           id: pulumi.Input[Optional[str]] = None,
                           instance_id: pulumi.Input[Optional[str]] = None,
                           opts: Optional[InvokeOutputOptions] = None) -> Output[GetSmDestinationResult]
    func LookupSmDestination(ctx *Context, args *LookupSmDestinationArgs, opts ...InvokeOption) (*LookupSmDestinationResult, error)
    func LookupSmDestinationOutput(ctx *Context, args *LookupSmDestinationOutputArgs, opts ...InvokeOption) LookupSmDestinationResultOutput

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

    public static class GetSmDestination 
    {
        public static Task<GetSmDestinationResult> InvokeAsync(GetSmDestinationArgs args, InvokeOptions? opts = null)
        public static Output<GetSmDestinationResult> Invoke(GetSmDestinationInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetSmDestinationResult> Invoke(GetSmDestinationInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetSmDestinationResult> getSmDestination(GetSmDestinationArgs args, InvokeOptions options)
    public static Output<GetSmDestinationResult> getSmDestination(GetSmDestinationArgs args, InvokeOptions options)
    public static Output<GetSmDestinationResult> getSmDestination(GetSmDestinationArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: ibm:index/getSmDestination:getSmDestination
      arguments:
        # arguments dictionary
    data "ibm_get_sm_destination" "name" {
        # arguments
    }

    The following arguments are supported:

    DestinationId string
    Destination ID.

    • Constraints: Length must be 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
    Secrets Manager instance ID.

    • Constraints: Length must be 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}$/.
    Id string
    The unique identifier of the sm_destination.
    DestinationId string
    Destination ID.

    • Constraints: Length must be 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
    Secrets Manager instance ID.

    • Constraints: Length must be 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}$/.
    Id string
    The unique identifier of the sm_destination.
    destination_id string
    Destination ID.

    • Constraints: Length must be 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 string
    Secrets Manager instance ID.

    • Constraints: Length must be 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}$/.
    id string
    The unique identifier of the sm_destination.
    destinationId String
    Destination ID.

    • Constraints: Length must be 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
    Secrets Manager instance ID.

    • Constraints: Length must be 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}$/.
    id String
    The unique identifier of the sm_destination.
    destinationId string
    Destination ID.

    • Constraints: Length must be 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
    Secrets Manager instance ID.

    • Constraints: Length must be 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}$/.
    id string
    The unique identifier of the sm_destination.
    destination_id str
    Destination ID.

    • Constraints: Length must be 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
    Secrets Manager instance ID.

    • Constraints: Length must be 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}$/.
    id str
    The unique identifier of the sm_destination.
    destinationId String
    Destination ID.

    • Constraints: Length must be 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
    Secrets Manager instance ID.

    • Constraints: Length must be 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}$/.
    id String
    The unique identifier of the sm_destination.

    getSmDestination Result

    The following output properties are available:

    CreatedAt string
    (String) Timestamp when the destination was created.
    CreatedBy string
    (String) IAM identity that created the destination.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^[\\S]+$/.
    Crn string
    (Forces new resource, String) IBM Cloud Database service instance CRN.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
    Description string
    (String) Optional description.

    • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
    DestinationId string
    Href string
    (String) The URL of the destination resource.

    • Constraints: The maximum length is 2048 characters. The minimum length is 1 character.
    Id string
    The unique identifier of the sm_destination.
    InstanceId string
    Message string
    (String) Human-readable message providing additional context about the current state. Present only when non-empty — set when state is failed, describing why provisioning or deletion failed.

    • Constraints: The maximum length is 1024 characters. The minimum length is 1 character.
    Name string
    (String) Destination 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]*)*[A-Za-z0-9]+$/.
    State string
    (String) Destination state:- not_started: Initial state before the first provisioning attempt begins- provisioning: Provisioning in progress — poll until succeeded or failed- succeeded: Destination ready and usable- failed: Terminal state reached when provisioning or deletion fails. A failed destination still counts against the per-instance quota until deleted.- deleting: Deletion in progress.

    • Constraints: Allowable values are: not_started, provisioning, succeeded, failed, deleting.
    Type string
    (String) Destination type.

    • Constraints: Allowable values are: ibm_cloud_database.
    UpdatedAt string
    (String) Timestamp when the destination was last updated.
    CreatedAt string
    (String) Timestamp when the destination was created.
    CreatedBy string
    (String) IAM identity that created the destination.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^[\\S]+$/.
    Crn string
    (Forces new resource, String) IBM Cloud Database service instance CRN.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
    Description string
    (String) Optional description.

    • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
    DestinationId string
    Href string
    (String) The URL of the destination resource.

    • Constraints: The maximum length is 2048 characters. The minimum length is 1 character.
    Id string
    The unique identifier of the sm_destination.
    InstanceId string
    Message string
    (String) Human-readable message providing additional context about the current state. Present only when non-empty — set when state is failed, describing why provisioning or deletion failed.

    • Constraints: The maximum length is 1024 characters. The minimum length is 1 character.
    Name string
    (String) Destination 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]*)*[A-Za-z0-9]+$/.
    State string
    (String) Destination state:- not_started: Initial state before the first provisioning attempt begins- provisioning: Provisioning in progress — poll until succeeded or failed- succeeded: Destination ready and usable- failed: Terminal state reached when provisioning or deletion fails. A failed destination still counts against the per-instance quota until deleted.- deleting: Deletion in progress.

    • Constraints: Allowable values are: not_started, provisioning, succeeded, failed, deleting.
    Type string
    (String) Destination type.

    • Constraints: Allowable values are: ibm_cloud_database.
    UpdatedAt string
    (String) Timestamp when the destination was last updated.
    created_at string
    (String) Timestamp when the destination was created.
    created_by string
    (String) IAM identity that created the destination.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^[\\S]+$/.
    crn string
    (Forces new resource, String) IBM Cloud Database service instance CRN.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
    description string
    (String) Optional description.

    • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
    destination_id string
    href string
    (String) The URL of the destination resource.

    • Constraints: The maximum length is 2048 characters. The minimum length is 1 character.
    id string
    The unique identifier of the sm_destination.
    instance_id string
    message string
    (String) Human-readable message providing additional context about the current state. Present only when non-empty — set when state is failed, describing why provisioning or deletion failed.

    • Constraints: The maximum length is 1024 characters. The minimum length is 1 character.
    name string
    (String) Destination 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]*)*[A-Za-z0-9]+$/.
    state string
    (String) Destination state:- not_started: Initial state before the first provisioning attempt begins- provisioning: Provisioning in progress — poll until succeeded or failed- succeeded: Destination ready and usable- failed: Terminal state reached when provisioning or deletion fails. A failed destination still counts against the per-instance quota until deleted.- deleting: Deletion in progress.

    • Constraints: Allowable values are: not_started, provisioning, succeeded, failed, deleting.
    type string
    (String) Destination type.

    • Constraints: Allowable values are: ibm_cloud_database.
    updated_at string
    (String) Timestamp when the destination was last updated.
    createdAt String
    (String) Timestamp when the destination was created.
    createdBy String
    (String) IAM identity that created the destination.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^[\\S]+$/.
    crn String
    (Forces new resource, String) IBM Cloud Database service instance CRN.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
    description String
    (String) Optional description.

    • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
    destinationId String
    href String
    (String) The URL of the destination resource.

    • Constraints: The maximum length is 2048 characters. The minimum length is 1 character.
    id String
    The unique identifier of the sm_destination.
    instanceId String
    message String
    (String) Human-readable message providing additional context about the current state. Present only when non-empty — set when state is failed, describing why provisioning or deletion failed.

    • Constraints: The maximum length is 1024 characters. The minimum length is 1 character.
    name String
    (String) Destination 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]*)*[A-Za-z0-9]+$/.
    state String
    (String) Destination state:- not_started: Initial state before the first provisioning attempt begins- provisioning: Provisioning in progress — poll until succeeded or failed- succeeded: Destination ready and usable- failed: Terminal state reached when provisioning or deletion fails. A failed destination still counts against the per-instance quota until deleted.- deleting: Deletion in progress.

    • Constraints: Allowable values are: not_started, provisioning, succeeded, failed, deleting.
    type String
    (String) Destination type.

    • Constraints: Allowable values are: ibm_cloud_database.
    updatedAt String
    (String) Timestamp when the destination was last updated.
    createdAt string
    (String) Timestamp when the destination was created.
    createdBy string
    (String) IAM identity that created the destination.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^[\\S]+$/.
    crn string
    (Forces new resource, String) IBM Cloud Database service instance CRN.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
    description string
    (String) Optional description.

    • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
    destinationId string
    href string
    (String) The URL of the destination resource.

    • Constraints: The maximum length is 2048 characters. The minimum length is 1 character.
    id string
    The unique identifier of the sm_destination.
    instanceId string
    message string
    (String) Human-readable message providing additional context about the current state. Present only when non-empty — set when state is failed, describing why provisioning or deletion failed.

    • Constraints: The maximum length is 1024 characters. The minimum length is 1 character.
    name string
    (String) Destination 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]*)*[A-Za-z0-9]+$/.
    state string
    (String) Destination state:- not_started: Initial state before the first provisioning attempt begins- provisioning: Provisioning in progress — poll until succeeded or failed- succeeded: Destination ready and usable- failed: Terminal state reached when provisioning or deletion fails. A failed destination still counts against the per-instance quota until deleted.- deleting: Deletion in progress.

    • Constraints: Allowable values are: not_started, provisioning, succeeded, failed, deleting.
    type string
    (String) Destination type.

    • Constraints: Allowable values are: ibm_cloud_database.
    updatedAt string
    (String) Timestamp when the destination was last updated.
    created_at str
    (String) Timestamp when the destination was created.
    created_by str
    (String) IAM identity that created the destination.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^[\\S]+$/.
    crn str
    (Forces new resource, String) IBM Cloud Database service instance CRN.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
    description str
    (String) Optional description.

    • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
    destination_id str
    href str
    (String) The URL of the destination resource.

    • Constraints: The maximum length is 2048 characters. The minimum length is 1 character.
    id str
    The unique identifier of the sm_destination.
    instance_id str
    message str
    (String) Human-readable message providing additional context about the current state. Present only when non-empty — set when state is failed, describing why provisioning or deletion failed.

    • Constraints: The maximum length is 1024 characters. The minimum length is 1 character.
    name str
    (String) Destination 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]*)*[A-Za-z0-9]+$/.
    state str
    (String) Destination state:- not_started: Initial state before the first provisioning attempt begins- provisioning: Provisioning in progress — poll until succeeded or failed- succeeded: Destination ready and usable- failed: Terminal state reached when provisioning or deletion fails. A failed destination still counts against the per-instance quota until deleted.- deleting: Deletion in progress.

    • Constraints: Allowable values are: not_started, provisioning, succeeded, failed, deleting.
    type str
    (String) Destination type.

    • Constraints: Allowable values are: ibm_cloud_database.
    updated_at str
    (String) Timestamp when the destination was last updated.
    createdAt String
    (String) Timestamp when the destination was created.
    createdBy String
    (String) IAM identity that created the destination.

    • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^[\\S]+$/.
    crn String
    (Forces new resource, String) IBM Cloud Database service instance CRN.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
    description String
    (String) Optional description.

    • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
    destinationId String
    href String
    (String) The URL of the destination resource.

    • Constraints: The maximum length is 2048 characters. The minimum length is 1 character.
    id String
    The unique identifier of the sm_destination.
    instanceId String
    message String
    (String) Human-readable message providing additional context about the current state. Present only when non-empty — set when state is failed, describing why provisioning or deletion failed.

    • Constraints: The maximum length is 1024 characters. The minimum length is 1 character.
    name String
    (String) Destination 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]*)*[A-Za-z0-9]+$/.
    state String
    (String) Destination state:- not_started: Initial state before the first provisioning attempt begins- provisioning: Provisioning in progress — poll until succeeded or failed- succeeded: Destination ready and usable- failed: Terminal state reached when provisioning or deletion fails. A failed destination still counts against the per-instance quota until deleted.- deleting: Deletion in progress.

    • Constraints: Allowable values are: not_started, provisioning, succeeded, failed, deleting.
    type String
    (String) Destination type.

    • Constraints: Allowable values are: ibm_cloud_database.
    updatedAt String
    (String) Timestamp when the destination was last updated.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm
    Viewing docs for ibm 2.9.0
    published on Thursday, Nov 5, 2026 by ibm-cloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial