ibm 1.79.2 published on Friday, Jun 13, 2025 by ibm-cloud
ibm.getSmCustomCredentialsSecretMetadata
Explore with Pulumi AI
Provides a read-only data source for the metadata of a custom credentials secret. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const mySecretMetadata = ibm.getSmCustomCredentialsSecretMetadata({
instanceId: ibm_resource_instance.sm_instance.guid,
region: "us-south",
secretId: "0b5571f7-21e6-42b7-91c5-3f5ac9793a46",
});
import pulumi
import pulumi_ibm as ibm
my_secret_metadata = ibm.get_sm_custom_credentials_secret_metadata(instance_id=ibm_resource_instance["sm_instance"]["guid"],
region="us-south",
secret_id="0b5571f7-21e6-42b7-91c5-3f5ac9793a46")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ibm.GetSmCustomCredentialsSecretMetadata(ctx, &ibm.GetSmCustomCredentialsSecretMetadataArgs{
InstanceId: ibm_resource_instance.Sm_instance.Guid,
Region: pulumi.StringRef("us-south"),
SecretId: pulumi.StringRef("0b5571f7-21e6-42b7-91c5-3f5ac9793a46"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;
return await Deployment.RunAsync(() =>
{
var mySecretMetadata = Ibm.GetSmCustomCredentialsSecretMetadata.Invoke(new()
{
InstanceId = ibm_resource_instance.Sm_instance.Guid,
Region = "us-south",
SecretId = "0b5571f7-21e6-42b7-91c5-3f5ac9793a46",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetSmCustomCredentialsSecretMetadataArgs;
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 mySecretMetadata = IbmFunctions.getSmCustomCredentialsSecretMetadata(GetSmCustomCredentialsSecretMetadataArgs.builder()
.instanceId(ibm_resource_instance.sm_instance().guid())
.region("us-south")
.secretId("0b5571f7-21e6-42b7-91c5-3f5ac9793a46")
.build());
}
}
variables:
mySecretMetadata:
fn::invoke:
function: ibm:getSmCustomCredentialsSecretMetadata
arguments:
instanceId: ${ibm_resource_instance.sm_instance.guid}
region: us-south
secretId: 0b5571f7-21e6-42b7-91c5-3f5ac9793a46
Using getSmCustomCredentialsSecretMetadata
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 getSmCustomCredentialsSecretMetadata(args: GetSmCustomCredentialsSecretMetadataArgs, opts?: InvokeOptions): Promise<GetSmCustomCredentialsSecretMetadataResult>
function getSmCustomCredentialsSecretMetadataOutput(args: GetSmCustomCredentialsSecretMetadataOutputArgs, opts?: InvokeOptions): Output<GetSmCustomCredentialsSecretMetadataResult>
def get_sm_custom_credentials_secret_metadata(endpoint_type: Optional[str] = None,
id: Optional[str] = None,
instance_id: Optional[str] = None,
name: Optional[str] = None,
region: Optional[str] = None,
secret_group_name: Optional[str] = None,
secret_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetSmCustomCredentialsSecretMetadataResult
def get_sm_custom_credentials_secret_metadata_output(endpoint_type: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
instance_id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
region: Optional[pulumi.Input[str]] = None,
secret_group_name: Optional[pulumi.Input[str]] = None,
secret_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetSmCustomCredentialsSecretMetadataResult]
func GetSmCustomCredentialsSecretMetadata(ctx *Context, args *GetSmCustomCredentialsSecretMetadataArgs, opts ...InvokeOption) (*GetSmCustomCredentialsSecretMetadataResult, error)
func GetSmCustomCredentialsSecretMetadataOutput(ctx *Context, args *GetSmCustomCredentialsSecretMetadataOutputArgs, opts ...InvokeOption) GetSmCustomCredentialsSecretMetadataResultOutput
> Note: This function is named GetSmCustomCredentialsSecretMetadata
in the Go SDK.
public static class GetSmCustomCredentialsSecretMetadata
{
public static Task<GetSmCustomCredentialsSecretMetadataResult> InvokeAsync(GetSmCustomCredentialsSecretMetadataArgs args, InvokeOptions? opts = null)
public static Output<GetSmCustomCredentialsSecretMetadataResult> Invoke(GetSmCustomCredentialsSecretMetadataInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetSmCustomCredentialsSecretMetadataResult> getSmCustomCredentialsSecretMetadata(GetSmCustomCredentialsSecretMetadataArgs args, InvokeOptions options)
public static Output<GetSmCustomCredentialsSecretMetadataResult> getSmCustomCredentialsSecretMetadata(GetSmCustomCredentialsSecretMetadataArgs args, InvokeOptions options)
fn::invoke:
function: ibm:index/getSmCustomCredentialsSecretMetadata:getSmCustomCredentialsSecretMetadata
arguments:
# arguments dictionary
The following arguments are supported:
- Instance
Id string - The GUID of the Secrets Manager instance.
- Endpoint
Type string - The endpoint type. If not provided the endpoint type is determined by the
visibility
argument provided in the provider configuration.- Constraints: Allowable values are:
private
,public
.
- Constraints: Allowable values are:
- Id string
- Name string
- (String) The human-readable name of your secret.
- Region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- Secret
Group stringName - Secret
Id string - The ID of the secret.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}/
.
- Constraints: The maximum length is
- Instance
Id string - The GUID of the Secrets Manager instance.
- Endpoint
Type string - The endpoint type. If not provided the endpoint type is determined by the
visibility
argument provided in the provider configuration.- Constraints: Allowable values are:
private
,public
.
- Constraints: Allowable values are:
- Id string
- Name string
- (String) The human-readable name of your secret.
- Region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- Secret
Group stringName - Secret
Id string - The ID of the secret.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}/
.
- Constraints: The maximum length is
- instance
Id String - The GUID of the Secrets Manager instance.
- endpoint
Type String - The endpoint type. If not provided the endpoint type is determined by the
visibility
argument provided in the provider configuration.- Constraints: Allowable values are:
private
,public
.
- Constraints: Allowable values are:
- id String
- name String
- (String) The human-readable name of your secret.
- region String
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- secret
Group StringName - secret
Id String - The ID of the secret.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}/
.
- Constraints: The maximum length is
- instance
Id string - The GUID of the Secrets Manager instance.
- endpoint
Type string - The endpoint type. If not provided the endpoint type is determined by the
visibility
argument provided in the provider configuration.- Constraints: Allowable values are:
private
,public
.
- Constraints: Allowable values are:
- id string
- name string
- (String) The human-readable name of your secret.
- region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- secret
Group stringName - secret
Id string - The ID of the secret.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}/
.
- Constraints: The maximum length is
- instance_
id str - The GUID of the Secrets Manager instance.
- endpoint_
type str - The endpoint type. If not provided the endpoint type is determined by the
visibility
argument provided in the provider configuration.- Constraints: Allowable values are:
private
,public
.
- Constraints: Allowable values are:
- id str
- name str
- (String) The human-readable name of your secret.
- region str
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- secret_
group_ strname - secret_
id str - The ID of the secret.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}/
.
- Constraints: The maximum length is
- instance
Id String - The GUID of the Secrets Manager instance.
- endpoint
Type String - The endpoint type. If not provided the endpoint type is determined by the
visibility
argument provided in the provider configuration.- Constraints: Allowable values are:
private
,public
.
- Constraints: Allowable values are:
- id String
- name String
- (String) The human-readable name of your secret.
- region String
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- secret
Group StringName - secret
Id String - The ID of the secret.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}/
.
- Constraints: The maximum length is
getSmCustomCredentialsSecretMetadata Result
The following output properties are available:
- Configuration string
- (String) The name of the Custom Credentials configuration.
- Created
At string - (String) The date when the secret was created. The date format follows RFC 3339.
- Created
By string - (String) The unique identifier that is associated with the entity that created the secret.
- Crn string
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Custom
Metadata Dictionary<string, string> - (Map) The secret metadata that a user can customize.
- Description string
- (String) An extended description of your secret.
- Downloaded bool
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- Expiration
Date string - (String) The date a secret is expired. The date format follows RFC 3339.
- Id string
- Instance
Id string - Labels List<string>
- (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Locks
Total double - (Integer) The number of locks of the secret.
- Name string
- (String) The human-readable name of your secret.
- Next
Rotation stringDate - (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.
- Parameters
List<Get
Sm Custom Credentials Secret Metadata Parameter> - (List) The parameters that were passed to the Code Engine job. Nested scheme for parameters:
- Region string
- Rotations
List<Get
Sm Custom Credentials Secret Metadata Rotation> - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- Secret
Group stringId - (String) A UUID identifier, or
default
secret group. - Secret
Id string - Secret
Type string - (String) The secret type.
- State double
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- State
Description string - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- Ttl string
- (String) The time-to-live or lease duration (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).
- Updated
At string - (String) The date when the secret was recently modified. The date format follows RFC 3339.
- Versions
Total double - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- Endpoint
Type string - Secret
Group stringName
- Configuration string
- (String) The name of the Custom Credentials configuration.
- Created
At string - (String) The date when the secret was created. The date format follows RFC 3339.
- Created
By string - (String) The unique identifier that is associated with the entity that created the secret.
- Crn string
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Custom
Metadata map[string]string - (Map) The secret metadata that a user can customize.
- Description string
- (String) An extended description of your secret.
- Downloaded bool
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- Expiration
Date string - (String) The date a secret is expired. The date format follows RFC 3339.
- Id string
- Instance
Id string - Labels []string
- (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Locks
Total float64 - (Integer) The number of locks of the secret.
- Name string
- (String) The human-readable name of your secret.
- Next
Rotation stringDate - (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.
- Parameters
[]Get
Sm Custom Credentials Secret Metadata Parameter - (List) The parameters that were passed to the Code Engine job. Nested scheme for parameters:
- Region string
- Rotations
[]Get
Sm Custom Credentials Secret Metadata Rotation - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- Secret
Group stringId - (String) A UUID identifier, or
default
secret group. - Secret
Id string - Secret
Type string - (String) The secret type.
- State float64
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- State
Description string - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- Ttl string
- (String) The time-to-live or lease duration (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).
- Updated
At string - (String) The date when the secret was recently modified. The date format follows RFC 3339.
- Versions
Total float64 - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- Endpoint
Type string - Secret
Group stringName
- configuration String
- (String) The name of the Custom Credentials configuration.
- created
At String - (String) The date when the secret was created. The date format follows RFC 3339.
- created
By String - (String) The unique identifier that is associated with the entity that created the secret.
- crn String
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- custom
Metadata Map<String,String> - (Map) The secret metadata that a user can customize.
- description String
- (String) An extended description of your secret.
- downloaded Boolean
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- expiration
Date String - (String) The date a secret is expired. The date format follows RFC 3339.
- id String
- instance
Id String - labels List<String>
- (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- locks
Total Double - (Integer) The number of locks of the secret.
- name String
- (String) The human-readable name of your secret.
- next
Rotation StringDate - (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.
- parameters
List<Get
Sm Custom Credentials Secret Metadata Parameter> - (List) The parameters that were passed to the Code Engine job. Nested scheme for parameters:
- region String
- rotations
List<Get
Sm Custom Credentials Secret Metadata Rotation> - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- secret
Group StringId - (String) A UUID identifier, or
default
secret group. - secret
Id String - secret
Type String - (String) The secret type.
- state Double
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state
Description String - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- ttl String
- (String) The time-to-live or lease duration (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).
- updated
At String - (String) The date when the secret was recently modified. The date format follows RFC 3339.
- versions
Total Double - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- endpoint
Type String - secret
Group StringName
- configuration string
- (String) The name of the Custom Credentials configuration.
- created
At string - (String) The date when the secret was created. The date format follows RFC 3339.
- created
By string - (String) The unique identifier that is associated with the entity that created the secret.
- crn string
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- custom
Metadata {[key: string]: string} - (Map) The secret metadata that a user can customize.
- description string
- (String) An extended description of your secret.
- downloaded boolean
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- expiration
Date string - (String) The date a secret is expired. The date format follows RFC 3339.
- id string
- instance
Id string - labels string[]
- (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- locks
Total number - (Integer) The number of locks of the secret.
- name string
- (String) The human-readable name of your secret.
- next
Rotation stringDate - (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.
- parameters
Get
Sm Custom Credentials Secret Metadata Parameter[] - (List) The parameters that were passed to the Code Engine job. Nested scheme for parameters:
- region string
- rotations
Get
Sm Custom Credentials Secret Metadata Rotation[] - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- secret
Group stringId - (String) A UUID identifier, or
default
secret group. - secret
Id string - secret
Type string - (String) The secret type.
- state number
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state
Description string - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- ttl string
- (String) The time-to-live or lease duration (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).
- updated
At string - (String) The date when the secret was recently modified. The date format follows RFC 3339.
- versions
Total number - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- endpoint
Type string - secret
Group stringName
- configuration str
- (String) The name of the Custom Credentials configuration.
- created_
at str - (String) The date when the secret was created. The date format follows RFC 3339.
- created_
by str - (String) The unique identifier that is associated with the entity that created the secret.
- crn str
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- custom_
metadata Mapping[str, str] - (Map) The secret metadata that a user can customize.
- description str
- (String) An extended description of your secret.
- downloaded bool
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- expiration_
date str - (String) The date a secret is expired. The date format follows RFC 3339.
- id str
- instance_
id str - labels Sequence[str]
- (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- locks_
total float - (Integer) The number of locks of the secret.
- name str
- (String) The human-readable name of your secret.
- next_
rotation_ strdate - (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.
- parameters
Sequence[Get
Sm Custom Credentials Secret Metadata Parameter] - (List) The parameters that were passed to the Code Engine job. Nested scheme for parameters:
- region str
- rotations
Sequence[Get
Sm Custom Credentials Secret Metadata Rotation] - (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- secret_
group_ strid - (String) A UUID identifier, or
default
secret group. - secret_
id str - secret_
type str - (String) The secret type.
- state float
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state_
description str - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- ttl str
- (String) The time-to-live or lease duration (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).
- updated_
at str - (String) The date when the secret was recently modified. The date format follows RFC 3339.
- versions_
total float - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- endpoint_
type str - secret_
group_ strname
- configuration String
- (String) The name of the Custom Credentials configuration.
- created
At String - (String) The date when the secret was created. The date format follows RFC 3339.
- created
By String - (String) The unique identifier that is associated with the entity that created the secret.
- crn String
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- custom
Metadata Map<String> - (Map) The secret metadata that a user can customize.
- description String
- (String) An extended description of your secret.
- downloaded Boolean
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- expiration
Date String - (String) The date a secret is expired. The date format follows RFC 3339.
- id String
- instance
Id String - labels List<String>
- (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- locks
Total Number - (Integer) The number of locks of the secret.
- name String
- (String) The human-readable name of your secret.
- next
Rotation StringDate - (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.
- parameters List<Property Map>
- (List) The parameters that were passed to the Code Engine job. Nested scheme for parameters:
- region String
- rotations List<Property Map>
- (List) Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:
- secret
Group StringId - (String) A UUID identifier, or
default
secret group. - secret
Id String - secret
Type String - (String) The secret type.
- state Number
- (Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the
Pre-activation = 0
,Active = 1
,Suspended = 2
,Deactivated = 3
, andDestroyed = 5
values.- Constraints: Allowable values are:
0
,1
,2
,3
,5
.
- Constraints: Allowable values are:
- state
Description String - (String) A text representation of the secret state.
- Constraints: Allowable values are:
pre_activation
,active
,suspended
,deactivated
,destroyed
.
- Constraints: Allowable values are:
- ttl String
- (String) The time-to-live or lease duration (in seconds) to assign to generated credentials. Minimum duration is 86400 seconds (one day).
- updated
At String - (String) The date when the secret was recently modified. The date format follows RFC 3339.
- versions
Total Number - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- endpoint
Type String - secret
Group StringName
Supporting Types
GetSmCustomCredentialsSecretMetadataParameter
- Boolean
Values Dictionary<string, bool> - (Map) Values of boolean parameters.
- Integer
Values Dictionary<string, double> - (Map) Values of integer parameters.
- String
Values Dictionary<string, string> - (Map) Values of string parameters.
- Boolean
Values map[string]bool - (Map) Values of boolean parameters.
- Integer
Values map[string]float64 - (Map) Values of integer parameters.
- String
Values map[string]string - (Map) Values of string parameters.
- boolean
Values Map<String,Boolean> - (Map) Values of boolean parameters.
- integer
Values Map<String,Double> - (Map) Values of integer parameters.
- string
Values Map<String,String> - (Map) Values of string parameters.
- boolean
Values {[key: string]: boolean} - (Map) Values of boolean parameters.
- integer
Values {[key: string]: number} - (Map) Values of integer parameters.
- string
Values {[key: string]: string} - (Map) Values of string parameters.
- boolean_
values Mapping[str, bool] - (Map) Values of boolean parameters.
- integer_
values Mapping[str, float] - (Map) Values of integer parameters.
- string_
values Mapping[str, str] - (Map) Values of string parameters.
- boolean
Values Map<Boolean> - (Map) Values of boolean parameters.
- integer
Values Map<Number> - (Map) Values of integer parameters.
- string
Values Map<String> - (Map) Values of string parameters.
GetSmCustomCredentialsSecretMetadataRotation
- Auto
Rotate bool - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is
false
. Ifauto_rotate
is set totrue
the service rotates your secret based on the defined interval. - Interval double
- (Integer) The length of the secret rotation time interval.
- Constraints: The minimum value is
1
.
- Constraints: The minimum value is
- Unit string
- (String) The units for the secret rotation time interval.
- Constraints: Allowable values are:
day
,month
.
- Constraints: Allowable values are:
- Auto
Rotate bool - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is
false
. Ifauto_rotate
is set totrue
the service rotates your secret based on the defined interval. - Interval float64
- (Integer) The length of the secret rotation time interval.
- Constraints: The minimum value is
1
.
- Constraints: The minimum value is
- Unit string
- (String) The units for the secret rotation time interval.
- Constraints: Allowable values are:
day
,month
.
- Constraints: Allowable values are:
- auto
Rotate Boolean - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is
false
. Ifauto_rotate
is set totrue
the service rotates your secret based on the defined interval. - interval Double
- (Integer) The length of the secret rotation time interval.
- Constraints: The minimum value is
1
.
- Constraints: The minimum value is
- unit String
- (String) The units for the secret rotation time interval.
- Constraints: Allowable values are:
day
,month
.
- Constraints: Allowable values are:
- auto
Rotate boolean - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is
false
. Ifauto_rotate
is set totrue
the service rotates your secret based on the defined interval. - interval number
- (Integer) The length of the secret rotation time interval.
- Constraints: The minimum value is
1
.
- Constraints: The minimum value is
- unit string
- (String) The units for the secret rotation time interval.
- Constraints: Allowable values are:
day
,month
.
- Constraints: Allowable values are:
- auto_
rotate bool - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is
false
. Ifauto_rotate
is set totrue
the service rotates your secret based on the defined interval. - interval float
- (Integer) The length of the secret rotation time interval.
- Constraints: The minimum value is
1
.
- Constraints: The minimum value is
- unit str
- (String) The units for the secret rotation time interval.
- Constraints: Allowable values are:
day
,month
.
- Constraints: Allowable values are:
- auto
Rotate Boolean - (Boolean) Determines whether Secrets Manager rotates your secret automatically.Default is
false
. Ifauto_rotate
is set totrue
the service rotates your secret based on the defined interval. - interval Number
- (Integer) The length of the secret rotation time interval.
- Constraints: The minimum value is
1
.
- Constraints: The minimum value is
- unit String
- (String) The units for the secret rotation time interval.
- Constraints: Allowable values are:
day
,month
.
- Constraints: Allowable values are:
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibm
Terraform Provider.