ibm 1.78.0, Apr 30 25

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

ibm.SmUsernamePasswordSecret

Explore with Pulumi AI

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const smUsernamePasswordSecret = new ibm.SmUsernamePasswordSecret("smUsernamePasswordSecret", {
    instanceId: ibm_resource_instance.sm_instance.guid,
    region: "us-south",
    customMetadata: {
        key: "value",
    },
    description: "Extended description for this secret.",
    expirationDate: "2024-04-12T23:20:50Z",
    labels: ["my-label"],
    passwordGenerationPolicy: {
        length: 32,
        includeDigits: true,
        includeSymbols: true,
        includeUppercase: true,
    },
    rotation: {
        autoRotate: true,
        interval: 1,
        unit: "day",
    },
    secretGroupId: ibm_sm_secret_group.sm_secret_group.secret_group_id,
    username: "username-example",
    password: "password-example",
});

import pulumi
import pulumi_ibm as ibm

sm_username_password_secret = ibm.SmUsernamePasswordSecret("smUsernamePasswordSecret",
    instance_id=ibm_resource_instance["sm_instance"]["guid"],
    region="us-south",
    custom_metadata={
        "key": "value",
    },
    description="Extended description for this secret.",
    expiration_date="2024-04-12T23:20:50Z",
    labels=["my-label"],
    password_generation_policy={
        "length": 32,
        "include_digits": True,
        "include_symbols": True,
        "include_uppercase": True,
    },
    rotation={
        "auto_rotate": True,
        "interval": 1,
        "unit": "day",
    },
    secret_group_id=ibm_sm_secret_group["sm_secret_group"]["secret_group_id"],
    username="username-example",
    password="password-example")

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.NewSmUsernamePasswordSecret(ctx, "smUsernamePasswordSecret", &ibm.SmUsernamePasswordSecretArgs{
			InstanceId: pulumi.Any(ibm_resource_instance.Sm_instance.Guid),
			Region:     pulumi.String("us-south"),
			CustomMetadata: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
			Description:    pulumi.String("Extended description for this secret."),
			ExpirationDate: pulumi.String("2024-04-12T23:20:50Z"),
			Labels: pulumi.StringArray{
				pulumi.String("my-label"),
			},
			PasswordGenerationPolicy: &ibm.SmUsernamePasswordSecretPasswordGenerationPolicyArgs{
				Length:           pulumi.Float64(32),
				IncludeDigits:    pulumi.Bool(true),
				IncludeSymbols:   pulumi.Bool(true),
				IncludeUppercase: pulumi.Bool(true),
			},
			Rotation: &ibm.SmUsernamePasswordSecretRotationArgs{
				AutoRotate: pulumi.Bool(true),
				Interval:   pulumi.Float64(1),
				Unit:       pulumi.String("day"),
			},
			SecretGroupId: pulumi.Any(ibm_sm_secret_group.Sm_secret_group.Secret_group_id),
			Username:      pulumi.String("username-example"),
			Password:      pulumi.String("password-example"),
		})
		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 smUsernamePasswordSecret = new Ibm.SmUsernamePasswordSecret("smUsernamePasswordSecret", new()
    {
        InstanceId = ibm_resource_instance.Sm_instance.Guid,
        Region = "us-south",
        CustomMetadata = 
        {
            { "key", "value" },
        },
        Description = "Extended description for this secret.",
        ExpirationDate = "2024-04-12T23:20:50Z",
        Labels = new[]
        {
            "my-label",
        },
        PasswordGenerationPolicy = new Ibm.Inputs.SmUsernamePasswordSecretPasswordGenerationPolicyArgs
        {
            Length = 32,
            IncludeDigits = true,
            IncludeSymbols = true,
            IncludeUppercase = true,
        },
        Rotation = new Ibm.Inputs.SmUsernamePasswordSecretRotationArgs
        {
            AutoRotate = true,
            Interval = 1,
            Unit = "day",
        },
        SecretGroupId = ibm_sm_secret_group.Sm_secret_group.Secret_group_id,
        Username = "username-example",
        Password = "password-example",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.SmUsernamePasswordSecret;
import com.pulumi.ibm.SmUsernamePasswordSecretArgs;
import com.pulumi.ibm.inputs.SmUsernamePasswordSecretPasswordGenerationPolicyArgs;
import com.pulumi.ibm.inputs.SmUsernamePasswordSecretRotationArgs;
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) {
        var smUsernamePasswordSecret = new SmUsernamePasswordSecret("smUsernamePasswordSecret", SmUsernamePasswordSecretArgs.builder()
            .instanceId(ibm_resource_instance.sm_instance().guid())
            .region("us-south")
            .customMetadata(Map.of("key", "value"))
            .description("Extended description for this secret.")
            .expirationDate("2024-04-12T23:20:50Z")
            .labels("my-label")
            .passwordGenerationPolicy(SmUsernamePasswordSecretPasswordGenerationPolicyArgs.builder()
                .length(32)
                .includeDigits(true)
                .includeSymbols(true)
                .includeUppercase(true)
                .build())
            .rotation(SmUsernamePasswordSecretRotationArgs.builder()
                .autoRotate(true)
                .interval(1)
                .unit("day")
                .build())
            .secretGroupId(ibm_sm_secret_group.sm_secret_group().secret_group_id())
            .username("username-example")
            .password("password-example")
            .build());

    }
}

resources:
  smUsernamePasswordSecret:
    type: ibm:SmUsernamePasswordSecret
    properties:
      instanceId: ${ibm_resource_instance.sm_instance.guid}
      region: us-south
      customMetadata:
        key: value
      description: Extended description for this secret.
      expirationDate: 2024-04-12T23:20:50Z
      labels:
        - my-label
      passwordGenerationPolicy:
        length: 32
        includeDigits: true
        includeSymbols: true
        includeUppercase: true
      rotation:
        autoRotate: true
        interval: 1
        unit: day
      secretGroupId: ${ibm_sm_secret_group.sm_secret_group.secret_group_id}
      username: username-example
      password: password-example

Provider Configuration

The IBM Cloud provider offers a flexible means of providing credentials for authentication. The following methods are supported, in this order, and explained below:

Static credentials
Environment variables

To find which credentials are required for this resource, see the service table here.

Static credentials

You can provide your static credentials by adding the ibmcloud_api_key, iaas_classic_username, and iaas_classic_api_key arguments in the IBM Cloud provider block.

Usage:

provider "ibm" {
    ibmcloud_api_key = ""
    iaas_classic_username = ""
    iaas_classic_api_key = ""
}

Environment variables

You can provide your credentials by exporting the IC_API_KEY, IAAS_CLASSIC_USERNAME, and IAAS_CLASSIC_API_KEY environment variables, representing your IBM Cloud platform API key, IBM Cloud Classic Infrastructure (SoftLayer) user name, and IBM Cloud infrastructure API key, respectively.

provider "ibm" {}

Usage:

export IC_API_KEY="ibmcloud_api_key"
export IAAS_CLASSIC_USERNAME="iaas_classic_username"
export IAAS_CLASSIC_API_KEY="iaas_classic_api_key"
pulumi preview

Note:

Create or find your ibmcloud_api_key and iaas_classic_api_key here.

Select My IBM Cloud API Keys option from view dropdown for ibmcloud_api_key
Select Classic Infrastructure API Keys option from view dropdown for iaas_classic_api_key

For iaas_classic_username

Go to Users
Click on user.
Find user name in the VPN password section under User Details tab

For more informaton, see here.

Create SmUsernamePasswordSecret Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SmUsernamePasswordSecret(name: string, args: SmUsernamePasswordSecretArgs, opts?: CustomResourceOptions);

@overload
def SmUsernamePasswordSecret(resource_name: str,
                             args: SmUsernamePasswordSecretArgs,
                             opts: Optional[ResourceOptions] = None)

@overload
def SmUsernamePasswordSecret(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             instance_id: Optional[str] = None,
                             username: Optional[str] = None,
                             name: Optional[str] = None,
                             expiration_date: Optional[str] = None,
                             endpoint_type: Optional[str] = None,
                             labels: Optional[Sequence[str]] = None,
                             custom_metadata: Optional[Mapping[str, str]] = None,
                             password: Optional[str] = None,
                             password_generation_policy: Optional[SmUsernamePasswordSecretPasswordGenerationPolicyArgs] = None,
                             region: Optional[str] = None,
                             rotation: Optional[SmUsernamePasswordSecretRotationArgs] = None,
                             secret_group_id: Optional[str] = None,
                             sm_username_password_secret_id: Optional[str] = None,
                             description: Optional[str] = None,
                             version_custom_metadata: Optional[Mapping[str, str]] = None)

func NewSmUsernamePasswordSecret(ctx *Context, name string, args SmUsernamePasswordSecretArgs, opts ...ResourceOption) (*SmUsernamePasswordSecret, error)

public SmUsernamePasswordSecret(string name, SmUsernamePasswordSecretArgs args, CustomResourceOptions? opts = null)

public SmUsernamePasswordSecret(String name, SmUsernamePasswordSecretArgs args)
public SmUsernamePasswordSecret(String name, SmUsernamePasswordSecretArgs args, CustomResourceOptions options)

type: ibm:SmUsernamePasswordSecret
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args SmUsernamePasswordSecretArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args SmUsernamePasswordSecretArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SmUsernamePasswordSecretArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SmUsernamePasswordSecretArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SmUsernamePasswordSecretArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var smUsernamePasswordSecretResource = new Ibm.SmUsernamePasswordSecret("smUsernamePasswordSecretResource", new()
{
    InstanceId = "string",
    Username = "string",
    Name = "string",
    ExpirationDate = "string",
    EndpointType = "string",
    Labels = new[]
    {
        "string",
    },
    CustomMetadata = 
    {
        { "string", "string" },
    },
    Password = "string",
    PasswordGenerationPolicy = new Ibm.Inputs.SmUsernamePasswordSecretPasswordGenerationPolicyArgs
    {
        IncludeDigits = false,
        IncludeSymbols = false,
        IncludeUppercase = false,
        Length = 0,
    },
    Region = "string",
    Rotation = new Ibm.Inputs.SmUsernamePasswordSecretRotationArgs
    {
        AutoRotate = false,
        Interval = 0,
        Unit = "string",
    },
    SecretGroupId = "string",
    SmUsernamePasswordSecretId = "string",
    Description = "string",
    VersionCustomMetadata = 
    {
        { "string", "string" },
    },
});

example, err := ibm.NewSmUsernamePasswordSecret(ctx, "smUsernamePasswordSecretResource", &ibm.SmUsernamePasswordSecretArgs{
	InstanceId:     pulumi.String("string"),
	Username:       pulumi.String("string"),
	Name:           pulumi.String("string"),
	ExpirationDate: pulumi.String("string"),
	EndpointType:   pulumi.String("string"),
	Labels: pulumi.StringArray{
		pulumi.String("string"),
	},
	CustomMetadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Password: pulumi.String("string"),
	PasswordGenerationPolicy: &ibm.SmUsernamePasswordSecretPasswordGenerationPolicyArgs{
		IncludeDigits:    pulumi.Bool(false),
		IncludeSymbols:   pulumi.Bool(false),
		IncludeUppercase: pulumi.Bool(false),
		Length:           pulumi.Float64(0),
	},
	Region: pulumi.String("string"),
	Rotation: &ibm.SmUsernamePasswordSecretRotationArgs{
		AutoRotate: pulumi.Bool(false),
		Interval:   pulumi.Float64(0),
		Unit:       pulumi.String("string"),
	},
	SecretGroupId:              pulumi.String("string"),
	SmUsernamePasswordSecretId: pulumi.String("string"),
	Description:                pulumi.String("string"),
	VersionCustomMetadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

var smUsernamePasswordSecretResource = new SmUsernamePasswordSecret("smUsernamePasswordSecretResource", SmUsernamePasswordSecretArgs.builder()
    .instanceId("string")
    .username("string")
    .name("string")
    .expirationDate("string")
    .endpointType("string")
    .labels("string")
    .customMetadata(Map.of("string", "string"))
    .password("string")
    .passwordGenerationPolicy(SmUsernamePasswordSecretPasswordGenerationPolicyArgs.builder()
        .includeDigits(false)
        .includeSymbols(false)
        .includeUppercase(false)
        .length(0)
        .build())
    .region("string")
    .rotation(SmUsernamePasswordSecretRotationArgs.builder()
        .autoRotate(false)
        .interval(0)
        .unit("string")
        .build())
    .secretGroupId("string")
    .smUsernamePasswordSecretId("string")
    .description("string")
    .versionCustomMetadata(Map.of("string", "string"))
    .build());

sm_username_password_secret_resource = ibm.SmUsernamePasswordSecret("smUsernamePasswordSecretResource",
    instance_id="string",
    username="string",
    name="string",
    expiration_date="string",
    endpoint_type="string",
    labels=["string"],
    custom_metadata={
        "string": "string",
    },
    password="string",
    password_generation_policy={
        "include_digits": False,
        "include_symbols": False,
        "include_uppercase": False,
        "length": 0,
    },
    region="string",
    rotation={
        "auto_rotate": False,
        "interval": 0,
        "unit": "string",
    },
    secret_group_id="string",
    sm_username_password_secret_id="string",
    description="string",
    version_custom_metadata={
        "string": "string",
    })

const smUsernamePasswordSecretResource = new ibm.SmUsernamePasswordSecret("smUsernamePasswordSecretResource", {
    instanceId: "string",
    username: "string",
    name: "string",
    expirationDate: "string",
    endpointType: "string",
    labels: ["string"],
    customMetadata: {
        string: "string",
    },
    password: "string",
    passwordGenerationPolicy: {
        includeDigits: false,
        includeSymbols: false,
        includeUppercase: false,
        length: 0,
    },
    region: "string",
    rotation: {
        autoRotate: false,
        interval: 0,
        unit: "string",
    },
    secretGroupId: "string",
    smUsernamePasswordSecretId: "string",
    description: "string",
    versionCustomMetadata: {
        string: "string",
    },
});

type: ibm:SmUsernamePasswordSecret
properties:
    customMetadata:
        string: string
    description: string
    endpointType: string
    expirationDate: string
    instanceId: string
    labels:
        - string
    name: string
    password: string
    passwordGenerationPolicy:
        includeDigits: false
        includeSymbols: false
        includeUppercase: false
        length: 0
    region: string
    rotation:
        autoRotate: false
        interval: 0
        unit: string
    secretGroupId: string
    smUsernamePasswordSecretId: string
    username: string
    versionCustomMetadata:
        string: string

SmUsernamePasswordSecret Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SmUsernamePasswordSecret resource accepts the following input properties:

InstanceId string

The GUID of the Secrets Manager instance.

Username string

The username that is assigned to the secret.

Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[A-Za-z0-9+-=.]*/.

CustomMetadata Dictionary<string, string>

The secret metadata that a user can customize.

Description string

An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.

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.

ExpirationDate string

The date a secret is expired. The date format follows RFC 3339.

Labels List<string>

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.

Name string

The human-readable name of your secret.

Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.

Password string

The password that is assigned to the secret. If password is omitted, Secrets Manager generates a new random password for your secret.

Constraints: The maximum length is 64 characters. The minimum length is 6 characters.

PasswordGenerationPolicy SmUsernamePasswordSecretPasswordGenerationPolicy

Policy for auto-generated passwords. Nested scheme for password_generation_policy:

Region string

The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

Rotation SmUsernamePasswordSecretRotation

Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:

SecretGroupId 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)$/.

SmUsernamePasswordSecretId string

VersionCustomMetadata Dictionary<string, string>

The secret version metadata that a user can customize.

InstanceId string

The GUID of the Secrets Manager instance.

Username string

The username that is assigned to the secret.

Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[A-Za-z0-9+-=.]*/.

CustomMetadata map[string]string

The secret metadata that a user can customize.

Description string

An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.

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.

ExpirationDate string

The date a secret is expired. The date format follows RFC 3339.

Labels []string

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.

Name string

The human-readable name of your secret.

Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.

Password string

The password that is assigned to the secret. If password is omitted, Secrets Manager generates a new random password for your secret.

Constraints: The maximum length is 64 characters. The minimum length is 6 characters.

PasswordGenerationPolicy SmUsernamePasswordSecretPasswordGenerationPolicyArgs

Policy for auto-generated passwords. Nested scheme for password_generation_policy:

Region string

The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

Rotation SmUsernamePasswordSecretRotationArgs

Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:

SecretGroupId 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)$/.

SmUsernamePasswordSecretId string

VersionCustomMetadata map[string]string

The secret version metadata that a user can customize.

instanceId String

The GUID of the Secrets Manager instance.

username String

The username that is assigned to the secret.

Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[A-Za-z0-9+-=.]*/.

customMetadata Map<String,String>

The secret metadata that a user can customize.

description String

An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.

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.

expirationDate String

The date a secret is expired. The date format follows RFC 3339.

labels List<String>

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.

name String

The human-readable name of your secret.

Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.

password String

The password that is assigned to the secret. If password is omitted, Secrets Manager generates a new random password for your secret.

Constraints: The maximum length is 64 characters. The minimum length is 6 characters.

passwordGenerationPolicy SmUsernamePasswordSecretPasswordGenerationPolicy

Policy for auto-generated passwords. Nested scheme for password_generation_policy:

region String

The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

rotation SmUsernamePasswordSecretRotation

Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:

secretGroupId 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)$/.

smUsernamePasswordSecretId String

versionCustomMetadata Map<String,String>

The secret version metadata that a user can customize.

instanceId string

The GUID of the Secrets Manager instance.

username string

The username that is assigned to the secret.

Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[A-Za-z0-9+-=.]*/.

customMetadata {[key: string]: string}

The secret metadata that a user can customize.

description string

An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.

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.

expirationDate string

The date a secret is expired. The date format follows RFC 3339.

labels string[]

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.

name string

The human-readable name of your secret.

Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.

password string

The password that is assigned to the secret. If password is omitted, Secrets Manager generates a new random password for your secret.

Constraints: The maximum length is 64 characters. The minimum length is 6 characters.

passwordGenerationPolicy SmUsernamePasswordSecretPasswordGenerationPolicy

Policy for auto-generated passwords. Nested scheme for password_generation_policy:

region string

The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

rotation SmUsernamePasswordSecretRotation

Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:

secretGroupId 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)$/.

smUsernamePasswordSecretId string

versionCustomMetadata {[key: string]: string}

The secret version metadata that a user can customize.

instance_id str

The GUID of the Secrets Manager instance.

username str

The username that is assigned to the secret.

Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[A-Za-z0-9+-=.]*/.

custom_metadata Mapping[str, str]

The secret metadata that a user can customize.

description str

An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.

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.

expiration_date str

The date a secret is expired. The date format follows RFC 3339.

labels Sequence[str]

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.

name str

The human-readable name of your secret.

Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.

password str

The password that is assigned to the secret. If password is omitted, Secrets Manager generates a new random password for your secret.

Constraints: The maximum length is 64 characters. The minimum length is 6 characters.

password_generation_policy SmUsernamePasswordSecretPasswordGenerationPolicyArgs

Policy for auto-generated passwords. Nested scheme for password_generation_policy:

region str

The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

rotation SmUsernamePasswordSecretRotationArgs

Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:

secret_group_id str

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)$/.

sm_username_password_secret_id str

version_custom_metadata Mapping[str, str]

The secret version metadata that a user can customize.

instanceId String

The GUID of the Secrets Manager instance.

username String

The username that is assigned to the secret.

Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[A-Za-z0-9+-=.]*/.

customMetadata Map<String>

The secret metadata that a user can customize.

description String

An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.

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.

expirationDate String

The date a secret is expired. The date format follows RFC 3339.

labels List<String>

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.

name String

The human-readable name of your secret.

Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.

password String

The password that is assigned to the secret. If password is omitted, Secrets Manager generates a new random password for your secret.

Constraints: The maximum length is 64 characters. The minimum length is 6 characters.

passwordGenerationPolicy Property Map

Policy for auto-generated passwords. Nested scheme for password_generation_policy:

region String

The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

rotation Property Map

Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:

secretGroupId 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)$/.

smUsernamePasswordSecretId String

versionCustomMetadata Map<String>

The secret version metadata that a user can customize.

Outputs

All input properties are implicitly available as output properties. Additionally, the SmUsernamePasswordSecret resource produces the following output properties:

CreatedAt string

(String) The date when a resource was created. The date format follows RFC 3339.

CreatedBy string

(String) The unique identifier that is associated with the entity that created the secret.

Constraints: The maximum length is 128 characters. The minimum length is 4 characters.

Crn string

(String) A CRN that uniquely identifies an IBM Cloud resource.

Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

Downloaded bool

(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.

Id string

The provider-assigned unique ID for this managed resource.

LocksTotal double

(Integer) The number of locks of the secret.

Constraints: The maximum value is 1000. The minimum value is 0.

NextRotationDate string

(String) The date that the secret is scheduled for automatic rotation.The service automatically creates a new version of the secret on its next rotation date. This field exists only for secrets that have an existing rotation policy.

SecretId string

The unique identifier of the UsernamePasswordSecret.

SecretType string

(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.

State double

(Integer) The secret state that is based on NIST SP 800-57. States are integers and correspond to the Pre-activation = 0, Active = 1, Suspended = 2, Deactivated = 3, and Destroyed = 5 values.

Constraints: Allowable values are: 0, 1, 2, 3, 5.

StateDescription string

(String) A text representation of the secret state.

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

UpdatedAt string

(String) The date when a resource was recently modified. The date format follows RFC 3339.

VersionsTotal double

(Integer) The number of versions of the secret.

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

CreatedAt string

(String) The date when a resource was created. The date format follows RFC 3339.

CreatedBy string

(String) The unique identifier that is associated with the entity that created the secret.

Constraints: The maximum length is 128 characters. The minimum length is 4 characters.

Crn string

(String) A CRN that uniquely identifies an IBM Cloud resource.

Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

Downloaded bool

(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.

Id string

The provider-assigned unique ID for this managed resource.

LocksTotal float64

(Integer) The number of locks of the secret.

Constraints: The maximum value is 1000. The minimum value is 0.

NextRotationDate string

SecretId string

The unique identifier of the UsernamePasswordSecret.

SecretType string

(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.

State float64

Constraints: Allowable values are: 0, 1, 2, 3, 5.

StateDescription string

(String) A text representation of the secret state.

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

UpdatedAt string

(String) The date when a resource was recently modified. The date format follows RFC 3339.

VersionsTotal float64

(Integer) The number of versions of the secret.

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

createdAt String

(String) The date when a resource was created. The date format follows RFC 3339.

createdBy String

(String) The unique identifier that is associated with the entity that created the secret.

Constraints: The maximum length is 128 characters. The minimum length is 4 characters.

crn String

(String) A CRN that uniquely identifies an IBM Cloud resource.

Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

downloaded Boolean

(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.

id String

The provider-assigned unique ID for this managed resource.

locksTotal Double

(Integer) The number of locks of the secret.

Constraints: The maximum value is 1000. The minimum value is 0.

nextRotationDate String

secretId String

The unique identifier of the UsernamePasswordSecret.

secretType String

(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.

state Double

Constraints: Allowable values are: 0, 1, 2, 3, 5.

stateDescription String

(String) A text representation of the secret state.

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

updatedAt String

(String) The date when a resource was recently modified. The date format follows RFC 3339.

versionsTotal Double

(Integer) The number of versions of the secret.

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

createdAt string

(String) The date when a resource was created. The date format follows RFC 3339.

createdBy string

(String) The unique identifier that is associated with the entity that created the secret.

Constraints: The maximum length is 128 characters. The minimum length is 4 characters.

crn string

(String) A CRN that uniquely identifies an IBM Cloud resource.

Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

downloaded boolean

(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.

id string

The provider-assigned unique ID for this managed resource.

locksTotal number

(Integer) The number of locks of the secret.

Constraints: The maximum value is 1000. The minimum value is 0.

nextRotationDate string

secretId string

The unique identifier of the UsernamePasswordSecret.

secretType string

(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.

state number

Constraints: Allowable values are: 0, 1, 2, 3, 5.

stateDescription string

(String) A text representation of the secret state.

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

updatedAt string

(String) The date when a resource was recently modified. The date format follows RFC 3339.

versionsTotal number

(Integer) The number of versions of the secret.

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

created_at str

(String) The date when a resource was created. The date format follows RFC 3339.

created_by str

(String) The unique identifier that is associated with the entity that created the secret.

Constraints: The maximum length is 128 characters. The minimum length is 4 characters.

crn str

(String) A CRN that uniquely identifies an IBM Cloud resource.

Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

downloaded bool

(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.

id str

The provider-assigned unique ID for this managed resource.

locks_total float

(Integer) The number of locks of the secret.

Constraints: The maximum value is 1000. The minimum value is 0.

next_rotation_date str

secret_id str

The unique identifier of the UsernamePasswordSecret.

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.

state float

Constraints: Allowable values are: 0, 1, 2, 3, 5.

state_description str

(String) A text representation of the secret state.

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

updated_at str

(String) The date when a resource was recently modified. The date format follows RFC 3339.

versions_total float

(Integer) The number of versions of the secret.

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

createdAt String

(String) The date when a resource was created. The date format follows RFC 3339.

createdBy String

(String) The unique identifier that is associated with the entity that created the secret.

Constraints: The maximum length is 128 characters. The minimum length is 4 characters.

crn String

(String) A CRN that uniquely identifies an IBM Cloud resource.

Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

downloaded Boolean

(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.

id String

The provider-assigned unique ID for this managed resource.

locksTotal Number

(Integer) The number of locks of the secret.

Constraints: The maximum value is 1000. The minimum value is 0.

nextRotationDate String

secretId String

The unique identifier of the UsernamePasswordSecret.

secretType String

(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.

state Number

Constraints: Allowable values are: 0, 1, 2, 3, 5.

stateDescription String

(String) A text representation of the secret state.

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

updatedAt String

(String) The date when a resource was recently modified. The date format follows RFC 3339.

versionsTotal Number

(Integer) The number of versions of the secret.

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

Look up Existing SmUsernamePasswordSecret Resource

Get an existing SmUsernamePasswordSecret resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SmUsernamePasswordSecretState, opts?: CustomResourceOptions): SmUsernamePasswordSecret

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        created_by: Optional[str] = None,
        crn: Optional[str] = None,
        custom_metadata: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        downloaded: Optional[bool] = None,
        endpoint_type: Optional[str] = None,
        expiration_date: Optional[str] = None,
        instance_id: Optional[str] = None,
        labels: Optional[Sequence[str]] = None,
        locks_total: Optional[float] = None,
        name: Optional[str] = None,
        next_rotation_date: Optional[str] = None,
        password: Optional[str] = None,
        password_generation_policy: Optional[SmUsernamePasswordSecretPasswordGenerationPolicyArgs] = None,
        region: Optional[str] = None,
        rotation: Optional[SmUsernamePasswordSecretRotationArgs] = None,
        secret_group_id: Optional[str] = None,
        secret_id: Optional[str] = None,
        secret_type: Optional[str] = None,
        sm_username_password_secret_id: Optional[str] = None,
        state: Optional[float] = None,
        state_description: Optional[str] = None,
        updated_at: Optional[str] = None,
        username: Optional[str] = None,
        version_custom_metadata: Optional[Mapping[str, str]] = None,
        versions_total: Optional[float] = None) -> SmUsernamePasswordSecret

func GetSmUsernamePasswordSecret(ctx *Context, name string, id IDInput, state *SmUsernamePasswordSecretState, opts ...ResourceOption) (*SmUsernamePasswordSecret, error)

public static SmUsernamePasswordSecret Get(string name, Input<string> id, SmUsernamePasswordSecretState? state, CustomResourceOptions? opts = null)

public static SmUsernamePasswordSecret get(String name, Output<String> id, SmUsernamePasswordSecretState state, CustomResourceOptions options)

resources:  _:    type: ibm:SmUsernamePasswordSecret    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CreatedAt string

(String) The date when a resource was created. The date format follows RFC 3339.

CreatedBy string

(String) The unique identifier that is associated with the entity that created the secret.

Constraints: The maximum length is 128 characters. The minimum length is 4 characters.

Crn string

(String) A CRN that uniquely identifies an IBM Cloud resource.

Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

CustomMetadata Dictionary<string, string>

The secret metadata that a user can customize.

Description string

An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.

Downloaded bool

(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.

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.

ExpirationDate string

The date a secret is expired. The date format follows RFC 3339.

InstanceId string

The GUID of the Secrets Manager instance.

Labels List<string>

Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.

LocksTotal double

(Integer) The number of locks of the secret.

Constraints: The maximum value is 1000. The minimum value is 0.

Name string

The human-readable name of your secret.

Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.

NextRotationDate string

Password string

The password that is assigned to the secret. If password is omitted, Secrets Manager generates a new random password for your secret.

Constraints: The maximum length is 64 characters. The minimum length is 6 characters.

PasswordGenerationPolicy SmUsernamePasswordSecretPasswordGenerationPolicy

Policy for auto-generated passwords. Nested scheme for password_generation_policy:

Region string

The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

Rotation SmUsernamePasswordSecretRotation

Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:

SecretGroupId string

A UUID identifier, or default secret group.

Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.

SecretId string

The unique identifier of the UsernamePasswordSecret.

SecretType string

(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.

SmUsernamePasswordSecretId string

State double

Constraints: Allowable values are: 0, 1, 2, 3, 5.

StateDescription string

(String) A text representation of the secret state.

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

UpdatedAt string

(String) The date when a resource was recently modified. The date format follows RFC 3339.

Username string

The username that is assigned to the secret.

Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[A-Za-z0-9+-=.]*/.

VersionCustomMetadata Dictionary<string, string>

The secret version metadata that a user can customize.

VersionsTotal double

(Integer) The number of versions of the secret.

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

CreatedAt string

(String) The date when a resource was created. The date format follows RFC 3339.

CreatedBy string

(String) The unique identifier that is associated with the entity that created the secret.

Constraints: The maximum length is 128 characters. The minimum length is 4 characters.

Crn string

(String) A CRN that uniquely identifies an IBM Cloud resource.

Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

CustomMetadata map[string]string

The secret metadata that a user can customize.

Description string

An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.

Downloaded bool

(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.

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.

ExpirationDate string

The date a secret is expired. The date format follows RFC 3339.

InstanceId string

The GUID of the Secrets Manager instance.

Labels []string

Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.

LocksTotal float64

(Integer) The number of locks of the secret.

Constraints: The maximum value is 1000. The minimum value is 0.

Name string

The human-readable name of your secret.

Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.

NextRotationDate string

Password string

The password that is assigned to the secret. If password is omitted, Secrets Manager generates a new random password for your secret.

Constraints: The maximum length is 64 characters. The minimum length is 6 characters.

PasswordGenerationPolicy SmUsernamePasswordSecretPasswordGenerationPolicyArgs

Policy for auto-generated passwords. Nested scheme for password_generation_policy:

Region string

The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

Rotation SmUsernamePasswordSecretRotationArgs

Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:

SecretGroupId string

A UUID identifier, or default secret group.

Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.

SecretId string

The unique identifier of the UsernamePasswordSecret.

SecretType string

(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.

SmUsernamePasswordSecretId string

State float64

Constraints: Allowable values are: 0, 1, 2, 3, 5.

StateDescription string

(String) A text representation of the secret state.

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

UpdatedAt string

(String) The date when a resource was recently modified. The date format follows RFC 3339.

Username string

The username that is assigned to the secret.

Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[A-Za-z0-9+-=.]*/.

VersionCustomMetadata map[string]string

The secret version metadata that a user can customize.

VersionsTotal float64

(Integer) The number of versions of the secret.

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

createdAt String

(String) The date when a resource was created. The date format follows RFC 3339.

createdBy String

(String) The unique identifier that is associated with the entity that created the secret.

Constraints: The maximum length is 128 characters. The minimum length is 4 characters.

crn String

(String) A CRN that uniquely identifies an IBM Cloud resource.

Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

customMetadata Map<String,String>

The secret metadata that a user can customize.

description String

An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.

downloaded Boolean

(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.

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.

expirationDate String

The date a secret is expired. The date format follows RFC 3339.

instanceId String

The GUID of the Secrets Manager instance.

labels List<String>

Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.

locksTotal Double

(Integer) The number of locks of the secret.

Constraints: The maximum value is 1000. The minimum value is 0.

name String

The human-readable name of your secret.

Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.

nextRotationDate String

password String

The password that is assigned to the secret. If password is omitted, Secrets Manager generates a new random password for your secret.

Constraints: The maximum length is 64 characters. The minimum length is 6 characters.

passwordGenerationPolicy SmUsernamePasswordSecretPasswordGenerationPolicy

Policy for auto-generated passwords. Nested scheme for password_generation_policy:

region String

The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

rotation SmUsernamePasswordSecretRotation

Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:

secretGroupId String

A UUID identifier, or default secret group.

Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.

secretId String

The unique identifier of the UsernamePasswordSecret.

secretType String

(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.

smUsernamePasswordSecretId String

state Double

Constraints: Allowable values are: 0, 1, 2, 3, 5.

stateDescription String

(String) A text representation of the secret state.

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

updatedAt String

(String) The date when a resource was recently modified. The date format follows RFC 3339.

username String

The username that is assigned to the secret.

Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[A-Za-z0-9+-=.]*/.

versionCustomMetadata Map<String,String>

The secret version metadata that a user can customize.

versionsTotal Double

(Integer) The number of versions of the secret.

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

createdAt string

(String) The date when a resource was created. The date format follows RFC 3339.

createdBy string

(String) The unique identifier that is associated with the entity that created the secret.

Constraints: The maximum length is 128 characters. The minimum length is 4 characters.

crn string

(String) A CRN that uniquely identifies an IBM Cloud resource.

Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

customMetadata {[key: string]: string}

The secret metadata that a user can customize.

description string

An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.

downloaded boolean

(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.

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.

expirationDate string

The date a secret is expired. The date format follows RFC 3339.

instanceId string

The GUID of the Secrets Manager instance.

labels string[]

Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.

locksTotal number

(Integer) The number of locks of the secret.

Constraints: The maximum value is 1000. The minimum value is 0.

name string

The human-readable name of your secret.

Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.

nextRotationDate string

password string

The password that is assigned to the secret. If password is omitted, Secrets Manager generates a new random password for your secret.

Constraints: The maximum length is 64 characters. The minimum length is 6 characters.

passwordGenerationPolicy SmUsernamePasswordSecretPasswordGenerationPolicy

Policy for auto-generated passwords. Nested scheme for password_generation_policy:

region string

The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

rotation SmUsernamePasswordSecretRotation

Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:

secretGroupId string

A UUID identifier, or default secret group.

Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.

secretId string

The unique identifier of the UsernamePasswordSecret.

secretType string

(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.

smUsernamePasswordSecretId string

state number

Constraints: Allowable values are: 0, 1, 2, 3, 5.

stateDescription string

(String) A text representation of the secret state.

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

updatedAt string

(String) The date when a resource was recently modified. The date format follows RFC 3339.

username string

The username that is assigned to the secret.

Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[A-Za-z0-9+-=.]*/.

versionCustomMetadata {[key: string]: string}

The secret version metadata that a user can customize.

versionsTotal number

(Integer) The number of versions of the secret.

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

created_at str

(String) The date when a resource was created. The date format follows RFC 3339.

created_by str

(String) The unique identifier that is associated with the entity that created the secret.

Constraints: The maximum length is 128 characters. The minimum length is 4 characters.

crn str

(String) A CRN that uniquely identifies an IBM Cloud resource.

Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

custom_metadata Mapping[str, str]

The secret metadata that a user can customize.

description str

An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.

downloaded bool

(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.

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.

expiration_date str

The date a secret is expired. The date format follows RFC 3339.

instance_id str

The GUID of the Secrets Manager instance.

labels Sequence[str]

Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.

locks_total float

(Integer) The number of locks of the secret.

Constraints: The maximum value is 1000. The minimum value is 0.

name str

The human-readable name of your secret.

Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.

next_rotation_date str

password str

The password that is assigned to the secret. If password is omitted, Secrets Manager generates a new random password for your secret.

Constraints: The maximum length is 64 characters. The minimum length is 6 characters.

password_generation_policy SmUsernamePasswordSecretPasswordGenerationPolicyArgs

Policy for auto-generated passwords. Nested scheme for password_generation_policy:

region str

The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

rotation SmUsernamePasswordSecretRotationArgs

Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:

secret_group_id str

A UUID identifier, or default secret group.

Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.

secret_id str

The unique identifier of the UsernamePasswordSecret.

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.

sm_username_password_secret_id str

state float

Constraints: Allowable values are: 0, 1, 2, 3, 5.

state_description str

(String) A text representation of the secret state.

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

updated_at str

(String) The date when a resource was recently modified. The date format follows RFC 3339.

username str

The username that is assigned to the secret.

Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[A-Za-z0-9+-=.]*/.

version_custom_metadata Mapping[str, str]

The secret version metadata that a user can customize.

versions_total float

(Integer) The number of versions of the secret.

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

createdAt String

(String) The date when a resource was created. The date format follows RFC 3339.

createdBy String

(String) The unique identifier that is associated with the entity that created the secret.

Constraints: The maximum length is 128 characters. The minimum length is 4 characters.

crn String

(String) A CRN that uniquely identifies an IBM Cloud resource.

Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v0-9*+,;=@\/]|%[0-9A-Z]{2})*){8}$/.

customMetadata Map<String>

The secret metadata that a user can customize.

description String

An extended description of your secret.To protect your privacy, do not use personal data, such as your name or location, as a description for your secret group.

Constraints: The maximum length is 1024 characters. The minimum length is 0 characters. The value must match regular expression /(.*?)/.

downloaded Boolean

(Boolean) Indicates whether the secret data that is associated with a secret version was retrieved in a call to the service API.

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.

expirationDate String

The date a secret is expired. The date format follows RFC 3339.

instanceId String

The GUID of the Secrets Manager instance.

labels List<String>

Labels that you can use to search for secrets in your instance.Up to 30 labels can be created.

Constraints: The list items must match regular expression /(.*?)/. The maximum length is 30 items. The minimum length is 0 items.

locksTotal Number

(Integer) The number of locks of the secret.

Constraints: The maximum value is 1000. The minimum value is 0.

name String

The human-readable name of your secret.

Constraints: The maximum length is 256 characters. The minimum length is 2 characters. The value must match regular expression ^[A-Za-z0-9_][A-Za-z0-9_]*(?:_*-*\.*[A-Za-z0-9]*)*[A-Za-z0-9]+$.

nextRotationDate String

password String

The password that is assigned to the secret. If password is omitted, Secrets Manager generates a new random password for your secret.

Constraints: The maximum length is 64 characters. The minimum length is 6 characters.

passwordGenerationPolicy Property Map

Policy for auto-generated passwords. Nested scheme for password_generation_policy:

region String

The region of the Secrets Manager instance. If not provided defaults to the region defined in the IBM provider configuration.

rotation Property Map

Determines whether Secrets Manager rotates your secrets automatically. Nested scheme for rotation:

secretGroupId String

A UUID identifier, or default secret group.

Constraints: The maximum length is 36 characters. The minimum length is 7 characters. The value must match regular expression /^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|default)$/.

secretId String

The unique identifier of the UsernamePasswordSecret.

secretType String

(String) The secret type. Supported types are arbitrary, certificates (imported, public, and private), IAM credentials, key-value, and user credentials.

Constraints: Allowable values are: arbitrary, imported_cert, public_cert, iam_credentials, kv, username_password, private_cert.

smUsernamePasswordSecretId String

state Number

Constraints: Allowable values are: 0, 1, 2, 3, 5.

stateDescription String

(String) A text representation of the secret state.

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

updatedAt String

(String) The date when a resource was recently modified. The date format follows RFC 3339.

username String

The username that is assigned to the secret.

Constraints: The maximum length is 64 characters. The minimum length is 2 characters. The value must match regular expression /[A-Za-z0-9+-=.]*/.

versionCustomMetadata Map<String>

The secret version metadata that a user can customize.

versionsTotal Number

(Integer) The number of versions of the secret.

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

Supporting Types

SmUsernamePasswordSecretPasswordGenerationPolicy, SmUsernamePasswordSecretPasswordGenerationPolicyArgs

IncludeDigits bool

Include digits in auto-generated passwords. Default is true.

IncludeSymbols bool

Include symbols in auto-generated passwords. Default is true.

IncludeUppercase bool

Include uppercase letters in auto-generated passwords. Default is true.

Length double

The length of auto-generated passwords. Default is 32.

Constraints: The minimum value is 12. The maximum value is 256.

IncludeDigits bool

Include digits in auto-generated passwords. Default is true.

IncludeSymbols bool

Include symbols in auto-generated passwords. Default is true.

IncludeUppercase bool

Include uppercase letters in auto-generated passwords. Default is true.

Length float64

The length of auto-generated passwords. Default is 32.

Constraints: The minimum value is 12. The maximum value is 256.

includeDigits Boolean

Include digits in auto-generated passwords. Default is true.

includeSymbols Boolean

Include symbols in auto-generated passwords. Default is true.

includeUppercase Boolean

Include uppercase letters in auto-generated passwords. Default is true.

length Double

The length of auto-generated passwords. Default is 32.

Constraints: The minimum value is 12. The maximum value is 256.

includeDigits boolean

Include digits in auto-generated passwords. Default is true.

includeSymbols boolean

Include symbols in auto-generated passwords. Default is true.

includeUppercase boolean

Include uppercase letters in auto-generated passwords. Default is true.

length number

The length of auto-generated passwords. Default is 32.

Constraints: The minimum value is 12. The maximum value is 256.

include_digits bool

Include digits in auto-generated passwords. Default is true.

include_symbols bool

Include symbols in auto-generated passwords. Default is true.

include_uppercase bool

Include uppercase letters in auto-generated passwords. Default is true.

length float

The length of auto-generated passwords. Default is 32.

Constraints: The minimum value is 12. The maximum value is 256.

includeDigits Boolean

Include digits in auto-generated passwords. Default is true.

includeSymbols Boolean

Include symbols in auto-generated passwords. Default is true.

includeUppercase Boolean

Include uppercase letters in auto-generated passwords. Default is true.

length Number

The length of auto-generated passwords. Default is 32.

Constraints: The minimum value is 12. The maximum value is 256.

SmUsernamePasswordSecretRotation, SmUsernamePasswordSecretRotationArgs

AutoRotate bool

Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.

Interval double

The length of the secret rotation time interval.

Constraints: The minimum value is 1.

Unit string

The units for the secret rotation time interval.

Constraints: Allowable values are: day, month.

AutoRotate bool

Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.

Interval float64

The length of the secret rotation time interval.

Constraints: The minimum value is 1.

Unit string

The units for the secret rotation time interval.

Constraints: Allowable values are: day, month.

autoRotate Boolean

Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.

interval Double

The length of the secret rotation time interval.

Constraints: The minimum value is 1.

unit String

The units for the secret rotation time interval.

Constraints: Allowable values are: day, month.

autoRotate boolean

Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.

interval number

The length of the secret rotation time interval.

Constraints: The minimum value is 1.

unit string

The units for the secret rotation time interval.

Constraints: Allowable values are: day, month.

auto_rotate bool

Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.

interval float

The length of the secret rotation time interval.

Constraints: The minimum value is 1.

unit str

The units for the secret rotation time interval.

Constraints: Allowable values are: day, month.

autoRotate Boolean

Determines whether Secrets Manager rotates your secret automatically.Default is false. If auto_rotate is set to true the service rotates your secret based on the defined interval.

interval Number

The length of the secret rotation time interval.

Constraints: The minimum value is 1.

unit String

The units for the secret rotation time interval.

Constraints: Allowable values are: day, month.

Import

You can import the ibm_sm_username_password_secret resource by using region, instance_id, and secret_id.

For more information, see the documentation

Syntax

bash

$ pulumi import ibm:index/smUsernamePasswordSecret:SmUsernamePasswordSecret sm_username_password_secret <region>/<instance_id>/<secret_id>

Example

bash

$ pulumi import ibm:index/smUsernamePasswordSecret:SmUsernamePasswordSecret sm_username_password_secret us-east/6ebc4224-e983-496a-8a54-f40a0bfa9175/b49ad24d-81d4-5ebc-b9b9-b0937d1c84d5

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: ibm ibm-cloud/terraform-provider-ibm
License
Notes: This Pulumi package is based on the ibm Terraform Provider.

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

ibm-cloud/terraform-provider-ibm

ibm.SmUsernamePasswordSecret

On this page

On this page

Example Usage

Provider Configuration

Static credentials

Environment variables

Create SmUsernamePasswordSecret Resource

Constructor syntax

Parameters

Constructor example

SmUsernamePasswordSecret Resource Properties

Inputs

Outputs

Look up Existing SmUsernamePasswordSecret Resource

Supporting Types

SmUsernamePasswordSecretPasswordGenerationPolicy, SmUsernamePasswordSecretPasswordGenerationPolicyArgs

SmUsernamePasswordSecretRotation, SmUsernamePasswordSecretRotationArgs

Import

Package Details

On this page

On this page