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

ibm.SmIamCredentialsConfiguration

Explore with Pulumi AI

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

    Provides a resource for IAMCredentialsConfiguration. This allows IAMCredentialsConfiguration to be created, updated and deleted.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const smIamCredentialsConfigurationInstance = new ibm.SmIamCredentialsConfiguration("smIamCredentialsConfigurationInstance", {
        instanceId: ibm_resource_instance.sm_instance.guid,
        region: "us-south",
        apiKey: "my-api-key",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    sm_iam_credentials_configuration_instance = ibm.SmIamCredentialsConfiguration("smIamCredentialsConfigurationInstance",
        instance_id=ibm_resource_instance["sm_instance"]["guid"],
        region="us-south",
        api_key="my-api-key")
    
    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.NewSmIamCredentialsConfiguration(ctx, "smIamCredentialsConfigurationInstance", &ibm.SmIamCredentialsConfigurationArgs{
    			InstanceId: pulumi.Any(ibm_resource_instance.Sm_instance.Guid),
    			Region:     pulumi.String("us-south"),
    			ApiKey:     pulumi.String("my-api-key"),
    		})
    		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 smIamCredentialsConfigurationInstance = new Ibm.SmIamCredentialsConfiguration("smIamCredentialsConfigurationInstance", new()
        {
            InstanceId = ibm_resource_instance.Sm_instance.Guid,
            Region = "us-south",
            ApiKey = "my-api-key",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.SmIamCredentialsConfiguration;
    import com.pulumi.ibm.SmIamCredentialsConfigurationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var smIamCredentialsConfigurationInstance = new SmIamCredentialsConfiguration("smIamCredentialsConfigurationInstance", SmIamCredentialsConfigurationArgs.builder()
                .instanceId(ibm_resource_instance.sm_instance().guid())
                .region("us-south")
                .apiKey("my-api-key")
                .build());
    
        }
    }
    
    resources:
      smIamCredentialsConfigurationInstance:
        type: ibm:SmIamCredentialsConfiguration
        properties:
          instanceId: ${ibm_resource_instance.sm_instance.guid}
          region: us-south
          apiKey: my-api-key
    

    Provider Configuration

    The IBM Cloud provider offers a flexible means of providing credentials for authentication. The following methods are supported, in this order, and explained below:

    • Static credentials
    • Environment variables

    To find which credentials are required for this resource, see the service table here.

    Static credentials

    You can provide your static credentials by adding the ibmcloud_api_key, iaas_classic_username, and iaas_classic_api_key arguments in the IBM Cloud provider block.

    Usage:

    provider "ibm" {
        ibmcloud_api_key = ""
        iaas_classic_username = ""
        iaas_classic_api_key = ""
    }
    

    Environment variables

    You can provide your credentials by exporting the IC_API_KEY, IAAS_CLASSIC_USERNAME, and IAAS_CLASSIC_API_KEY environment variables, representing your IBM Cloud platform API key, IBM Cloud Classic Infrastructure (SoftLayer) user name, and IBM Cloud infrastructure API key, respectively.

    provider "ibm" {}
    

    Usage:

    export IC_API_KEY="ibmcloud_api_key"
    export IAAS_CLASSIC_USERNAME="iaas_classic_username"
    export IAAS_CLASSIC_API_KEY="iaas_classic_api_key"
    pulumi preview
    

    Note:

    1. Create or find your ibmcloud_api_key and iaas_classic_api_key here.
    • Select My IBM Cloud API Keys option from view dropdown for ibmcloud_api_key
    • Select Classic Infrastructure API Keys option from view dropdown for iaas_classic_api_key
    1. For iaas_classic_username
    • Go to Users
    • Click on user.
    • Find user name in the VPN password section under User Details tab

    For more informaton, see here.

    Create SmIamCredentialsConfiguration Resource

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

    Constructor syntax

    new SmIamCredentialsConfiguration(name: string, args: SmIamCredentialsConfigurationArgs, opts?: CustomResourceOptions);
    @overload
    def SmIamCredentialsConfiguration(resource_name: str,
                                      args: SmIamCredentialsConfigurationArgs,
                                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def SmIamCredentialsConfiguration(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      api_key: Optional[str] = None,
                                      instance_id: Optional[str] = None,
                                      disabled: Optional[bool] = None,
                                      endpoint_type: Optional[str] = None,
                                      name: Optional[str] = None,
                                      region: Optional[str] = None,
                                      sm_iam_credentials_configuration_id: Optional[str] = None)
    func NewSmIamCredentialsConfiguration(ctx *Context, name string, args SmIamCredentialsConfigurationArgs, opts ...ResourceOption) (*SmIamCredentialsConfiguration, error)
    public SmIamCredentialsConfiguration(string name, SmIamCredentialsConfigurationArgs args, CustomResourceOptions? opts = null)
    public SmIamCredentialsConfiguration(String name, SmIamCredentialsConfigurationArgs args)
    public SmIamCredentialsConfiguration(String name, SmIamCredentialsConfigurationArgs args, CustomResourceOptions options)
    
    type: ibm:SmIamCredentialsConfiguration
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args SmIamCredentialsConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SmIamCredentialsConfigurationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SmIamCredentialsConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SmIamCredentialsConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SmIamCredentialsConfigurationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var smIamCredentialsConfigurationResource = new Ibm.SmIamCredentialsConfiguration("smIamCredentialsConfigurationResource", new()
    {
        ApiKey = "string",
        InstanceId = "string",
        Disabled = false,
        EndpointType = "string",
        Name = "string",
        Region = "string",
        SmIamCredentialsConfigurationId = "string",
    });
    
    example, err := ibm.NewSmIamCredentialsConfiguration(ctx, "smIamCredentialsConfigurationResource", &ibm.SmIamCredentialsConfigurationArgs{
    	ApiKey:                          pulumi.String("string"),
    	InstanceId:                      pulumi.String("string"),
    	Disabled:                        pulumi.Bool(false),
    	EndpointType:                    pulumi.String("string"),
    	Name:                            pulumi.String("string"),
    	Region:                          pulumi.String("string"),
    	SmIamCredentialsConfigurationId: pulumi.String("string"),
    })
    
    var smIamCredentialsConfigurationResource = new SmIamCredentialsConfiguration("smIamCredentialsConfigurationResource", SmIamCredentialsConfigurationArgs.builder()
        .apiKey("string")
        .instanceId("string")
        .disabled(false)
        .endpointType("string")
        .name("string")
        .region("string")
        .smIamCredentialsConfigurationId("string")
        .build());
    
    sm_iam_credentials_configuration_resource = ibm.SmIamCredentialsConfiguration("smIamCredentialsConfigurationResource",
        api_key="string",
        instance_id="string",
        disabled=False,
        endpoint_type="string",
        name="string",
        region="string",
        sm_iam_credentials_configuration_id="string")
    
    const smIamCredentialsConfigurationResource = new ibm.SmIamCredentialsConfiguration("smIamCredentialsConfigurationResource", {
        apiKey: "string",
        instanceId: "string",
        disabled: false,
        endpointType: "string",
        name: "string",
        region: "string",
        smIamCredentialsConfigurationId: "string",
    });
    
    type: ibm:SmIamCredentialsConfiguration
    properties:
        apiKey: string
        disabled: false
        endpointType: string
        instanceId: string
        name: string
        region: string
        smIamCredentialsConfigurationId: string
    

    SmIamCredentialsConfiguration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SmIamCredentialsConfiguration resource accepts the following input properties:

    ApiKey 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}=)?$/.
    InstanceId string
    The GUID of the Secrets Manager instance.
    Disabled bool
    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. Default is false.
    EndpointType string
    The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

    • Constraints: Allowable values are: private, public.
    Name string
    A human-readable unique name to assign to your IAM Credentials configuration.
    Region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    SmIamCredentialsConfigurationId string
    The unique identifier of the IAMCredentialsConfiguration.
    ApiKey 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}=)?$/.
    InstanceId string
    The GUID of the Secrets Manager instance.
    Disabled bool
    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. Default is false.
    EndpointType string
    The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

    • Constraints: Allowable values are: private, public.
    Name string
    A human-readable unique name to assign to your IAM Credentials configuration.
    Region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    SmIamCredentialsConfigurationId string
    The unique identifier of the IAMCredentialsConfiguration.
    apiKey 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}=)?$/.
    instanceId String
    The GUID of the Secrets Manager instance.
    disabled 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. Default is false.
    endpointType String
    The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

    • Constraints: Allowable values are: private, public.
    name String
    A human-readable unique name to assign to your IAM Credentials configuration.
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    smIamCredentialsConfigurationId String
    The unique identifier of the IAMCredentialsConfiguration.
    apiKey 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}=)?$/.
    instanceId string
    The GUID of the Secrets Manager instance.
    disabled 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. Default is false.
    endpointType string
    The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

    • Constraints: Allowable values are: private, public.
    name string
    A human-readable unique name to assign to your IAM Credentials configuration.
    region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    smIamCredentialsConfigurationId string
    The unique identifier of the IAMCredentialsConfiguration.
    api_key str
    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}=)?$/.
    instance_id str
    The GUID of the Secrets Manager instance.
    disabled bool
    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. Default is false.
    endpoint_type str
    The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

    • Constraints: Allowable values are: private, public.
    name str
    A human-readable unique name to assign to your IAM Credentials configuration.
    region str
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    sm_iam_credentials_configuration_id str
    The unique identifier of the IAMCredentialsConfiguration.
    apiKey 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}=)?$/.
    instanceId String
    The GUID of the Secrets Manager instance.
    disabled 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. Default is false.
    endpointType String
    The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

    • Constraints: Allowable values are: private, public.
    name String
    A human-readable unique name to assign to your IAM Credentials configuration.
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    smIamCredentialsConfigurationId String
    The unique identifier of the IAMCredentialsConfiguration.

    Outputs

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

    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.

    Look up Existing SmIamCredentialsConfiguration Resource

    Get an existing SmIamCredentialsConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SmIamCredentialsConfigurationState, opts?: CustomResourceOptions): SmIamCredentialsConfiguration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_key: Optional[str] = None,
            config_type: Optional[str] = None,
            created_at: Optional[str] = None,
            created_by: Optional[str] = None,
            disabled: Optional[bool] = None,
            endpoint_type: Optional[str] = None,
            instance_id: Optional[str] = None,
            name: Optional[str] = None,
            region: Optional[str] = None,
            secret_type: Optional[str] = None,
            sm_iam_credentials_configuration_id: Optional[str] = None,
            updated_at: Optional[str] = None) -> SmIamCredentialsConfiguration
    func GetSmIamCredentialsConfiguration(ctx *Context, name string, id IDInput, state *SmIamCredentialsConfigurationState, opts ...ResourceOption) (*SmIamCredentialsConfiguration, error)
    public static SmIamCredentialsConfiguration Get(string name, Input<string> id, SmIamCredentialsConfigurationState? state, CustomResourceOptions? opts = null)
    public static SmIamCredentialsConfiguration get(String name, Output<String> id, SmIamCredentialsConfigurationState state, CustomResourceOptions options)
    resources:  _:    type: ibm:SmIamCredentialsConfiguration    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiKey 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
    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. Default is false.
    EndpointType string
    The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

    • Constraints: Allowable values are: private, public.
    InstanceId string
    The GUID of the Secrets Manager instance.
    Name string
    A human-readable unique name to assign to your IAM Credentials configuration.
    Region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    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.
    SmIamCredentialsConfigurationId string
    The unique identifier of the IAMCredentialsConfiguration.
    UpdatedAt string
    (String) The date when a resource was modified. The date format follows RFC 3339.
    ApiKey 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
    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. Default is false.
    EndpointType string
    The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

    • Constraints: Allowable values are: private, public.
    InstanceId string
    The GUID of the Secrets Manager instance.
    Name string
    A human-readable unique name to assign to your IAM Credentials configuration.
    Region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    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.
    SmIamCredentialsConfigurationId string
    The unique identifier of the IAMCredentialsConfiguration.
    UpdatedAt string
    (String) The date when a resource was modified. The date format follows RFC 3339.
    apiKey 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
    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. Default is false.
    endpointType String
    The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

    • Constraints: Allowable values are: private, public.
    instanceId String
    The GUID of the Secrets Manager instance.
    name String
    A human-readable unique name to assign to your IAM Credentials configuration.
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    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.
    smIamCredentialsConfigurationId String
    The unique identifier of the IAMCredentialsConfiguration.
    updatedAt String
    (String) The date when a resource was modified. The date format follows RFC 3339.
    apiKey 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
    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. Default is false.
    endpointType string
    The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

    • Constraints: Allowable values are: private, public.
    instanceId string
    The GUID of the Secrets Manager instance.
    name string
    A human-readable unique name to assign to your IAM Credentials configuration.
    region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    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.
    smIamCredentialsConfigurationId string
    The unique identifier of the IAMCredentialsConfiguration.
    updatedAt string
    (String) The date when a resource was modified. The date format follows RFC 3339.
    api_key str
    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
    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. Default is false.
    endpoint_type str
    The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

    • Constraints: Allowable values are: private, public.
    instance_id str
    The GUID of the Secrets Manager instance.
    name str
    A human-readable unique name to assign to your IAM Credentials configuration.
    region str
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    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.
    sm_iam_credentials_configuration_id str
    The unique identifier of the IAMCredentialsConfiguration.
    updated_at str
    (String) The date when a resource was modified. The date format follows RFC 3339.
    apiKey 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
    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. Default is false.
    endpointType String
    The endpoint type. If not provided the endpoint type is determined by the visibility argument provided in the provider configuration.

    • Constraints: Allowable values are: private, public.
    instanceId String
    The GUID of the Secrets Manager instance.
    name String
    A human-readable unique name to assign to your IAM Credentials configuration.
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    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.
    smIamCredentialsConfigurationId String
    The unique identifier of the IAMCredentialsConfiguration.
    updatedAt String
    (String) The date when a resource was modified. The date format follows RFC 3339.

    Import

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

    For more information, see the documentation

    Syntax

    bash

    $ pulumi import ibm:index/smIamCredentialsConfiguration:SmIamCredentialsConfiguration sm_iam_credentials_configuration <region>/<instance_id>/<name>
    

    Example

    bash

    $ pulumi import ibm:index/smIamCredentialsConfiguration:SmIamCredentialsConfiguration sm_iam_credentials_configuration us-east/6ebc4224-e983-496a-8a54-f40a0bfa9175/my-secret-engine-config
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud