1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. Provider
MongoDB Atlas v4.0.0 published on Tuesday, Dec 30, 2025 by Pulumi
mongodbatlas logo
MongoDB Atlas v4.0.0 published on Tuesday, Dec 30, 2025 by Pulumi

    The provider type for the mongodbatlas package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

    Create Provider Resource

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

    Constructor syntax

    new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
    @overload
    def Provider(resource_name: str,
                 args: Optional[ProviderArgs] = None,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Provider(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 access_token: Optional[str] = None,
                 assume_role: Optional[ProviderAssumeRoleArgs] = None,
                 aws_access_key_id: Optional[str] = None,
                 aws_secret_access_key: Optional[str] = None,
                 aws_session_token: Optional[str] = None,
                 base_url: Optional[str] = None,
                 client_id: Optional[str] = None,
                 client_secret: Optional[str] = None,
                 is_mongodbgov_cloud: Optional[bool] = None,
                 private_key: Optional[str] = None,
                 public_key: Optional[str] = None,
                 realm_base_url: Optional[str] = None,
                 region: Optional[str] = None,
                 secret_name: Optional[str] = None,
                 sts_endpoint: Optional[str] = None)
    func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
    public Provider(String name, ProviderArgs args, CustomResourceOptions options)
    
    type: pulumi:providers:mongodbatlas
    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 ProviderArgs
    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 ProviderArgs
    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 ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    AccessToken string
    MongoDB Atlas Access Token for Service Account.
    AssumeRole ProviderAssumeRole
    AwsAccessKeyId string
    AWS API Access Key.
    AwsSecretAccessKey string
    AWS API Access Secret Key.
    AwsSessionToken string
    AWS Security Token Service provided session token.
    BaseUrl string
    MongoDB Atlas Base URL
    ClientId string
    MongoDB Atlas Client ID for Service Account.
    ClientSecret string
    MongoDB Atlas Client Secret for Service Account.
    IsMongodbgovCloud bool
    MongoDB Atlas Base URL default to gov
    PrivateKey string
    MongoDB Atlas Programmatic Private Key
    PublicKey string
    MongoDB Atlas Programmatic Public Key
    RealmBaseUrl string
    MongoDB Realm Base URL
    Region string
    Region where secret is stored as part of AWS Secret Manager.
    SecretName string
    Name of secret stored in AWS Secret Manager.
    StsEndpoint string
    AWS Security Token Service endpoint. Required for cross-AWS region or cross-AWS account secrets.
    AccessToken string
    MongoDB Atlas Access Token for Service Account.
    AssumeRole ProviderAssumeRoleArgs
    AwsAccessKeyId string
    AWS API Access Key.
    AwsSecretAccessKey string
    AWS API Access Secret Key.
    AwsSessionToken string
    AWS Security Token Service provided session token.
    BaseUrl string
    MongoDB Atlas Base URL
    ClientId string
    MongoDB Atlas Client ID for Service Account.
    ClientSecret string
    MongoDB Atlas Client Secret for Service Account.
    IsMongodbgovCloud bool
    MongoDB Atlas Base URL default to gov
    PrivateKey string
    MongoDB Atlas Programmatic Private Key
    PublicKey string
    MongoDB Atlas Programmatic Public Key
    RealmBaseUrl string
    MongoDB Realm Base URL
    Region string
    Region where secret is stored as part of AWS Secret Manager.
    SecretName string
    Name of secret stored in AWS Secret Manager.
    StsEndpoint string
    AWS Security Token Service endpoint. Required for cross-AWS region or cross-AWS account secrets.
    accessToken String
    MongoDB Atlas Access Token for Service Account.
    assumeRole ProviderAssumeRole
    awsAccessKeyId String
    AWS API Access Key.
    awsSecretAccessKey String
    AWS API Access Secret Key.
    awsSessionToken String
    AWS Security Token Service provided session token.
    baseUrl String
    MongoDB Atlas Base URL
    clientId String
    MongoDB Atlas Client ID for Service Account.
    clientSecret String
    MongoDB Atlas Client Secret for Service Account.
    isMongodbgovCloud Boolean
    MongoDB Atlas Base URL default to gov
    privateKey String
    MongoDB Atlas Programmatic Private Key
    publicKey String
    MongoDB Atlas Programmatic Public Key
    realmBaseUrl String
    MongoDB Realm Base URL
    region String
    Region where secret is stored as part of AWS Secret Manager.
    secretName String
    Name of secret stored in AWS Secret Manager.
    stsEndpoint String
    AWS Security Token Service endpoint. Required for cross-AWS region or cross-AWS account secrets.
    accessToken string
    MongoDB Atlas Access Token for Service Account.
    assumeRole ProviderAssumeRole
    awsAccessKeyId string
    AWS API Access Key.
    awsSecretAccessKey string
    AWS API Access Secret Key.
    awsSessionToken string
    AWS Security Token Service provided session token.
    baseUrl string
    MongoDB Atlas Base URL
    clientId string
    MongoDB Atlas Client ID for Service Account.
    clientSecret string
    MongoDB Atlas Client Secret for Service Account.
    isMongodbgovCloud boolean
    MongoDB Atlas Base URL default to gov
    privateKey string
    MongoDB Atlas Programmatic Private Key
    publicKey string
    MongoDB Atlas Programmatic Public Key
    realmBaseUrl string
    MongoDB Realm Base URL
    region string
    Region where secret is stored as part of AWS Secret Manager.
    secretName string
    Name of secret stored in AWS Secret Manager.
    stsEndpoint string
    AWS Security Token Service endpoint. Required for cross-AWS region or cross-AWS account secrets.
    access_token str
    MongoDB Atlas Access Token for Service Account.
    assume_role ProviderAssumeRoleArgs
    aws_access_key_id str
    AWS API Access Key.
    aws_secret_access_key str
    AWS API Access Secret Key.
    aws_session_token str
    AWS Security Token Service provided session token.
    base_url str
    MongoDB Atlas Base URL
    client_id str
    MongoDB Atlas Client ID for Service Account.
    client_secret str
    MongoDB Atlas Client Secret for Service Account.
    is_mongodbgov_cloud bool
    MongoDB Atlas Base URL default to gov
    private_key str
    MongoDB Atlas Programmatic Private Key
    public_key str
    MongoDB Atlas Programmatic Public Key
    realm_base_url str
    MongoDB Realm Base URL
    region str
    Region where secret is stored as part of AWS Secret Manager.
    secret_name str
    Name of secret stored in AWS Secret Manager.
    sts_endpoint str
    AWS Security Token Service endpoint. Required for cross-AWS region or cross-AWS account secrets.
    accessToken String
    MongoDB Atlas Access Token for Service Account.
    assumeRole Property Map
    awsAccessKeyId String
    AWS API Access Key.
    awsSecretAccessKey String
    AWS API Access Secret Key.
    awsSessionToken String
    AWS Security Token Service provided session token.
    baseUrl String
    MongoDB Atlas Base URL
    clientId String
    MongoDB Atlas Client ID for Service Account.
    clientSecret String
    MongoDB Atlas Client Secret for Service Account.
    isMongodbgovCloud Boolean
    MongoDB Atlas Base URL default to gov
    privateKey String
    MongoDB Atlas Programmatic Private Key
    publicKey String
    MongoDB Atlas Programmatic Public Key
    realmBaseUrl String
    MongoDB Realm Base URL
    region String
    Region where secret is stored as part of AWS Secret Manager.
    secretName String
    Name of secret stored in AWS Secret Manager.
    stsEndpoint String
    AWS Security Token Service endpoint. Required for cross-AWS region or cross-AWS account secrets.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Provider 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.

    Provider Resource Methods

    TerraformConfig Method

    This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.

    Using TerraformConfig

    terraformConfig(): Output<Provider.TerraformConfigResult>
    def terraform_config() -> Output[Provider.Terraform_configResult]
    func (r *Provider) TerraformConfig() (ProviderTerraformConfigResultOutput, error)
    public Output<Provider.TerraformConfigResult> TerraformConfig()

    TerraformConfig Result

    Result Dictionary<string, object>
    Result map[string]interface{}
    result Map<String,Object>
    result {[key: string]: any}
    result Mapping[str, Any]
    result Map<Any>

    Supporting Types

    ProviderAssumeRole, ProviderAssumeRoleArgs

    RoleArn string
    Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.
    RoleArn string
    Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.
    roleArn String
    Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.
    roleArn string
    Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.
    role_arn str
    Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.
    roleArn String
    Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v4.0.0 published on Tuesday, Dec 30, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate