ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm.getSmUsernamePasswordSecretMetadata
Explore with Pulumi AI
Provides a read-only data source for UsernamePasswordSecretMetadata. 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 usernamePasswordSecretMetadata = ibm.getSmUsernamePasswordSecretMetadata({
instanceId: ibm_resource_instance.sm_instance.guid,
region: "us-south",
secretId: "0b5571f7-21e6-42b7-91c5-3f5ac9793a46",
});
import pulumi
import pulumi_ibm as ibm
username_password_secret_metadata = ibm.get_sm_username_password_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.GetSmUsernamePasswordSecretMetadata(ctx, &ibm.GetSmUsernamePasswordSecretMetadataArgs{
InstanceId: ibm_resource_instance.Sm_instance.Guid,
Region: pulumi.StringRef("us-south"),
SecretId: "0b5571f7-21e6-42b7-91c5-3f5ac9793a46",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;
return await Deployment.RunAsync(() =>
{
var usernamePasswordSecretMetadata = Ibm.GetSmUsernamePasswordSecretMetadata.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.GetSmUsernamePasswordSecretMetadataArgs;
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 usernamePasswordSecretMetadata = IbmFunctions.getSmUsernamePasswordSecretMetadata(GetSmUsernamePasswordSecretMetadataArgs.builder()
.instanceId(ibm_resource_instance.sm_instance().guid())
.region("us-south")
.secretId("0b5571f7-21e6-42b7-91c5-3f5ac9793a46")
.build());
}
}
variables:
usernamePasswordSecretMetadata:
fn::invoke:
function: ibm:getSmUsernamePasswordSecretMetadata
arguments:
instanceId: ${ibm_resource_instance.sm_instance.guid}
region: us-south
secretId: 0b5571f7-21e6-42b7-91c5-3f5ac9793a46
Using getSmUsernamePasswordSecretMetadata
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 getSmUsernamePasswordSecretMetadata(args: GetSmUsernamePasswordSecretMetadataArgs, opts?: InvokeOptions): Promise<GetSmUsernamePasswordSecretMetadataResult>
function getSmUsernamePasswordSecretMetadataOutput(args: GetSmUsernamePasswordSecretMetadataOutputArgs, opts?: InvokeOptions): Output<GetSmUsernamePasswordSecretMetadataResult>
def get_sm_username_password_secret_metadata(endpoint_type: Optional[str] = None,
id: Optional[str] = None,
instance_id: Optional[str] = None,
region: Optional[str] = None,
secret_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetSmUsernamePasswordSecretMetadataResult
def get_sm_username_password_secret_metadata_output(endpoint_type: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
instance_id: Optional[pulumi.Input[str]] = None,
region: Optional[pulumi.Input[str]] = None,
secret_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetSmUsernamePasswordSecretMetadataResult]
func GetSmUsernamePasswordSecretMetadata(ctx *Context, args *GetSmUsernamePasswordSecretMetadataArgs, opts ...InvokeOption) (*GetSmUsernamePasswordSecretMetadataResult, error)
func GetSmUsernamePasswordSecretMetadataOutput(ctx *Context, args *GetSmUsernamePasswordSecretMetadataOutputArgs, opts ...InvokeOption) GetSmUsernamePasswordSecretMetadataResultOutput
> Note: This function is named GetSmUsernamePasswordSecretMetadata
in the Go SDK.
public static class GetSmUsernamePasswordSecretMetadata
{
public static Task<GetSmUsernamePasswordSecretMetadataResult> InvokeAsync(GetSmUsernamePasswordSecretMetadataArgs args, InvokeOptions? opts = null)
public static Output<GetSmUsernamePasswordSecretMetadataResult> Invoke(GetSmUsernamePasswordSecretMetadataInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetSmUsernamePasswordSecretMetadataResult> getSmUsernamePasswordSecretMetadata(GetSmUsernamePasswordSecretMetadataArgs args, InvokeOptions options)
public static Output<GetSmUsernamePasswordSecretMetadataResult> getSmUsernamePasswordSecretMetadata(GetSmUsernamePasswordSecretMetadataArgs args, InvokeOptions options)
fn::invoke:
function: ibm:index/getSmUsernamePasswordSecretMetadata:getSmUsernamePasswordSecretMetadata
arguments:
# arguments dictionary
The following arguments are supported:
- Instance
Id string - The GUID of the Secrets Manager instance.
- 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
- 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
- The unique identifier of the UsernamePasswordSecretMetadata.
- Region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- Instance
Id string - The GUID of the Secrets Manager instance.
- 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
- 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
- The unique identifier of the UsernamePasswordSecretMetadata.
- Region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- instance
Id String - The GUID of the Secrets Manager instance.
- 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
- 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
- The unique identifier of the UsernamePasswordSecretMetadata.
- region String
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- instance
Id string - The GUID of the Secrets Manager instance.
- 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
- 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
- The unique identifier of the UsernamePasswordSecretMetadata.
- region string
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- instance_
id str - The GUID of the Secrets Manager instance.
- secret_
id str - The ID of the secret.
- Constraints: The maximum length is
36
characters. The minimum length 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
- 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
- The unique identifier of the UsernamePasswordSecretMetadata.
- region str
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
- instance
Id String - The GUID of the Secrets Manager instance.
- 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
- 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
- The unique identifier of the UsernamePasswordSecretMetadata.
- region String
- The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.
getSmUsernamePasswordSecretMetadata Result
The following output properties are available:
- Created
At string - (String) The date when a resource was created. The date format follows RFC 3339.
- Created
By string - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- Crn string
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Constraints: The maximum length is
512
characters. The minimum length is9
characters. The value must match regular expression/^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- Custom
Metadata Dictionary<string, string> - (Map) The secret metadata that a user can customize.
- Description string
- (String) An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- 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
- The unique identifier of the UsernamePasswordSecretMetadata.
- 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.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Locks
Total double - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- Name string
- (String) The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters.
- Constraints: The maximum length is
- 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.
- Password
Generation List<GetPolicies Sm Username Password Secret Metadata Password Generation Policy> - (List) Policy for auto-generated passwords. Nested scheme for password_generation_policy:
- Region string
- Rotations
List<Get
Sm Username Password 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.- Constraints: The maximum length is
36
characters. The minimum length is7
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)$/
.
- Constraints: The maximum length is
- Secret
Id string - Secret
Type string - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- 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:
- Updated
At string - (String) The date when a resource 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
- Created
At string - (String) The date when a resource was created. The date format follows RFC 3339.
- Created
By string - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- Crn string
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Constraints: The maximum length is
512
characters. The minimum length is9
characters. The value must match regular expression/^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- Custom
Metadata map[string]string - (Map) The secret metadata that a user can customize.
- Description string
- (String) An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- 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
- The unique identifier of the UsernamePasswordSecretMetadata.
- 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.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Locks
Total float64 - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- Name string
- (String) The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters.
- Constraints: The maximum length is
- 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.
- Password
Generation []GetPolicies Sm Username Password Secret Metadata Password Generation Policy - (List) Policy for auto-generated passwords. Nested scheme for password_generation_policy:
- Region string
- Rotations
[]Get
Sm Username Password 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.- Constraints: The maximum length is
36
characters. The minimum length is7
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)$/
.
- Constraints: The maximum length is
- Secret
Id string - Secret
Type string - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- 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:
- Updated
At string - (String) The date when a resource 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
- created
At String - (String) The date when a resource was created. The date format follows RFC 3339.
- created
By String - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- crn String
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Constraints: The maximum length is
512
characters. The minimum length is9
characters. The value must match regular expression/^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- custom
Metadata Map<String,String> - (Map) The secret metadata that a user can customize.
- description String
- (String) An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- 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
- The unique identifier of the UsernamePasswordSecretMetadata.
- 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.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- locks
Total Double - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- name String
- (String) The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters.
- Constraints: The maximum length is
- 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.
- password
Generation List<GetPolicies Sm Username Password Secret Metadata Password Generation Policy> - (List) Policy for auto-generated passwords. Nested scheme for password_generation_policy:
- region String
- rotations
List<Get
Sm Username Password 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.- Constraints: The maximum length is
36
characters. The minimum length is7
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)$/
.
- Constraints: The maximum length is
- secret
Id String - secret
Type String - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- 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:
- updated
At String - (String) The date when a resource 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
- created
At string - (String) The date when a resource was created. The date format follows RFC 3339.
- created
By string - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- crn string
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Constraints: The maximum length is
512
characters. The minimum length is9
characters. The value must match regular expression/^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- custom
Metadata {[key: string]: string} - (Map) The secret metadata that a user can customize.
- description string
- (String) An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- 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
- The unique identifier of the UsernamePasswordSecretMetadata.
- 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.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- locks
Total number - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- name string
- (String) The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters.
- Constraints: The maximum length is
- 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.
- password
Generation GetPolicies Sm Username Password Secret Metadata Password Generation Policy[] - (List) Policy for auto-generated passwords. Nested scheme for password_generation_policy:
- region string
- rotations
Get
Sm Username Password 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.- Constraints: The maximum length is
36
characters. The minimum length is7
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)$/
.
- Constraints: The maximum length is
- secret
Id string - secret
Type string - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- 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:
- updated
At string - (String) The date when a resource 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
- created_
at str - (String) The date when a resource was created. The date format follows RFC 3339.
- created_
by str - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- crn str
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Constraints: The maximum length is
512
characters. The minimum length is9
characters. The value must match regular expression/^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- custom_
metadata Mapping[str, str] - (Map) The secret metadata that a user can customize.
- description str
- (String) An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- downloaded bool
- (Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.
- expiration_
date str - (String) The date a secret is expired. The date format follows RFC 3339.
- id str
- The unique identifier of the UsernamePasswordSecretMetadata.
- instance_
id str - labels Sequence[str]
- (List) Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- locks_
total float - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- name str
- (String) The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters.
- Constraints: The maximum length is
- 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.
- password_
generation_ Sequence[Getpolicies Sm Username Password Secret Metadata Password Generation Policy] - (List) Policy for auto-generated passwords. Nested scheme for password_generation_policy:
- region str
- rotations
Sequence[Get
Sm Username Password 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.- Constraints: The maximum length is
36
characters. The minimum length is7
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)$/
.
- Constraints: The maximum length is
- secret_
id str - secret_
type str - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- 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:
- updated_
at str - (String) The date when a resource was recently modified. The date format follows RFC 3339.
- versions_
total float - (Integer) The number of versions of the secret.
- Constraints: The maximum value is
50
. The minimum value is0
.
- Constraints: The maximum value is
- endpoint_
type str
- created
At String - (String) The date when a resource was created. The date format follows RFC 3339.
- created
By String - (String) The unique identifier that is associated with the entity that created the secret.
- Constraints: The maximum length is
128
characters. The minimum length is4
characters.
- Constraints: The maximum length is
- crn String
- (String) A CRN that uniquely identifies an IBM Cloud resource.
- Constraints: The maximum length is
512
characters. The minimum length is9
characters. The value must match regular expression/^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/
.
- Constraints: The maximum length is
- custom
Metadata Map<String> - (Map) The secret metadata that a user can customize.
- description String
- (String) An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.
- Constraints: The maximum length is
1024
characters. The minimum length is0
characters. The value must match regular expression/(.*?)/
.
- Constraints: The maximum length is
- 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
- The unique identifier of the UsernamePasswordSecretMetadata.
- 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.
- Constraints: The list items must match regular expression
/(.*?)/
. The maximum length is30
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- locks
Total Number - (Integer) The number of locks of the secret.
- Constraints: The maximum value is
1000
. The minimum value is0
.
- Constraints: The maximum value is
- name String
- (String) The human-readable name of your secret.
- Constraints: The maximum length is
256
characters. The minimum length is2
characters.
- Constraints: The maximum length is
- 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.
- password
Generation List<Property Map>Policies - (List) Policy for auto-generated passwords. Nested scheme for password_generation_policy:
- 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.- Constraints: The maximum length is
36
characters. The minimum length is7
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)$/
.
- Constraints: The maximum length is
- secret
Id String - secret
Type String - (String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.
- Constraints: Allowable values are:
arbitrary
,imported_cert
,public_cert
,iam_credentials
,kv
,username_password
,private_cert
.
- Constraints: Allowable values are:
- 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:
- updated
At String - (String) The date when a resource 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
Supporting Types
GetSmUsernamePasswordSecretMetadataPasswordGenerationPolicy
- Include
Digits bool - (Boolean) Include digits in auto-generated passwords.
- Include
Symbols bool - (Boolean) Include symbols in auto-generated passwords.
- Include
Uppercase bool - (Boolean) Include uppercase letters in auto-generated passwords.
- Length double
- (Integer) The length of auto-generated passwords.
- Include
Digits bool - (Boolean) Include digits in auto-generated passwords.
- Include
Symbols bool - (Boolean) Include symbols in auto-generated passwords.
- Include
Uppercase bool - (Boolean) Include uppercase letters in auto-generated passwords.
- Length float64
- (Integer) The length of auto-generated passwords.
- include
Digits Boolean - (Boolean) Include digits in auto-generated passwords.
- include
Symbols Boolean - (Boolean) Include symbols in auto-generated passwords.
- include
Uppercase Boolean - (Boolean) Include uppercase letters in auto-generated passwords.
- length Double
- (Integer) The length of auto-generated passwords.
- include
Digits boolean - (Boolean) Include digits in auto-generated passwords.
- include
Symbols boolean - (Boolean) Include symbols in auto-generated passwords.
- include
Uppercase boolean - (Boolean) Include uppercase letters in auto-generated passwords.
- length number
- (Integer) The length of auto-generated passwords.
- include_
digits bool - (Boolean) Include digits in auto-generated passwords.
- include_
symbols bool - (Boolean) Include symbols in auto-generated passwords.
- include_
uppercase bool - (Boolean) Include uppercase letters in auto-generated passwords.
- length float
- (Integer) The length of auto-generated passwords.
- include
Digits Boolean - (Boolean) Include digits in auto-generated passwords.
- include
Symbols Boolean - (Boolean) Include symbols in auto-generated passwords.
- include
Uppercase Boolean - (Boolean) Include uppercase letters in auto-generated passwords.
- length Number
- (Integer) The length of auto-generated passwords.
GetSmUsernamePasswordSecretMetadataRotation
- 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.