1. Packages
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. DynamicSecretMongodb
Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community
Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

    Mongo DB dynamic secret resource

    Create DynamicSecretMongodb Resource

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

    Constructor syntax

    new DynamicSecretMongodb(name: string, args?: DynamicSecretMongodbArgs, opts?: CustomResourceOptions);
    @overload
    def DynamicSecretMongodb(resource_name: str,
                             args: Optional[DynamicSecretMongodbArgs] = None,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def DynamicSecretMongodb(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             custom_username_template: Optional[str] = None,
                             delete_protection: Optional[str] = None,
                             description: Optional[str] = None,
                             dynamic_secret_mongodb_id: Optional[str] = None,
                             encryption_key_name: Optional[str] = None,
                             item_custom_fields: Optional[Mapping[str, str]] = None,
                             mongodb_atlas_api_private_key: Optional[str] = None,
                             mongodb_atlas_api_public_key: Optional[str] = None,
                             mongodb_atlas_project_id: Optional[str] = None,
                             mongodb_custom_data: Optional[str] = None,
                             mongodb_default_auth_db: Optional[str] = None,
                             mongodb_host_port: Optional[str] = None,
                             mongodb_name: Optional[str] = None,
                             mongodb_password: Optional[str] = None,
                             mongodb_roles: Optional[str] = None,
                             mongodb_scopes: Optional[str] = None,
                             mongodb_server_uri: Optional[str] = None,
                             mongodb_uri_options: Optional[str] = None,
                             mongodb_username: Optional[str] = None,
                             name: Optional[str] = None,
                             password_length: Optional[str] = None,
                             secure_access_bastion_issuer: Optional[str] = None,
                             secure_access_certificate_issuer: Optional[str] = None,
                             secure_access_db_name: Optional[str] = None,
                             secure_access_delay: Optional[float] = None,
                             secure_access_enable: Optional[str] = None,
                             secure_access_hosts: Optional[Sequence[str]] = None,
                             secure_access_web: Optional[bool] = None,
                             tags: Optional[Sequence[str]] = None,
                             target_name: Optional[str] = None,
                             user_ttl: Optional[str] = None)
    func NewDynamicSecretMongodb(ctx *Context, name string, args *DynamicSecretMongodbArgs, opts ...ResourceOption) (*DynamicSecretMongodb, error)
    public DynamicSecretMongodb(string name, DynamicSecretMongodbArgs? args = null, CustomResourceOptions? opts = null)
    public DynamicSecretMongodb(String name, DynamicSecretMongodbArgs args)
    public DynamicSecretMongodb(String name, DynamicSecretMongodbArgs args, CustomResourceOptions options)
    
    type: akeyless:DynamicSecretMongodb
    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 DynamicSecretMongodbArgs
    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 DynamicSecretMongodbArgs
    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 DynamicSecretMongodbArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DynamicSecretMongodbArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DynamicSecretMongodbArgs
    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 dynamicSecretMongodbResource = new Akeyless.DynamicSecretMongodb("dynamicSecretMongodbResource", new()
    {
        CustomUsernameTemplate = "string",
        DeleteProtection = "string",
        Description = "string",
        DynamicSecretMongodbId = "string",
        EncryptionKeyName = "string",
        ItemCustomFields = 
        {
            { "string", "string" },
        },
        MongodbAtlasApiPrivateKey = "string",
        MongodbAtlasApiPublicKey = "string",
        MongodbAtlasProjectId = "string",
        MongodbCustomData = "string",
        MongodbDefaultAuthDb = "string",
        MongodbHostPort = "string",
        MongodbName = "string",
        MongodbPassword = "string",
        MongodbRoles = "string",
        MongodbScopes = "string",
        MongodbServerUri = "string",
        MongodbUriOptions = "string",
        MongodbUsername = "string",
        Name = "string",
        PasswordLength = "string",
        SecureAccessCertificateIssuer = "string",
        SecureAccessDbName = "string",
        SecureAccessDelay = 0,
        SecureAccessEnable = "string",
        SecureAccessHosts = new[]
        {
            "string",
        },
        SecureAccessWeb = false,
        Tags = new[]
        {
            "string",
        },
        TargetName = "string",
        UserTtl = "string",
    });
    
    example, err := akeyless.NewDynamicSecretMongodb(ctx, "dynamicSecretMongodbResource", &akeyless.DynamicSecretMongodbArgs{
    	CustomUsernameTemplate: pulumi.String("string"),
    	DeleteProtection:       pulumi.String("string"),
    	Description:            pulumi.String("string"),
    	DynamicSecretMongodbId: pulumi.String("string"),
    	EncryptionKeyName:      pulumi.String("string"),
    	ItemCustomFields: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	MongodbAtlasApiPrivateKey:     pulumi.String("string"),
    	MongodbAtlasApiPublicKey:      pulumi.String("string"),
    	MongodbAtlasProjectId:         pulumi.String("string"),
    	MongodbCustomData:             pulumi.String("string"),
    	MongodbDefaultAuthDb:          pulumi.String("string"),
    	MongodbHostPort:               pulumi.String("string"),
    	MongodbName:                   pulumi.String("string"),
    	MongodbPassword:               pulumi.String("string"),
    	MongodbRoles:                  pulumi.String("string"),
    	MongodbScopes:                 pulumi.String("string"),
    	MongodbServerUri:              pulumi.String("string"),
    	MongodbUriOptions:             pulumi.String("string"),
    	MongodbUsername:               pulumi.String("string"),
    	Name:                          pulumi.String("string"),
    	PasswordLength:                pulumi.String("string"),
    	SecureAccessCertificateIssuer: pulumi.String("string"),
    	SecureAccessDbName:            pulumi.String("string"),
    	SecureAccessDelay:             pulumi.Float64(0),
    	SecureAccessEnable:            pulumi.String("string"),
    	SecureAccessHosts: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	SecureAccessWeb: pulumi.Bool(false),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	TargetName: pulumi.String("string"),
    	UserTtl:    pulumi.String("string"),
    })
    
    var dynamicSecretMongodbResource = new DynamicSecretMongodb("dynamicSecretMongodbResource", DynamicSecretMongodbArgs.builder()
        .customUsernameTemplate("string")
        .deleteProtection("string")
        .description("string")
        .dynamicSecretMongodbId("string")
        .encryptionKeyName("string")
        .itemCustomFields(Map.of("string", "string"))
        .mongodbAtlasApiPrivateKey("string")
        .mongodbAtlasApiPublicKey("string")
        .mongodbAtlasProjectId("string")
        .mongodbCustomData("string")
        .mongodbDefaultAuthDb("string")
        .mongodbHostPort("string")
        .mongodbName("string")
        .mongodbPassword("string")
        .mongodbRoles("string")
        .mongodbScopes("string")
        .mongodbServerUri("string")
        .mongodbUriOptions("string")
        .mongodbUsername("string")
        .name("string")
        .passwordLength("string")
        .secureAccessCertificateIssuer("string")
        .secureAccessDbName("string")
        .secureAccessDelay(0.0)
        .secureAccessEnable("string")
        .secureAccessHosts("string")
        .secureAccessWeb(false)
        .tags("string")
        .targetName("string")
        .userTtl("string")
        .build());
    
    dynamic_secret_mongodb_resource = akeyless.DynamicSecretMongodb("dynamicSecretMongodbResource",
        custom_username_template="string",
        delete_protection="string",
        description="string",
        dynamic_secret_mongodb_id="string",
        encryption_key_name="string",
        item_custom_fields={
            "string": "string",
        },
        mongodb_atlas_api_private_key="string",
        mongodb_atlas_api_public_key="string",
        mongodb_atlas_project_id="string",
        mongodb_custom_data="string",
        mongodb_default_auth_db="string",
        mongodb_host_port="string",
        mongodb_name="string",
        mongodb_password="string",
        mongodb_roles="string",
        mongodb_scopes="string",
        mongodb_server_uri="string",
        mongodb_uri_options="string",
        mongodb_username="string",
        name="string",
        password_length="string",
        secure_access_certificate_issuer="string",
        secure_access_db_name="string",
        secure_access_delay=float(0),
        secure_access_enable="string",
        secure_access_hosts=["string"],
        secure_access_web=False,
        tags=["string"],
        target_name="string",
        user_ttl="string")
    
    const dynamicSecretMongodbResource = new akeyless.DynamicSecretMongodb("dynamicSecretMongodbResource", {
        customUsernameTemplate: "string",
        deleteProtection: "string",
        description: "string",
        dynamicSecretMongodbId: "string",
        encryptionKeyName: "string",
        itemCustomFields: {
            string: "string",
        },
        mongodbAtlasApiPrivateKey: "string",
        mongodbAtlasApiPublicKey: "string",
        mongodbAtlasProjectId: "string",
        mongodbCustomData: "string",
        mongodbDefaultAuthDb: "string",
        mongodbHostPort: "string",
        mongodbName: "string",
        mongodbPassword: "string",
        mongodbRoles: "string",
        mongodbScopes: "string",
        mongodbServerUri: "string",
        mongodbUriOptions: "string",
        mongodbUsername: "string",
        name: "string",
        passwordLength: "string",
        secureAccessCertificateIssuer: "string",
        secureAccessDbName: "string",
        secureAccessDelay: 0,
        secureAccessEnable: "string",
        secureAccessHosts: ["string"],
        secureAccessWeb: false,
        tags: ["string"],
        targetName: "string",
        userTtl: "string",
    });
    
    type: akeyless:DynamicSecretMongodb
    properties:
        customUsernameTemplate: string
        deleteProtection: string
        description: string
        dynamicSecretMongodbId: string
        encryptionKeyName: string
        itemCustomFields:
            string: string
        mongodbAtlasApiPrivateKey: string
        mongodbAtlasApiPublicKey: string
        mongodbAtlasProjectId: string
        mongodbCustomData: string
        mongodbDefaultAuthDb: string
        mongodbHostPort: string
        mongodbName: string
        mongodbPassword: string
        mongodbRoles: string
        mongodbScopes: string
        mongodbServerUri: string
        mongodbUriOptions: string
        mongodbUsername: string
        name: string
        passwordLength: string
        secureAccessCertificateIssuer: string
        secureAccessDbName: string
        secureAccessDelay: 0
        secureAccessEnable: string
        secureAccessHosts:
            - string
        secureAccessWeb: false
        tags:
            - string
        targetName: string
        userTtl: string
    

    DynamicSecretMongodb 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 DynamicSecretMongodb resource accepts the following input properties:

    CustomUsernameTemplate string
    Customize how temporary usernames are generated using go template
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    DynamicSecretMongodbId string
    The ID of this resource.
    EncryptionKeyName string
    Encrypt producer with following key
    ItemCustomFields Dictionary<string, string>
    Additional custom fields to associate with the item
    MongodbAtlasApiPrivateKey string
    MongoDB Atlas private key
    MongodbAtlasApiPublicKey string
    MongoDB Atlas public key
    MongodbAtlasProjectId string
    MongoDB Atlas project ID
    MongodbCustomData string
    MongoDB custom data
    MongodbDefaultAuthDb string
    MongoDB server default authentication database
    MongodbHostPort string
    MongoDB server host and port
    MongodbName string
    MongoDB Name
    MongodbPassword string
    MongoDB server password. You will prompted to provide a password if it will not appear in CLI parameters
    MongodbRoles string
    MongoDB Roles
    MongodbScopes string
    MongoDB Scopes (Atlas only)
    MongodbServerUri string
    MongoDB server URI
    MongodbUriOptions string
    MongoDB server URI options
    MongodbUsername string
    MongoDB server username
    Name string
    Dynamic secret name
    PasswordLength string
    The length of the password to be generated
    SecureAccessBastionIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Bastion

    Deprecated: Deprecated

    SecureAccessCertificateIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    SecureAccessDbName string
    The DB name
    SecureAccessDelay double
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    SecureAccessEnable string
    Enable/Disable secure remote access, [true/false]
    SecureAccessHosts List<string>
    Target DB servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts)
    SecureAccessWeb bool
    Enable Web Secure Remote Access
    Tags List<string>
    Add tags attached to this object
    TargetName string
    Target name
    UserTtl string
    User TTL (e.g. 60s, 60m, 60h)
    CustomUsernameTemplate string
    Customize how temporary usernames are generated using go template
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    DynamicSecretMongodbId string
    The ID of this resource.
    EncryptionKeyName string
    Encrypt producer with following key
    ItemCustomFields map[string]string
    Additional custom fields to associate with the item
    MongodbAtlasApiPrivateKey string
    MongoDB Atlas private key
    MongodbAtlasApiPublicKey string
    MongoDB Atlas public key
    MongodbAtlasProjectId string
    MongoDB Atlas project ID
    MongodbCustomData string
    MongoDB custom data
    MongodbDefaultAuthDb string
    MongoDB server default authentication database
    MongodbHostPort string
    MongoDB server host and port
    MongodbName string
    MongoDB Name
    MongodbPassword string
    MongoDB server password. You will prompted to provide a password if it will not appear in CLI parameters
    MongodbRoles string
    MongoDB Roles
    MongodbScopes string
    MongoDB Scopes (Atlas only)
    MongodbServerUri string
    MongoDB server URI
    MongodbUriOptions string
    MongoDB server URI options
    MongodbUsername string
    MongoDB server username
    Name string
    Dynamic secret name
    PasswordLength string
    The length of the password to be generated
    SecureAccessBastionIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Bastion

    Deprecated: Deprecated

    SecureAccessCertificateIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    SecureAccessDbName string
    The DB name
    SecureAccessDelay float64
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    SecureAccessEnable string
    Enable/Disable secure remote access, [true/false]
    SecureAccessHosts []string
    Target DB servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts)
    SecureAccessWeb bool
    Enable Web Secure Remote Access
    Tags []string
    Add tags attached to this object
    TargetName string
    Target name
    UserTtl string
    User TTL (e.g. 60s, 60m, 60h)
    customUsernameTemplate String
    Customize how temporary usernames are generated using go template
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    dynamicSecretMongodbId String
    The ID of this resource.
    encryptionKeyName String
    Encrypt producer with following key
    itemCustomFields Map<String,String>
    Additional custom fields to associate with the item
    mongodbAtlasApiPrivateKey String
    MongoDB Atlas private key
    mongodbAtlasApiPublicKey String
    MongoDB Atlas public key
    mongodbAtlasProjectId String
    MongoDB Atlas project ID
    mongodbCustomData String
    MongoDB custom data
    mongodbDefaultAuthDb String
    MongoDB server default authentication database
    mongodbHostPort String
    MongoDB server host and port
    mongodbName String
    MongoDB Name
    mongodbPassword String
    MongoDB server password. You will prompted to provide a password if it will not appear in CLI parameters
    mongodbRoles String
    MongoDB Roles
    mongodbScopes String
    MongoDB Scopes (Atlas only)
    mongodbServerUri String
    MongoDB server URI
    mongodbUriOptions String
    MongoDB server URI options
    mongodbUsername String
    MongoDB server username
    name String
    Dynamic secret name
    passwordLength String
    The length of the password to be generated
    secureAccessBastionIssuer String
    Path to the SSH Certificate Issuer for your Akeyless Bastion

    Deprecated: Deprecated

    secureAccessCertificateIssuer String
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secureAccessDbName String
    The DB name
    secureAccessDelay Double
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    secureAccessEnable String
    Enable/Disable secure remote access, [true/false]
    secureAccessHosts List<String>
    Target DB servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts)
    secureAccessWeb Boolean
    Enable Web Secure Remote Access
    tags List<String>
    Add tags attached to this object
    targetName String
    Target name
    userTtl String
    User TTL (e.g. 60s, 60m, 60h)
    customUsernameTemplate string
    Customize how temporary usernames are generated using go template
    deleteProtection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    dynamicSecretMongodbId string
    The ID of this resource.
    encryptionKeyName string
    Encrypt producer with following key
    itemCustomFields {[key: string]: string}
    Additional custom fields to associate with the item
    mongodbAtlasApiPrivateKey string
    MongoDB Atlas private key
    mongodbAtlasApiPublicKey string
    MongoDB Atlas public key
    mongodbAtlasProjectId string
    MongoDB Atlas project ID
    mongodbCustomData string
    MongoDB custom data
    mongodbDefaultAuthDb string
    MongoDB server default authentication database
    mongodbHostPort string
    MongoDB server host and port
    mongodbName string
    MongoDB Name
    mongodbPassword string
    MongoDB server password. You will prompted to provide a password if it will not appear in CLI parameters
    mongodbRoles string
    MongoDB Roles
    mongodbScopes string
    MongoDB Scopes (Atlas only)
    mongodbServerUri string
    MongoDB server URI
    mongodbUriOptions string
    MongoDB server URI options
    mongodbUsername string
    MongoDB server username
    name string
    Dynamic secret name
    passwordLength string
    The length of the password to be generated
    secureAccessBastionIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Bastion

    Deprecated: Deprecated

    secureAccessCertificateIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secureAccessDbName string
    The DB name
    secureAccessDelay number
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    secureAccessEnable string
    Enable/Disable secure remote access, [true/false]
    secureAccessHosts string[]
    Target DB servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts)
    secureAccessWeb boolean
    Enable Web Secure Remote Access
    tags string[]
    Add tags attached to this object
    targetName string
    Target name
    userTtl string
    User TTL (e.g. 60s, 60m, 60h)
    custom_username_template str
    Customize how temporary usernames are generated using go template
    delete_protection str
    Protection from accidental deletion of this object [true/false]
    description str
    Description of the object
    dynamic_secret_mongodb_id str
    The ID of this resource.
    encryption_key_name str
    Encrypt producer with following key
    item_custom_fields Mapping[str, str]
    Additional custom fields to associate with the item
    mongodb_atlas_api_private_key str
    MongoDB Atlas private key
    mongodb_atlas_api_public_key str
    MongoDB Atlas public key
    mongodb_atlas_project_id str
    MongoDB Atlas project ID
    mongodb_custom_data str
    MongoDB custom data
    mongodb_default_auth_db str
    MongoDB server default authentication database
    mongodb_host_port str
    MongoDB server host and port
    mongodb_name str
    MongoDB Name
    mongodb_password str
    MongoDB server password. You will prompted to provide a password if it will not appear in CLI parameters
    mongodb_roles str
    MongoDB Roles
    mongodb_scopes str
    MongoDB Scopes (Atlas only)
    mongodb_server_uri str
    MongoDB server URI
    mongodb_uri_options str
    MongoDB server URI options
    mongodb_username str
    MongoDB server username
    name str
    Dynamic secret name
    password_length str
    The length of the password to be generated
    secure_access_bastion_issuer str
    Path to the SSH Certificate Issuer for your Akeyless Bastion

    Deprecated: Deprecated

    secure_access_certificate_issuer str
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secure_access_db_name str
    The DB name
    secure_access_delay float
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    secure_access_enable str
    Enable/Disable secure remote access, [true/false]
    secure_access_hosts Sequence[str]
    Target DB servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts)
    secure_access_web bool
    Enable Web Secure Remote Access
    tags Sequence[str]
    Add tags attached to this object
    target_name str
    Target name
    user_ttl str
    User TTL (e.g. 60s, 60m, 60h)
    customUsernameTemplate String
    Customize how temporary usernames are generated using go template
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    dynamicSecretMongodbId String
    The ID of this resource.
    encryptionKeyName String
    Encrypt producer with following key
    itemCustomFields Map<String>
    Additional custom fields to associate with the item
    mongodbAtlasApiPrivateKey String
    MongoDB Atlas private key
    mongodbAtlasApiPublicKey String
    MongoDB Atlas public key
    mongodbAtlasProjectId String
    MongoDB Atlas project ID
    mongodbCustomData String
    MongoDB custom data
    mongodbDefaultAuthDb String
    MongoDB server default authentication database
    mongodbHostPort String
    MongoDB server host and port
    mongodbName String
    MongoDB Name
    mongodbPassword String
    MongoDB server password. You will prompted to provide a password if it will not appear in CLI parameters
    mongodbRoles String
    MongoDB Roles
    mongodbScopes String
    MongoDB Scopes (Atlas only)
    mongodbServerUri String
    MongoDB server URI
    mongodbUriOptions String
    MongoDB server URI options
    mongodbUsername String
    MongoDB server username
    name String
    Dynamic secret name
    passwordLength String
    The length of the password to be generated
    secureAccessBastionIssuer String
    Path to the SSH Certificate Issuer for your Akeyless Bastion

    Deprecated: Deprecated

    secureAccessCertificateIssuer String
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secureAccessDbName String
    The DB name
    secureAccessDelay Number
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    secureAccessEnable String
    Enable/Disable secure remote access, [true/false]
    secureAccessHosts List<String>
    Target DB servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts)
    secureAccessWeb Boolean
    Enable Web Secure Remote Access
    tags List<String>
    Add tags attached to this object
    targetName String
    Target name
    userTtl String
    User TTL (e.g. 60s, 60m, 60h)

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DynamicSecretMongodb Resource

    Get an existing DynamicSecretMongodb 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?: DynamicSecretMongodbState, opts?: CustomResourceOptions): DynamicSecretMongodb
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            custom_username_template: Optional[str] = None,
            delete_protection: Optional[str] = None,
            description: Optional[str] = None,
            dynamic_secret_mongodb_id: Optional[str] = None,
            encryption_key_name: Optional[str] = None,
            item_custom_fields: Optional[Mapping[str, str]] = None,
            mongodb_atlas_api_private_key: Optional[str] = None,
            mongodb_atlas_api_public_key: Optional[str] = None,
            mongodb_atlas_project_id: Optional[str] = None,
            mongodb_custom_data: Optional[str] = None,
            mongodb_default_auth_db: Optional[str] = None,
            mongodb_host_port: Optional[str] = None,
            mongodb_name: Optional[str] = None,
            mongodb_password: Optional[str] = None,
            mongodb_roles: Optional[str] = None,
            mongodb_scopes: Optional[str] = None,
            mongodb_server_uri: Optional[str] = None,
            mongodb_uri_options: Optional[str] = None,
            mongodb_username: Optional[str] = None,
            name: Optional[str] = None,
            password_length: Optional[str] = None,
            secure_access_bastion_issuer: Optional[str] = None,
            secure_access_certificate_issuer: Optional[str] = None,
            secure_access_db_name: Optional[str] = None,
            secure_access_delay: Optional[float] = None,
            secure_access_enable: Optional[str] = None,
            secure_access_hosts: Optional[Sequence[str]] = None,
            secure_access_web: Optional[bool] = None,
            tags: Optional[Sequence[str]] = None,
            target_name: Optional[str] = None,
            user_ttl: Optional[str] = None) -> DynamicSecretMongodb
    func GetDynamicSecretMongodb(ctx *Context, name string, id IDInput, state *DynamicSecretMongodbState, opts ...ResourceOption) (*DynamicSecretMongodb, error)
    public static DynamicSecretMongodb Get(string name, Input<string> id, DynamicSecretMongodbState? state, CustomResourceOptions? opts = null)
    public static DynamicSecretMongodb get(String name, Output<String> id, DynamicSecretMongodbState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:DynamicSecretMongodb    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:
    CustomUsernameTemplate string
    Customize how temporary usernames are generated using go template
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    DynamicSecretMongodbId string
    The ID of this resource.
    EncryptionKeyName string
    Encrypt producer with following key
    ItemCustomFields Dictionary<string, string>
    Additional custom fields to associate with the item
    MongodbAtlasApiPrivateKey string
    MongoDB Atlas private key
    MongodbAtlasApiPublicKey string
    MongoDB Atlas public key
    MongodbAtlasProjectId string
    MongoDB Atlas project ID
    MongodbCustomData string
    MongoDB custom data
    MongodbDefaultAuthDb string
    MongoDB server default authentication database
    MongodbHostPort string
    MongoDB server host and port
    MongodbName string
    MongoDB Name
    MongodbPassword string
    MongoDB server password. You will prompted to provide a password if it will not appear in CLI parameters
    MongodbRoles string
    MongoDB Roles
    MongodbScopes string
    MongoDB Scopes (Atlas only)
    MongodbServerUri string
    MongoDB server URI
    MongodbUriOptions string
    MongoDB server URI options
    MongodbUsername string
    MongoDB server username
    Name string
    Dynamic secret name
    PasswordLength string
    The length of the password to be generated
    SecureAccessBastionIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Bastion

    Deprecated: Deprecated

    SecureAccessCertificateIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    SecureAccessDbName string
    The DB name
    SecureAccessDelay double
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    SecureAccessEnable string
    Enable/Disable secure remote access, [true/false]
    SecureAccessHosts List<string>
    Target DB servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts)
    SecureAccessWeb bool
    Enable Web Secure Remote Access
    Tags List<string>
    Add tags attached to this object
    TargetName string
    Target name
    UserTtl string
    User TTL (e.g. 60s, 60m, 60h)
    CustomUsernameTemplate string
    Customize how temporary usernames are generated using go template
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    DynamicSecretMongodbId string
    The ID of this resource.
    EncryptionKeyName string
    Encrypt producer with following key
    ItemCustomFields map[string]string
    Additional custom fields to associate with the item
    MongodbAtlasApiPrivateKey string
    MongoDB Atlas private key
    MongodbAtlasApiPublicKey string
    MongoDB Atlas public key
    MongodbAtlasProjectId string
    MongoDB Atlas project ID
    MongodbCustomData string
    MongoDB custom data
    MongodbDefaultAuthDb string
    MongoDB server default authentication database
    MongodbHostPort string
    MongoDB server host and port
    MongodbName string
    MongoDB Name
    MongodbPassword string
    MongoDB server password. You will prompted to provide a password if it will not appear in CLI parameters
    MongodbRoles string
    MongoDB Roles
    MongodbScopes string
    MongoDB Scopes (Atlas only)
    MongodbServerUri string
    MongoDB server URI
    MongodbUriOptions string
    MongoDB server URI options
    MongodbUsername string
    MongoDB server username
    Name string
    Dynamic secret name
    PasswordLength string
    The length of the password to be generated
    SecureAccessBastionIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Bastion

    Deprecated: Deprecated

    SecureAccessCertificateIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    SecureAccessDbName string
    The DB name
    SecureAccessDelay float64
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    SecureAccessEnable string
    Enable/Disable secure remote access, [true/false]
    SecureAccessHosts []string
    Target DB servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts)
    SecureAccessWeb bool
    Enable Web Secure Remote Access
    Tags []string
    Add tags attached to this object
    TargetName string
    Target name
    UserTtl string
    User TTL (e.g. 60s, 60m, 60h)
    customUsernameTemplate String
    Customize how temporary usernames are generated using go template
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    dynamicSecretMongodbId String
    The ID of this resource.
    encryptionKeyName String
    Encrypt producer with following key
    itemCustomFields Map<String,String>
    Additional custom fields to associate with the item
    mongodbAtlasApiPrivateKey String
    MongoDB Atlas private key
    mongodbAtlasApiPublicKey String
    MongoDB Atlas public key
    mongodbAtlasProjectId String
    MongoDB Atlas project ID
    mongodbCustomData String
    MongoDB custom data
    mongodbDefaultAuthDb String
    MongoDB server default authentication database
    mongodbHostPort String
    MongoDB server host and port
    mongodbName String
    MongoDB Name
    mongodbPassword String
    MongoDB server password. You will prompted to provide a password if it will not appear in CLI parameters
    mongodbRoles String
    MongoDB Roles
    mongodbScopes String
    MongoDB Scopes (Atlas only)
    mongodbServerUri String
    MongoDB server URI
    mongodbUriOptions String
    MongoDB server URI options
    mongodbUsername String
    MongoDB server username
    name String
    Dynamic secret name
    passwordLength String
    The length of the password to be generated
    secureAccessBastionIssuer String
    Path to the SSH Certificate Issuer for your Akeyless Bastion

    Deprecated: Deprecated

    secureAccessCertificateIssuer String
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secureAccessDbName String
    The DB name
    secureAccessDelay Double
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    secureAccessEnable String
    Enable/Disable secure remote access, [true/false]
    secureAccessHosts List<String>
    Target DB servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts)
    secureAccessWeb Boolean
    Enable Web Secure Remote Access
    tags List<String>
    Add tags attached to this object
    targetName String
    Target name
    userTtl String
    User TTL (e.g. 60s, 60m, 60h)
    customUsernameTemplate string
    Customize how temporary usernames are generated using go template
    deleteProtection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    dynamicSecretMongodbId string
    The ID of this resource.
    encryptionKeyName string
    Encrypt producer with following key
    itemCustomFields {[key: string]: string}
    Additional custom fields to associate with the item
    mongodbAtlasApiPrivateKey string
    MongoDB Atlas private key
    mongodbAtlasApiPublicKey string
    MongoDB Atlas public key
    mongodbAtlasProjectId string
    MongoDB Atlas project ID
    mongodbCustomData string
    MongoDB custom data
    mongodbDefaultAuthDb string
    MongoDB server default authentication database
    mongodbHostPort string
    MongoDB server host and port
    mongodbName string
    MongoDB Name
    mongodbPassword string
    MongoDB server password. You will prompted to provide a password if it will not appear in CLI parameters
    mongodbRoles string
    MongoDB Roles
    mongodbScopes string
    MongoDB Scopes (Atlas only)
    mongodbServerUri string
    MongoDB server URI
    mongodbUriOptions string
    MongoDB server URI options
    mongodbUsername string
    MongoDB server username
    name string
    Dynamic secret name
    passwordLength string
    The length of the password to be generated
    secureAccessBastionIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Bastion

    Deprecated: Deprecated

    secureAccessCertificateIssuer string
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secureAccessDbName string
    The DB name
    secureAccessDelay number
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    secureAccessEnable string
    Enable/Disable secure remote access, [true/false]
    secureAccessHosts string[]
    Target DB servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts)
    secureAccessWeb boolean
    Enable Web Secure Remote Access
    tags string[]
    Add tags attached to this object
    targetName string
    Target name
    userTtl string
    User TTL (e.g. 60s, 60m, 60h)
    custom_username_template str
    Customize how temporary usernames are generated using go template
    delete_protection str
    Protection from accidental deletion of this object [true/false]
    description str
    Description of the object
    dynamic_secret_mongodb_id str
    The ID of this resource.
    encryption_key_name str
    Encrypt producer with following key
    item_custom_fields Mapping[str, str]
    Additional custom fields to associate with the item
    mongodb_atlas_api_private_key str
    MongoDB Atlas private key
    mongodb_atlas_api_public_key str
    MongoDB Atlas public key
    mongodb_atlas_project_id str
    MongoDB Atlas project ID
    mongodb_custom_data str
    MongoDB custom data
    mongodb_default_auth_db str
    MongoDB server default authentication database
    mongodb_host_port str
    MongoDB server host and port
    mongodb_name str
    MongoDB Name
    mongodb_password str
    MongoDB server password. You will prompted to provide a password if it will not appear in CLI parameters
    mongodb_roles str
    MongoDB Roles
    mongodb_scopes str
    MongoDB Scopes (Atlas only)
    mongodb_server_uri str
    MongoDB server URI
    mongodb_uri_options str
    MongoDB server URI options
    mongodb_username str
    MongoDB server username
    name str
    Dynamic secret name
    password_length str
    The length of the password to be generated
    secure_access_bastion_issuer str
    Path to the SSH Certificate Issuer for your Akeyless Bastion

    Deprecated: Deprecated

    secure_access_certificate_issuer str
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secure_access_db_name str
    The DB name
    secure_access_delay float
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    secure_access_enable str
    Enable/Disable secure remote access, [true/false]
    secure_access_hosts Sequence[str]
    Target DB servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts)
    secure_access_web bool
    Enable Web Secure Remote Access
    tags Sequence[str]
    Add tags attached to this object
    target_name str
    Target name
    user_ttl str
    User TTL (e.g. 60s, 60m, 60h)
    customUsernameTemplate String
    Customize how temporary usernames are generated using go template
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    dynamicSecretMongodbId String
    The ID of this resource.
    encryptionKeyName String
    Encrypt producer with following key
    itemCustomFields Map<String>
    Additional custom fields to associate with the item
    mongodbAtlasApiPrivateKey String
    MongoDB Atlas private key
    mongodbAtlasApiPublicKey String
    MongoDB Atlas public key
    mongodbAtlasProjectId String
    MongoDB Atlas project ID
    mongodbCustomData String
    MongoDB custom data
    mongodbDefaultAuthDb String
    MongoDB server default authentication database
    mongodbHostPort String
    MongoDB server host and port
    mongodbName String
    MongoDB Name
    mongodbPassword String
    MongoDB server password. You will prompted to provide a password if it will not appear in CLI parameters
    mongodbRoles String
    MongoDB Roles
    mongodbScopes String
    MongoDB Scopes (Atlas only)
    mongodbServerUri String
    MongoDB server URI
    mongodbUriOptions String
    MongoDB server URI options
    mongodbUsername String
    MongoDB server username
    name String
    Dynamic secret name
    passwordLength String
    The length of the password to be generated
    secureAccessBastionIssuer String
    Path to the SSH Certificate Issuer for your Akeyless Bastion

    Deprecated: Deprecated

    secureAccessCertificateIssuer String
    Path to the SSH Certificate Issuer for your Akeyless Secure Access
    secureAccessDbName String
    The DB name
    secureAccessDelay Number
    The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
    secureAccessEnable String
    Enable/Disable secure remote access, [true/false]
    secureAccessHosts List<String>
    Target DB servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts)
    secureAccessWeb Boolean
    Enable Web Secure Remote Access
    tags List<String>
    Add tags attached to this object
    targetName String
    Target name
    userTtl String
    User TTL (e.g. 60s, 60m, 60h)

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    Viewing docs for akeyless 2.0.1
    published on Monday, Apr 27, 2026 by akeyless-community
      Try Pulumi Cloud free. Your team will thank you.