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

ibm.getSmPublicCertificate

Explore with Pulumi AI

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

    Provides a read-only data source for a public certificate. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax. The data source can be defined by providing the secret ID or the secret and secret group names.

    Example Usage

    By secret id

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const publicCertificate = ibm.getSmPublicCertificate({
        instanceId: ibm_resource_instance.sm_instance.guid,
        region: "us-south",
        secretId: "0b5571f7-21e6-42b7-91c5-3f5ac9793a46",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    public_certificate = ibm.get_sm_public_certificate(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.LookupSmPublicCertificate(ctx, &ibm.LookupSmPublicCertificateArgs{
    			InstanceId: ibm_resource_instance.Sm_instance.Guid,
    			Region:     pulumi.StringRef("us-south"),
    			SecretId:   pulumi.StringRef("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 publicCertificate = Ibm.GetSmPublicCertificate.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.GetSmPublicCertificateArgs;
    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 publicCertificate = IbmFunctions.getSmPublicCertificate(GetSmPublicCertificateArgs.builder()
                .instanceId(ibm_resource_instance.sm_instance().guid())
                .region("us-south")
                .secretId("0b5571f7-21e6-42b7-91c5-3f5ac9793a46")
                .build());
    
        }
    }
    
    variables:
      publicCertificate:
        fn::invoke:
          function: ibm:getSmPublicCertificate
          arguments:
            instanceId: ${ibm_resource_instance.sm_instance.guid}
            region: us-south
            secretId: 0b5571f7-21e6-42b7-91c5-3f5ac9793a46
    

    By secret name and group name

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const publicCertificate = ibm.getSmPublicCertificate({
        instanceId: ibm_resource_instance.sm_instance.guid,
        region: "us-south",
        name: "secret-name",
        secretGroupName: "group-name",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    public_certificate = ibm.get_sm_public_certificate(instance_id=ibm_resource_instance["sm_instance"]["guid"],
        region="us-south",
        name="secret-name",
        secret_group_name="group-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.LookupSmPublicCertificate(ctx, &ibm.LookupSmPublicCertificateArgs{
    			InstanceId:      ibm_resource_instance.Sm_instance.Guid,
    			Region:          pulumi.StringRef("us-south"),
    			Name:            pulumi.StringRef("secret-name"),
    			SecretGroupName: pulumi.StringRef("group-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 publicCertificate = Ibm.GetSmPublicCertificate.Invoke(new()
        {
            InstanceId = ibm_resource_instance.Sm_instance.Guid,
            Region = "us-south",
            Name = "secret-name",
            SecretGroupName = "group-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.GetSmPublicCertificateArgs;
    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 publicCertificate = IbmFunctions.getSmPublicCertificate(GetSmPublicCertificateArgs.builder()
                .instanceId(ibm_resource_instance.sm_instance().guid())
                .region("us-south")
                .name("secret-name")
                .secretGroupName("group-name")
                .build());
    
        }
    }
    
    variables:
      publicCertificate:
        fn::invoke:
          function: ibm:getSmPublicCertificate
          arguments:
            instanceId: ${ibm_resource_instance.sm_instance.guid}
            region: us-south
            name: secret-name
            secretGroupName: group-name
    

    Using getSmPublicCertificate

    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 getSmPublicCertificate(args: GetSmPublicCertificateArgs, opts?: InvokeOptions): Promise<GetSmPublicCertificateResult>
    function getSmPublicCertificateOutput(args: GetSmPublicCertificateOutputArgs, opts?: InvokeOptions): Output<GetSmPublicCertificateResult>
    def get_sm_public_certificate(endpoint_type: Optional[str] = None,
                                  id: Optional[str] = None,
                                  instance_id: Optional[str] = None,
                                  name: Optional[str] = None,
                                  region: Optional[str] = None,
                                  secret_group_name: Optional[str] = None,
                                  secret_id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetSmPublicCertificateResult
    def get_sm_public_certificate_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,
                                  secret_group_name: Optional[pulumi.Input[str]] = None,
                                  secret_id: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetSmPublicCertificateResult]
    func LookupSmPublicCertificate(ctx *Context, args *LookupSmPublicCertificateArgs, opts ...InvokeOption) (*LookupSmPublicCertificateResult, error)
    func LookupSmPublicCertificateOutput(ctx *Context, args *LookupSmPublicCertificateOutputArgs, opts ...InvokeOption) LookupSmPublicCertificateResultOutput

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

    public static class GetSmPublicCertificate 
    {
        public static Task<GetSmPublicCertificateResult> InvokeAsync(GetSmPublicCertificateArgs args, InvokeOptions? opts = null)
        public static Output<GetSmPublicCertificateResult> Invoke(GetSmPublicCertificateInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSmPublicCertificateResult> getSmPublicCertificate(GetSmPublicCertificateArgs args, InvokeOptions options)
    public static Output<GetSmPublicCertificateResult> getSmPublicCertificate(GetSmPublicCertificateArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getSmPublicCertificate:getSmPublicCertificate
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceId string
    The GUID of the Secrets Manager instance.
    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.
    Name string
    The human-readable name of your secret. To be used in combination with secret_group_name.

    • Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$.
    Region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    SecretGroupName string
    The name of your existing secret group. To be used in combination with name.

    • Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
    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}/.
    InstanceId string
    The GUID of the Secrets Manager instance.
    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.
    Name string
    The human-readable name of your secret. To be used in combination with secret_group_name.

    • Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$.
    Region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    SecretGroupName string
    The name of your existing secret group. To be used in combination with name.

    • Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
    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}/.
    instanceId String
    The GUID of the Secrets Manager instance.
    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.
    name String
    The human-readable name of your secret. To be used in combination with secret_group_name.

    • Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$.
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    secretGroupName String
    The name of your existing secret group. To be used in combination with name.

    • Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
    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}/.
    instanceId string
    The GUID of the Secrets Manager instance.
    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.
    name string
    The human-readable name of your secret. To be used in combination with secret_group_name.

    • Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$.
    region string
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    secretGroupName string
    The name of your existing secret group. To be used in combination with name.

    • Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
    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}/.
    instance_id str
    The GUID of the Secrets Manager instance.
    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.
    name str
    The human-readable name of your secret. To be used in combination with secret_group_name.

    • Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$.
    region str
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    secret_group_name str
    The name of your existing secret group. To be used in combination with name.

    • Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
    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}/.
    instanceId String
    The GUID of the Secrets Manager instance.
    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.
    name String
    The human-readable name of your secret. To be used in combination with secret_group_name.

    • Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9][A-Za-z0-9]*(?:_*-*\\.*[A-Za-z0-9]+)*$.
    region String
    The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
    secretGroupName String
    The name of your existing secret group. To be used in combination with name.

    • Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
    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}/.

    getSmPublicCertificate Result

    The following output properties are available:

    AltNames List<string>
    (List) With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.

    • Constraints: The list items must match regular expression /^(.*?)$/. The maximum length is 99 items. The minimum length is 0 items.
    BundleCerts bool
    (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
    Ca string
    (String) The name of the certificate authority configuration..
    Certificate string
    (String) The PEM-encoded contents of your certificate.

    • Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.
    CommonName string
    (String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.

    • Constraints: The maximum length is 64 characters. The minimum length is 4 characters. The value must match regular expression /^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/.
    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) A CRN that uniquely identifies an IBM Cloud resource.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
    CustomMetadata Dictionary<string, string>
    (Map) The secret metadata that a user can customize.
    Description string
    (String) An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

    • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
    Dns string
    (String) The name of the DNS provider configuration.
    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
    Intermediate string
    (String) (Optional) The PEM-encoded intermediate certificate to associate with the root certificate.

    • Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.
    IssuanceInfos List<GetSmPublicCertificateIssuanceInfo>
    (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
    Issuer string
    (String) The distinguished name that identifies the entity that signed and issued the certificate.

    • Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
    KeyAlgorithm string
    (String) The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (RSA or ECDSA) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.

    • Constraints: The default value is RSA2048. The maximum length is 7 characters. The minimum length is 5 characters. The value must match regular expression /^(RSA2048|RSA4096|EC256|EC384)$/.
    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 human-readable name of your secret.

    • Constraints: The maximum length is 256 characters. The minimum length is 2 characters.
    PrivateKey string
    (String) (Optional) The PEM-encoded private key to associate with the certificate.

    • Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.
    Region string
    Rotations List<GetSmPublicCertificateRotation>
    (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.
    SerialNumber string
    (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.

    • Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[^a-fA-F0-9]/.
    SigningAlgorithm string
    (String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.

    • Constraints: The maximum length is 64 characters. The minimum length is 4 characters.
    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.
    UpdatedAt string
    (String) The date when a resource was recently modified. The date format follows RFC 3339.
    Validities List<GetSmPublicCertificateValidity>
    (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
    VersionsTotal double
    (Integer) The number of versions of the secret.

    • Constraints: The maximum value is 50. The minimum value is 0.
    EndpointType string
    SecretGroupName string
    AltNames []string
    (List) With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.

    • Constraints: The list items must match regular expression /^(.*?)$/. The maximum length is 99 items. The minimum length is 0 items.
    BundleCerts bool
    (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
    Ca string
    (String) The name of the certificate authority configuration..
    Certificate string
    (String) The PEM-encoded contents of your certificate.

    • Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.
    CommonName string
    (String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.

    • Constraints: The maximum length is 64 characters. The minimum length is 4 characters. The value must match regular expression /^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/.
    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) A CRN that uniquely identifies an IBM Cloud resource.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
    CustomMetadata map[string]string
    (Map) The secret metadata that a user can customize.
    Description string
    (String) An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

    • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
    Dns string
    (String) The name of the DNS provider configuration.
    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
    Intermediate string
    (String) (Optional) The PEM-encoded intermediate certificate to associate with the root certificate.

    • Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.
    IssuanceInfos []GetSmPublicCertificateIssuanceInfo
    (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
    Issuer string
    (String) The distinguished name that identifies the entity that signed and issued the certificate.

    • Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
    KeyAlgorithm string
    (String) The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (RSA or ECDSA) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.

    • Constraints: The default value is RSA2048. The maximum length is 7 characters. The minimum length is 5 characters. The value must match regular expression /^(RSA2048|RSA4096|EC256|EC384)$/.
    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 human-readable name of your secret.

    • Constraints: The maximum length is 256 characters. The minimum length is 2 characters.
    PrivateKey string
    (String) (Optional) The PEM-encoded private key to associate with the certificate.

    • Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.
    Region string
    Rotations []GetSmPublicCertificateRotation
    (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.
    SerialNumber string
    (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.

    • Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[^a-fA-F0-9]/.
    SigningAlgorithm string
    (String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.

    • Constraints: The maximum length is 64 characters. The minimum length is 4 characters.
    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.
    UpdatedAt string
    (String) The date when a resource was recently modified. The date format follows RFC 3339.
    Validities []GetSmPublicCertificateValidity
    (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
    VersionsTotal float64
    (Integer) The number of versions of the secret.

    • Constraints: The maximum value is 50. The minimum value is 0.
    EndpointType string
    SecretGroupName string
    altNames List<String>
    (List) With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.

    • Constraints: The list items must match regular expression /^(.*?)$/. The maximum length is 99 items. The minimum length is 0 items.
    bundleCerts Boolean
    (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
    ca String
    (String) The name of the certificate authority configuration..
    certificate String
    (String) The PEM-encoded contents of your certificate.

    • Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.
    commonName String
    (String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.

    • Constraints: The maximum length is 64 characters. The minimum length is 4 characters. The value must match regular expression /^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/.
    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) A CRN that uniquely identifies an IBM Cloud resource.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
    customMetadata Map<String,String>
    (Map) The secret metadata that a user can customize.
    description String
    (String) An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

    • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
    dns String
    (String) The name of the DNS provider configuration.
    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
    intermediate String
    (String) (Optional) The PEM-encoded intermediate certificate to associate with the root certificate.

    • Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.
    issuanceInfos List<GetSmPublicCertificateIssuanceInfo>
    (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
    issuer String
    (String) The distinguished name that identifies the entity that signed and issued the certificate.

    • Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
    keyAlgorithm String
    (String) The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (RSA or ECDSA) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.

    • Constraints: The default value is RSA2048. The maximum length is 7 characters. The minimum length is 5 characters. The value must match regular expression /^(RSA2048|RSA4096|EC256|EC384)$/.
    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 human-readable name of your secret.

    • Constraints: The maximum length is 256 characters. The minimum length is 2 characters.
    privateKey String
    (String) (Optional) The PEM-encoded private key to associate with the certificate.

    • Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.
    region String
    rotations List<GetSmPublicCertificateRotation>
    (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.
    serialNumber String
    (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.

    • Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[^a-fA-F0-9]/.
    signingAlgorithm String
    (String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.

    • Constraints: The maximum length is 64 characters. The minimum length is 4 characters.
    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.
    updatedAt String
    (String) The date when a resource was recently modified. The date format follows RFC 3339.
    validities List<GetSmPublicCertificateValidity>
    (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
    versionsTotal Double
    (Integer) The number of versions of the secret.

    • Constraints: The maximum value is 50. The minimum value is 0.
    endpointType String
    secretGroupName String
    altNames string[]
    (List) With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.

    • Constraints: The list items must match regular expression /^(.*?)$/. The maximum length is 99 items. The minimum length is 0 items.
    bundleCerts boolean
    (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
    ca string
    (String) The name of the certificate authority configuration..
    certificate string
    (String) The PEM-encoded contents of your certificate.

    • Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.
    commonName string
    (String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.

    • Constraints: The maximum length is 64 characters. The minimum length is 4 characters. The value must match regular expression /^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/.
    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) A CRN that uniquely identifies an IBM Cloud resource.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
    customMetadata {[key: string]: string}
    (Map) The secret metadata that a user can customize.
    description string
    (String) An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

    • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
    dns string
    (String) The name of the DNS provider configuration.
    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
    intermediate string
    (String) (Optional) The PEM-encoded intermediate certificate to associate with the root certificate.

    • Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.
    issuanceInfos GetSmPublicCertificateIssuanceInfo[]
    (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
    issuer string
    (String) The distinguished name that identifies the entity that signed and issued the certificate.

    • Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
    keyAlgorithm string
    (String) The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (RSA or ECDSA) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.

    • Constraints: The default value is RSA2048. The maximum length is 7 characters. The minimum length is 5 characters. The value must match regular expression /^(RSA2048|RSA4096|EC256|EC384)$/.
    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 human-readable name of your secret.

    • Constraints: The maximum length is 256 characters. The minimum length is 2 characters.
    privateKey string
    (String) (Optional) The PEM-encoded private key to associate with the certificate.

    • Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.
    region string
    rotations GetSmPublicCertificateRotation[]
    (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.
    serialNumber string
    (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.

    • Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[^a-fA-F0-9]/.
    signingAlgorithm string
    (String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.

    • Constraints: The maximum length is 64 characters. The minimum length is 4 characters.
    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.
    updatedAt string
    (String) The date when a resource was recently modified. The date format follows RFC 3339.
    validities GetSmPublicCertificateValidity[]
    (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
    versionsTotal number
    (Integer) The number of versions of the secret.

    • Constraints: The maximum value is 50. The minimum value is 0.
    endpointType string
    secretGroupName string
    alt_names Sequence[str]
    (List) With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.

    • Constraints: The list items must match regular expression /^(.*?)$/. The maximum length is 99 items. The minimum length is 0 items.
    bundle_certs bool
    (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
    ca str
    (String) The name of the certificate authority configuration..
    certificate str
    (String) The PEM-encoded contents of your certificate.

    • Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.
    common_name str
    (String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.

    • Constraints: The maximum length is 64 characters. The minimum length is 4 characters. The value must match regular expression /^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/.
    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) A CRN that uniquely identifies an IBM Cloud resource.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
    custom_metadata Mapping[str, str]
    (Map) The secret metadata that a user can customize.
    description str
    (String) An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

    • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
    dns str
    (String) The name of the DNS provider configuration.
    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
    intermediate str
    (String) (Optional) The PEM-encoded intermediate certificate to associate with the root certificate.

    • Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.
    issuance_infos Sequence[GetSmPublicCertificateIssuanceInfo]
    (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
    issuer str
    (String) The distinguished name that identifies the entity that signed and issued the certificate.

    • Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
    key_algorithm str
    (String) The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (RSA or ECDSA) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.

    • Constraints: The default value is RSA2048. The maximum length is 7 characters. The minimum length is 5 characters. The value must match regular expression /^(RSA2048|RSA4096|EC256|EC384)$/.
    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 human-readable name of your secret.

    • Constraints: The maximum length is 256 characters. The minimum length is 2 characters.
    private_key str
    (String) (Optional) The PEM-encoded private key to associate with the certificate.

    • Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.
    region str
    rotations Sequence[GetSmPublicCertificateRotation]
    (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.
    serial_number str
    (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.

    • Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[^a-fA-F0-9]/.
    signing_algorithm str
    (String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.

    • Constraints: The maximum length is 64 characters. The minimum length is 4 characters.
    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.
    updated_at str
    (String) The date when a resource was recently modified. The date format follows RFC 3339.
    validities Sequence[GetSmPublicCertificateValidity]
    (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
    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
    secret_group_name str
    altNames List<String>
    (List) With the Subject Alternative Name field, you can specify additional host names to be protected by a single SSL certificate.

    • Constraints: The list items must match regular expression /^(.*?)$/. The maximum length is 99 items. The minimum length is 0 items.
    bundleCerts Boolean
    (Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
    ca String
    (String) The name of the certificate authority configuration..
    certificate String
    (String) The PEM-encoded contents of your certificate.

    • Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.
    commonName String
    (String) The Common Name (AKA CN) represents the server name protected by the SSL certificate.

    • Constraints: The maximum length is 64 characters. The minimum length is 4 characters. The value must match regular expression /^(\\*\\.)?(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])\\.?$/.
    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) A CRN that uniquely identifies an IBM Cloud resource.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.
    customMetadata Map<String>
    (Map) The secret metadata that a user can customize.
    description String
    (String) An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

    • Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.
    dns String
    (String) The name of the DNS provider configuration.
    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
    intermediate String
    (String) (Optional) The PEM-encoded intermediate certificate to associate with the root certificate.

    • Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.
    issuanceInfos List<Property Map>
    (List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
    issuer String
    (String) The distinguished name that identifies the entity that signed and issued the certificate.

    • Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
    keyAlgorithm String
    (String) The identifier for the cryptographic algorithm to be used to generate the public key that is associated with the certificate.The algorithm that you select determines the encryption algorithm (RSA or ECDSA) and key size to be used to generate keys and sign certificates. For longer living certificates, it is recommended to use longer keys to provide more encryption protection. Allowed values: RSA2048, RSA4096, EC256, EC384.

    • Constraints: The default value is RSA2048. The maximum length is 7 characters. The minimum length is 5 characters. The value must match regular expression /^(RSA2048|RSA4096|EC256|EC384)$/.
    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 human-readable name of your secret.

    • Constraints: The maximum length is 256 characters. The minimum length is 2 characters.
    privateKey String
    (String) (Optional) The PEM-encoded private key to associate with the certificate.

    • Constraints: The maximum length is 100000 characters. The minimum length is 50 characters. The value must match regular expression /^(-{5}BEGIN.+?-{5}[\\s\\S]+-{5}END.+?-{5})$/.
    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.
    serialNumber String
    (String) The unique serial number that was assigned to a certificate by the issuing certificate authority.

    • Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[^a-fA-F0-9]/.
    signingAlgorithm String
    (String) The identifier for the cryptographic algorithm that was used by the issuing certificate authority to sign a certificate.

    • Constraints: The maximum length is 64 characters. The minimum length is 4 characters.
    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.
    updatedAt String
    (String) The date when a resource was recently modified. The date format follows RFC 3339.
    validities List<Property Map>
    (List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
    versionsTotal Number
    (Integer) The number of versions of the secret.

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

    Supporting Types

    GetSmPublicCertificateIssuanceInfo

    AutoRotated bool
    (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
    Challenges List<GetSmPublicCertificateIssuanceInfoChallenge>
    (List) The set of challenges. It is returned only when ordering public certificates by using manual DNS configuration.

    • Constraints: The maximum length is 100 items. The minimum length is 1 item. Nested scheme for challenges:
    DnsChallengeValidationTime string
    (String) The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS provider. The date format follows RFC 3339.
    ErrorCode string
    (String) A code that identifies an issuance error.This field, along with error_message, is returned when Secrets Manager successfully processes your request, but the certificate authority is unable to issue a certificate.
    ErrorMessage string
    (String) A human-readable message that provides details about the issuance error.
    OrderedOn string
    (String) The date when the certificate is ordered. The date format follows RFC 3339.
    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.
    AutoRotated bool
    (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
    Challenges []GetSmPublicCertificateIssuanceInfoChallenge
    (List) The set of challenges. It is returned only when ordering public certificates by using manual DNS configuration.

    • Constraints: The maximum length is 100 items. The minimum length is 1 item. Nested scheme for challenges:
    DnsChallengeValidationTime string
    (String) The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS provider. The date format follows RFC 3339.
    ErrorCode string
    (String) A code that identifies an issuance error.This field, along with error_message, is returned when Secrets Manager successfully processes your request, but the certificate authority is unable to issue a certificate.
    ErrorMessage string
    (String) A human-readable message that provides details about the issuance error.
    OrderedOn string
    (String) The date when the certificate is ordered. The date format follows RFC 3339.
    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.
    autoRotated Boolean
    (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
    challenges List<GetSmPublicCertificateIssuanceInfoChallenge>
    (List) The set of challenges. It is returned only when ordering public certificates by using manual DNS configuration.

    • Constraints: The maximum length is 100 items. The minimum length is 1 item. Nested scheme for challenges:
    dnsChallengeValidationTime String
    (String) The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS provider. The date format follows RFC 3339.
    errorCode String
    (String) A code that identifies an issuance error.This field, along with error_message, is returned when Secrets Manager successfully processes your request, but the certificate authority is unable to issue a certificate.
    errorMessage String
    (String) A human-readable message that provides details about the issuance error.
    orderedOn String
    (String) The date when the certificate is ordered. The date format follows RFC 3339.
    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.
    autoRotated boolean
    (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
    challenges GetSmPublicCertificateIssuanceInfoChallenge[]
    (List) The set of challenges. It is returned only when ordering public certificates by using manual DNS configuration.

    • Constraints: The maximum length is 100 items. The minimum length is 1 item. Nested scheme for challenges:
    dnsChallengeValidationTime string
    (String) The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS provider. The date format follows RFC 3339.
    errorCode string
    (String) A code that identifies an issuance error.This field, along with error_message, is returned when Secrets Manager successfully processes your request, but the certificate authority is unable to issue a certificate.
    errorMessage string
    (String) A human-readable message that provides details about the issuance error.
    orderedOn string
    (String) The date when the certificate is ordered. The date format follows RFC 3339.
    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.
    auto_rotated bool
    (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
    challenges Sequence[GetSmPublicCertificateIssuanceInfoChallenge]
    (List) The set of challenges. It is returned only when ordering public certificates by using manual DNS configuration.

    • Constraints: The maximum length is 100 items. The minimum length is 1 item. Nested scheme for challenges:
    dns_challenge_validation_time str
    (String) The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS provider. The date format follows RFC 3339.
    error_code str
    (String) A code that identifies an issuance error.This field, along with error_message, is returned when Secrets Manager successfully processes your request, but the certificate authority is unable to issue a certificate.
    error_message str
    (String) A human-readable message that provides details about the issuance error.
    ordered_on str
    (String) The date when the certificate is ordered. The date format follows RFC 3339.
    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.
    autoRotated Boolean
    (Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
    challenges List<Property Map>
    (List) The set of challenges. It is returned only when ordering public certificates by using manual DNS configuration.

    • Constraints: The maximum length is 100 items. The minimum length is 1 item. Nested scheme for challenges:
    dnsChallengeValidationTime String
    (String) The date that a user requests to validate DNS challenges for certificates that are ordered with a manual DNS provider. The date format follows RFC 3339.
    errorCode String
    (String) A code that identifies an issuance error.This field, along with error_message, is returned when Secrets Manager successfully processes your request, but the certificate authority is unable to issue a certificate.
    errorMessage String
    (String) A human-readable message that provides details about the issuance error.
    orderedOn String
    (String) The date when the certificate is ordered. The date format follows RFC 3339.
    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.

    GetSmPublicCertificateIssuanceInfoChallenge

    Domain string
    (String) The challenge domain.
    Expiration string
    (String) The challenge expiration date. The date format follows RFC 3339.
    Status string
    (String) The challenge status.
    TxtRecordName string
    (String) The TXT record name.
    TxtRecordValue string
    (String) The TXT record value.
    Domain string
    (String) The challenge domain.
    Expiration string
    (String) The challenge expiration date. The date format follows RFC 3339.
    Status string
    (String) The challenge status.
    TxtRecordName string
    (String) The TXT record name.
    TxtRecordValue string
    (String) The TXT record value.
    domain String
    (String) The challenge domain.
    expiration String
    (String) The challenge expiration date. The date format follows RFC 3339.
    status String
    (String) The challenge status.
    txtRecordName String
    (String) The TXT record name.
    txtRecordValue String
    (String) The TXT record value.
    domain string
    (String) The challenge domain.
    expiration string
    (String) The challenge expiration date. The date format follows RFC 3339.
    status string
    (String) The challenge status.
    txtRecordName string
    (String) The TXT record name.
    txtRecordValue string
    (String) The TXT record value.
    domain str
    (String) The challenge domain.
    expiration str
    (String) The challenge expiration date. The date format follows RFC 3339.
    status str
    (String) The challenge status.
    txt_record_name str
    (String) The TXT record name.
    txt_record_value str
    (String) The TXT record value.
    domain String
    (String) The challenge domain.
    expiration String
    (String) The challenge expiration date. The date format follows RFC 3339.
    status String
    (String) The challenge status.
    txtRecordName String
    (String) The TXT record name.
    txtRecordValue String
    (String) The TXT record value.

    GetSmPublicCertificateRotation

    AutoRotate bool
    (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is false.
    RotateKeys bool
    (Boolean) Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is false. If it is set to true, the service generates and stores a new private key for your rotated certificate.
    AutoRotate bool
    (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is false.
    RotateKeys bool
    (Boolean) Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is false. If it is set to true, the service generates and stores a new private key for your rotated certificate.
    autoRotate Boolean
    (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is false.
    rotateKeys Boolean
    (Boolean) Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is false. If it is set to true, the service generates and stores a new private key for your rotated certificate.
    autoRotate boolean
    (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is false.
    rotateKeys boolean
    (Boolean) Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is false. If it is set to true, the service generates and stores a new private key for your rotated certificate.
    auto_rotate bool
    (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is false.
    rotate_keys bool
    (Boolean) Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is false. If it is set to true, the service generates and stores a new private key for your rotated certificate.
    autoRotate Boolean
    (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is false.
    rotateKeys Boolean
    (Boolean) Determines whether Secrets Manager rotates the private key for your public certificate automatically.Default is false. If it is set to true, the service generates and stores a new private key for your rotated certificate.

    GetSmPublicCertificateValidity

    NotAfter string
    (String) The date-time format follows RFC 3339.
    NotBefore string
    (String) The date-time format follows RFC 3339.
    NotAfter string
    (String) The date-time format follows RFC 3339.
    NotBefore string
    (String) The date-time format follows RFC 3339.
    notAfter String
    (String) The date-time format follows RFC 3339.
    notBefore String
    (String) The date-time format follows RFC 3339.
    notAfter string
    (String) The date-time format follows RFC 3339.
    notBefore string
    (String) The date-time format follows RFC 3339.
    not_after str
    (String) The date-time format follows RFC 3339.
    not_before str
    (String) The date-time format follows RFC 3339.
    notAfter String
    (String) The date-time format follows RFC 3339.
    notBefore String
    (String) The date-time format follows RFC 3339.

    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