1. Packages
  2. Ibm Provider
  3. API Docs
  4. getSmSecrets
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getSmSecrets

Explore with Pulumi AI

Provides a read-only data source for sm_secrets. 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 secrets = ibm.getSmSecrets({
    instanceId: ibm_resource_instance.sm_instance.guid,
    region: "us-south",
});
Copy
import pulumi
import pulumi_ibm as ibm

secrets = ibm.get_sm_secrets(instance_id=ibm_resource_instance["sm_instance"]["guid"],
    region="us-south")
Copy
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.GetSmSecrets(ctx, &ibm.GetSmSecretsArgs{
			InstanceId: ibm_resource_instance.Sm_instance.Guid,
			Region:     pulumi.StringRef("us-south"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var secrets = Ibm.GetSmSecrets.Invoke(new()
    {
        InstanceId = ibm_resource_instance.Sm_instance.Guid,
        Region = "us-south",
    });

});
Copy
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.GetSmSecretsArgs;
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 secrets = IbmFunctions.getSmSecrets(GetSmSecretsArgs.builder()
            .instanceId(ibm_resource_instance.sm_instance().guid())
            .region("us-south")
            .build());

    }
}
Copy
variables:
  secrets:
    fn::invoke:
      function: ibm:getSmSecrets
      arguments:
        instanceId: ${ibm_resource_instance.sm_instance.guid}
        region: us-south
Copy

Using getSmSecrets

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 getSmSecrets(args: GetSmSecretsArgs, opts?: InvokeOptions): Promise<GetSmSecretsResult>
function getSmSecretsOutput(args: GetSmSecretsOutputArgs, opts?: InvokeOptions): Output<GetSmSecretsResult>
Copy
def get_sm_secrets(endpoint_type: Optional[str] = None,
                   groups: Optional[str] = None,
                   id: Optional[str] = None,
                   instance_id: Optional[str] = None,
                   match_all_labels: Optional[Sequence[str]] = None,
                   region: Optional[str] = None,
                   search: Optional[str] = None,
                   secret_types: Optional[Sequence[str]] = None,
                   sort: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetSmSecretsResult
def get_sm_secrets_output(endpoint_type: Optional[pulumi.Input[str]] = None,
                   groups: Optional[pulumi.Input[str]] = None,
                   id: Optional[pulumi.Input[str]] = None,
                   instance_id: Optional[pulumi.Input[str]] = None,
                   match_all_labels: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                   region: Optional[pulumi.Input[str]] = None,
                   search: Optional[pulumi.Input[str]] = None,
                   secret_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                   sort: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetSmSecretsResult]
Copy
func GetSmSecrets(ctx *Context, args *GetSmSecretsArgs, opts ...InvokeOption) (*GetSmSecretsResult, error)
func GetSmSecretsOutput(ctx *Context, args *GetSmSecretsOutputArgs, opts ...InvokeOption) GetSmSecretsResultOutput
Copy

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

public static class GetSmSecrets 
{
    public static Task<GetSmSecretsResult> InvokeAsync(GetSmSecretsArgs args, InvokeOptions? opts = null)
    public static Output<GetSmSecretsResult> Invoke(GetSmSecretsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSmSecretsResult> getSmSecrets(GetSmSecretsArgs args, InvokeOptions options)
public static Output<GetSmSecretsResult> getSmSecrets(GetSmSecretsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getSmSecrets:getSmSecrets
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

InstanceId This property is required. 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.
Groups string
Filter secrets by groups. You can apply multiple filters by using a comma-separated list of secret group IDs. If you need to filter secrets that are in the default secret group, use the default keyword.
Id string
(String) A UUID identifier.

  • 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}/.
MatchAllLabels List<string>
Filter secrets by a label or a combination of labels (comma-separated list).
Region string
The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
Search string
Obtain a collection of secrets that contain the specified string in one or more of the fields: id, name, description, labels, secret_type.
SecretTypes List<string>
Filter secrets by secret types. You can apply multiple filters by using a comma-separated list of secret types.
Sort string
Sort a collection of secrets by the specified field in ascending order. To sort in descending order use the - character.

  • Constraints: Allowable values are: id, created_at, updated_at, expiration_date, secret_type, name.
InstanceId This property is required. 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.
Groups string
Filter secrets by groups. You can apply multiple filters by using a comma-separated list of secret group IDs. If you need to filter secrets that are in the default secret group, use the default keyword.
Id string
(String) A UUID identifier.

  • 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}/.
MatchAllLabels []string
Filter secrets by a label or a combination of labels (comma-separated list).
Region string
The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
Search string
Obtain a collection of secrets that contain the specified string in one or more of the fields: id, name, description, labels, secret_type.
SecretTypes []string
Filter secrets by secret types. You can apply multiple filters by using a comma-separated list of secret types.
Sort string
Sort a collection of secrets by the specified field in ascending order. To sort in descending order use the - character.

  • Constraints: Allowable values are: id, created_at, updated_at, expiration_date, secret_type, name.
instanceId This property is required. 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.
groups String
Filter secrets by groups. You can apply multiple filters by using a comma-separated list of secret group IDs. If you need to filter secrets that are in the default secret group, use the default keyword.
id String
(String) A UUID identifier.

  • 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}/.
matchAllLabels List<String>
Filter secrets by a label or a combination of labels (comma-separated list).
region String
The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
search String
Obtain a collection of secrets that contain the specified string in one or more of the fields: id, name, description, labels, secret_type.
secretTypes List<String>
Filter secrets by secret types. You can apply multiple filters by using a comma-separated list of secret types.
sort String
Sort a collection of secrets by the specified field in ascending order. To sort in descending order use the - character.

  • Constraints: Allowable values are: id, created_at, updated_at, expiration_date, secret_type, name.
instanceId This property is required. 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.
groups string
Filter secrets by groups. You can apply multiple filters by using a comma-separated list of secret group IDs. If you need to filter secrets that are in the default secret group, use the default keyword.
id string
(String) A UUID identifier.

  • 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}/.
matchAllLabels string[]
Filter secrets by a label or a combination of labels (comma-separated list).
region string
The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
search string
Obtain a collection of secrets that contain the specified string in one or more of the fields: id, name, description, labels, secret_type.
secretTypes string[]
Filter secrets by secret types. You can apply multiple filters by using a comma-separated list of secret types.
sort string
Sort a collection of secrets by the specified field in ascending order. To sort in descending order use the - character.

  • Constraints: Allowable values are: id, created_at, updated_at, expiration_date, secret_type, name.
instance_id This property is required. 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.
groups str
Filter secrets by groups. You can apply multiple filters by using a comma-separated list of secret group IDs. If you need to filter secrets that are in the default secret group, use the default keyword.
id str
(String) A UUID identifier.

  • 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}/.
match_all_labels Sequence[str]
Filter secrets by a label or a combination of labels (comma-separated list).
region str
The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
search str
Obtain a collection of secrets that contain the specified string in one or more of the fields: id, name, description, labels, secret_type.
secret_types Sequence[str]
Filter secrets by secret types. You can apply multiple filters by using a comma-separated list of secret types.
sort str
Sort a collection of secrets by the specified field in ascending order. To sort in descending order use the - character.

  • Constraints: Allowable values are: id, created_at, updated_at, expiration_date, secret_type, name.
instanceId This property is required. 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.
groups String
Filter secrets by groups. You can apply multiple filters by using a comma-separated list of secret group IDs. If you need to filter secrets that are in the default secret group, use the default keyword.
id String
(String) A UUID identifier.

  • 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}/.
matchAllLabels List<String>
Filter secrets by a label or a combination of labels (comma-separated list).
region String
The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
search String
Obtain a collection of secrets that contain the specified string in one or more of the fields: id, name, description, labels, secret_type.
secretTypes List<String>
Filter secrets by secret types. You can apply multiple filters by using a comma-separated list of secret types.
sort String
Sort a collection of secrets by the specified field in ascending order. To sort in descending order use the - character.

  • Constraints: Allowable values are: id, created_at, updated_at, expiration_date, secret_type, name.

getSmSecrets Result

The following output properties are available:

Id string
(String) A UUID identifier.

  • 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
Region string
Secrets List<GetSmSecretsSecret>
(List) A collection of secret metadata. Note that the list of metadata attributes conatains attributes that are common to all types of secrets, as well as attributes that are specific to cetrain secret types. A type specific attribute is included in every secret but the value is empty for secrets of other types. The common attributes are: name, id, description, secret_type, crn, created_by, created_at, updated_at, downloaded, secret_group_id, state, state_description, versions_total.

  • Constraints: The maximum length is 1000 items. The minimum length is 0 items. Nested scheme for secrets:
TotalCount double
EndpointType string
Groups string
MatchAllLabels List<string>
Search string
SecretTypes List<string>
Sort string
Id string
(String) A UUID identifier.

  • 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
Region string
Secrets []GetSmSecretsSecret
(List) A collection of secret metadata. Note that the list of metadata attributes conatains attributes that are common to all types of secrets, as well as attributes that are specific to cetrain secret types. A type specific attribute is included in every secret but the value is empty for secrets of other types. The common attributes are: name, id, description, secret_type, crn, created_by, created_at, updated_at, downloaded, secret_group_id, state, state_description, versions_total.

  • Constraints: The maximum length is 1000 items. The minimum length is 0 items. Nested scheme for secrets:
TotalCount float64
EndpointType string
Groups string
MatchAllLabels []string
Search string
SecretTypes []string
Sort string
id String
(String) A UUID identifier.

  • 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
region String
secrets List<GetSmSecretsSecret>
(List) A collection of secret metadata. Note that the list of metadata attributes conatains attributes that are common to all types of secrets, as well as attributes that are specific to cetrain secret types. A type specific attribute is included in every secret but the value is empty for secrets of other types. The common attributes are: name, id, description, secret_type, crn, created_by, created_at, updated_at, downloaded, secret_group_id, state, state_description, versions_total.

  • Constraints: The maximum length is 1000 items. The minimum length is 0 items. Nested scheme for secrets:
totalCount Double
endpointType String
groups String
matchAllLabels List<String>
search String
secretTypes List<String>
sort String
id string
(String) A UUID identifier.

  • 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
region string
secrets GetSmSecretsSecret[]
(List) A collection of secret metadata. Note that the list of metadata attributes conatains attributes that are common to all types of secrets, as well as attributes that are specific to cetrain secret types. A type specific attribute is included in every secret but the value is empty for secrets of other types. The common attributes are: name, id, description, secret_type, crn, created_by, created_at, updated_at, downloaded, secret_group_id, state, state_description, versions_total.

  • Constraints: The maximum length is 1000 items. The minimum length is 0 items. Nested scheme for secrets:
totalCount number
endpointType string
groups string
matchAllLabels string[]
search string
secretTypes string[]
sort string
id str
(String) A UUID identifier.

  • 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
region str
secrets Sequence[GetSmSecretsSecret]
(List) A collection of secret metadata. Note that the list of metadata attributes conatains attributes that are common to all types of secrets, as well as attributes that are specific to cetrain secret types. A type specific attribute is included in every secret but the value is empty for secrets of other types. The common attributes are: name, id, description, secret_type, crn, created_by, created_at, updated_at, downloaded, secret_group_id, state, state_description, versions_total.

  • Constraints: The maximum length is 1000 items. The minimum length is 0 items. Nested scheme for secrets:
total_count float
endpoint_type str
groups str
match_all_labels Sequence[str]
search str
secret_types Sequence[str]
sort str
id String
(String) A UUID identifier.

  • 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
region String
secrets List<Property Map>
(List) A collection of secret metadata. Note that the list of metadata attributes conatains attributes that are common to all types of secrets, as well as attributes that are specific to cetrain secret types. A type specific attribute is included in every secret but the value is empty for secrets of other types. The common attributes are: name, id, description, secret_type, crn, created_by, created_at, updated_at, downloaded, secret_group_id, state, state_description, versions_total.

  • Constraints: The maximum length is 1000 items. The minimum length is 0 items. Nested scheme for secrets:
totalCount Number
endpointType String
groups String
matchAllLabels List<String>
search String
secretTypes List<String>
sort String

Supporting Types

GetSmSecretsSecret

AccessGroups This property is required. List<string>
(List) Access Groups that you can use for an iam_credentials secret.Up to 10 Access Groups can be used for each secret.

  • Constraints: The list items must match regular expression /^AccessGroupId-[a-z0-9-]+[a-z0-9]$/. The maximum length is 10 items. The minimum length is 1 item.
AltNames This property is required. 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.
ApiKeyId This property is required. string
(String) The ID of the API key that is generated for this secret.
BundleCerts This property is required. bool
(Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
Ca This property is required. string
(String) The name that is assigned to the certificate authority configuration.
CertificateAuthority This property is required. string
(String) The intermediate certificate authority that signed this certificate.
CertificateTemplate This property is required. string
(String) The name of the certificate template.

  • Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/.
CommonName This property is required. 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 This property is required. string
(String) The date when a resource was created. The date format follows RFC 3339.
CreatedBy This property is required. 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 This property is required. string
(String) The CRN role identifier for creating a service-id.
CustomMetadata This property is required. Dictionary<string, string>
(Map) The secret metadata that a user can customize.
Description This property is required. string
(String) The IAM API key description for the generated service credentials.
Dns This property is required. string
(String) The name that is assigned to the DNS provider configuration.
Downloaded This property is required. bool
(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
ExpirationDate This property is required. string
(String) The date a secret is expired. The date format follows RFC 3339.
Id This property is required. string
(String) A UUID identifier.

  • 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}/.
IntermediateIncluded This property is required. bool
(Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
IssuanceInfos This property is required. List<GetSmSecretsSecretIssuanceInfo>
(List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
Issuer This property is required. 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 This property is required. string
(String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.

  • Constraints: The maximum length is 10 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
Labels This property is required. 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 This property is required. double
(Integer) The number of locks of the secret.

  • Constraints: The maximum value is 1000. The minimum value is 0.
Name This property is required. string
(String) The resource key name of the generated service credentials.
NextRotationDate This property is required. 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.
PrivateKeyIncluded This property is required. bool
(Boolean) Indicates whether the certificate was imported with an associated private key.
ReuseApiKey This property is required. bool
RevocationTimeRfc3339 This property is required. string
(String) The date and time that the certificate was revoked. The date format follows RFC 3339.
RevocationTimeSeconds This property is required. double
(Integer) The timestamp of the certificate revocation.
Rotations This property is required. List<GetSmSecretsSecretRotation>
(List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
SecretGroupId This property is required. 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)$/.
SecretType This property is required. 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 This property is required. 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]/.
ServiceId This property is required. string
(String) The service ID under which the API key (see the api_key field) is created.If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation and adds it to the access groups that you assign.Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include the access_groups parameter.

  • Constraints: The maximum length is 50 characters. The minimum length is 40 characters. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9]*(?:-?[A-Za-z0-9]+)*$/.
ServiceIdIsStatic This property is required. bool
(Boolean) Indicates whether an iam_credentials secret was created with a static service ID.If it is set to true, the service ID for the secret was provided by the user at secret creation. If it is set to false, the service ID was generated by Secrets Manager.
SigningAlgorithm This property is required. 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.
SourceServices This property is required. List<GetSmSecretsSecretSourceService>
(List) The properties required for creating the service credentials for the specified source service instance. Nested scheme for source_service:
State This property is required. 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 This property is required. string
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
Ttl This property is required. string
(String) The time-to-live (TTL) or lease duration to assign to generated credentials.For iam_credentials secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as 120m or 24h.Minimum duration is 1 minute. Maximum is 90 days.

  • Constraints: The maximum length is 10 characters. The minimum length is 2 characters. The value must match regular expression /^[0-9]+[s,m,h,d]{0,1}$/.
UpdatedAt This property is required. string
(String) The date when a resource was recently modified. The date format follows RFC 3339.
Validities This property is required. List<GetSmSecretsSecretValidity>
(List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
VersionsTotal This property is required. double
(Integer) The number of versions of the secret.

  • Constraints: The maximum value is 50. The minimum value is 0.
AccessGroups This property is required. []string
(List) Access Groups that you can use for an iam_credentials secret.Up to 10 Access Groups can be used for each secret.

  • Constraints: The list items must match regular expression /^AccessGroupId-[a-z0-9-]+[a-z0-9]$/. The maximum length is 10 items. The minimum length is 1 item.
AltNames This property is required. []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.
ApiKeyId This property is required. string
(String) The ID of the API key that is generated for this secret.
BundleCerts This property is required. bool
(Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
Ca This property is required. string
(String) The name that is assigned to the certificate authority configuration.
CertificateAuthority This property is required. string
(String) The intermediate certificate authority that signed this certificate.
CertificateTemplate This property is required. string
(String) The name of the certificate template.

  • Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/.
CommonName This property is required. 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 This property is required. string
(String) The date when a resource was created. The date format follows RFC 3339.
CreatedBy This property is required. 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 This property is required. string
(String) The CRN role identifier for creating a service-id.
CustomMetadata This property is required. map[string]string
(Map) The secret metadata that a user can customize.
Description This property is required. string
(String) The IAM API key description for the generated service credentials.
Dns This property is required. string
(String) The name that is assigned to the DNS provider configuration.
Downloaded This property is required. bool
(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
ExpirationDate This property is required. string
(String) The date a secret is expired. The date format follows RFC 3339.
Id This property is required. string
(String) A UUID identifier.

  • 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}/.
IntermediateIncluded This property is required. bool
(Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
IssuanceInfos This property is required. []GetSmSecretsSecretIssuanceInfo
(List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
Issuer This property is required. 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 This property is required. string
(String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.

  • Constraints: The maximum length is 10 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
Labels This property is required. []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 This property is required. float64
(Integer) The number of locks of the secret.

  • Constraints: The maximum value is 1000. The minimum value is 0.
Name This property is required. string
(String) The resource key name of the generated service credentials.
NextRotationDate This property is required. 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.
PrivateKeyIncluded This property is required. bool
(Boolean) Indicates whether the certificate was imported with an associated private key.
ReuseApiKey This property is required. bool
RevocationTimeRfc3339 This property is required. string
(String) The date and time that the certificate was revoked. The date format follows RFC 3339.
RevocationTimeSeconds This property is required. float64
(Integer) The timestamp of the certificate revocation.
Rotations This property is required. []GetSmSecretsSecretRotation
(List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
SecretGroupId This property is required. 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)$/.
SecretType This property is required. 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 This property is required. 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]/.
ServiceId This property is required. string
(String) The service ID under which the API key (see the api_key field) is created.If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation and adds it to the access groups that you assign.Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include the access_groups parameter.

  • Constraints: The maximum length is 50 characters. The minimum length is 40 characters. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9]*(?:-?[A-Za-z0-9]+)*$/.
ServiceIdIsStatic This property is required. bool
(Boolean) Indicates whether an iam_credentials secret was created with a static service ID.If it is set to true, the service ID for the secret was provided by the user at secret creation. If it is set to false, the service ID was generated by Secrets Manager.
SigningAlgorithm This property is required. 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.
SourceServices This property is required. []GetSmSecretsSecretSourceService
(List) The properties required for creating the service credentials for the specified source service instance. Nested scheme for source_service:
State This property is required. 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 This property is required. string
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
Ttl This property is required. string
(String) The time-to-live (TTL) or lease duration to assign to generated credentials.For iam_credentials secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as 120m or 24h.Minimum duration is 1 minute. Maximum is 90 days.

  • Constraints: The maximum length is 10 characters. The minimum length is 2 characters. The value must match regular expression /^[0-9]+[s,m,h,d]{0,1}$/.
UpdatedAt This property is required. string
(String) The date when a resource was recently modified. The date format follows RFC 3339.
Validities This property is required. []GetSmSecretsSecretValidity
(List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
VersionsTotal This property is required. float64
(Integer) The number of versions of the secret.

  • Constraints: The maximum value is 50. The minimum value is 0.
accessGroups This property is required. List<String>
(List) Access Groups that you can use for an iam_credentials secret.Up to 10 Access Groups can be used for each secret.

  • Constraints: The list items must match regular expression /^AccessGroupId-[a-z0-9-]+[a-z0-9]$/. The maximum length is 10 items. The minimum length is 1 item.
altNames This property is required. 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.
apiKeyId This property is required. String
(String) The ID of the API key that is generated for this secret.
bundleCerts This property is required. Boolean
(Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
ca This property is required. String
(String) The name that is assigned to the certificate authority configuration.
certificateAuthority This property is required. String
(String) The intermediate certificate authority that signed this certificate.
certificateTemplate This property is required. String
(String) The name of the certificate template.

  • Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/.
commonName This property is required. 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 This property is required. String
(String) The date when a resource was created. The date format follows RFC 3339.
createdBy This property is required. 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 This property is required. String
(String) The CRN role identifier for creating a service-id.
customMetadata This property is required. Map<String,String>
(Map) The secret metadata that a user can customize.
description This property is required. String
(String) The IAM API key description for the generated service credentials.
dns This property is required. String
(String) The name that is assigned to the DNS provider configuration.
downloaded This property is required. Boolean
(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
expirationDate This property is required. String
(String) The date a secret is expired. The date format follows RFC 3339.
id This property is required. String
(String) A UUID identifier.

  • 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}/.
intermediateIncluded This property is required. Boolean
(Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
issuanceInfos This property is required. List<GetSmSecretsSecretIssuanceInfo>
(List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
issuer This property is required. 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 This property is required. String
(String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.

  • Constraints: The maximum length is 10 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
labels This property is required. 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 This property is required. Double
(Integer) The number of locks of the secret.

  • Constraints: The maximum value is 1000. The minimum value is 0.
name This property is required. String
(String) The resource key name of the generated service credentials.
nextRotationDate This property is required. 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.
privateKeyIncluded This property is required. Boolean
(Boolean) Indicates whether the certificate was imported with an associated private key.
reuseApiKey This property is required. Boolean
revocationTimeRfc3339 This property is required. String
(String) The date and time that the certificate was revoked. The date format follows RFC 3339.
revocationTimeSeconds This property is required. Double
(Integer) The timestamp of the certificate revocation.
rotations This property is required. List<GetSmSecretsSecretRotation>
(List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
secretGroupId This property is required. 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)$/.
secretType This property is required. 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 This property is required. 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]/.
serviceId This property is required. String
(String) The service ID under which the API key (see the api_key field) is created.If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation and adds it to the access groups that you assign.Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include the access_groups parameter.

  • Constraints: The maximum length is 50 characters. The minimum length is 40 characters. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9]*(?:-?[A-Za-z0-9]+)*$/.
serviceIdIsStatic This property is required. Boolean
(Boolean) Indicates whether an iam_credentials secret was created with a static service ID.If it is set to true, the service ID for the secret was provided by the user at secret creation. If it is set to false, the service ID was generated by Secrets Manager.
signingAlgorithm This property is required. 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.
sourceServices This property is required. List<GetSmSecretsSecretSourceService>
(List) The properties required for creating the service credentials for the specified source service instance. Nested scheme for source_service:
state This property is required. 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 This property is required. String
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
ttl This property is required. String
(String) The time-to-live (TTL) or lease duration to assign to generated credentials.For iam_credentials secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as 120m or 24h.Minimum duration is 1 minute. Maximum is 90 days.

  • Constraints: The maximum length is 10 characters. The minimum length is 2 characters. The value must match regular expression /^[0-9]+[s,m,h,d]{0,1}$/.
updatedAt This property is required. String
(String) The date when a resource was recently modified. The date format follows RFC 3339.
validities This property is required. List<GetSmSecretsSecretValidity>
(List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
versionsTotal This property is required. Double
(Integer) The number of versions of the secret.

  • Constraints: The maximum value is 50. The minimum value is 0.
accessGroups This property is required. string[]
(List) Access Groups that you can use for an iam_credentials secret.Up to 10 Access Groups can be used for each secret.

  • Constraints: The list items must match regular expression /^AccessGroupId-[a-z0-9-]+[a-z0-9]$/. The maximum length is 10 items. The minimum length is 1 item.
altNames This property is required. 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.
apiKeyId This property is required. string
(String) The ID of the API key that is generated for this secret.
bundleCerts This property is required. boolean
(Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
ca This property is required. string
(String) The name that is assigned to the certificate authority configuration.
certificateAuthority This property is required. string
(String) The intermediate certificate authority that signed this certificate.
certificateTemplate This property is required. string
(String) The name of the certificate template.

  • Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/.
commonName This property is required. 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 This property is required. string
(String) The date when a resource was created. The date format follows RFC 3339.
createdBy This property is required. 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 This property is required. string
(String) The CRN role identifier for creating a service-id.
customMetadata This property is required. {[key: string]: string}
(Map) The secret metadata that a user can customize.
description This property is required. string
(String) The IAM API key description for the generated service credentials.
dns This property is required. string
(String) The name that is assigned to the DNS provider configuration.
downloaded This property is required. boolean
(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
expirationDate This property is required. string
(String) The date a secret is expired. The date format follows RFC 3339.
id This property is required. string
(String) A UUID identifier.

  • 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}/.
intermediateIncluded This property is required. boolean
(Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
issuanceInfos This property is required. GetSmSecretsSecretIssuanceInfo[]
(List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
issuer This property is required. 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 This property is required. string
(String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.

  • Constraints: The maximum length is 10 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
labels This property is required. 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 This property is required. number
(Integer) The number of locks of the secret.

  • Constraints: The maximum value is 1000. The minimum value is 0.
name This property is required. string
(String) The resource key name of the generated service credentials.
nextRotationDate This property is required. 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.
privateKeyIncluded This property is required. boolean
(Boolean) Indicates whether the certificate was imported with an associated private key.
reuseApiKey This property is required. boolean
revocationTimeRfc3339 This property is required. string
(String) The date and time that the certificate was revoked. The date format follows RFC 3339.
revocationTimeSeconds This property is required. number
(Integer) The timestamp of the certificate revocation.
rotations This property is required. GetSmSecretsSecretRotation[]
(List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
secretGroupId This property is required. 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)$/.
secretType This property is required. 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 This property is required. 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]/.
serviceId This property is required. string
(String) The service ID under which the API key (see the api_key field) is created.If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation and adds it to the access groups that you assign.Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include the access_groups parameter.

  • Constraints: The maximum length is 50 characters. The minimum length is 40 characters. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9]*(?:-?[A-Za-z0-9]+)*$/.
serviceIdIsStatic This property is required. boolean
(Boolean) Indicates whether an iam_credentials secret was created with a static service ID.If it is set to true, the service ID for the secret was provided by the user at secret creation. If it is set to false, the service ID was generated by Secrets Manager.
signingAlgorithm This property is required. 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.
sourceServices This property is required. GetSmSecretsSecretSourceService[]
(List) The properties required for creating the service credentials for the specified source service instance. Nested scheme for source_service:
state This property is required. 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 This property is required. string
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
ttl This property is required. string
(String) The time-to-live (TTL) or lease duration to assign to generated credentials.For iam_credentials secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as 120m or 24h.Minimum duration is 1 minute. Maximum is 90 days.

  • Constraints: The maximum length is 10 characters. The minimum length is 2 characters. The value must match regular expression /^[0-9]+[s,m,h,d]{0,1}$/.
updatedAt This property is required. string
(String) The date when a resource was recently modified. The date format follows RFC 3339.
validities This property is required. GetSmSecretsSecretValidity[]
(List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
versionsTotal This property is required. number
(Integer) The number of versions of the secret.

  • Constraints: The maximum value is 50. The minimum value is 0.
access_groups This property is required. Sequence[str]
(List) Access Groups that you can use for an iam_credentials secret.Up to 10 Access Groups can be used for each secret.

  • Constraints: The list items must match regular expression /^AccessGroupId-[a-z0-9-]+[a-z0-9]$/. The maximum length is 10 items. The minimum length is 1 item.
alt_names This property is required. 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.
api_key_id This property is required. str
(String) The ID of the API key that is generated for this secret.
bundle_certs This property is required. bool
(Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
ca This property is required. str
(String) The name that is assigned to the certificate authority configuration.
certificate_authority This property is required. str
(String) The intermediate certificate authority that signed this certificate.
certificate_template This property is required. str
(String) The name of the certificate template.

  • Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/.
common_name This property is required. 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 This property is required. str
(String) The date when a resource was created. The date format follows RFC 3339.
created_by This property is required. 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 This property is required. str
(String) The CRN role identifier for creating a service-id.
custom_metadata This property is required. Mapping[str, str]
(Map) The secret metadata that a user can customize.
description This property is required. str
(String) The IAM API key description for the generated service credentials.
dns This property is required. str
(String) The name that is assigned to the DNS provider configuration.
downloaded This property is required. 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 This property is required. str
(String) The date a secret is expired. The date format follows RFC 3339.
id This property is required. str
(String) A UUID identifier.

  • 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}/.
intermediate_included This property is required. bool
(Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
issuance_infos This property is required. Sequence[GetSmSecretsSecretIssuanceInfo]
(List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
issuer This property is required. 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 This property is required. str
(String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.

  • Constraints: The maximum length is 10 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
labels This property is required. 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 This property is required. float
(Integer) The number of locks of the secret.

  • Constraints: The maximum value is 1000. The minimum value is 0.
name This property is required. str
(String) The resource key name of the generated service credentials.
next_rotation_date This property is required. 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.
private_key_included This property is required. bool
(Boolean) Indicates whether the certificate was imported with an associated private key.
reuse_api_key This property is required. bool
revocation_time_rfc3339 This property is required. str
(String) The date and time that the certificate was revoked. The date format follows RFC 3339.
revocation_time_seconds This property is required. float
(Integer) The timestamp of the certificate revocation.
rotations This property is required. Sequence[GetSmSecretsSecretRotation]
(List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
secret_group_id This property is required. 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_type This property is required. 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 This property is required. 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]/.
service_id This property is required. str
(String) The service ID under which the API key (see the api_key field) is created.If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation and adds it to the access groups that you assign.Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include the access_groups parameter.

  • Constraints: The maximum length is 50 characters. The minimum length is 40 characters. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9]*(?:-?[A-Za-z0-9]+)*$/.
service_id_is_static This property is required. bool
(Boolean) Indicates whether an iam_credentials secret was created with a static service ID.If it is set to true, the service ID for the secret was provided by the user at secret creation. If it is set to false, the service ID was generated by Secrets Manager.
signing_algorithm This property is required. 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.
source_services This property is required. Sequence[GetSmSecretsSecretSourceService]
(List) The properties required for creating the service credentials for the specified source service instance. Nested scheme for source_service:
state This property is required. 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 This property is required. str
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
ttl This property is required. str
(String) The time-to-live (TTL) or lease duration to assign to generated credentials.For iam_credentials secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as 120m or 24h.Minimum duration is 1 minute. Maximum is 90 days.

  • Constraints: The maximum length is 10 characters. The minimum length is 2 characters. The value must match regular expression /^[0-9]+[s,m,h,d]{0,1}$/.
updated_at This property is required. str
(String) The date when a resource was recently modified. The date format follows RFC 3339.
validities This property is required. Sequence[GetSmSecretsSecretValidity]
(List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
versions_total This property is required. float
(Integer) The number of versions of the secret.

  • Constraints: The maximum value is 50. The minimum value is 0.
accessGroups This property is required. List<String>
(List) Access Groups that you can use for an iam_credentials secret.Up to 10 Access Groups can be used for each secret.

  • Constraints: The list items must match regular expression /^AccessGroupId-[a-z0-9-]+[a-z0-9]$/. The maximum length is 10 items. The minimum length is 1 item.
altNames This property is required. 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.
apiKeyId This property is required. String
(String) The ID of the API key that is generated for this secret.
bundleCerts This property is required. Boolean
(Boolean) Indicates whether the issued certificate is bundled with intermediate certificates.
ca This property is required. String
(String) The name that is assigned to the certificate authority configuration.
certificateAuthority This property is required. String
(String) The intermediate certificate authority that signed this certificate.
certificateTemplate This property is required. String
(String) The name of the certificate template.

  • Constraints: The maximum length is 128 characters. The minimum length is 2 characters. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9]*(?:_?-?\\.?[A-Za-z0-9]+)*$/.
commonName This property is required. 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 This property is required. String
(String) The date when a resource was created. The date format follows RFC 3339.
createdBy This property is required. 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 This property is required. String
(String) The CRN role identifier for creating a service-id.
customMetadata This property is required. Map<String>
(Map) The secret metadata that a user can customize.
description This property is required. String
(String) The IAM API key description for the generated service credentials.
dns This property is required. String
(String) The name that is assigned to the DNS provider configuration.
downloaded This property is required. Boolean
(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
expirationDate This property is required. String
(String) The date a secret is expired. The date format follows RFC 3339.
id This property is required. String
(String) A UUID identifier.

  • 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}/.
intermediateIncluded This property is required. Boolean
(Boolean) Indicates whether the certificate was imported with an associated intermediate certificate.
issuanceInfos This property is required. List<Property Map>
(List) Issuance information that is associated with your certificate. Nested scheme for issuance_info:
issuer This property is required. 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 This property is required. String
(String) The identifier for the cryptographic algorithm used to generate the public key that is associated with the certificate.

  • Constraints: The maximum length is 10 characters. The minimum length is 2 characters. The value must match regular expression /(.*?)/.
labels This property is required. 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 This property is required. Number
(Integer) The number of locks of the secret.

  • Constraints: The maximum value is 1000. The minimum value is 0.
name This property is required. String
(String) The resource key name of the generated service credentials.
nextRotationDate This property is required. 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.
privateKeyIncluded This property is required. Boolean
(Boolean) Indicates whether the certificate was imported with an associated private key.
reuseApiKey This property is required. Boolean
revocationTimeRfc3339 This property is required. String
(String) The date and time that the certificate was revoked. The date format follows RFC 3339.
revocationTimeSeconds This property is required. Number
(Integer) The timestamp of the certificate revocation.
rotations This property is required. List<Property Map>
(List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
secretGroupId This property is required. 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)$/.
secretType This property is required. 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 This property is required. 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]/.
serviceId This property is required. String
(String) The service ID under which the API key (see the api_key field) is created.If you omit this parameter, Secrets Manager generates a new service ID for your secret at its creation and adds it to the access groups that you assign.Optionally, you can use this field to provide your own service ID if you prefer to manage its access directly or retain the service ID after your secret expires, is rotated, or deleted. If you provide a service ID, do not include the access_groups parameter.

  • Constraints: The maximum length is 50 characters. The minimum length is 40 characters. The value must match regular expression /^[A-Za-z0-9][A-Za-z0-9]*(?:-?[A-Za-z0-9]+)*$/.
serviceIdIsStatic This property is required. Boolean
(Boolean) Indicates whether an iam_credentials secret was created with a static service ID.If it is set to true, the service ID for the secret was provided by the user at secret creation. If it is set to false, the service ID was generated by Secrets Manager.
signingAlgorithm This property is required. 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.
sourceServices This property is required. List<Property Map>
(List) The properties required for creating the service credentials for the specified source service instance. Nested scheme for source_service:
state This property is required. 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 This property is required. String
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
ttl This property is required. String
(String) The time-to-live (TTL) or lease duration to assign to generated credentials.For iam_credentials secrets, the TTL defines for how long each generated API key remains valid. The value can be either an integer that specifies the number of seconds, or the string representation of a duration, such as 120m or 24h.Minimum duration is 1 minute. Maximum is 90 days.

  • Constraints: The maximum length is 10 characters. The minimum length is 2 characters. The value must match regular expression /^[0-9]+[s,m,h,d]{0,1}$/.
updatedAt This property is required. String
(String) The date when a resource was recently modified. The date format follows RFC 3339.
validities This property is required. List<Property Map>
(List) The date and time that the certificate validity period begins and ends. Nested scheme for validity:
versionsTotal This property is required. Number
(Integer) The number of versions of the secret.

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

GetSmSecretsSecretIssuanceInfo

AutoRotated This property is required. bool
(Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
Challenges This property is required. List<GetSmSecretsSecretIssuanceInfoChallenge>
(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 This property is required. 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 This property is required. 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 This property is required. string
(String) A human-readable message that provides details about the issuance error.
OrderedOn This property is required. string
(String) The date when the certificate is ordered. The date format follows RFC 3339.
State This property is required. 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 This property is required. string
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
AutoRotated This property is required. bool
(Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
Challenges This property is required. []GetSmSecretsSecretIssuanceInfoChallenge
(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 This property is required. 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 This property is required. 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 This property is required. string
(String) A human-readable message that provides details about the issuance error.
OrderedOn This property is required. string
(String) The date when the certificate is ordered. The date format follows RFC 3339.
State This property is required. 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 This property is required. string
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
autoRotated This property is required. Boolean
(Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
challenges This property is required. List<GetSmSecretsSecretIssuanceInfoChallenge>
(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 This property is required. 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 This property is required. 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 This property is required. String
(String) A human-readable message that provides details about the issuance error.
orderedOn This property is required. String
(String) The date when the certificate is ordered. The date format follows RFC 3339.
state This property is required. 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 This property is required. String
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
autoRotated This property is required. boolean
(Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
challenges This property is required. GetSmSecretsSecretIssuanceInfoChallenge[]
(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 This property is required. 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 This property is required. 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 This property is required. string
(String) A human-readable message that provides details about the issuance error.
orderedOn This property is required. string
(String) The date when the certificate is ordered. The date format follows RFC 3339.
state This property is required. 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 This property is required. string
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
auto_rotated This property is required. bool
(Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
challenges This property is required. Sequence[GetSmSecretsSecretIssuanceInfoChallenge]
(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 This property is required. 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 This property is required. 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 This property is required. str
(String) A human-readable message that provides details about the issuance error.
ordered_on This property is required. str
(String) The date when the certificate is ordered. The date format follows RFC 3339.
state This property is required. 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 This property is required. str
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.
autoRotated This property is required. Boolean
(Boolean) Indicates whether the issued certificate is configured with an automatic rotation policy.
challenges This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
(String) A human-readable message that provides details about the issuance error.
orderedOn This property is required. String
(String) The date when the certificate is ordered. The date format follows RFC 3339.
state This property is required. 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 This property is required. String
(String) A text representation of the secret state.

  • Constraints: Allowable values are: pre_activation, active, suspended, deactivated, destroyed.

GetSmSecretsSecretIssuanceInfoChallenge

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

GetSmSecretsSecretRotation

AutoRotate This property is required. 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 This property is required. double
(Integer) The length of the secret rotation time interval.

  • Constraints: The minimum value is 1.
RotateKeys This property is required. 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.
Unit This property is required. string
(String) The units for the secret rotation time interval.

  • Constraints: Allowable values are: day, month.
AutoRotate This property is required. 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 This property is required. float64
(Integer) The length of the secret rotation time interval.

  • Constraints: The minimum value is 1.
RotateKeys This property is required. 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.
Unit This property is required. string
(String) The units for the secret rotation time interval.

  • Constraints: Allowable values are: day, month.
autoRotate This property is required. 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 This property is required. Double
(Integer) The length of the secret rotation time interval.

  • Constraints: The minimum value is 1.
rotateKeys This property is required. 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.
unit This property is required. String
(String) The units for the secret rotation time interval.

  • Constraints: Allowable values are: day, month.
autoRotate This property is required. 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 This property is required. number
(Integer) The length of the secret rotation time interval.

  • Constraints: The minimum value is 1.
rotateKeys This property is required. 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.
unit This property is required. string
(String) The units for the secret rotation time interval.

  • Constraints: Allowable values are: day, month.
auto_rotate This property is required. 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 This property is required. float
(Integer) The length of the secret rotation time interval.

  • Constraints: The minimum value is 1.
rotate_keys This property is required. 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.
unit This property is required. str
(String) The units for the secret rotation time interval.

  • Constraints: Allowable values are: day, month.
autoRotate This property is required. 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 This property is required. Number
(Integer) The length of the secret rotation time interval.

  • Constraints: The minimum value is 1.
rotateKeys This property is required. 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.
unit This property is required. String
(String) The units for the secret rotation time interval.

  • Constraints: Allowable values are: day, month.

GetSmSecretsSecretSourceService

Iams This property is required. List<GetSmSecretsSecretSourceServiceIam>
(List) The source service IAM data is returned in case IAM credentials where created for this secret. Nested scheme for iam:
Instances This property is required. List<GetSmSecretsSecretSourceServiceInstance>
(List) The source service instance identifier. Nested scheme for instance:
Parameters This property is required. Dictionary<string, string>
(Map) The collection of parameters for the service credentials target.
ResourceKeys This property is required. List<GetSmSecretsSecretSourceServiceResourceKey>
(List) The source service resource key data of the generated service credentials. Nested scheme for resource_key:
Roles This property is required. List<GetSmSecretsSecretSourceServiceRole>
(List) The service-specific custom role object. Nested scheme for role:
Iams This property is required. []GetSmSecretsSecretSourceServiceIam
(List) The source service IAM data is returned in case IAM credentials where created for this secret. Nested scheme for iam:
Instances This property is required. []GetSmSecretsSecretSourceServiceInstance
(List) The source service instance identifier. Nested scheme for instance:
Parameters This property is required. map[string]string
(Map) The collection of parameters for the service credentials target.
ResourceKeys This property is required. []GetSmSecretsSecretSourceServiceResourceKey
(List) The source service resource key data of the generated service credentials. Nested scheme for resource_key:
Roles This property is required. []GetSmSecretsSecretSourceServiceRole
(List) The service-specific custom role object. Nested scheme for role:
iams This property is required. List<GetSmSecretsSecretSourceServiceIam>
(List) The source service IAM data is returned in case IAM credentials where created for this secret. Nested scheme for iam:
instances This property is required. List<GetSmSecretsSecretSourceServiceInstance>
(List) The source service instance identifier. Nested scheme for instance:
parameters This property is required. Map<String,String>
(Map) The collection of parameters for the service credentials target.
resourceKeys This property is required. List<GetSmSecretsSecretSourceServiceResourceKey>
(List) The source service resource key data of the generated service credentials. Nested scheme for resource_key:
roles This property is required. List<GetSmSecretsSecretSourceServiceRole>
(List) The service-specific custom role object. Nested scheme for role:
iams This property is required. GetSmSecretsSecretSourceServiceIam[]
(List) The source service IAM data is returned in case IAM credentials where created for this secret. Nested scheme for iam:
instances This property is required. GetSmSecretsSecretSourceServiceInstance[]
(List) The source service instance identifier. Nested scheme for instance:
parameters This property is required. {[key: string]: string}
(Map) The collection of parameters for the service credentials target.
resourceKeys This property is required. GetSmSecretsSecretSourceServiceResourceKey[]
(List) The source service resource key data of the generated service credentials. Nested scheme for resource_key:
roles This property is required. GetSmSecretsSecretSourceServiceRole[]
(List) The service-specific custom role object. Nested scheme for role:
iams This property is required. Sequence[GetSmSecretsSecretSourceServiceIam]
(List) The source service IAM data is returned in case IAM credentials where created for this secret. Nested scheme for iam:
instances This property is required. Sequence[GetSmSecretsSecretSourceServiceInstance]
(List) The source service instance identifier. Nested scheme for instance:
parameters This property is required. Mapping[str, str]
(Map) The collection of parameters for the service credentials target.
resource_keys This property is required. Sequence[GetSmSecretsSecretSourceServiceResourceKey]
(List) The source service resource key data of the generated service credentials. Nested scheme for resource_key:
roles This property is required. Sequence[GetSmSecretsSecretSourceServiceRole]
(List) The service-specific custom role object. Nested scheme for role:
iams This property is required. 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 This property is required. List<Property Map>
(List) The source service instance identifier. Nested scheme for instance:
parameters This property is required. Map<String>
(Map) The collection of parameters for the service credentials target.
resourceKeys This property is required. List<Property Map>
(List) The source service resource key data of the generated service credentials. Nested scheme for resource_key:
roles This property is required. List<Property Map>
(List) The service-specific custom role object. Nested scheme for role:

GetSmSecretsSecretSourceServiceIam

Apikeys This property is required. List<GetSmSecretsSecretSourceServiceIamApikey>
(String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
Roles This property is required. List<GetSmSecretsSecretSourceServiceIamRole>
(List) The service-specific custom role object. Nested scheme for role:
Serviceids This property is required. List<GetSmSecretsSecretSourceServiceIamServiceid>
(String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
Apikeys This property is required. []GetSmSecretsSecretSourceServiceIamApikey
(String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
Roles This property is required. []GetSmSecretsSecretSourceServiceIamRole
(List) The service-specific custom role object. Nested scheme for role:
Serviceids This property is required. []GetSmSecretsSecretSourceServiceIamServiceid
(String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
apikeys This property is required. List<GetSmSecretsSecretSourceServiceIamApikey>
(String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
roles This property is required. List<GetSmSecretsSecretSourceServiceIamRole>
(List) The service-specific custom role object. Nested scheme for role:
serviceids This property is required. List<GetSmSecretsSecretSourceServiceIamServiceid>
(String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
apikeys This property is required. GetSmSecretsSecretSourceServiceIamApikey[]
(String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
roles This property is required. GetSmSecretsSecretSourceServiceIamRole[]
(List) The service-specific custom role object. Nested scheme for role:
serviceids This property is required. GetSmSecretsSecretSourceServiceIamServiceid[]
(String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
apikeys This property is required. Sequence[GetSmSecretsSecretSourceServiceIamApikey]
(String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
roles This property is required. Sequence[GetSmSecretsSecretSourceServiceIamRole]
(List) The service-specific custom role object. Nested scheme for role:
serviceids This property is required. Sequence[GetSmSecretsSecretSourceServiceIamServiceid]
(String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:
apikeys This property is required. List<Property Map>
(String) The IAM apikey metadata for the IAM credentials that were generated. Nested scheme for apikey:
roles This property is required. List<Property Map>
(List) The service-specific custom role object. Nested scheme for role:
serviceids This property is required. List<Property Map>
(String) The IAM serviceid for the generated service credentials. Nested scheme for serviceid:

GetSmSecretsSecretSourceServiceIamApikey

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

GetSmSecretsSecretSourceServiceIamRole

Crn This property is required. string
(String) The CRN role identifier for creating a service-id.
Crn This property is required. string
(String) The CRN role identifier for creating a service-id.
crn This property is required. String
(String) The CRN role identifier for creating a service-id.
crn This property is required. string
(String) The CRN role identifier for creating a service-id.
crn This property is required. str
(String) The CRN role identifier for creating a service-id.
crn This property is required. String
(String) The CRN role identifier for creating a service-id.

GetSmSecretsSecretSourceServiceIamServiceid

Crn This property is required. string
(String) The CRN role identifier for creating a service-id.
Crn This property is required. string
(String) The CRN role identifier for creating a service-id.
crn This property is required. String
(String) The CRN role identifier for creating a service-id.
crn This property is required. string
(String) The CRN role identifier for creating a service-id.
crn This property is required. str
(String) The CRN role identifier for creating a service-id.
crn This property is required. String
(String) The CRN role identifier for creating a service-id.

GetSmSecretsSecretSourceServiceInstance

Crn This property is required. string
(String) The CRN role identifier for creating a service-id.
Crn This property is required. string
(String) The CRN role identifier for creating a service-id.
crn This property is required. String
(String) The CRN role identifier for creating a service-id.
crn This property is required. string
(String) The CRN role identifier for creating a service-id.
crn This property is required. str
(String) The CRN role identifier for creating a service-id.
crn This property is required. String
(String) The CRN role identifier for creating a service-id.

GetSmSecretsSecretSourceServiceResourceKey

Crn This property is required. string
(String) The CRN role identifier for creating a service-id.
Name This property is required. string
(String) The resource key name of the generated service credentials.
Crn This property is required. string
(String) The CRN role identifier for creating a service-id.
Name This property is required. string
(String) The resource key name of the generated service credentials.
crn This property is required. String
(String) The CRN role identifier for creating a service-id.
name This property is required. String
(String) The resource key name of the generated service credentials.
crn This property is required. string
(String) The CRN role identifier for creating a service-id.
name This property is required. string
(String) The resource key name of the generated service credentials.
crn This property is required. str
(String) The CRN role identifier for creating a service-id.
name This property is required. str
(String) The resource key name of the generated service credentials.
crn This property is required. String
(String) The CRN role identifier for creating a service-id.
name This property is required. String
(String) The resource key name of the generated service credentials.

GetSmSecretsSecretSourceServiceRole

Crn This property is required. string
(String) The CRN role identifier for creating a service-id.
Crn This property is required. string
(String) The CRN role identifier for creating a service-id.
crn This property is required. String
(String) The CRN role identifier for creating a service-id.
crn This property is required. string
(String) The CRN role identifier for creating a service-id.
crn This property is required. str
(String) The CRN role identifier for creating a service-id.
crn This property is required. String
(String) The CRN role identifier for creating a service-id.

GetSmSecretsSecretValidity

NotAfter This property is required. string
(String) The date-time format follows RFC 3339.
NotBefore This property is required. string
(String) The date-time format follows RFC 3339.
NotAfter This property is required. string
(String) The date-time format follows RFC 3339.
NotBefore This property is required. string
(String) The date-time format follows RFC 3339.
notAfter This property is required. String
(String) The date-time format follows RFC 3339.
notBefore This property is required. String
(String) The date-time format follows RFC 3339.
notAfter This property is required. string
(String) The date-time format follows RFC 3339.
notBefore This property is required. string
(String) The date-time format follows RFC 3339.
not_after This property is required. str
(String) The date-time format follows RFC 3339.
not_before This property is required. str
(String) The date-time format follows RFC 3339.
notAfter This property is required. String
(String) The date-time format follows RFC 3339.
notBefore This property is required. 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.