1. Packages
  2. HashiCorp Vault Provider
  3. API Docs
  4. mongodbatlas
  5. SecretBackend
HashiCorp Vault v7.7.0 published on Friday, Feb 6, 2026 by Pulumi
vault logo
HashiCorp Vault v7.7.0 published on Friday, Feb 6, 2026 by Pulumi

    Import

    MongoDB Atlas secret backends can be imported using the ${mount}/config, e.g.

    $ pulumi import vault:mongodbatlas/secretBackend:SecretBackend config mongodbatlas/config
    

    Create SecretBackend Resource

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

    Constructor syntax

    new SecretBackend(name: string, args: SecretBackendArgs, opts?: CustomResourceOptions);
    @overload
    def SecretBackend(resource_name: str,
                      args: SecretBackendArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def SecretBackend(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      mount: Optional[str] = None,
                      public_key: Optional[str] = None,
                      namespace: Optional[str] = None,
                      private_key: Optional[str] = None,
                      private_key_wo: Optional[str] = None,
                      private_key_wo_version: Optional[int] = None)
    func NewSecretBackend(ctx *Context, name string, args SecretBackendArgs, opts ...ResourceOption) (*SecretBackend, error)
    public SecretBackend(string name, SecretBackendArgs args, CustomResourceOptions? opts = null)
    public SecretBackend(String name, SecretBackendArgs args)
    public SecretBackend(String name, SecretBackendArgs args, CustomResourceOptions options)
    
    type: vault:mongodbatlas:SecretBackend
    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 SecretBackendArgs
    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 SecretBackendArgs
    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 SecretBackendArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SecretBackendArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SecretBackendArgs
    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 examplesecretBackendResourceResourceFromMongodbatlassecretBackend = new Vault.MongoDBAtlas.SecretBackend("examplesecretBackendResourceResourceFromMongodbatlassecretBackend", new()
    {
        Mount = "string",
        PublicKey = "string",
        Namespace = "string",
        PrivateKey = "string",
        PrivateKeyWo = "string",
        PrivateKeyWoVersion = 0,
    });
    
    example, err := mongodbatlas.NewSecretBackend(ctx, "examplesecretBackendResourceResourceFromMongodbatlassecretBackend", &mongodbatlas.SecretBackendArgs{
    	Mount:               pulumi.String("string"),
    	PublicKey:           pulumi.String("string"),
    	Namespace:           pulumi.String("string"),
    	PrivateKey:          pulumi.String("string"),
    	PrivateKeyWo:        pulumi.String("string"),
    	PrivateKeyWoVersion: pulumi.Int(0),
    })
    
    var examplesecretBackendResourceResourceFromMongodbatlassecretBackend = new com.pulumi.vault.mongodbatlas.SecretBackend("examplesecretBackendResourceResourceFromMongodbatlassecretBackend", com.pulumi.vault.mongodbatlas.SecretBackendArgs.builder()
        .mount("string")
        .publicKey("string")
        .namespace("string")
        .privateKey("string")
        .privateKeyWo("string")
        .privateKeyWoVersion(0)
        .build());
    
    examplesecret_backend_resource_resource_from_mongodbatlassecret_backend = vault.mongodbatlas.SecretBackend("examplesecretBackendResourceResourceFromMongodbatlassecretBackend",
        mount="string",
        public_key="string",
        namespace="string",
        private_key="string",
        private_key_wo="string",
        private_key_wo_version=0)
    
    const examplesecretBackendResourceResourceFromMongodbatlassecretBackend = new vault.mongodbatlas.SecretBackend("examplesecretBackendResourceResourceFromMongodbatlassecretBackend", {
        mount: "string",
        publicKey: "string",
        namespace: "string",
        privateKey: "string",
        privateKeyWo: "string",
        privateKeyWoVersion: 0,
    });
    
    type: vault:mongodbatlas:SecretBackend
    properties:
        mount: string
        namespace: string
        privateKey: string
        privateKeyWo: string
        privateKeyWoVersion: 0
        publicKey: string
    

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

    Mount string
    Path where the MongoDB Atlas Secrets Engine is mounted.
    PublicKey string
    Specifies the Public API Key used to authenticate with the MongoDB Atlas API.
    Namespace string
    The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
    PrivateKey string
    The Private Programmatic API Key used to connect with MongoDB Atlas API
    PrivateKeyWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Private Programmatic API Key used to connect with MongoDB Atlas API. This is a write-only field that is not stored in state.
    PrivateKeyWoVersion int
    An incrementing version counter. Increment this value to force an update to the private key. Required when using private_key_wo.
    Mount string
    Path where the MongoDB Atlas Secrets Engine is mounted.
    PublicKey string
    Specifies the Public API Key used to authenticate with the MongoDB Atlas API.
    Namespace string
    The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
    PrivateKey string
    The Private Programmatic API Key used to connect with MongoDB Atlas API
    PrivateKeyWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Private Programmatic API Key used to connect with MongoDB Atlas API. This is a write-only field that is not stored in state.
    PrivateKeyWoVersion int
    An incrementing version counter. Increment this value to force an update to the private key. Required when using private_key_wo.
    mount String
    Path where the MongoDB Atlas Secrets Engine is mounted.
    publicKey String
    Specifies the Public API Key used to authenticate with the MongoDB Atlas API.
    namespace String
    The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
    privateKey String
    The Private Programmatic API Key used to connect with MongoDB Atlas API
    privateKeyWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Private Programmatic API Key used to connect with MongoDB Atlas API. This is a write-only field that is not stored in state.
    privateKeyWoVersion Integer
    An incrementing version counter. Increment this value to force an update to the private key. Required when using private_key_wo.
    mount string
    Path where the MongoDB Atlas Secrets Engine is mounted.
    publicKey string
    Specifies the Public API Key used to authenticate with the MongoDB Atlas API.
    namespace string
    The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
    privateKey string
    The Private Programmatic API Key used to connect with MongoDB Atlas API
    privateKeyWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Private Programmatic API Key used to connect with MongoDB Atlas API. This is a write-only field that is not stored in state.
    privateKeyWoVersion number
    An incrementing version counter. Increment this value to force an update to the private key. Required when using private_key_wo.
    mount str
    Path where the MongoDB Atlas Secrets Engine is mounted.
    public_key str
    Specifies the Public API Key used to authenticate with the MongoDB Atlas API.
    namespace str
    The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
    private_key str
    The Private Programmatic API Key used to connect with MongoDB Atlas API
    private_key_wo str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Private Programmatic API Key used to connect with MongoDB Atlas API. This is a write-only field that is not stored in state.
    private_key_wo_version int
    An incrementing version counter. Increment this value to force an update to the private key. Required when using private_key_wo.
    mount String
    Path where the MongoDB Atlas Secrets Engine is mounted.
    publicKey String
    Specifies the Public API Key used to authenticate with the MongoDB Atlas API.
    namespace String
    The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
    privateKey String
    The Private Programmatic API Key used to connect with MongoDB Atlas API
    privateKeyWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Private Programmatic API Key used to connect with MongoDB Atlas API. This is a write-only field that is not stored in state.
    privateKeyWoVersion Number
    An incrementing version counter. Increment this value to force an update to the private key. Required when using private_key_wo.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    Path where MongoDB Atlas configuration is located
    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    Path where MongoDB Atlas configuration is located
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    Path where MongoDB Atlas configuration is located
    id string
    The provider-assigned unique ID for this managed resource.
    path string
    Path where MongoDB Atlas configuration is located
    id str
    The provider-assigned unique ID for this managed resource.
    path str
    Path where MongoDB Atlas configuration is located
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    Path where MongoDB Atlas configuration is located

    Look up Existing SecretBackend Resource

    Get an existing SecretBackend 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?: SecretBackendState, opts?: CustomResourceOptions): SecretBackend
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            mount: Optional[str] = None,
            namespace: Optional[str] = None,
            path: Optional[str] = None,
            private_key: Optional[str] = None,
            private_key_wo: Optional[str] = None,
            private_key_wo_version: Optional[int] = None,
            public_key: Optional[str] = None) -> SecretBackend
    func GetSecretBackend(ctx *Context, name string, id IDInput, state *SecretBackendState, opts ...ResourceOption) (*SecretBackend, error)
    public static SecretBackend Get(string name, Input<string> id, SecretBackendState? state, CustomResourceOptions? opts = null)
    public static SecretBackend get(String name, Output<String> id, SecretBackendState state, CustomResourceOptions options)
    resources:  _:    type: vault:mongodbatlas:SecretBackend    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:
    Mount string
    Path where the MongoDB Atlas Secrets Engine is mounted.
    Namespace string
    The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
    Path string
    Path where MongoDB Atlas configuration is located
    PrivateKey string
    The Private Programmatic API Key used to connect with MongoDB Atlas API
    PrivateKeyWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Private Programmatic API Key used to connect with MongoDB Atlas API. This is a write-only field that is not stored in state.
    PrivateKeyWoVersion int
    An incrementing version counter. Increment this value to force an update to the private key. Required when using private_key_wo.
    PublicKey string
    Specifies the Public API Key used to authenticate with the MongoDB Atlas API.
    Mount string
    Path where the MongoDB Atlas Secrets Engine is mounted.
    Namespace string
    The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
    Path string
    Path where MongoDB Atlas configuration is located
    PrivateKey string
    The Private Programmatic API Key used to connect with MongoDB Atlas API
    PrivateKeyWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Private Programmatic API Key used to connect with MongoDB Atlas API. This is a write-only field that is not stored in state.
    PrivateKeyWoVersion int
    An incrementing version counter. Increment this value to force an update to the private key. Required when using private_key_wo.
    PublicKey string
    Specifies the Public API Key used to authenticate with the MongoDB Atlas API.
    mount String
    Path where the MongoDB Atlas Secrets Engine is mounted.
    namespace String
    The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
    path String
    Path where MongoDB Atlas configuration is located
    privateKey String
    The Private Programmatic API Key used to connect with MongoDB Atlas API
    privateKeyWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Private Programmatic API Key used to connect with MongoDB Atlas API. This is a write-only field that is not stored in state.
    privateKeyWoVersion Integer
    An incrementing version counter. Increment this value to force an update to the private key. Required when using private_key_wo.
    publicKey String
    Specifies the Public API Key used to authenticate with the MongoDB Atlas API.
    mount string
    Path where the MongoDB Atlas Secrets Engine is mounted.
    namespace string
    The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
    path string
    Path where MongoDB Atlas configuration is located
    privateKey string
    The Private Programmatic API Key used to connect with MongoDB Atlas API
    privateKeyWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Private Programmatic API Key used to connect with MongoDB Atlas API. This is a write-only field that is not stored in state.
    privateKeyWoVersion number
    An incrementing version counter. Increment this value to force an update to the private key. Required when using private_key_wo.
    publicKey string
    Specifies the Public API Key used to authenticate with the MongoDB Atlas API.
    mount str
    Path where the MongoDB Atlas Secrets Engine is mounted.
    namespace str
    The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
    path str
    Path where MongoDB Atlas configuration is located
    private_key str
    The Private Programmatic API Key used to connect with MongoDB Atlas API
    private_key_wo str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Private Programmatic API Key used to connect with MongoDB Atlas API. This is a write-only field that is not stored in state.
    private_key_wo_version int
    An incrementing version counter. Increment this value to force an update to the private key. Required when using private_key_wo.
    public_key str
    Specifies the Public API Key used to authenticate with the MongoDB Atlas API.
    mount String
    Path where the MongoDB Atlas Secrets Engine is mounted.
    namespace String
    The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.
    path String
    Path where MongoDB Atlas configuration is located
    privateKey String
    The Private Programmatic API Key used to connect with MongoDB Atlas API
    privateKeyWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Private Programmatic API Key used to connect with MongoDB Atlas API. This is a write-only field that is not stored in state.
    privateKeyWoVersion Number
    An incrementing version counter. Increment this value to force an update to the private key. Required when using private_key_wo.
    publicKey String
    Specifies the Public API Key used to authenticate with the MongoDB Atlas API.

    Package Details

    Repository
    Vault pulumi/pulumi-vault
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vault Terraform Provider.
    vault logo
    HashiCorp Vault v7.7.0 published on Friday, Feb 6, 2026 by Pulumi
      Meet Neo: Your AI Platform Teammate