1. Packages
  2. Ibm Provider
  3. API Docs
  4. getSmIamCredentialsConfiguration
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getSmIamCredentialsConfiguration

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

    Provides a read-only data source for IAM Credentials configuration properties. 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 smIamCredentialsConfiguration = ibm.getSmIamCredentialsConfiguration({
        instanceId: ibm_resource_instance.sm_instance.guid,
        region: "us-south",
        name: "configuration-name",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    sm_iam_credentials_configuration = ibm.get_sm_iam_credentials_configuration(instance_id=ibm_resource_instance["sm_instance"]["guid"],
        region="us-south",
        name="configuration-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.LookupSmIamCredentialsConfiguration(ctx, &ibm.LookupSmIamCredentialsConfigurationArgs{
    			InstanceId: ibm_resource_instance.Sm_instance.Guid,
    			Region:     pulumi.StringRef("us-south"),
    			Name:       "configuration-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 smIamCredentialsConfiguration = Ibm.GetSmIamCredentialsConfiguration.Invoke(new()
        {
            InstanceId = ibm_resource_instance.Sm_instance.Guid,
            Region = "us-south",
            Name = "configuration-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.GetSmIamCredentialsConfigurationArgs;
    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 smIamCredentialsConfiguration = IbmFunctions.getSmIamCredentialsConfiguration(GetSmIamCredentialsConfigurationArgs.builder()
                .instanceId(ibm_resource_instance.sm_instance().guid())
                .region("us-south")
                .name("configuration-name")
                .build());
    
        }
    }
    
    variables:
      smIamCredentialsConfiguration:
        fn::invoke:
          function: ibm:getSmIamCredentialsConfiguration
          arguments:
            instanceId: ${ibm_resource_instance.sm_instance.guid}
            region: us-south
            name: configuration-name
    

    Using getSmIamCredentialsConfiguration

    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 getSmIamCredentialsConfiguration(args: GetSmIamCredentialsConfigurationArgs, opts?: InvokeOptions): Promise<GetSmIamCredentialsConfigurationResult>
    function getSmIamCredentialsConfigurationOutput(args: GetSmIamCredentialsConfigurationOutputArgs, opts?: InvokeOptions): Output<GetSmIamCredentialsConfigurationResult>
    def get_sm_iam_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) -> GetSmIamCredentialsConfigurationResult
    def get_sm_iam_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[GetSmIamCredentialsConfigurationResult]
    func LookupSmIamCredentialsConfiguration(ctx *Context, args *LookupSmIamCredentialsConfigurationArgs, opts ...InvokeOption) (*LookupSmIamCredentialsConfigurationResult, error)
    func LookupSmIamCredentialsConfigurationOutput(ctx *Context, args *LookupSmIamCredentialsConfigurationOutputArgs, opts ...InvokeOption) LookupSmIamCredentialsConfigurationResultOutput

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

    public static class GetSmIamCredentialsConfiguration 
    {
        public static Task<GetSmIamCredentialsConfigurationResult> InvokeAsync(GetSmIamCredentialsConfigurationArgs args, InvokeOptions? opts = null)
        public static Output<GetSmIamCredentialsConfigurationResult> Invoke(GetSmIamCredentialsConfigurationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSmIamCredentialsConfigurationResult> getSmIamCredentialsConfiguration(GetSmIamCredentialsConfigurationArgs args, InvokeOptions options)
    public static Output<GetSmIamCredentialsConfigurationResult> getSmIamCredentialsConfiguration(GetSmIamCredentialsConfigurationArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getSmIamCredentialsConfiguration:getSmIamCredentialsConfiguration
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceId string
    The GUID of the Secrets Manager instance.
    Name string
    The name of the configuration.

    • Constraints: The maximum length is 128 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]+)*$/.
    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
    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 configuration.

    • Constraints: The maximum length is 128 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]+)*$/.
    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
    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 configuration.

    • Constraints: The maximum length is 128 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]+)*$/.
    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
    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 configuration.

    • Constraints: The maximum length is 128 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]+)*$/.
    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
    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 configuration.

    • Constraints: The maximum length is 128 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]+)*$/.
    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
    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 configuration.

    • Constraints: The maximum length is 128 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]+)*$/.
    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
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

    getSmIamCredentialsConfiguration Result

    The following output properties are available:

    ApiKey string
    (String) An IBM Cloud API key that can create and manage service IDs. The API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform role on the IAM Identity Service. For more information, see the docs.

    • Constraints: The maximum length is 60 characters. The minimum length is 5 characters. The value must match regular expression /^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/.
    ConfigType string
    (String) The configuration type.

    • Constraints: Allowable values are: public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, iam_credentials_configuration, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
    CreatedAt string
    (String) The date when the resource was created. The date format follows RFC 3339.
    CreatedBy string
    (String) The unique identifier that is associated with the entity that created the secret.

    • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
    Disabled bool
    (Boolean) Indicates whether the API key configuration is disabled. If it is set to true, the IAM credentials engine doesn't use the configured API key for credentials management.
    Id string
    InstanceId string
    Name string
    Region string
    SecretType string
    (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

    • Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.
    UpdatedAt string
    (String) The date when a resource was modified. The date format follows RFC 3339.
    EndpointType string
    ApiKey string
    (String) An IBM Cloud API key that can create and manage service IDs. The API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform role on the IAM Identity Service. For more information, see the docs.

    • Constraints: The maximum length is 60 characters. The minimum length is 5 characters. The value must match regular expression /^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/.
    ConfigType string
    (String) The configuration type.

    • Constraints: Allowable values are: public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, iam_credentials_configuration, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
    CreatedAt string
    (String) The date when the resource was created. The date format follows RFC 3339.
    CreatedBy string
    (String) The unique identifier that is associated with the entity that created the secret.

    • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
    Disabled bool
    (Boolean) Indicates whether the API key configuration is disabled. If it is set to true, the IAM credentials engine doesn't use the configured API key for credentials management.
    Id string
    InstanceId string
    Name string
    Region string
    SecretType string
    (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

    • Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.
    UpdatedAt string
    (String) The date when a resource was modified. The date format follows RFC 3339.
    EndpointType string
    apiKey String
    (String) An IBM Cloud API key that can create and manage service IDs. The API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform role on the IAM Identity Service. For more information, see the docs.

    • Constraints: The maximum length is 60 characters. The minimum length is 5 characters. The value must match regular expression /^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/.
    configType String
    (String) The configuration type.

    • Constraints: Allowable values are: public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, iam_credentials_configuration, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
    createdAt String
    (String) The date when the resource was created. The date format follows RFC 3339.
    createdBy String
    (String) The unique identifier that is associated with the entity that created the secret.

    • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
    disabled Boolean
    (Boolean) Indicates whether the API key configuration is disabled. If it is set to true, the IAM credentials engine doesn't use the configured API key for credentials management.
    id String
    instanceId String
    name String
    region String
    secretType String
    (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

    • Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.
    updatedAt String
    (String) The date when a resource was modified. The date format follows RFC 3339.
    endpointType String
    apiKey string
    (String) An IBM Cloud API key that can create and manage service IDs. The API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform role on the IAM Identity Service. For more information, see the docs.

    • Constraints: The maximum length is 60 characters. The minimum length is 5 characters. The value must match regular expression /^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/.
    configType string
    (String) The configuration type.

    • Constraints: Allowable values are: public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, iam_credentials_configuration, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
    createdAt string
    (String) The date when the resource was created. The date format follows RFC 3339.
    createdBy string
    (String) The unique identifier that is associated with the entity that created the secret.

    • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
    disabled boolean
    (Boolean) Indicates whether the API key configuration is disabled. If it is set to true, the IAM credentials engine doesn't use the configured API key for credentials management.
    id string
    instanceId string
    name string
    region string
    secretType string
    (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

    • Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.
    updatedAt string
    (String) The date when a resource was modified. The date format follows RFC 3339.
    endpointType string
    api_key str
    (String) An IBM Cloud API key that can create and manage service IDs. The API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform role on the IAM Identity Service. For more information, see the docs.

    • Constraints: The maximum length is 60 characters. The minimum length is 5 characters. The value must match regular expression /^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/.
    config_type str
    (String) The configuration type.

    • Constraints: Allowable values are: public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, iam_credentials_configuration, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
    created_at str
    (String) The date when the resource was created. The date format follows RFC 3339.
    created_by str
    (String) The unique identifier that is associated with the entity that created the secret.

    • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
    disabled bool
    (Boolean) Indicates whether the API key configuration is disabled. If it is set to true, the IAM credentials engine doesn't use the configured API key for credentials management.
    id str
    instance_id str
    name str
    region str
    secret_type str
    (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

    • Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.
    updated_at str
    (String) The date when a resource was modified. The date format follows RFC 3339.
    endpoint_type str
    apiKey String
    (String) An IBM Cloud API key that can create and manage service IDs. The API key must be assigned the Editor platform role on the Access Groups Service and the Operator platform role on the IAM Identity Service. For more information, see the docs.

    • Constraints: The maximum length is 60 characters. The minimum length is 5 characters. The value must match regular expression /^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/.
    configType String
    (String) The configuration type.

    • Constraints: Allowable values are: public_cert_configuration_ca_lets_encrypt, public_cert_configuration_dns_classic_infrastructure, public_cert_configuration_dns_cloud_internet_services, iam_credentials_configuration, private_cert_configuration_root_ca, private_cert_configuration_intermediate_ca, private_cert_configuration_template.
    createdAt String
    (String) The date when the resource was created. The date format follows RFC 3339.
    createdBy String
    (String) The unique identifier that is associated with the entity that created the secret.

    • Constraints: The maximum length is 128 characters. The minimum length is 4 characters.
    disabled Boolean
    (Boolean) Indicates whether the API key configuration is disabled. If it is set to true, the IAM credentials engine doesn't use the configured API key for credentials management.
    id String
    instanceId String
    name String
    region String
    secretType String
    (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

    • Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.
    updatedAt String
    (String) The date when a resource was modified. The date format follows RFC 3339.
    endpointType String

    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.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud