Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getSmServiceCredentialsSecretMetadata
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getSmServiceCredentialsSecretMetadata

Explore with Pulumi AI

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

    Provides a read-only data source for the metadata of an service credentials secret. 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 serviceCredentialsSecretMetadata = ibm.getSmServiceCredentialsSecretMetadata({
    instanceId: ibm_resource_instance.sm_instance.guid,
    region: "us-south",
    secretId: "0b5571f7-21e6-42b7-91c5-3f5ac9793a46",
});

    import pulumi
import pulumi_ibm as ibm

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

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetSmServiceCredentialsSecretMetadata(ctx, &ibm.GetSmServiceCredentialsSecretMetadataArgs{
			InstanceId: ibm_resource_instance.Sm_instance.Guid,
			Region:     pulumi.StringRef("us-south"),
			SecretId:   "0b5571f7-21e6-42b7-91c5-3f5ac9793a46",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var serviceCredentialsSecretMetadata = Ibm.GetSmServiceCredentialsSecretMetadata.Invoke(new()
    {
        InstanceId = ibm_resource_instance.Sm_instance.Guid,
        Region = "us-south",
        SecretId = "0b5571f7-21e6-42b7-91c5-3f5ac9793a46",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetSmServiceCredentialsSecretMetadataArgs;
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 serviceCredentialsSecretMetadata = IbmFunctions.getSmServiceCredentialsSecretMetadata(GetSmServiceCredentialsSecretMetadataArgs.builder()
            .instanceId(ibm_resource_instance.sm_instance().guid())
            .region("us-south")
            .secretId("0b5571f7-21e6-42b7-91c5-3f5ac9793a46")
            .build());

    }
}

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

    Using getSmServiceCredentialsSecretMetadata

    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 getSmServiceCredentialsSecretMetadata(args: GetSmServiceCredentialsSecretMetadataArgs, opts?: InvokeOptions): Promise<GetSmServiceCredentialsSecretMetadataResult>
function getSmServiceCredentialsSecretMetadataOutput(args: GetSmServiceCredentialsSecretMetadataOutputArgs, opts?: InvokeOptions): Output<GetSmServiceCredentialsSecretMetadataResult>
    def get_sm_service_credentials_secret_metadata(endpoint_type: Optional[str] = None,
                                               id: Optional[str] = None,
                                               instance_id: Optional[str] = None,
                                               region: Optional[str] = None,
                                               secret_id: Optional[str] = None,
                                               opts: Optional[InvokeOptions] = None) -> GetSmServiceCredentialsSecretMetadataResult
def get_sm_service_credentials_secret_metadata_output(endpoint_type: Optional[pulumi.Input[str]] = None,
                                               id: Optional[pulumi.Input[str]] = None,
                                               instance_id: Optional[pulumi.Input[str]] = None,
                                               region: Optional[pulumi.Input[str]] = None,
                                               secret_id: Optional[pulumi.Input[str]] = None,
                                               opts: Optional[InvokeOptions] = None) -> Output[GetSmServiceCredentialsSecretMetadataResult]
    func GetSmServiceCredentialsSecretMetadata(ctx *Context, args *GetSmServiceCredentialsSecretMetadataArgs, opts ...InvokeOption) (*GetSmServiceCredentialsSecretMetadataResult, error)
func GetSmServiceCredentialsSecretMetadataOutput(ctx *Context, args *GetSmServiceCredentialsSecretMetadataOutputArgs, opts ...InvokeOption) GetSmServiceCredentialsSecretMetadataResultOutput

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

    public static class GetSmServiceCredentialsSecretMetadata 
{
    public static Task<GetSmServiceCredentialsSecretMetadataResult> InvokeAsync(GetSmServiceCredentialsSecretMetadataArgs args, InvokeOptions? opts = null)
    public static Output<GetSmServiceCredentialsSecretMetadataResult> Invoke(GetSmServiceCredentialsSecretMetadataInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSmServiceCredentialsSecretMetadataResult> getSmServiceCredentialsSecretMetadata(GetSmServiceCredentialsSecretMetadataArgs args, InvokeOptions options)
public static Output<GetSmServiceCredentialsSecretMetadataResult> getSmServiceCredentialsSecretMetadata(GetSmServiceCredentialsSecretMetadataArgs args, InvokeOptions options)

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

    The following arguments are supported:

    InstanceId string
    The GUID of the Secrets Manager instance.
    SecretId string
    The ID of the secret.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
    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
    The unique identifier of the data source.
    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.
    SecretId string
    The ID of the secret.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
    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
    The unique identifier of the data source.
    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.
    secretId String
    The ID of the secret.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
    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
    The unique identifier of the data source.
    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.
    secretId string
    The ID of the secret.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
    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
    The unique identifier of the data source.
    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.
    secret_id str
    The ID of the secret.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
    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
    The unique identifier of the data source.
    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.
    secretId String
    The ID of the secret.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/.
    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
    The unique identifier of the data source.
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

    getSmServiceCredentialsSecretMetadata Result

    The following output properties are available:

    CreatedAt string
    (String) The date when a 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.
    Crn string
    (String) The resource key CRN of the generated service credentials.
    CustomMetadata Dictionary<string, string>
    (Map) The secret metadata that a user can customize.
    Description string
    (String) The IAM API key description for the generated service credentials.
    Downloaded bool
    (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
    ExpirationDate string
    (String) The date a secret is expired. The date format follows RFC 3339.
    Id string
    The unique identifier of the data source.
    InstanceId string
    Labels List<string>
    (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

    • Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.
    LocksTotal double
    (Integer) The number of locks of the secret.

    • Constraints: The maximum value is 1000. The minimum value is 0.
    Name string
    (String) The resource key name of the generated service credentials.
    NextRotationDate string
    (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
    Region string
    Rotations List<GetSmServiceCredentialsSecretMetadataRotation>
    (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    SecretGroupId string
    (String) A UUID identifier, or default secret group.

    • Constraints: The maximum length is 36 characters. The minimum length is 7 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}|default)$/.
    SecretId 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.
    SourceServices List<GetSmServiceCredentialsSecretMetadataSourceService>
    (List) The properties required for creating the service credentials for the specified source service instance. Nested scheme for source_service:
    State double
    (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

    • Constraints: Allowable values are: 0, 1, 2, 3, 5.
    StateDescription string
    (String) A text representation of the secret state.

    • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
    Ttl string
    (String) The time-to-live (TTL) or lease duration to assign to generated credentials. The TTL defines for how long generated credentials remain valid. The value should be a string that specifies the number of seconds. Minimum duration is 86400 (1 day). Maximum is 7776000 seconds (90 days).

    • Constraints: The maximum length is 7 characters. The minimum length is 2 characters.
    UpdatedAt string
    (String) The date when a resource was recently modified. The date format follows RFC 3339.
    VersionsTotal double
    (Integer) The number of versions of the secret.

    • Constraints: The maximum value is 50. The minimum value is 0.
    EndpointType string
    CreatedAt string
    (String) The date when a 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.
    Crn string
    (String) The resource key CRN of the generated service credentials.
    CustomMetadata map[string]string
    (Map) The secret metadata that a user can customize.
    Description string
    (String) The IAM API key description for the generated service credentials.
    Downloaded bool
    (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
    ExpirationDate string
    (String) The date a secret is expired. The date format follows RFC 3339.
    Id string
    The unique identifier of the data source.
    InstanceId string
    Labels []string
    (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

    • Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.
    LocksTotal float64
    (Integer) The number of locks of the secret.

    • Constraints: The maximum value is 1000. The minimum value is 0.
    Name string
    (String) The resource key name of the generated service credentials.
    NextRotationDate string
    (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
    Region string
    Rotations []GetSmServiceCredentialsSecretMetadataRotation
    (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    SecretGroupId string
    (String) A UUID identifier, or default secret group.

    • Constraints: The maximum length is 36 characters. The minimum length is 7 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}|default)$/.
    SecretId 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.
    SourceServices []GetSmServiceCredentialsSecretMetadataSourceService
    (List) The properties required for creating the service credentials for the specified source service instance. Nested scheme for source_service:
    State float64
    (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

    • Constraints: Allowable values are: 0, 1, 2, 3, 5.
    StateDescription string
    (String) A text representation of the secret state.

    • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
    Ttl string
    (String) The time-to-live (TTL) or lease duration to assign to generated credentials. The TTL defines for how long generated credentials remain valid. The value should be a string that specifies the number of seconds. Minimum duration is 86400 (1 day). Maximum is 7776000 seconds (90 days).

    • Constraints: The maximum length is 7 characters. The minimum length is 2 characters.
    UpdatedAt string
    (String) The date when a resource was recently modified. The date format follows RFC 3339.
    VersionsTotal float64
    (Integer) The number of versions of the secret.

    • Constraints: The maximum value is 50. The minimum value is 0.
    EndpointType string
    createdAt String
    (String) The date when a 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.
    crn String
    (String) The resource key CRN of the generated service credentials.
    customMetadata Map<String,String>
    (Map) The secret metadata that a user can customize.
    description String
    (String) The IAM API key description for the generated service credentials.
    downloaded Boolean
    (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
    expirationDate String
    (String) The date a secret is expired. The date format follows RFC 3339.
    id String
    The unique identifier of the data source.
    instanceId String
    labels List<String>
    (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

    • Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.
    locksTotal Double
    (Integer) The number of locks of the secret.

    • Constraints: The maximum value is 1000. The minimum value is 0.
    name String
    (String) The resource key name of the generated service credentials.
    nextRotationDate String
    (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
    region String
    rotations List<GetSmServiceCredentialsSecretMetadataRotation>
    (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    secretGroupId String
    (String) A UUID identifier, or default secret group.

    • Constraints: The maximum length is 36 characters. The minimum length is 7 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}|default)$/.
    secretId 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.
    sourceServices List<GetSmServiceCredentialsSecretMetadataSourceService>
    (List) The properties required for creating the service credentials for the specified source service instance. Nested scheme for source_service:
    state Double
    (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

    • Constraints: Allowable values are: 0, 1, 2, 3, 5.
    stateDescription String
    (String) A text representation of the secret state.

    • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
    ttl String
    (String) The time-to-live (TTL) or lease duration to assign to generated credentials. The TTL defines for how long generated credentials remain valid. The value should be a string that specifies the number of seconds. Minimum duration is 86400 (1 day). Maximum is 7776000 seconds (90 days).

    • Constraints: The maximum length is 7 characters. The minimum length is 2 characters.
    updatedAt String
    (String) The date when a resource was recently modified. The date format follows RFC 3339.
    versionsTotal Double
    (Integer) The number of versions of the secret.

    • Constraints: The maximum value is 50. The minimum value is 0.
    endpointType String
    createdAt string
    (String) The date when a 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.
    crn string
    (String) The resource key CRN of the generated service credentials.
    customMetadata {[key: string]: string}
    (Map) The secret metadata that a user can customize.
    description string
    (String) The IAM API key description for the generated service credentials.
    downloaded boolean
    (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
    expirationDate string
    (String) The date a secret is expired. The date format follows RFC 3339.
    id string
    The unique identifier of the data source.
    instanceId string
    labels string[]
    (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

    • Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.
    locksTotal number
    (Integer) The number of locks of the secret.

    • Constraints: The maximum value is 1000. The minimum value is 0.
    name string
    (String) The resource key name of the generated service credentials.
    nextRotationDate string
    (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
    region string
    rotations GetSmServiceCredentialsSecretMetadataRotation[]
    (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    secretGroupId string
    (String) A UUID identifier, or default secret group.

    • Constraints: The maximum length is 36 characters. The minimum length is 7 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}|default)$/.
    secretId 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.
    sourceServices GetSmServiceCredentialsSecretMetadataSourceService[]
    (List) The properties required for creating the service credentials for the specified source service instance. Nested scheme for source_service:
    state number
    (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

    • Constraints: Allowable values are: 0, 1, 2, 3, 5.
    stateDescription string
    (String) A text representation of the secret state.

    • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
    ttl string
    (String) The time-to-live (TTL) or lease duration to assign to generated credentials. The TTL defines for how long generated credentials remain valid. The value should be a string that specifies the number of seconds. Minimum duration is 86400 (1 day). Maximum is 7776000 seconds (90 days).

    • Constraints: The maximum length is 7 characters. The minimum length is 2 characters.
    updatedAt string
    (String) The date when a resource was recently modified. The date format follows RFC 3339.
    versionsTotal number
    (Integer) The number of versions of the secret.

    • Constraints: The maximum value is 50. The minimum value is 0.
    endpointType string
    created_at str
    (String) The date when a 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.
    crn str
    (String) The resource key CRN of the generated service credentials.
    custom_metadata Mapping[str, str]
    (Map) The secret metadata that a user can customize.
    description str
    (String) The IAM API key description for the generated service credentials.
    downloaded bool
    (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
    expiration_date str
    (String) The date a secret is expired. The date format follows RFC 3339.
    id str
    The unique identifier of the data source.
    instance_id str
    labels Sequence[str]
    (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

    • Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.
    locks_total float
    (Integer) The number of locks of the secret.

    • Constraints: The maximum value is 1000. The minimum value is 0.
    name str
    (String) The resource key name of the generated service credentials.
    next_rotation_date str
    (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
    region str
    rotations Sequence[GetSmServiceCredentialsSecretMetadataRotation]
    (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    secret_group_id str
    (String) A UUID identifier, or default secret group.

    • Constraints: The maximum length is 36 characters. The minimum length is 7 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}|default)$/.
    secret_id 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.
    source_services Sequence[GetSmServiceCredentialsSecretMetadataSourceService]
    (List) The properties required for creating the service credentials for the specified source service instance. Nested scheme for source_service:
    state float
    (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

    • Constraints: Allowable values are: 0, 1, 2, 3, 5.
    state_description str
    (String) A text representation of the secret state.

    • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
    ttl str
    (String) The time-to-live (TTL) or lease duration to assign to generated credentials. The TTL defines for how long generated credentials remain valid. The value should be a string that specifies the number of seconds. Minimum duration is 86400 (1 day). Maximum is 7776000 seconds (90 days).

    • Constraints: The maximum length is 7 characters. The minimum length is 2 characters.
    updated_at str
    (String) The date when a resource was recently modified. The date format follows RFC 3339.
    versions_total float
    (Integer) The number of versions of the secret.

    • Constraints: The maximum value is 50. The minimum value is 0.
    endpoint_type str
    createdAt String
    (String) The date when a 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.
    crn String
    (String) The resource key CRN of the generated service credentials.
    customMetadata Map<String>
    (Map) The secret metadata that a user can customize.
    description String
    (String) The IAM API key description for the generated service credentials.
    downloaded Boolean
    (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
    expirationDate String
    (String) The date a secret is expired. The date format follows RFC 3339.
    id String
    The unique identifier of the data source.
    instanceId String
    labels List<String>
    (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

    • Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.
    locksTotal Number
    (Integer) The number of locks of the secret.

    • Constraints: The maximum value is 1000. The minimum value is 0.
    name String
    (String) The resource key name of the generated service credentials.
    nextRotationDate String
    (String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.
    region String
    rotations List<Property Map>
    (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
    secretGroupId String
    (String) A UUID identifier, or default secret group.

    • Constraints: The maximum length is 36 characters. The minimum length is 7 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}|default)$/.
    secretId 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.
    sourceServices List<Property Map>
    (List) The properties required for creating the service credentials for the specified source service instance. Nested scheme for source_service:
    state Number
    (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

    • Constraints: Allowable values are: 0, 1, 2, 3, 5.
    stateDescription String
    (String) A text representation of the secret state.

    • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
    ttl String
    (String) The time-to-live (TTL) or lease duration to assign to generated credentials. The TTL defines for how long generated credentials remain valid. The value should be a string that specifies the number of seconds. Minimum duration is 86400 (1 day). Maximum is 7776000 seconds (90 days).

    • Constraints: The maximum length is 7 characters. The minimum length is 2 characters.
    updatedAt String
    (String) The date when a resource was recently modified. The date format follows RFC 3339.
    versionsTotal Number
    (Integer) The number of versions of the secret.

    • Constraints: The maximum value is 50. The minimum value is 0.
    endpointType String

    Supporting Types

    GetSmServiceCredentialsSecretMetadataRotation

    AutoRotate bool
    (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.
    Interval double
    (Integer) The length of the secret rotation time interval.

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

    • Constraints: Allowable values are: day, month.
    AutoRotate bool
    (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.
    Interval float64
    (Integer) The length of the secret rotation time interval.

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

    • Constraints: Allowable values are: day, month.
    autoRotate Boolean
    (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.
    interval Double
    (Integer) The length of the secret rotation time interval.

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

    • Constraints: Allowable values are: day, month.
    autoRotate boolean
    (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.
    interval number
    (Integer) The length of the secret rotation time interval.

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

    • Constraints: Allowable values are: day, month.
    auto_rotate bool
    (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.
    interval float
    (Integer) The length of the secret rotation time interval.

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

    • Constraints: Allowable values are: day, month.
    autoRotate Boolean
    (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.
    interval Number
    (Integer) The length of the secret rotation time interval.

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

    • Constraints: Allowable values are: day, month.

    GetSmServiceCredentialsSecretMetadataSourceService

    Iams List<GetSmServiceCredentialsSecretMetadataSourceServiceIam>
    (List) The source service IAM data is returned in case IAM credentials where created for this secret. Nested scheme for iam:
    Instances List<GetSmServiceCredentialsSecretMetadataSourceServiceInstance>
    Parameters Dictionary<string, string>
    ResourceKeys List<GetSmServiceCredentialsSecretMetadataSourceServiceResourceKey>
    (List) The source service resource key data of the generated service credentials. Nested scheme for resource_key:
    Roles List<GetSmServiceCredentialsSecretMetadataSourceServiceRole>
    (String) The IAM role for the generate service credentials. Nested scheme for role:
    Iams []GetSmServiceCredentialsSecretMetadataSourceServiceIam
    (List) The source service IAM data is returned in case IAM credentials where created for this secret. Nested scheme for iam:
    Instances []GetSmServiceCredentialsSecretMetadataSourceServiceInstance
    Parameters map[string]string
    ResourceKeys []GetSmServiceCredentialsSecretMetadataSourceServiceResourceKey
    (List) The source service resource key data of the generated service credentials. Nested scheme for resource_key:
    Roles []GetSmServiceCredentialsSecretMetadataSourceServiceRole
    (String) The IAM role for the generate service credentials. Nested scheme for role:
    iams List<GetSmServiceCredentialsSecretMetadataSourceServiceIam>
    (List) The source service IAM data is returned in case IAM credentials where created for this secret. Nested scheme for iam:
    instances List<GetSmServiceCredentialsSecretMetadataSourceServiceInstance>
    parameters Map<String,String>
    resourceKeys List<GetSmServiceCredentialsSecretMetadataSourceServiceResourceKey>
    (List) The source service resource key data of the generated service credentials. Nested scheme for resource_key:
    roles List<GetSmServiceCredentialsSecretMetadataSourceServiceRole>
    (String) The IAM role for the generate service credentials. Nested scheme for role:
    iams GetSmServiceCredentialsSecretMetadataSourceServiceIam[]
    (List) The source service IAM data is returned in case IAM credentials where created for this secret. Nested scheme for iam:
    instances GetSmServiceCredentialsSecretMetadataSourceServiceInstance[]
    parameters {[key: string]: string}
    resourceKeys GetSmServiceCredentialsSecretMetadataSourceServiceResourceKey[]
    (List) The source service resource key data of the generated service credentials. Nested scheme for resource_key:
    roles GetSmServiceCredentialsSecretMetadataSourceServiceRole[]
    (String) The IAM role for the generate service credentials. Nested scheme for role:
    iams Sequence[GetSmServiceCredentialsSecretMetadataSourceServiceIam]
    (List) The source service IAM data is returned in case IAM credentials where created for this secret. Nested scheme for iam:
    instances Sequence[GetSmServiceCredentialsSecretMetadataSourceServiceInstance]
    parameters Mapping[str, str]
    resource_keys Sequence[GetSmServiceCredentialsSecretMetadataSourceServiceResourceKey]
    (List) The source service resource key data of the generated service credentials. Nested scheme for resource_key:
    roles Sequence[GetSmServiceCredentialsSecretMetadataSourceServiceRole]
    (String) The IAM role for the generate service credentials. Nested scheme for role:
    iams List<Property Map>
    (List) The source service IAM data is returned in case IAM credentials where created for this secret. Nested scheme for iam:
    instances List<Property Map>
    parameters Map<String>
    resourceKeys List<Property Map>
    (List) The source service resource key data of the generated service credentials. Nested scheme for resource_key:
    roles List<Property Map>
    (String) The IAM role for the generate service credentials. Nested scheme for role:

    GetSmServiceCredentialsSecretMetadataSourceServiceIam

    Apikeys List<GetSmServiceCredentialsSecretMetadataSourceServiceIamApikey>
    (String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
    Roles List<GetSmServiceCredentialsSecretMetadataSourceServiceIamRole>
    (String) The IAM role for the generate service credentials. Nested scheme for role:
    Serviceids List<GetSmServiceCredentialsSecretMetadataSourceServiceIamServiceid>
    (String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
    Apikeys []GetSmServiceCredentialsSecretMetadataSourceServiceIamApikey
    (String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
    Roles []GetSmServiceCredentialsSecretMetadataSourceServiceIamRole
    (String) The IAM role for the generate service credentials. Nested scheme for role:
    Serviceids []GetSmServiceCredentialsSecretMetadataSourceServiceIamServiceid
    (String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
    apikeys List<GetSmServiceCredentialsSecretMetadataSourceServiceIamApikey>
    (String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
    roles List<GetSmServiceCredentialsSecretMetadataSourceServiceIamRole>
    (String) The IAM role for the generate service credentials. Nested scheme for role:
    serviceids List<GetSmServiceCredentialsSecretMetadataSourceServiceIamServiceid>
    (String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
    apikeys GetSmServiceCredentialsSecretMetadataSourceServiceIamApikey[]
    (String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
    roles GetSmServiceCredentialsSecretMetadataSourceServiceIamRole[]
    (String) The IAM role for the generate service credentials. Nested scheme for role:
    serviceids GetSmServiceCredentialsSecretMetadataSourceServiceIamServiceid[]
    (String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
    apikeys Sequence[GetSmServiceCredentialsSecretMetadataSourceServiceIamApikey]
    (String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
    roles Sequence[GetSmServiceCredentialsSecretMetadataSourceServiceIamRole]
    (String) The IAM role for the generate service credentials. Nested scheme for role:
    serviceids Sequence[GetSmServiceCredentialsSecretMetadataSourceServiceIamServiceid]
    (String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
    apikeys List<Property Map>
    (String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
    roles List<Property Map>
    (String) The IAM role for the generate service credentials. Nested scheme for role:
    serviceids List<Property Map>
    (String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:

    GetSmServiceCredentialsSecretMetadataSourceServiceIamApikey

    Description string
    (String) The IAM API key description for the generated service credentials.
    Name string
    (String) The resource key name of the generated service credentials.
    Description string
    (String) The IAM API key description for the generated service credentials.
    Name string
    (String) The resource key name of the generated service credentials.
    description String
    (String) The IAM API key description for the generated service credentials.
    name String
    (String) The resource key name of the generated service credentials.
    description string
    (String) The IAM API key description for the generated service credentials.
    name string
    (String) The resource key name of the generated service credentials.
    description str
    (String) The IAM API key description for the generated service credentials.
    name str
    (String) The resource key name of the generated service credentials.
    description String
    (String) The IAM API key description for the generated service credentials.
    name String
    (String) The resource key name of the generated service credentials.

    GetSmServiceCredentialsSecretMetadataSourceServiceIamRole

    Crn string
    (String) The resource key CRN of the generated service credentials.
    Crn string
    (String) The resource key CRN of the generated service credentials.
    crn String
    (String) The resource key CRN of the generated service credentials.
    crn string
    (String) The resource key CRN of the generated service credentials.
    crn str
    (String) The resource key CRN of the generated service credentials.
    crn String
    (String) The resource key CRN of the generated service credentials.

    GetSmServiceCredentialsSecretMetadataSourceServiceIamServiceid

    Crn string
    (String) The resource key CRN of the generated service credentials.
    Crn string
    (String) The resource key CRN of the generated service credentials.
    crn String
    (String) The resource key CRN of the generated service credentials.
    crn string
    (String) The resource key CRN of the generated service credentials.
    crn str
    (String) The resource key CRN of the generated service credentials.
    crn String
    (String) The resource key CRN of the generated service credentials.

    GetSmServiceCredentialsSecretMetadataSourceServiceInstance

    Crn string
    (String) The resource key CRN of the generated service credentials.
    Crn string
    (String) The resource key CRN of the generated service credentials.
    crn String
    (String) The resource key CRN of the generated service credentials.
    crn string
    (String) The resource key CRN of the generated service credentials.
    crn str
    (String) The resource key CRN of the generated service credentials.
    crn String
    (String) The resource key CRN of the generated service credentials.

    GetSmServiceCredentialsSecretMetadataSourceServiceResourceKey

    Crn string
    (String) The resource key CRN of the generated service credentials.
    Name string
    (String) The resource key name of the generated service credentials.
    Crn string
    (String) The resource key CRN of the generated service credentials.
    Name string
    (String) The resource key name of the generated service credentials.
    crn String
    (String) The resource key CRN of the generated service credentials.
    name String
    (String) The resource key name of the generated service credentials.
    crn string
    (String) The resource key CRN of the generated service credentials.
    name string
    (String) The resource key name of the generated service credentials.
    crn str
    (String) The resource key CRN of the generated service credentials.
    name str
    (String) The resource key name of the generated service credentials.
    crn String
    (String) The resource key CRN of the generated service credentials.
    name String
    (String) The resource key name of the generated service credentials.

    GetSmServiceCredentialsSecretMetadataSourceServiceRole

    Crn string
    (String) The resource key CRN of the generated service credentials.
    Crn string
    (String) The resource key CRN of the generated service credentials.
    crn String
    (String) The resource key CRN of the generated service credentials.
    crn string
    (String) The resource key CRN of the generated service credentials.
    crn str
    (String) The resource key CRN of the generated service credentials.
    crn String
    (String) The resource key CRN of the generated service credentials.

    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
    ibm-cloud/terraform-provider-ibm