ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm.getSmIamCredentialsConfiguration
Explore with Pulumi AI
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:
- Instance
Id 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 is2
characters. The value must match regular expression/^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/
.
- Constraints: The maximum length is
- Endpoint
Type 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
.
- Constraints: Allowable values are:
- 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 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 is2
characters. The value must match regular expression/^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/
.
- Constraints: The maximum length is
- Endpoint
Type 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
.
- Constraints: Allowable values are:
- 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 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 is2
characters. The value must match regular expression/^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/
.
- Constraints: The maximum length is
- endpoint
Type 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
.
- Constraints: Allowable values are:
- 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 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 is2
characters. The value must match regular expression/^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/
.
- Constraints: The maximum length is
- endpoint
Type 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
.
- Constraints: Allowable values are:
- 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 is2
characters. The value must match regular expression/^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/
.
- Constraints: The maximum length is
- 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
.
- Constraints: Allowable values are:
- id str
- region str
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- instance
Id 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 is2
characters. The value must match regular expression/^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/
.
- Constraints: The maximum length is
- endpoint
Type 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
.
- Constraints: Allowable values are:
- 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:
- Api
Key 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 is5
characters. The value must match regular expression/^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/
.
- Constraints: The maximum length is
- Config
Type 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
.
- Constraints: Allowable values are:
- Created
At string - (String) The date when the resource was created. The date format follows
RFC 3339
. - Created
By 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 is4
characters.
- Constraints: The maximum length is
- 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
- Instance
Id string - Name string
- Region string
- Secret
Type 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
.
- Constraints: Allowable values are:
- Updated
At string - (String) The date when a resource was modified. The date format follows
RFC 3339
. - Endpoint
Type string
- Api
Key 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 is5
characters. The value must match regular expression/^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/
.
- Constraints: The maximum length is
- Config
Type 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
.
- Constraints: Allowable values are:
- Created
At string - (String) The date when the resource was created. The date format follows
RFC 3339
. - Created
By 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 is4
characters.
- Constraints: The maximum length is
- 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
- Instance
Id string - Name string
- Region string
- Secret
Type 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
.
- Constraints: Allowable values are:
- Updated
At string - (String) The date when a resource was modified. The date format follows
RFC 3339
. - Endpoint
Type string
- api
Key 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 is5
characters. The value must match regular expression/^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/
.
- Constraints: The maximum length is
- config
Type 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
.
- Constraints: Allowable values are:
- created
At String - (String) The date when the resource was created. The date format follows
RFC 3339
. - created
By 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 is4
characters.
- Constraints: The maximum length is
- 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
- instance
Id String - name String
- region String
- secret
Type 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
.
- Constraints: Allowable values are:
- updated
At String - (String) The date when a resource was modified. The date format follows
RFC 3339
. - endpoint
Type String
- api
Key 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 is5
characters. The value must match regular expression/^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/
.
- Constraints: The maximum length is
- config
Type 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
.
- Constraints: Allowable values are:
- created
At string - (String) The date when the resource was created. The date format follows
RFC 3339
. - created
By 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 is4
characters.
- Constraints: The maximum length is
- 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
- instance
Id string - name string
- region string
- secret
Type 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
.
- Constraints: Allowable values are:
- updated
At string - (String) The date when a resource was modified. The date format follows
RFC 3339
. - endpoint
Type 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 is5
characters. The value must match regular expression/^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/
.
- Constraints: The maximum length is
- 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
.
- Constraints: Allowable values are:
- 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 is4
characters.
- Constraints: The maximum length is
- 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
.
- Constraints: Allowable values are:
- updated_
at str - (String) The date when a resource was modified. The date format follows
RFC 3339
. - endpoint_
type str
- api
Key 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 is5
characters. The value must match regular expression/^(?:[A-Za-z0-9_\\-]{4})*(?:[A-Za-z0-9_\\-]{2}==|[A-Za-z0-9_\\-]{3}=)?$/
.
- Constraints: The maximum length is
- config
Type 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
.
- Constraints: Allowable values are:
- created
At String - (String) The date when the resource was created. The date format follows
RFC 3339
. - created
By 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 is4
characters.
- Constraints: The maximum length is
- 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
- instance
Id String - name String
- region String
- secret
Type 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
.
- Constraints: Allowable values are:
- updated
At String - (String) The date when a resource was modified. The date format follows
RFC 3339
. - endpoint
Type String
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibm
Terraform Provider.