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:
- Access
Token string - MongoDB Atlas Access Token for Service Account.
- Assume
Role ProviderAssume Role - Aws
Access stringKey Id - AWS API Access Key.
- Aws
Secret stringAccess Key - AWS API Access Secret Key.
- Aws
Session stringToken - AWS Security Token Service provided session token.
- Base
Url string - MongoDB Atlas Base URL
- Client
Id string - MongoDB Atlas Client ID for Service Account.
- Client
Secret string - MongoDB Atlas Client Secret for Service Account.
- Is
Mongodbgov boolCloud - MongoDB Atlas Base URL default to gov
- Private
Key string - MongoDB Atlas Programmatic Private Key
- Public
Key string - MongoDB Atlas Programmatic Public Key
- Realm
Base stringUrl - MongoDB Realm Base URL
- Region string
- Region where secret is stored as part of AWS Secret Manager.
- Secret
Name string - Name of secret stored in AWS Secret Manager.
- Sts
Endpoint string - AWS Security Token Service endpoint. Required for cross-AWS region or cross-AWS account secrets.
- Access
Token string - MongoDB Atlas Access Token for Service Account.
- Assume
Role ProviderAssume Role Args - Aws
Access stringKey Id - AWS API Access Key.
- Aws
Secret stringAccess Key - AWS API Access Secret Key.
- Aws
Session stringToken - AWS Security Token Service provided session token.
- Base
Url string - MongoDB Atlas Base URL
- Client
Id string - MongoDB Atlas Client ID for Service Account.
- Client
Secret string - MongoDB Atlas Client Secret for Service Account.
- Is
Mongodbgov boolCloud - MongoDB Atlas Base URL default to gov
- Private
Key string - MongoDB Atlas Programmatic Private Key
- Public
Key string - MongoDB Atlas Programmatic Public Key
- Realm
Base stringUrl - MongoDB Realm Base URL
- Region string
- Region where secret is stored as part of AWS Secret Manager.
- Secret
Name string - Name of secret stored in AWS Secret Manager.
- Sts
Endpoint string - AWS Security Token Service endpoint. Required for cross-AWS region or cross-AWS account secrets.
- access
Token String - MongoDB Atlas Access Token for Service Account.
- assume
Role ProviderAssume Role - aws
Access StringKey Id - AWS API Access Key.
- aws
Secret StringAccess Key - AWS API Access Secret Key.
- aws
Session StringToken - AWS Security Token Service provided session token.
- base
Url String - MongoDB Atlas Base URL
- client
Id String - MongoDB Atlas Client ID for Service Account.
- client
Secret String - MongoDB Atlas Client Secret for Service Account.
- is
Mongodbgov BooleanCloud - MongoDB Atlas Base URL default to gov
- private
Key String - MongoDB Atlas Programmatic Private Key
- public
Key String - MongoDB Atlas Programmatic Public Key
- realm
Base StringUrl - MongoDB Realm Base URL
- region String
- Region where secret is stored as part of AWS Secret Manager.
- secret
Name String - Name of secret stored in AWS Secret Manager.
- sts
Endpoint String - AWS Security Token Service endpoint. Required for cross-AWS region or cross-AWS account secrets.
- access
Token string - MongoDB Atlas Access Token for Service Account.
- assume
Role ProviderAssume Role - aws
Access stringKey Id - AWS API Access Key.
- aws
Secret stringAccess Key - AWS API Access Secret Key.
- aws
Session stringToken - AWS Security Token Service provided session token.
- base
Url string - MongoDB Atlas Base URL
- client
Id string - MongoDB Atlas Client ID for Service Account.
- client
Secret string - MongoDB Atlas Client Secret for Service Account.
- is
Mongodbgov booleanCloud - MongoDB Atlas Base URL default to gov
- private
Key string - MongoDB Atlas Programmatic Private Key
- public
Key string - MongoDB Atlas Programmatic Public Key
- realm
Base stringUrl - MongoDB Realm Base URL
- region string
- Region where secret is stored as part of AWS Secret Manager.
- secret
Name string - Name of secret stored in AWS Secret Manager.
- sts
Endpoint 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 ProviderAssume Role Args - aws_
access_ strkey_ id - AWS API Access Key.
- aws_
secret_ straccess_ key - AWS API Access Secret Key.
- aws_
session_ strtoken - 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_ boolcloud - 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_ strurl - 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.
- access
Token String - MongoDB Atlas Access Token for Service Account.
- assume
Role Property Map - aws
Access StringKey Id - AWS API Access Key.
- aws
Secret StringAccess Key - AWS API Access Secret Key.
- aws
Session StringToken - AWS Security Token Service provided session token.
- base
Url String - MongoDB Atlas Base URL
- client
Id String - MongoDB Atlas Client ID for Service Account.
- client
Secret String - MongoDB Atlas Client Secret for Service Account.
- is
Mongodbgov BooleanCloud - MongoDB Atlas Base URL default to gov
- private
Key String - MongoDB Atlas Programmatic Private Key
- public
Key String - MongoDB Atlas Programmatic Public Key
- realm
Base StringUrl - MongoDB Realm Base URL
- region String
- Region where secret is stored as part of AWS Secret Manager.
- secret
Name String - Name of secret stored in AWS Secret Manager.
- sts
Endpoint 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
- Role
Arn string - Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.
- Role
Arn string - Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.
- role
Arn String - Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.
- role
Arn 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.
- role
Arn 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
mongodbatlasTerraform Provider.
