Want to learn about running containers in Lambda? Join our free hands-on workshop. Register Now

This page documents the language specification for the mongodbatlas package. If you're looking for help working with the inputs, outputs, or functions of mongodbatlas resources in a Pulumi program, please see the resource documentation for examples and API reference.

Pulumi MongoDB Atlas

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-mongodbatlas repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-mongodbatlas repo.

class pulumi_mongodbatlas.AlertConfiguration(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, enabled: Union[bool, Awaitable[bool], Output[T], None] = None, event_type: Union[str, Awaitable[str], Output[T], None] = None, matchers: Union[Sequence[Union[AlertConfigurationMatcherArgs, Mapping[str, Any], Awaitable[Union[AlertConfigurationMatcherArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[AlertConfigurationMatcherArgs, Mapping[str, Any], Awaitable[Union[AlertConfigurationMatcherArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, metric_threshold: Union[AlertConfigurationMetricThresholdArgs, Mapping[str, Any], Awaitable[Union[AlertConfigurationMetricThresholdArgs, Mapping[str, Any]]], Output[T], None] = None, notifications: Union[Sequence[Union[AlertConfigurationNotificationArgs, Mapping[str, Any], Awaitable[Union[AlertConfigurationNotificationArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[AlertConfigurationNotificationArgs, Mapping[str, Any], Awaitable[Union[AlertConfigurationNotificationArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, threshold: Union[AlertConfigurationThresholdArgs, Mapping[str, Any], Awaitable[Union[AlertConfigurationThresholdArgs, Mapping[str, Any]]], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

AlertConfiguration provides an Alert Configuration resource to define the conditions that trigger an alert and the methods of notification within a MongoDB Atlas project.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.AlertConfiguration("test",
    enabled=True,
    event_type="OUTSIDE_METRIC_THRESHOLD",
    matchers=[mongodbatlas.AlertConfigurationMatcherArgs(
        field_name="HOSTNAME_AND_PORT",
        operator="EQUALS",
        value="SECONDARY",
    )],
    metric_threshold=mongodbatlas.AlertConfigurationMetricThresholdArgs(
        metric_name="ASSERT_REGULAR",
        mode="AVERAGE",
        operator="LESS_THAN",
        threshold=99,
        units="RAW",
    ),
    notifications=[mongodbatlas.AlertConfigurationNotificationArgs(
        delay_min=0,
        email_enabled=True,
        interval_min=5,
        roles=[
            "GROUP_CHARTS_ADMIN",
            "GROUP_CLUSTER_MANAGER",
        ],
        sms_enabled=False,
        type_name="GROUP",
    )],
    project_id="<PROJECT-ID>")

NOTE: In order to allow for a fast pace of change to alert variables some validations have been removed from this resource in order to unblock alert creation. Impacted areas have links to the MongoDB Atlas API documentation so always check it for the most current information: https://docs.atlas.mongodb.com/reference/api/alert-configurations-create-config/

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.AlertConfiguration("test",
    enabled=True,
    event_type="REPLICATION_OPLOG_WINDOW_RUNNING_OUT",
    matchers=[mongodbatlas.AlertConfigurationMatcherArgs(
        field_name="HOSTNAME_AND_PORT",
        operator="EQUALS",
        value="SECONDARY",
    )],
    notifications=[mongodbatlas.AlertConfigurationNotificationArgs(
        delay_min=0,
        email_enabled=True,
        interval_min=5,
        roles=[
            "GROUP_CHARTS_ADMIN",
            "GROUP_CLUSTER_MANAGER",
        ],
        sms_enabled=False,
        type_name="GROUP",
    )],
    project_id="<PROJECT-ID>",
    threshold=mongodbatlas.AlertConfigurationThresholdArgs(
        operator="LESS_THAN",
        threshold=1,
        units="HOURS",
    ))
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • enabled (pulumi.Input[bool]) – It is not required, but If the attribute is omitted, by default will be false, and the configuration would be disabled. You must set true to enable the configuration.

  • event_type (pulumi.Input[str]) – The type of event that will trigger an alert.

  • project_id (pulumi.Input[str]) – The ID of the project where the alert configuration will create.

  • threshold (pulumi.Input[pulumi.InputType['AlertConfigurationThresholdArgs']]) – Threshold value outside of which an alert will be triggered.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, alert_configuration_id: Union[str, Awaitable[str], Output[T], None] = None, created: Union[str, Awaitable[str], Output[T], None] = None, enabled: Union[bool, Awaitable[bool], Output[T], None] = None, event_type: Union[str, Awaitable[str], Output[T], None] = None, matchers: Union[Sequence[Union[AlertConfigurationMatcherArgs, Mapping[str, Any], Awaitable[Union[AlertConfigurationMatcherArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[AlertConfigurationMatcherArgs, Mapping[str, Any], Awaitable[Union[AlertConfigurationMatcherArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, metric_threshold: Union[AlertConfigurationMetricThresholdArgs, Mapping[str, Any], Awaitable[Union[AlertConfigurationMetricThresholdArgs, Mapping[str, Any]]], Output[T], None] = None, notifications: Union[Sequence[Union[AlertConfigurationNotificationArgs, Mapping[str, Any], Awaitable[Union[AlertConfigurationNotificationArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[AlertConfigurationNotificationArgs, Mapping[str, Any], Awaitable[Union[AlertConfigurationNotificationArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, threshold: Union[AlertConfigurationThresholdArgs, Mapping[str, Any], Awaitable[Union[AlertConfigurationThresholdArgs, Mapping[str, Any]]], Output[T], None] = None, updated: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_mongodbatlas.alert_configuration.AlertConfiguration

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • alert_configuration_id (pulumi.Input[str]) – Unique identifier for the alert configuration.

  • created (pulumi.Input[str]) – Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created.

  • enabled (pulumi.Input[bool]) – It is not required, but If the attribute is omitted, by default will be false, and the configuration would be disabled. You must set true to enable the configuration.

  • event_type (pulumi.Input[str]) – The type of event that will trigger an alert.

  • project_id (pulumi.Input[str]) – The ID of the project where the alert configuration will create.

  • threshold (pulumi.Input[pulumi.InputType['AlertConfigurationThresholdArgs']]) – Threshold value outside of which an alert will be triggered.

  • updated (pulumi.Input[str]) – Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.

property alert_configuration_id

Unique identifier for the alert configuration.

property created

Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created.

property enabled

It is not required, but If the attribute is omitted, by default will be false, and the configuration would be disabled. You must set true to enable the configuration.

property event_type

The type of event that will trigger an alert.

property project_id

The ID of the project where the alert configuration will create.

property threshold

Threshold value outside of which an alert will be triggered.

property updated

Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.Auditing(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, audit_authorization_success: Union[bool, Awaitable[bool], Output[T], None] = None, audit_filter: Union[str, Awaitable[str], Output[T], None] = None, enabled: Union[bool, Awaitable[bool], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Auditing provides an Auditing resource. This allows auditing to be created.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.Auditing("test",
    audit_authorization_success=False,
    audit_filter="{ 'atype': 'authenticate', 'param': {   'user': 'auditAdmin',   'db': 'admin',   'mechanism': 'SCRAM-SHA-1' }}",
    enabled=True,
    project_id="<project-id>")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • audit_authorization_success (pulumi.Input[bool]) – JSON-formatted audit filter used by the project

  • audit_filter (pulumi.Input[str]) – Indicates whether the auditing system captures successful authentication attempts for audit filters using the “atype” : “authCheck” auditing event. For more information, see auditAuthorizationSuccess

  • enabled (pulumi.Input[bool]) – Denotes whether or not the project associated with the {project_id} has database auditing enabled.

  • project_id (pulumi.Input[str]) – The unique ID for the project to configure auditing.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, audit_authorization_success: Union[bool, Awaitable[bool], Output[T], None] = None, audit_filter: Union[str, Awaitable[str], Output[T], None] = None, configuration_type: Union[str, Awaitable[str], Output[T], None] = None, enabled: Union[bool, Awaitable[bool], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_mongodbatlas.auditing.Auditing

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • audit_authorization_success (pulumi.Input[bool]) – JSON-formatted audit filter used by the project

  • audit_filter (pulumi.Input[str]) – Indicates whether the auditing system captures successful authentication attempts for audit filters using the “atype” : “authCheck” auditing event. For more information, see auditAuthorizationSuccess

  • configuration_type (pulumi.Input[str]) – Denotes the configuration method for the audit filter. Possible values are:

* NONE - auditing not configured for the project.
* FILTER_BUILDER - auditing configured via Atlas UI filter builder.
* FILTER_JSON - auditing configured via Atlas custom filter or API.
Parameters
  • enabled (pulumi.Input[bool]) – Denotes whether or not the project associated with the {project_id} has database auditing enabled.

  • project_id (pulumi.Input[str]) – The unique ID for the project to configure auditing.

property audit_authorization_success

JSON-formatted audit filter used by the project

property audit_filter

Indicates whether the auditing system captures successful authentication attempts for audit filters using the “atype” : “authCheck” auditing event. For more information, see auditAuthorizationSuccess

property configuration_type

Denotes the configuration method for the audit filter. Possible values are:

  • NONE - auditing not configured for the project.

  • FILTER_BUILDER - auditing configured via Atlas UI filter builder.

  • FILTER_JSON - auditing configured via Atlas custom filter or API.

property enabled

Denotes whether or not the project associated with the {project_id} has database auditing enabled.

property project_id

The unique ID for the project to configure auditing.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.AwaitableGet509AuthenticationDatabaseUserResult(certificates=None, customer_x509_cas=None, id=None, project_id=None, username=None)
class pulumi_mongodbatlas.AwaitableGetAlertConfigurationResult(alert_configuration_id=None, created=None, enabled=None, event_type=None, id=None, matchers=None, metric_threshold=None, notifications=None, project_id=None, threshold=None, updated=None)
class pulumi_mongodbatlas.AwaitableGetAuditingResult(audit_authorization_success=None, audit_filter=None, configuration_type=None, enabled=None, id=None, project_id=None)
class pulumi_mongodbatlas.AwaitableGetCloudProviderSnapshotBackupPolicyResult(cluster_id=None, cluster_name=None, id=None, next_snapshot=None, policies=None, project_id=None, reference_hour_of_day=None, reference_minute_of_hour=None, restore_window_days=None, update_snapshots=None)
class pulumi_mongodbatlas.AwaitableGetCloudProviderSnapshotRestoreJobResult(cancelled=None, cluster_name=None, created_at=None, delivery_type=None, delivery_urls=None, expired=None, expires_at=None, finished_at=None, id=None, job_id=None, oplog_inc=None, oplog_ts=None, point_in_time_utc_seconds=None, project_id=None, snapshot_id=None, target_cluster_name=None, target_project_id=None, timestamp=None)
class pulumi_mongodbatlas.AwaitableGetCloudProviderSnapshotRestoreJobsResult(cluster_name=None, id=None, items_per_page=None, page_num=None, project_id=None, results=None, total_count=None)
class pulumi_mongodbatlas.AwaitableGetCloudProviderSnapshotResult(cluster_name=None, created_at=None, description=None, expires_at=None, id=None, master_key_uuid=None, mongod_version=None, project_id=None, snapshot_id=None, snapshot_type=None, status=None, storage_size_bytes=None, type=None)
class pulumi_mongodbatlas.AwaitableGetCloudProviderSnapshotsResult(cluster_name=None, id=None, items_per_page=None, page_num=None, project_id=None, results=None, total_count=None)
class pulumi_mongodbatlas.AwaitableGetClusterResult(auto_scaling_compute_enabled=None, auto_scaling_compute_scale_down_enabled=None, auto_scaling_disk_gb_enabled=None, backing_provider_name=None, backup_enabled=None, bi_connector=None, cluster_type=None, connection_strings=None, container_id=None, disk_size_gb=None, encryption_at_rest_provider=None, id=None, labels=None, mongo_db_major_version=None, mongo_db_version=None, mongo_uri=None, mongo_uri_updated=None, mongo_uri_with_options=None, name=None, num_shards=None, paused=None, pit_enabled=None, project_id=None, provider_auto_scaling_compute_max_instance_size=None, provider_auto_scaling_compute_min_instance_size=None, provider_backup_enabled=None, provider_disk_iops=None, provider_disk_type_name=None, provider_encrypt_ebs_volume=None, provider_instance_size_name=None, provider_name=None, provider_region_name=None, provider_volume_type=None, replication_factor=None, replication_specs=None, snapshot_backup_policies=None, srv_address=None, state_name=None)
class pulumi_mongodbatlas.AwaitableGetClustersResult(id=None, project_id=None, results=None)
class pulumi_mongodbatlas.AwaitableGetCustomDbRoleResult(actions=None, id=None, inherited_roles=None, project_id=None, role_name=None)
class pulumi_mongodbatlas.AwaitableGetCustomDbRolesResult(id=None, project_id=None, results=None)
class pulumi_mongodbatlas.AwaitableGetDatabaseUserResult(auth_database_name=None, aws_iam_type=None, database_name=None, id=None, labels=None, project_id=None, roles=None, scopes=None, username=None, x509_type=None)
class pulumi_mongodbatlas.AwaitableGetDatabaseUsersResult(id=None, project_id=None, results=None)
class pulumi_mongodbatlas.AwaitableGetGlobalClusterConfigResult(cluster_name=None, custom_zone_mapping=None, id=None, managed_namespaces=None, project_id=None)
class pulumi_mongodbatlas.AwaitableGetMaintenanceWindowResult(day_of_week=None, hour_of_day=None, id=None, number_of_deferrals=None, project_id=None, start_asap=None)
class pulumi_mongodbatlas.AwaitableGetNetworkContainerResult(atlas_cidr_block=None, azure_subscription_id=None, container_id=None, gcp_project_id=None, id=None, network_name=None, project_id=None, provider_name=None, provisioned=None, region=None, region_name=None, vnet_name=None, vpc_id=None)
class pulumi_mongodbatlas.AwaitableGetNetworkContainersResult(id=None, project_id=None, provider_name=None, results=None)
class pulumi_mongodbatlas.AwaitableGetNetworkPeeringResult(accepter_region_name=None, atlas_cidr_block=None, atlas_id=None, aws_account_id=None, azure_directory_id=None, azure_subscription_id=None, connection_id=None, container_id=None, error_message=None, error_state=None, error_state_name=None, gcp_project_id=None, id=None, network_name=None, peering_id=None, project_id=None, provider_name=None, resource_group_name=None, route_table_cidr_block=None, status=None, status_name=None, vnet_name=None, vpc_id=None)
class pulumi_mongodbatlas.AwaitableGetNetworkPeeringsResult(id=None, project_id=None, results=None)
class pulumi_mongodbatlas.AwaitableGetPrivateEndpointInterfaceLinkResult(connection_status=None, delete_requested=None, error_message=None, id=None, interface_endpoint_id=None, private_link_id=None, project_id=None)
class pulumi_mongodbatlas.AwaitableGetPrivateEndpointResult(endpoint_service_name=None, error_message=None, id=None, interface_endpoints=None, private_link_id=None, project_id=None, status=None)
class pulumi_mongodbatlas.AwaitableGetProjectIpWhitelistResult(aws_security_group=None, cidr_block=None, comment=None, id=None, ip_address=None, project_id=None)
class pulumi_mongodbatlas.AwaitableGetProjectResult(cluster_count=None, created=None, id=None, name=None, org_id=None, project_id=None, teams=None)
class pulumi_mongodbatlas.AwaitableGetProjectsResult(id=None, items_per_page=None, page_num=None, results=None, total_count=None)
class pulumi_mongodbatlas.AwaitableGetTeamResult(id=None, name=None, org_id=None, team_id=None, usernames=None)
class pulumi_mongodbatlas.AwaitableGetTeamsResult(id=None, name=None, org_id=None, team_id=None, usernames=None)
class pulumi_mongodbatlas.CloudProviderSnapshot(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, cluster_name: Union[str, Awaitable[str], Output[T], None] = None, description: Union[str, Awaitable[str], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, retention_in_days: Union[int, Awaitable[int], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

CloudProviderSnapshot provides a resource to take a cloud backup snapshot on demand. On-demand snapshots happen immediately, unlike scheduled snapshots which occur at regular intervals. If there is already an on-demand snapshot with a status of queued or inProgress, you must wait until Atlas has completed the on-demand snapshot before taking another.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

my_cluster = mongodbatlas.Cluster("myCluster",
    project_id="5cf5a45a9ccf6400e60981b6",
    disk_size_gb=5,
    provider_name="AWS",
    provider_region_name="EU_WEST_2",
    provider_instance_size_name="M10",
    provider_backup_enabled=True,
    provider_disk_iops=100,
    provider_encrypt_ebs_volume=False)
test_cloud_provider_snapshot = mongodbatlas.CloudProviderSnapshot("testCloudProviderSnapshot",
    project_id=my_cluster.project_id,
    cluster_name=my_cluster.name,
    description="myDescription",
    retention_in_days=1)
test_cloud_provider_snapshot_restore_job = mongodbatlas.CloudProviderSnapshotRestoreJob("testCloudProviderSnapshotRestoreJob",
    project_id=test_cloud_provider_snapshot.project_id,
    cluster_name=test_cloud_provider_snapshot.cluster_name,
    snapshot_id=test_cloud_provider_snapshot.snapshot_id,
    delivery_type=mongodbatlas.CloudProviderSnapshotRestoreJobDeliveryTypeArgs(
        download=True,
    ))
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cluster_name (pulumi.Input[str]) – The name of the Atlas cluster that contains the snapshots you want to retrieve.

  • description (pulumi.Input[str]) – Description of the on-demand snapshot.

  • project_id (pulumi.Input[str]) – The unique identifier of the project for the Atlas cluster.

  • retention_in_days (pulumi.Input[int]) – The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, cluster_name: Union[str, Awaitable[str], Output[T], None] = None, created_at: Union[str, Awaitable[str], Output[T], None] = None, description: Union[str, Awaitable[str], Output[T], None] = None, expires_at: Union[str, Awaitable[str], Output[T], None] = None, master_key_uuid: Union[str, Awaitable[str], Output[T], None] = None, mongod_version: Union[str, Awaitable[str], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, retention_in_days: Union[int, Awaitable[int], Output[T], None] = None, snapshot_id: Union[str, Awaitable[str], Output[T], None] = None, snapshot_type: Union[str, Awaitable[str], Output[T], None] = None, status: Union[str, Awaitable[str], Output[T], None] = None, storage_size_bytes: Union[int, Awaitable[int], Output[T], None] = None, type: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_mongodbatlas.cloud_provider_snapshot.CloudProviderSnapshot

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cluster_name (pulumi.Input[str]) – The name of the Atlas cluster that contains the snapshots you want to retrieve.

  • created_at (pulumi.Input[str]) – UTC ISO 8601 formatted point in time when Atlas took the snapshot.

  • description (pulumi.Input[str]) – Description of the on-demand snapshot.

  • expires_at (pulumi.Input[str]) – UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.

  • master_key_uuid (pulumi.Input[str]) – Unique ID of the AWS KMS Customer Master Key used to encrypt the snapshot. Only visible for clusters using Encryption at Rest via Customer KMS.

  • mongod_version (pulumi.Input[str]) – Version of the MongoDB server.

  • project_id (pulumi.Input[str]) – The unique identifier of the project for the Atlas cluster.

  • retention_in_days (pulumi.Input[int]) – The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.

  • snapshot_id (pulumi.Input[str]) – Unique identifier of the snapshot.

  • snapshot_type (pulumi.Input[str]) – Specified the type of snapshot. Valid values are onDemand and scheduled.

  • status (pulumi.Input[str]) – Current status of the snapshot. One of the following values will be returned: queued, inProgress, completed, failed.

  • storage_size_bytes (pulumi.Input[int]) – Specifies the size of the snapshot in bytes.

  • type (pulumi.Input[str]) – Specifies the type of cluster: replicaSet or shardedCluster.

property cluster_name

The name of the Atlas cluster that contains the snapshots you want to retrieve.

property created_at

UTC ISO 8601 formatted point in time when Atlas took the snapshot.

property description

Description of the on-demand snapshot.

property expires_at

UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.

property master_key_uuid

Unique ID of the AWS KMS Customer Master Key used to encrypt the snapshot. Only visible for clusters using Encryption at Rest via Customer KMS.

property mongod_version

Version of the MongoDB server.

property project_id

The unique identifier of the project for the Atlas cluster.

property retention_in_days

The number of days that Atlas should retain the on-demand snapshot. Must be at least 1.

property snapshot_id

Unique identifier of the snapshot.

property snapshot_type

Specified the type of snapshot. Valid values are onDemand and scheduled.

property status

Current status of the snapshot. One of the following values will be returned: queued, inProgress, completed, failed.

property storage_size_bytes

Specifies the size of the snapshot in bytes.

property type

Specifies the type of cluster: replicaSet or shardedCluster.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.CloudProviderSnapshotBackupPolicy(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, cluster_name: Union[str, Awaitable[str], Output[T], None] = None, policies: Union[Sequence[Union[CloudProviderSnapshotBackupPolicyPolicyArgs, Mapping[str, Any], Awaitable[Union[CloudProviderSnapshotBackupPolicyPolicyArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[CloudProviderSnapshotBackupPolicyPolicyArgs, Mapping[str, Any], Awaitable[Union[CloudProviderSnapshotBackupPolicyPolicyArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, reference_hour_of_day: Union[int, Awaitable[int], Output[T], None] = None, reference_minute_of_hour: Union[int, Awaitable[int], Output[T], None] = None, restore_window_days: Union[int, Awaitable[int], Output[T], None] = None, update_snapshots: Union[bool, Awaitable[bool], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Create a CloudProviderSnapshotBackupPolicy resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] cluster_name: The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve. :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType[‘CloudProviderSnapshotBackupPolicyPolicyArgs’]]]] policies: Contains a document for each backup policy item in the desired updated backup policy.

* `policies.#.id` - (Required) Unique identifier of the backup policy that you want to update. policies.#.id is a value obtained via the Cluster resource. provider_backup_enabled of the Cluster resource must be set to true. See the example above for how to refer to the Cluster resource for policies.#.id
Parameters
  • project_id (pulumi.Input[str]) – The unique identifier of the project for the Atlas cluster.

  • reference_hour_of_day (pulumi.Input[int]) – UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.

  • reference_minute_of_hour (pulumi.Input[int]) – UTC Minutes after referenceHourOfDay that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.

  • restore_window_days (pulumi.Input[int]) – Number of days back in time you can restore to with point-in-time accuracy. Must be a positive, non-zero integer.

  • update_snapshots (pulumi.Input[bool]) – Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, cluster_id: Union[str, Awaitable[str], Output[T], None] = None, cluster_name: Union[str, Awaitable[str], Output[T], None] = None, next_snapshot: Union[str, Awaitable[str], Output[T], None] = None, policies: Union[Sequence[Union[CloudProviderSnapshotBackupPolicyPolicyArgs, Mapping[str, Any], Awaitable[Union[CloudProviderSnapshotBackupPolicyPolicyArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[CloudProviderSnapshotBackupPolicyPolicyArgs, Mapping[str, Any], Awaitable[Union[CloudProviderSnapshotBackupPolicyPolicyArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, reference_hour_of_day: Union[int, Awaitable[int], Output[T], None] = None, reference_minute_of_hour: Union[int, Awaitable[int], Output[T], None] = None, restore_window_days: Union[int, Awaitable[int], Output[T], None] = None, update_snapshots: Union[bool, Awaitable[bool], Output[T], None] = None) → pulumi_mongodbatlas.cloud_provider_snapshot_backup_policy.CloudProviderSnapshotBackupPolicy

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cluster_id (pulumi.Input[str]) – Unique identifier of the Atlas cluster.

  • cluster_name (pulumi.Input[str]) – The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.

  • next_snapshot (pulumi.Input[str]) – Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

  • policies (pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['CloudProviderSnapshotBackupPolicyPolicyArgs']]]]) – Contains a document for each backup policy item in the desired updated backup policy.

* `policies.#.id` - (Required) Unique identifier of the backup policy that you want to update. policies.#.id is a value obtained via the Cluster resource. provider_backup_enabled of the Cluster resource must be set to true. See the example above for how to refer to the Cluster resource for policies.#.id
Parameters
  • project_id (pulumi.Input[str]) – The unique identifier of the project for the Atlas cluster.

  • reference_hour_of_day (pulumi.Input[int]) – UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.

  • reference_minute_of_hour (pulumi.Input[int]) – UTC Minutes after referenceHourOfDay that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.

  • restore_window_days (pulumi.Input[int]) – Number of days back in time you can restore to with point-in-time accuracy. Must be a positive, non-zero integer.

  • update_snapshots (pulumi.Input[bool]) – Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

property cluster_id

Unique identifier of the Atlas cluster.

property cluster_name

The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.

property next_snapshot

Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

property policies

Contains a document for each backup policy item in the desired updated backup policy.

  • policies.#.id - (Required) Unique identifier of the backup policy that you want to update. policies.#.id is a value obtained via the Cluster resource. provider_backup_enabled of the Cluster resource must be set to true. See the example above for how to refer to the Cluster resource for policies.#.id

property project_id

The unique identifier of the project for the Atlas cluster.

property reference_hour_of_day

UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.

property reference_minute_of_hour

UTC Minutes after referenceHourOfDay that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.

property restore_window_days

Number of days back in time you can restore to with point-in-time accuracy. Must be a positive, non-zero integer.

property update_snapshots

Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.CloudProviderSnapshotRestoreJob(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, cluster_name: Union[str, Awaitable[str], Output[T], None] = None, delivery_type: Union[CloudProviderSnapshotRestoreJobDeliveryTypeArgs, Mapping[str, Any], Awaitable[Union[CloudProviderSnapshotRestoreJobDeliveryTypeArgs, Mapping[str, Any]]], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, snapshot_id: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

CloudProviderSnapshotRestoreJob provides a resource to create a new restore job from a cloud backup snapshot of a specified cluster. The restore job can be one of three types:

  • automated: Atlas automatically restores the snapshot with snapshotId to the Atlas cluster with name targetClusterName in the Atlas project with targetGroupId.

  • download: Atlas provides a URL to download a .tar.gz of the snapshot with snapshotId. The contents of the archive contain the data files for your Atlas cluster.

  • pointInTime: Atlas performs a Continuous Cloud Backup restore.

Important: If you specify deliveryType : automated or deliveryType : pointInTime in your request body to create an automated restore job, Atlas removes all existing data on the target cluster prior to the restore.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

my_cluster = mongodbatlas.Cluster("myCluster",
    project_id="5cf5a45a9ccf6400e60981b6",
    disk_size_gb=5,
    provider_name="AWS",
    provider_region_name="EU_WEST_2",
    provider_instance_size_name="M10",
    provider_backup_enabled=True,
    provider_disk_iops=100,
    provider_encrypt_ebs_volume=False)
test_cloud_provider_snapshot = mongodbatlas.CloudProviderSnapshot("testCloudProviderSnapshot",
    project_id=my_cluster.project_id,
    cluster_name=my_cluster.name,
    description="myDescription",
    retention_in_days=1)
test_cloud_provider_snapshot_restore_job = mongodbatlas.CloudProviderSnapshotRestoreJob("testCloudProviderSnapshotRestoreJob",
    project_id=test_cloud_provider_snapshot.project_id,
    cluster_name=test_cloud_provider_snapshot.cluster_name,
    snapshot_id=test_cloud_provider_snapshot.snapshot_id,
    delivery_type=mongodbatlas.CloudProviderSnapshotRestoreJobDeliveryTypeArgs(
        automated=True,
        target_cluster_name="MyCluster",
        target_project_id="5cf5a45a9ccf6400e60981b6",
    ),
    opts=ResourceOptions(depends_on=["mongodbatlas_cloud_provider_snapshot.test"]))
import pulumi
import pulumi_mongodbatlas as mongodbatlas

my_cluster = mongodbatlas.Cluster("myCluster",
    project_id="5cf5a45a9ccf6400e60981b6",
    disk_size_gb=5,
    provider_name="AWS",
    provider_region_name="EU_WEST_2",
    provider_instance_size_name="M10",
    provider_backup_enabled=True,
    provider_disk_iops=100,
    provider_encrypt_ebs_volume=False)
test_cloud_provider_snapshot = mongodbatlas.CloudProviderSnapshot("testCloudProviderSnapshot",
    project_id=my_cluster.project_id,
    cluster_name=my_cluster.name,
    description="myDescription",
    retention_in_days=1)
test_cloud_provider_snapshot_restore_job = mongodbatlas.CloudProviderSnapshotRestoreJob("testCloudProviderSnapshotRestoreJob",
    project_id=test_cloud_provider_snapshot.project_id,
    cluster_name=test_cloud_provider_snapshot.cluster_name,
    snapshot_id=test_cloud_provider_snapshot.snapshot_id,
    delivery_type=mongodbatlas.CloudProviderSnapshotRestoreJobDeliveryTypeArgs(
        download=True,
    ))
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cluster_name (pulumi.Input[str]) – The name of the Atlas cluster whose snapshot you want to restore.

  • delivery_type (pulumi.Input[pulumi.InputType['CloudProviderSnapshotRestoreJobDeliveryTypeArgs']]) – Type of restore job to create. Possible values are: download or automated, only one must be set it in true.

  • project_id (pulumi.Input[str]) – The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.

  • snapshot_id (pulumi.Input[str]) – Unique identifier of the snapshot to restore.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, cancelled: Union[bool, Awaitable[bool], Output[T], None] = None, cluster_name: Union[str, Awaitable[str], Output[T], None] = None, created_at: Union[str, Awaitable[str], Output[T], None] = None, delivery_type: Union[CloudProviderSnapshotRestoreJobDeliveryTypeArgs, Mapping[str, Any], Awaitable[Union[CloudProviderSnapshotRestoreJobDeliveryTypeArgs, Mapping[str, Any]]], Output[T], None] = None, delivery_urls: Union[Sequence[Union[str, Awaitable[str], Output[T]]], Awaitable[Sequence[Union[str, Awaitable[str], Output[T]]]], Output[T], None] = None, expired: Union[bool, Awaitable[bool], Output[T], None] = None, expires_at: Union[str, Awaitable[str], Output[T], None] = None, finished_at: Union[str, Awaitable[str], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, snapshot_id: Union[str, Awaitable[str], Output[T], None] = None, snapshot_restore_job_id: Union[str, Awaitable[str], Output[T], None] = None, timestamp: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_mongodbatlas.cloud_provider_snapshot_restore_job.CloudProviderSnapshotRestoreJob

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cancelled (pulumi.Input[bool]) – Indicates whether the restore job was canceled.

  • cluster_name (pulumi.Input[str]) – The name of the Atlas cluster whose snapshot you want to restore.

  • created_at (pulumi.Input[str]) – UTC ISO 8601 formatted point in time when Atlas created the restore job.

  • delivery_type (pulumi.Input[pulumi.InputType['CloudProviderSnapshotRestoreJobDeliveryTypeArgs']]) – Type of restore job to create. Possible values are: download or automated, only one must be set it in true.

  • delivery_urls (pulumi.Input[Sequence[pulumi.Input[str]]]) – One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.

  • expired (pulumi.Input[bool]) – Indicates whether the restore job expired.

  • expires_at (pulumi.Input[str]) – UTC ISO 8601 formatted point in time when the restore job expires.

  • finished_at (pulumi.Input[str]) – UTC ISO 8601 formatted point in time when the restore job completed.

  • project_id (pulumi.Input[str]) – The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.

  • snapshot_id (pulumi.Input[str]) – Unique identifier of the snapshot to restore.

  • snapshot_restore_job_id (pulumi.Input[str]) – The unique identifier of the restore job.

  • timestamp (pulumi.Input[str]) – Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.

property cancelled

Indicates whether the restore job was canceled.

property cluster_name

The name of the Atlas cluster whose snapshot you want to restore.

property created_at

UTC ISO 8601 formatted point in time when Atlas created the restore job.

property delivery_type

Type of restore job to create. Possible values are: download or automated, only one must be set it in true.

property delivery_urls

One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.

property expired

Indicates whether the restore job expired.

property expires_at

UTC ISO 8601 formatted point in time when the restore job expires.

property finished_at

UTC ISO 8601 formatted point in time when the restore job completed.

property project_id

The unique identifier of the project for the Atlas cluster whose snapshot you want to restore.

property snapshot_id

Unique identifier of the snapshot to restore.

property snapshot_restore_job_id

The unique identifier of the restore job.

property timestamp

Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.Cluster(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, advanced_configuration: Union[ClusterAdvancedConfigurationArgs, Mapping[str, Any], Awaitable[Union[ClusterAdvancedConfigurationArgs, Mapping[str, Any]]], Output[T], None] = None, auto_scaling_compute_enabled: Union[bool, Awaitable[bool], Output[T], None] = None, auto_scaling_compute_scale_down_enabled: Union[bool, Awaitable[bool], Output[T], None] = None, auto_scaling_disk_gb_enabled: Union[bool, Awaitable[bool], Output[T], None] = None, backing_provider_name: Union[str, Awaitable[str], Output[T], None] = None, backup_enabled: Union[bool, Awaitable[bool], Output[T], None] = None, bi_connector: Union[ClusterBiConnectorArgs, Mapping[str, Any], Awaitable[Union[ClusterBiConnectorArgs, Mapping[str, Any]]], Output[T], None] = None, cluster_type: Union[str, Awaitable[str], Output[T], None] = None, disk_size_gb: Union[float, Awaitable[float], Output[T], None] = None, encryption_at_rest_provider: Union[str, Awaitable[str], Output[T], None] = None, labels: Union[Sequence[Union[ClusterLabelArgs, Mapping[str, Any], Awaitable[Union[ClusterLabelArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[ClusterLabelArgs, Mapping[str, Any], Awaitable[Union[ClusterLabelArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, mongo_db_major_version: Union[str, Awaitable[str], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None, num_shards: Union[int, Awaitable[int], Output[T], None] = None, pit_enabled: Union[bool, Awaitable[bool], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, provider_auto_scaling_compute_max_instance_size: Union[str, Awaitable[str], Output[T], None] = None, provider_auto_scaling_compute_min_instance_size: Union[str, Awaitable[str], Output[T], None] = None, provider_backup_enabled: Union[bool, Awaitable[bool], Output[T], None] = None, provider_disk_iops: Union[int, Awaitable[int], Output[T], None] = None, provider_disk_type_name: Union[str, Awaitable[str], Output[T], None] = None, provider_encrypt_ebs_volume: Union[bool, Awaitable[bool], Output[T], None] = None, provider_instance_size_name: Union[str, Awaitable[str], Output[T], None] = None, provider_name: Union[str, Awaitable[str], Output[T], None] = None, provider_region_name: Union[str, Awaitable[str], Output[T], None] = None, provider_volume_type: Union[str, Awaitable[str], Output[T], None] = None, replication_factor: Union[int, Awaitable[int], Output[T], None] = None, replication_specs: Union[Sequence[Union[ClusterReplicationSpecArgs, Mapping[str, Any], Awaitable[Union[ClusterReplicationSpecArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[ClusterReplicationSpecArgs, Mapping[str, Any], Awaitable[Union[ClusterReplicationSpecArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Cluster provides a Cluster resource. The resource lets you create, edit and delete clusters. The resource requires your Project ID.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

NOTE: A network container is created for a cluster to reside in if one does not yet exist in the project. To use this automatically created container with another resource, such as peering, the container_id is exported after creation.

IMPORTANT:
&#8226; Free tier cluster creation (M0) is not supported via API or by this Provider.
&#8226; Shared tier clusters (M2, M5) cannot be upgraded to higher tiers via API or by this Provider.
&#8226; Changes to cluster configurations can affect costs. Before making changes, please see Billing.
&#8226; If your Atlas project contains a custom role that uses actions introduced in a specific MongoDB version, you cannot create a cluster with a MongoDB version less than that version unless you delete the custom role.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

cluster_test = mongodbatlas.Cluster("cluster-test",
    auto_scaling_disk_gb_enabled=True,
    disk_size_gb=100,
    mongo_db_major_version="4.2",
    num_shards=1,
    project_id="<YOUR-PROJECT-ID>",
    provider_backup_enabled=True,
    provider_disk_iops=300,
    provider_encrypt_ebs_volume=True,
    provider_instance_size_name="M40",
    provider_name="AWS",
    provider_region_name="US_EAST_1",
    provider_volume_type="STANDARD",
    replication_factor=3)
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.Cluster("test",
    auto_scaling_disk_gb_enabled=True,
    mongo_db_major_version="4.2",
    num_shards=1,
    project_id="<YOUR-PROJECT-ID>",
    provider_backup_enabled=True,
    provider_disk_type_name="P6",
    provider_instance_size_name="M30",
    provider_name="AZURE",
    provider_region_name="US_EAST_2",
    replication_factor=3)
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.Cluster("test",
    auto_scaling_disk_gb_enabled=True,
    disk_size_gb=40,
    mongo_db_major_version="4.2",
    num_shards=1,
    project_id="<YOUR-PROJECT-ID>",
    provider_backup_enabled=True,
    provider_instance_size_name="M30",
    provider_name="GCP",
    provider_region_name="US_EAST_4",
    replication_factor=3)
import pulumi
import pulumi_mongodbatlas as mongodbatlas

cluster_test = mongodbatlas.Cluster("cluster-test",
    cluster_type="REPLICASET",
    disk_size_gb=100,
    num_shards=1,
    project_id="<YOUR-PROJECT-ID>",
    provider_backup_enabled=True,
    provider_disk_iops=300,
    provider_instance_size_name="M10",
    provider_name="AWS",
    provider_volume_type="STANDARD",
    replication_specs=[mongodbatlas.ClusterReplicationSpecArgs(
        num_shards=1,
        regions_configs=[
            mongodbatlas.ClusterReplicationSpecRegionsConfigArgs(
                electable_nodes=3,
                priority=7,
                read_only_nodes=0,
                region_name="US_EAST_1",
            ),
            mongodbatlas.ClusterReplicationSpecRegionsConfigArgs(
                electable_nodes=2,
                priority=6,
                read_only_nodes=0,
                region_name="US_EAST_2",
            ),
            mongodbatlas.ClusterReplicationSpecRegionsConfigArgs(
                electable_nodes=2,
                priority=5,
                read_only_nodes=2,
                region_name="US_WEST_1",
            ),
        ],
    )])
import pulumi
import pulumi_mongodbatlas as mongodbatlas

cluster_test = mongodbatlas.Cluster("cluster-test",
    cluster_type="GEOSHARDED",
    disk_size_gb=80,
    num_shards=1,
    project_id="<YOUR-PROJECT-ID>",
    provider_backup_enabled=True,
    provider_disk_iops=240,
    provider_instance_size_name="M30",
    provider_name="AWS",
    provider_volume_type="STANDARD",
    replication_specs=[
        mongodbatlas.ClusterReplicationSpecArgs(
            num_shards=2,
            regions_configs=[mongodbatlas.ClusterReplicationSpecRegionsConfigArgs(
                electable_nodes=3,
                priority=7,
                read_only_nodes=0,
                region_name="US_EAST_1",
            )],
            zone_name="Zone 1",
        ),
        mongodbatlas.ClusterReplicationSpecArgs(
            num_shards=2,
            regions_configs=[mongodbatlas.ClusterReplicationSpecRegionsConfigArgs(
                electable_nodes=3,
                priority=7,
                read_only_nodes=0,
                region_name="EU_CENTRAL_1",
            )],
            zone_name="Zone 2",
        ),
    ])
import pulumi
import pulumi_mongodbatlas as mongodbatlas

cluster_test = mongodbatlas.Cluster("cluster-test",
    auto_scaling_disk_gb_enabled=False,
    backing_provider_name="AWS",
    disk_size_gb=2,
    mongo_db_major_version="4.2",
    project_id="<YOUR-PROJECT-ID>",
    provider_instance_size_name="M2",
    provider_name="TENANT",
    provider_region_name="US_EAST_1")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auto_scaling_compute_enabled (pulumi.Input[bool]) – Specifies whether cluster tier auto-scaling is enabled. The default is false.

- Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for `providerSettings.autoScaling.compute.maxInstanceSize`.
- Set to `false` to disable cluster tier auto-scaling.
Parameters

auto_scaling_compute_scale_down_enabled (pulumi.Input[bool]) – Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true.

- If this option is enabled, you must specify a value for `providerSettings.autoScaling.compute.minInstanceSize`
Parameters

auto_scaling_disk_gb_enabled (pulumi.Input[bool]) – Specifies whether disk auto-scaling is enabled. The default is true.

- Set to `true` to enable disk auto-scaling.
- Set to `false` to disable disk auto-scaling.
Parameters
  • backing_provider_name (pulumi.Input[str]) – Cloud service provider on which the server for a multi-tenant cluster is provisioned.

  • bi_connector (pulumi.Input[pulumi.InputType['ClusterBiConnectorArgs']]) – Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.

  • cluster_type (pulumi.Input[str]) – Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

  • disk_size_gb (pulumi.Input[float]) – Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.

* The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value.
* Note: The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier.
* Cannot be used with clusters with local NVMe SSDs
* Cannot be used with Azure clusters
Parameters
  • encryption_at_rest_provider (pulumi.Input[str]) – Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

  • mongo_db_major_version (pulumi.Input[str]) – Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 3.6, 4.0, or 4.2. You must set this value to 4.2 if provider_instance_size_name is either M2 or M5.

  • name (pulumi.Input[str]) – Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

  • num_shards (pulumi.Input[int]) – Number of shards to deploy in the specified zone, minimum 1.

  • pit_enabled (pulumi.Input[bool]) –

    • Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, provider_backup_enabled must also be set to true.

  • project_id (pulumi.Input[str]) – The unique ID for the project to create the database user.

  • provider_auto_scaling_compute_max_instance_size (pulumi.Input[str]) – Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

  • provider_auto_scaling_compute_min_instance_size (pulumi.Input[str]) – Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

  • provider_backup_enabled (pulumi.Input[bool]) – Flag indicating if the cluster uses Cloud Backup for backups.

  • provider_disk_iops (pulumi.Input[int]) – The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected provider_instance_size_name and disk_size_gb.

  • provider_disk_type_name (pulumi.Input[str]) – Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.

  • provider_encrypt_ebs_volume (pulumi.Input[bool]) – If enabled, the Amazon EBS encryption feature encrypts the server’s root volume for both data at rest within the volume and for data moving between the volume and the cluster. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

  • provider_instance_size_name (pulumi.Input[str]) – Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster providerSettings.instanceSizeName for valid values and default resources. Note free tier (M0) creation is not supported by the Atlas API and hence not supported by this provider.)

  • provider_name (pulumi.Input[str]) – Cloud service provider on which the servers are provisioned.

  • provider_region_name (pulumi.Input[str]) – Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.

  • provider_volume_type (pulumi.Input[str]) – The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED required if setting IOPS higher than the default instance IOPS.

  • replication_factor (pulumi.Input[int]) – Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.

  • replication_specs (pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ClusterReplicationSpecArgs']]]]) – Configuration for cluster regions. See Replication Spec below for more details.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, advanced_configuration: Union[ClusterAdvancedConfigurationArgs, Mapping[str, Any], Awaitable[Union[ClusterAdvancedConfigurationArgs, Mapping[str, Any]]], Output[T], None] = None, auto_scaling_compute_enabled: Union[bool, Awaitable[bool], Output[T], None] = None, auto_scaling_compute_scale_down_enabled: Union[bool, Awaitable[bool], Output[T], None] = None, auto_scaling_disk_gb_enabled: Union[bool, Awaitable[bool], Output[T], None] = None, backing_provider_name: Union[str, Awaitable[str], Output[T], None] = None, backup_enabled: Union[bool, Awaitable[bool], Output[T], None] = None, bi_connector: Union[ClusterBiConnectorArgs, Mapping[str, Any], Awaitable[Union[ClusterBiConnectorArgs, Mapping[str, Any]]], Output[T], None] = None, cluster_id: Union[str, Awaitable[str], Output[T], None] = None, cluster_type: Union[str, Awaitable[str], Output[T], None] = None, connection_strings: Union[ClusterConnectionStringsArgs, Mapping[str, Any], Awaitable[Union[ClusterConnectionStringsArgs, Mapping[str, Any]]], Output[T], None] = None, container_id: Union[str, Awaitable[str], Output[T], None] = None, disk_size_gb: Union[float, Awaitable[float], Output[T], None] = None, encryption_at_rest_provider: Union[str, Awaitable[str], Output[T], None] = None, labels: Union[Sequence[Union[ClusterLabelArgs, Mapping[str, Any], Awaitable[Union[ClusterLabelArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[ClusterLabelArgs, Mapping[str, Any], Awaitable[Union[ClusterLabelArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, mongo_db_major_version: Union[str, Awaitable[str], Output[T], None] = None, mongo_db_version: Union[str, Awaitable[str], Output[T], None] = None, mongo_uri: Union[str, Awaitable[str], Output[T], None] = None, mongo_uri_updated: Union[str, Awaitable[str], Output[T], None] = None, mongo_uri_with_options: Union[str, Awaitable[str], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None, num_shards: Union[int, Awaitable[int], Output[T], None] = None, paused: Union[bool, Awaitable[bool], Output[T], None] = None, pit_enabled: Union[bool, Awaitable[bool], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, provider_auto_scaling_compute_max_instance_size: Union[str, Awaitable[str], Output[T], None] = None, provider_auto_scaling_compute_min_instance_size: Union[str, Awaitable[str], Output[T], None] = None, provider_backup_enabled: Union[bool, Awaitable[bool], Output[T], None] = None, provider_disk_iops: Union[int, Awaitable[int], Output[T], None] = None, provider_disk_type_name: Union[str, Awaitable[str], Output[T], None] = None, provider_encrypt_ebs_volume: Union[bool, Awaitable[bool], Output[T], None] = None, provider_instance_size_name: Union[str, Awaitable[str], Output[T], None] = None, provider_name: Union[str, Awaitable[str], Output[T], None] = None, provider_region_name: Union[str, Awaitable[str], Output[T], None] = None, provider_volume_type: Union[str, Awaitable[str], Output[T], None] = None, replication_factor: Union[int, Awaitable[int], Output[T], None] = None, replication_specs: Union[Sequence[Union[ClusterReplicationSpecArgs, Mapping[str, Any], Awaitable[Union[ClusterReplicationSpecArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[ClusterReplicationSpecArgs, Mapping[str, Any], Awaitable[Union[ClusterReplicationSpecArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, snapshot_backup_policies: Union[Sequence[Union[ClusterSnapshotBackupPolicyArgs, Mapping[str, Any], Awaitable[Union[ClusterSnapshotBackupPolicyArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[ClusterSnapshotBackupPolicyArgs, Mapping[str, Any], Awaitable[Union[ClusterSnapshotBackupPolicyArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, srv_address: Union[str, Awaitable[str], Output[T], None] = None, state_name: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_mongodbatlas.cluster.Cluster

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auto_scaling_compute_enabled (pulumi.Input[bool]) – Specifies whether cluster tier auto-scaling is enabled. The default is false.

- Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for `providerSettings.autoScaling.compute.maxInstanceSize`.
- Set to `false` to disable cluster tier auto-scaling.
Parameters

auto_scaling_compute_scale_down_enabled (pulumi.Input[bool]) – Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true.

- If this option is enabled, you must specify a value for `providerSettings.autoScaling.compute.minInstanceSize`
Parameters

auto_scaling_disk_gb_enabled (pulumi.Input[bool]) – Specifies whether disk auto-scaling is enabled. The default is true.

- Set to `true` to enable disk auto-scaling.
- Set to `false` to disable disk auto-scaling.
Parameters
  • backing_provider_name (pulumi.Input[str]) – Cloud service provider on which the server for a multi-tenant cluster is provisioned.

  • bi_connector (pulumi.Input[pulumi.InputType['ClusterBiConnectorArgs']]) – Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.

  • cluster_id (pulumi.Input[str]) – The cluster ID.

  • cluster_type (pulumi.Input[str]) – Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

  • connection_strings (pulumi.Input[pulumi.InputType['ClusterConnectionStringsArgs']]) – Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

  • container_id (pulumi.Input[str]) – The Network Peering Container ID. The id of the container either created programmatically by the user before any clusters existed in the project or when the first cluster in the region (AWS/Azure) or project (GCP) was created.

  • disk_size_gb (pulumi.Input[float]) – Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.

* The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value.
* Note: The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier.
* Cannot be used with clusters with local NVMe SSDs
* Cannot be used with Azure clusters
Parameters
  • encryption_at_rest_provider (pulumi.Input[str]) –

    Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

  • mongo_db_major_version (pulumi.Input[str]) – Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 3.6, 4.0, or 4.2. You must set this value to 4.2 if provider_instance_size_name is either M2 or M5.

  • mongo_db_version (pulumi.Input[str]) – Version of MongoDB the cluster runs, in major-version.minor-version format.

  • mongo_uri (pulumi.Input[str]) – Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

  • mongo_uri_updated (pulumi.Input[str]) – Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

  • mongo_uri_with_options (pulumi.Input[str]) – connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.

  • name (pulumi.Input[str]) – Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

  • num_shards (pulumi.Input[int]) – Number of shards to deploy in the specified zone, minimum 1.

  • paused (pulumi.Input[bool]) – Flag that indicates whether the cluster is paused or not.

  • pit_enabled (pulumi.Input[bool]) –

    • Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, provider_backup_enabled must also be set to true.

  • project_id (pulumi.Input[str]) – The unique ID for the project to create the database user.

  • provider_auto_scaling_compute_max_instance_size (pulumi.Input[str]) – Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

  • provider_auto_scaling_compute_min_instance_size (pulumi.Input[str]) – Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

  • provider_backup_enabled (pulumi.Input[bool]) – Flag indicating if the cluster uses Cloud Backup for backups.

  • provider_disk_iops (pulumi.Input[int]) – The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected provider_instance_size_name and disk_size_gb.

  • provider_disk_type_name (pulumi.Input[str]) – Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.

  • provider_encrypt_ebs_volume (pulumi.Input[bool]) – If enabled, the Amazon EBS encryption feature encrypts the server’s root volume for both data at rest within the volume and for data moving between the volume and the cluster. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

  • provider_instance_size_name (pulumi.Input[str]) –

    Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster providerSettings.instanceSizeName for valid values and default resources. Note free tier (M0) creation is not supported by the Atlas API and hence not supported by this provider.)

  • provider_name (pulumi.Input[str]) – Cloud service provider on which the servers are provisioned.

  • provider_region_name (pulumi.Input[str]) –

    Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.

  • provider_volume_type (pulumi.Input[str]) – The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED required if setting IOPS higher than the default instance IOPS.

  • replication_factor (pulumi.Input[int]) – Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.

  • replication_specs (pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ClusterReplicationSpecArgs']]]]) – Configuration for cluster regions. See Replication Spec below for more details.

  • snapshot_backup_policies (pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['ClusterSnapshotBackupPolicyArgs']]]]) – current snapshot schedule and retention settings for the cluster.

  • srv_address (pulumi.Input[str]) – Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.

  • state_name (pulumi.Input[str]) – Current state of the cluster. The possible states are:

- IDLE
- CREATING
- UPDATING
- DELETING
- DELETED
- REPAIRING
property auto_scaling_compute_enabled

Specifies whether cluster tier auto-scaling is enabled. The default is false.

  • Set to true to enable cluster tier auto-scaling. If enabled, you must specify a value for providerSettings.autoScaling.compute.maxInstanceSize.

  • Set to false to disable cluster tier auto-scaling.

property auto_scaling_compute_scale_down_enabled

Set to true to enable the cluster tier to scale down. This option is only available if autoScaling.compute.enabled is true.

  • If this option is enabled, you must specify a value for providerSettings.autoScaling.compute.minInstanceSize

property auto_scaling_disk_gb_enabled

Specifies whether disk auto-scaling is enabled. The default is true.

  • Set to true to enable disk auto-scaling.

  • Set to false to disable disk auto-scaling.

property backing_provider_name

Cloud service provider on which the server for a multi-tenant cluster is provisioned.

property bi_connector

Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.

property cluster_id

The cluster ID.

property cluster_type

Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

property connection_strings

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

property container_id

The Network Peering Container ID. The id of the container either created programmatically by the user before any clusters existed in the project or when the first cluster in the region (AWS/Azure) or project (GCP) was created.

property disk_size_gb

Capacity, in gigabytes, of the host’s root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.

  • The minimum disk size for dedicated clusters is 10GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value.

  • Note: The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier.

  • Cannot be used with clusters with local NVMe SSDs

  • Cannot be used with Azure clusters

property encryption_at_rest_provider

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

property mongo_db_major_version

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 3.6, 4.0, or 4.2. You must set this value to 4.2 if provider_instance_size_name is either M2 or M5.

property mongo_db_version

Version of MongoDB the cluster runs, in major-version.minor-version format.

property mongo_uri

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

property mongo_uri_updated

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

property mongo_uri_with_options

connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.

property name

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

property num_shards

Number of shards to deploy in the specified zone, minimum 1.

property paused

Flag that indicates whether the cluster is paused or not.

property pit_enabled
  • Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, provider_backup_enabled must also be set to true.

property project_id

The unique ID for the project to create the database user.

property provider_auto_scaling_compute_max_instance_size

Maximum instance size to which your cluster can automatically scale (e.g., M40). Required if autoScaling.compute.enabled is true.

property provider_auto_scaling_compute_min_instance_size

Minimum instance size to which your cluster can automatically scale (e.g., M10). Required if autoScaling.compute.scaleDownEnabled is true.

property provider_backup_enabled

Flag indicating if the cluster uses Cloud Backup for backups.

property provider_disk_iops

The maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected provider_instance_size_name and disk_size_gb.

property provider_disk_type_name

Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P15 - 256GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.

property provider_encrypt_ebs_volume

If enabled, the Amazon EBS encryption feature encrypts the server’s root volume for both data at rest within the volume and for data moving between the volume and the cluster. Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

property provider_instance_size_name

Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster providerSettings.instanceSizeName for valid values and default resources. Note free tier (M0) creation is not supported by the Atlas API and hence not supported by this provider.)

property provider_name

Cloud service provider on which the servers are provisioned.

property provider_region_name

Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.

property provider_volume_type

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED required if setting IOPS higher than the default instance IOPS.

property replication_factor

Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.

property replication_specs

Configuration for cluster regions. See Replication Spec below for more details.

property snapshot_backup_policies

current snapshot schedule and retention settings for the cluster.

property srv_address

Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.

property state_name

Current state of the cluster. The possible states are:

  • IDLE

  • CREATING

  • UPDATING

  • DELETING

  • DELETED

  • REPAIRING

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.CustomDbRole(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, actions: Union[Sequence[Union[CustomDbRoleActionArgs, Mapping[str, Any], Awaitable[Union[CustomDbRoleActionArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[CustomDbRoleActionArgs, Mapping[str, Any], Awaitable[Union[CustomDbRoleActionArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, inherited_roles: Union[Sequence[Union[CustomDbRoleInheritedRoleArgs, Mapping[str, Any], Awaitable[Union[CustomDbRoleInheritedRoleArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[CustomDbRoleInheritedRoleArgs, Mapping[str, Any], Awaitable[Union[CustomDbRoleInheritedRoleArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, role_name: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

CustomDbRole provides a Custom DB Role resource. The customDBRoles resource lets you retrieve, create and modify the custom MongoDB roles in your cluster. Use custom MongoDB roles to specify custom sets of actions which cannot be described by the built-in Atlas database user privileges.

IMPORTANT Custom roles cannot use actions unavailable to any cluster version in your project. Custom roles are defined at the project level, and must be compatible with each MongoDB version used by your project’s clusters. If you have a cluster in your project with MongoDB 3.4, you cannot create a custom role that uses actions introduced in MongoDB 3.6, such as useUUID.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_role = mongodbatlas.CustomDbRole("testRole",
    actions=[
        mongodbatlas.CustomDbRoleActionArgs(
            action="UPDATE",
            resources=[mongodbatlas.CustomDbRoleActionResourceArgs(
                collection_name="",
                database_name="anyDatabase",
            )],
        ),
        mongodbatlas.CustomDbRoleActionArgs(
            action="INSERT",
            resources=[mongodbatlas.CustomDbRoleActionResourceArgs(
                collection_name="",
                database_name="anyDatabase",
            )],
        ),
        mongodbatlas.CustomDbRoleActionArgs(
            action="REMOVE",
            resources=[mongodbatlas.CustomDbRoleActionResourceArgs(
                collection_name="",
                database_name="anyDatabase",
            )],
        ),
    ],
    project_id="<PROJECT-ID>",
    role_name="myCustomRole")
import pulumi
import pulumi_mongodbatlas as mongodbatlas

inherited_role_one = mongodbatlas.CustomDbRole("inheritedRoleOne",
    actions=[mongodbatlas.CustomDbRoleActionArgs(
        action="INSERT",
        resources=[mongodbatlas.CustomDbRoleActionResourceArgs(
            collection_name="",
            database_name="anyDatabase",
        )],
    )],
    project_id="<PROJECT-ID>",
    role_name="insertRole")
inherited_role_two = mongodbatlas.CustomDbRole("inheritedRoleTwo",
    actions=[mongodbatlas.CustomDbRoleActionArgs(
        action="SERVER_STATUS",
        resources=[mongodbatlas.CustomDbRoleActionResourceArgs(
            cluster=True,
        )],
    )],
    project_id=inherited_role_one.project_id,
    role_name="statusServerRole")
test_role = mongodbatlas.CustomDbRole("testRole",
    actions=[
        mongodbatlas.CustomDbRoleActionArgs(
            action="UPDATE",
            resources=[mongodbatlas.CustomDbRoleActionResourceArgs(
                collection_name="",
                database_name="anyDatabase",
            )],
        ),
        mongodbatlas.CustomDbRoleActionArgs(
            action="REMOVE",
            resources=[mongodbatlas.CustomDbRoleActionResourceArgs(
                collection_name="",
                database_name="anyDatabase",
            )],
        ),
    ],
    inherited_roles=[
        mongodbatlas.CustomDbRoleInheritedRoleArgs(
            database_name="admin",
            role_name=inherited_role_one.role_name,
        ),
        mongodbatlas.CustomDbRoleInheritedRoleArgs(
            database_name="admin",
            role_name=inherited_role_two.role_name,
        ),
    ],
    project_id=inherited_role_one.project_id,
    role_name="myCustomRole")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project_id (pulumi.Input[str]) – The unique ID for the project to create the database user.

  • role_name (pulumi.Input[str]) – Name of the inherited role. This can either be another custom role or a built-in role.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, actions: Union[Sequence[Union[CustomDbRoleActionArgs, Mapping[str, Any], Awaitable[Union[CustomDbRoleActionArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[CustomDbRoleActionArgs, Mapping[str, Any], Awaitable[Union[CustomDbRoleActionArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, inherited_roles: Union[Sequence[Union[CustomDbRoleInheritedRoleArgs, Mapping[str, Any], Awaitable[Union[CustomDbRoleInheritedRoleArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[CustomDbRoleInheritedRoleArgs, Mapping[str, Any], Awaitable[Union[CustomDbRoleInheritedRoleArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, role_name: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_mongodbatlas.custom_db_role.CustomDbRole

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project_id (pulumi.Input[str]) – The unique ID for the project to create the database user.

  • role_name (pulumi.Input[str]) – Name of the inherited role. This can either be another custom role or a built-in role.

property project_id

The unique ID for the project to create the database user.

property role_name

Name of the inherited role. This can either be another custom role or a built-in role.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.DatabaseUser(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, auth_database_name: Union[str, Awaitable[str], Output[T], None] = None, aws_iam_type: Union[str, Awaitable[str], Output[T], None] = None, database_name: Union[str, Awaitable[str], Output[T], None] = None, labels: Union[Sequence[Union[DatabaseUserLabelArgs, Mapping[str, Any], Awaitable[Union[DatabaseUserLabelArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[DatabaseUserLabelArgs, Mapping[str, Any], Awaitable[Union[DatabaseUserLabelArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, password: Union[str, Awaitable[str], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, roles: Union[Sequence[Union[DatabaseUserRoleArgs, Mapping[str, Any], Awaitable[Union[DatabaseUserRoleArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[DatabaseUserRoleArgs, Mapping[str, Any], Awaitable[Union[DatabaseUserRoleArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, scopes: Union[Sequence[Union[DatabaseUserScopeArgs, Mapping[str, Any], Awaitable[Union[DatabaseUserScopeArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[DatabaseUserScopeArgs, Mapping[str, Any], Awaitable[Union[DatabaseUserScopeArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, username: Union[str, Awaitable[str], Output[T], None] = None, x509_type: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Create a DatabaseUser resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] auth_database_name: Database against which Atlas authenticates the user. A user must provide both a username and authentication database to log into MongoDB.

Accepted values include:

Parameters
  • aws_iam_type (pulumi.Input[str]) – If this value is set, the new database user authenticates with AWS IAM credentials. If no value is given, Atlas uses the default value of NONE. The accepted types are:

  • database_name (pulumi.Input[str]) – Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

  • project_id (pulumi.Input[str]) – The unique ID for the project to create the database user.

  • roles (pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['DatabaseUserRoleArgs']]]]) – List of user’s roles and the databases / collections on which the roles apply. A role allows the user to perform particular actions on the specified database. A role on the admin database can include privileges that apply to the other databases as well. See Roles below for more details.

  • username (pulumi.Input[str]) – Username for authenticating to MongoDB.

  • x509_type (pulumi.Input[str]) – X.509 method by which the provided username is authenticated. If no value is given, Atlas uses the default value of NONE. The accepted types are:

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, auth_database_name: Union[str, Awaitable[str], Output[T], None] = None, aws_iam_type: Union[str, Awaitable[str], Output[T], None] = None, database_name: Union[str, Awaitable[str], Output[T], None] = None, labels: Union[Sequence[Union[DatabaseUserLabelArgs, Mapping[str, Any], Awaitable[Union[DatabaseUserLabelArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[DatabaseUserLabelArgs, Mapping[str, Any], Awaitable[Union[DatabaseUserLabelArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, password: Union[str, Awaitable[str], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, roles: Union[Sequence[Union[DatabaseUserRoleArgs, Mapping[str, Any], Awaitable[Union[DatabaseUserRoleArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[DatabaseUserRoleArgs, Mapping[str, Any], Awaitable[Union[DatabaseUserRoleArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, scopes: Union[Sequence[Union[DatabaseUserScopeArgs, Mapping[str, Any], Awaitable[Union[DatabaseUserScopeArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[DatabaseUserScopeArgs, Mapping[str, Any], Awaitable[Union[DatabaseUserScopeArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, username: Union[str, Awaitable[str], Output[T], None] = None, x509_type: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_mongodbatlas.database_user.DatabaseUser

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auth_database_name (pulumi.Input[str]) – Database against which Atlas authenticates the user. A user must provide both a username and authentication database to log into MongoDB. Accepted values include:

  • aws_iam_type (pulumi.Input[str]) – If this value is set, the new database user authenticates with AWS IAM credentials. If no value is given, Atlas uses the default value of NONE. The accepted types are:

  • database_name (pulumi.Input[str]) – Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

  • project_id (pulumi.Input[str]) – The unique ID for the project to create the database user.

  • roles (pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['DatabaseUserRoleArgs']]]]) – List of user’s roles and the databases / collections on which the roles apply. A role allows the user to perform particular actions on the specified database. A role on the admin database can include privileges that apply to the other databases as well. See Roles below for more details.

  • username (pulumi.Input[str]) – Username for authenticating to MongoDB.

  • x509_type (pulumi.Input[str]) – X.509 method by which the provided username is authenticated. If no value is given, Atlas uses the default value of NONE. The accepted types are:

property auth_database_name

Database against which Atlas authenticates the user. A user must provide both a username and authentication database to log into MongoDB. Accepted values include:

property aws_iam_type

If this value is set, the new database user authenticates with AWS IAM credentials. If no value is given, Atlas uses the default value of NONE. The accepted types are:

property database_name

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

property project_id

The unique ID for the project to create the database user.

property roles

List of user’s roles and the databases / collections on which the roles apply. A role allows the user to perform particular actions on the specified database. A role on the admin database can include privileges that apply to the other databases as well. See Roles below for more details.

property username

Username for authenticating to MongoDB.

property x509_type

X.509 method by which the provided username is authenticated. If no value is given, Atlas uses the default value of NONE. The accepted types are:

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.EncryptionAtRest(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, aws_kms: Union[EncryptionAtRestAwsKmsArgs, Mapping[str, Any], Awaitable[Union[EncryptionAtRestAwsKmsArgs, Mapping[str, Any]]], Output[T], None] = None, azure_key_vault: Union[EncryptionAtRestAzureKeyVaultArgs, Mapping[str, Any], Awaitable[Union[EncryptionAtRestAzureKeyVaultArgs, Mapping[str, Any]]], Output[T], None] = None, google_cloud_kms: Union[EncryptionAtRestGoogleCloudKmsArgs, Mapping[str, Any], Awaitable[Union[EncryptionAtRestGoogleCloudKmsArgs, Mapping[str, Any]]], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

EncryptionAtRest Allows management of encryption at rest for an Atlas project with one of the following providers:

Amazon Web Services Key Management Service Azure Key Vault Google Cloud KMS

After configuring at least one Encryption at Rest provider for the Atlas project, Project Owners can enable Encryption at Rest for each Atlas cluster for which they require encryption. The Encryption at Rest provider does not have to match the cluster cloud service provider.

Atlas does not automatically rotate user-managed encryption keys. Defer to your preferred Encryption at Rest provider’s documentation and guidance for best practices on key rotation. Atlas automatically creates a 365-day key rotation alert when you configure Encryption at Rest using your Key Management in an Atlas project.

See Encryption at Rest for more information, including prerequisites and restrictions.

IMPORTANT Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.EncryptionAtRest("test",
    aws_kms=mongodbatlas.EncryptionAtRestAwsKmsArgs(
        access_key_id="AKIAIOSFODNN7EXAMPLE",
        customer_master_key_id="030gce02-586d-48d2-a966-05ea954fde0g",
        enabled=True,
        region="US_EAST_1",
        secret_access_key="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
    ),
    azure_key_vault=mongodbatlas.EncryptionAtRestAzureKeyVaultArgs(
        azure_environment="AZURE",
        client_id="g54f9e2-89e3-40fd-8188-EXAMPLEID",
        enabled=True,
        key_identifier="https://EXAMPLEKeyVault.vault.azure.net/keys/EXAMPLEKey/d891821e3d364e9eb88fbd3d11807b86",
        key_vault_name="EXAMPLEKeyVault",
        resource_group_name="ExampleRGName",
        secret="EXAMPLESECRET",
        subscription_id="0ec944e3-g725-44f9-a147-EXAMPLEID",
        tenant_id="e8e4b6ba-ff32-4c88-a9af-EXAMPLEID",
    ),
    google_cloud_kms=mongodbatlas.EncryptionAtRestGoogleCloudKmsArgs(
        enabled=True,
        key_version_resource_id="projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1",
        service_account_key="{"type": "service_account","project_id": "my-project-common-0","private_key_id": "e120598ea4f88249469fcdd75a9a785c1bb3","private_key": "-----BEGIN PRIVATE KEY-----\nMIIEuwIBA(truncated)SfecnS0mT94D9\n-----END PRIVATE KEY-----\n","client_email": "my-email-kms-0@my-project-common-0.iam.gserviceaccount.com","client_id": "10180967717292066","auth_uri": "https://accounts.google.com/o/oauth2/auth","token_uri": "https://accounts.google.com/o/oauth2/token","auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs","client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/my-email-kms-0%40my-project-common-0.iam.gserviceaccount.com"}",
    ),
    project_id="<PROJECT-ID>")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • aws_kms (pulumi.Input[pulumi.InputType['EncryptionAtRestAwsKmsArgs']]) – Specifies AWS KMS configuration details and whether Encryption at Rest is enabled for an Atlas project.

  • azure_key_vault (pulumi.Input[pulumi.InputType['EncryptionAtRestAzureKeyVaultArgs']]) – Specifies Azure Key Vault configuration details and whether Encryption at Rest is enabled for an Atlas project.

  • google_cloud_kms (pulumi.Input[pulumi.InputType['EncryptionAtRestGoogleCloudKmsArgs']]) – Specifies GCP KMS configuration details and whether Encryption at Rest is enabled for an Atlas project.

  • project_id (pulumi.Input[str]) – The unique identifier for the project.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, aws_kms: Union[EncryptionAtRestAwsKmsArgs, Mapping[str, Any], Awaitable[Union[EncryptionAtRestAwsKmsArgs, Mapping[str, Any]]], Output[T], None] = None, azure_key_vault: Union[EncryptionAtRestAzureKeyVaultArgs, Mapping[str, Any], Awaitable[Union[EncryptionAtRestAzureKeyVaultArgs, Mapping[str, Any]]], Output[T], None] = None, google_cloud_kms: Union[EncryptionAtRestGoogleCloudKmsArgs, Mapping[str, Any], Awaitable[Union[EncryptionAtRestGoogleCloudKmsArgs, Mapping[str, Any]]], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_mongodbatlas.encryption_at_rest.EncryptionAtRest

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • aws_kms (pulumi.Input[pulumi.InputType['EncryptionAtRestAwsKmsArgs']]) – Specifies AWS KMS configuration details and whether Encryption at Rest is enabled for an Atlas project.

  • azure_key_vault (pulumi.Input[pulumi.InputType['EncryptionAtRestAzureKeyVaultArgs']]) – Specifies Azure Key Vault configuration details and whether Encryption at Rest is enabled for an Atlas project.

  • google_cloud_kms (pulumi.Input[pulumi.InputType['EncryptionAtRestGoogleCloudKmsArgs']]) – Specifies GCP KMS configuration details and whether Encryption at Rest is enabled for an Atlas project.

  • project_id (pulumi.Input[str]) – The unique identifier for the project.

property aws_kms

Specifies AWS KMS configuration details and whether Encryption at Rest is enabled for an Atlas project.

property azure_key_vault

Specifies Azure Key Vault configuration details and whether Encryption at Rest is enabled for an Atlas project.

property google_cloud_kms

Specifies GCP KMS configuration details and whether Encryption at Rest is enabled for an Atlas project.

property project_id

The unique identifier for the project.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.Get509AuthenticationDatabaseUserResult(certificates=None, customer_x509_cas=None, id=None, project_id=None, username=None)

A collection of values returned by get509AuthenticationDatabaseUser.

property certificates

Array of objects where each details one unexpired database user certificate.

property id

The provider-assigned unique ID for this managed resource.

class pulumi_mongodbatlas.GetAlertConfigurationResult(alert_configuration_id=None, created=None, enabled=None, event_type=None, id=None, matchers=None, metric_threshold=None, notifications=None, project_id=None, threshold=None, updated=None)

A collection of values returned by getAlertConfiguration.

property created

Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created.

property enabled

If set to true, the alert configuration is enabled. If enabled is not exported it is set to false.

property event_type

The type of event that will trigger an alert.

property id

The provider-assigned unique ID for this managed resource.

property threshold

Threshold value outside of which an alert will be triggered.

property updated

Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.

class pulumi_mongodbatlas.GetAuditingResult(audit_authorization_success=None, audit_filter=None, configuration_type=None, enabled=None, id=None, project_id=None)

A collection of values returned by getAuditing.

property audit_authorization_success

JSON-formatted audit filter used by the project

property audit_filter

Indicates whether the auditing system captures successful authentication attempts for audit filters using the “atype” : “authCheck” auditing event. For more information, see auditAuthorizationSuccess

property configuration_type

Denotes the configuration method for the audit filter. Possible values are: NONE - auditing not configured for the project.m FILTER_BUILDER - auditing configured via Atlas UI filter builderm FILTER_JSON - auditing configured via Atlas custom filter or API.

property enabled

Denotes whether or not the project associated with the {GROUP-ID} has database auditing enabled.

property id

The provider-assigned unique ID for this managed resource.

class pulumi_mongodbatlas.GetCloudProviderSnapshotBackupPolicyResult(cluster_id=None, cluster_name=None, id=None, next_snapshot=None, policies=None, project_id=None, reference_hour_of_day=None, reference_minute_of_hour=None, restore_window_days=None, update_snapshots=None)

A collection of values returned by getCloudProviderSnapshotBackupPolicy.

property cluster_id

Unique identifier of the Atlas cluster.

property id

The provider-assigned unique ID for this managed resource.

property next_snapshot

UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.

property policies

A list of policy definitions for the cluster.

  • policies.#.id - Unique identifier of the backup policy.

property reference_hour_of_day

UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.

property reference_minute_of_hour

UTC Minute of day between 0 and 59 representing which minute of the referenceHourOfDay that Atlas takes the snapshot.

property restore_window_days

Specifies a restore window in days for cloud backup to maintain.

class pulumi_mongodbatlas.GetCloudProviderSnapshotRestoreJobResult(cancelled=None, cluster_name=None, created_at=None, delivery_type=None, delivery_urls=None, expired=None, expires_at=None, finished_at=None, id=None, job_id=None, oplog_inc=None, oplog_ts=None, point_in_time_utc_seconds=None, project_id=None, snapshot_id=None, target_cluster_name=None, target_project_id=None, timestamp=None)

A collection of values returned by getCloudProviderSnapshotRestoreJob.

property cancelled

Indicates whether the restore job was canceled.

property created_at

UTC ISO 8601 formatted point in time when Atlas created the restore job.

property delivery_type

Type of restore job to create. Possible values are: automated and download.

property delivery_urls

One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.

property expired

Indicates whether the restore job expired.

property expires_at

UTC ISO 8601 formatted point in time when the restore job expires.

property finished_at

UTC ISO 8601 formatted point in time when the restore job completed.

property id

The provider-assigned unique ID for this managed resource.

property snapshot_id

Unique identifier of the source snapshot ID of the restore job.

property target_cluster_name

Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated.

property timestamp

Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.

class pulumi_mongodbatlas.GetCloudProviderSnapshotRestoreJobsResult(cluster_name=None, id=None, items_per_page=None, page_num=None, project_id=None, results=None, total_count=None)

A collection of values returned by getCloudProviderSnapshotRestoreJobs.

property id

The provider-assigned unique ID for this managed resource.

property results

Includes cloudProviderSnapshotRestoreJob object for each item detailed in the results array section.

class pulumi_mongodbatlas.GetCloudProviderSnapshotResult(cluster_name=None, created_at=None, description=None, expires_at=None, id=None, master_key_uuid=None, mongod_version=None, project_id=None, snapshot_id=None, snapshot_type=None, status=None, storage_size_bytes=None, type=None)

A collection of values returned by getCloudProviderSnapshot.

property created_at

UTC ISO 8601 formatted point in time when Atlas took the snapshot.

property description

UDescription of the snapshot. Only present for on-demand snapshots.

property expires_at

UTC ISO 8601 formatted point in time when Atlas will delete the snapshot.

property id

The provider-assigned unique ID for this managed resource.

property master_key_uuid

Unique ID of the AWS KMS Customer Master Key used to encrypt the snapshot. Only visible for clusters using Encryption at Rest via Customer KMS.

property mongod_version

Version of the MongoDB server.

property snapshot_type

Specified the type of snapshot. Valid values are onDemand and scheduled.

property status

Current status of the snapshot. One of the following values: queued, inProgress, completed, failed.

property storage_size_bytes

Specifies the size of the snapshot in bytes.

property type

Specifies the type of cluster: replicaSet or shardedCluster.

class pulumi_mongodbatlas.GetCloudProviderSnapshotsResult(cluster_name=None, id=None, items_per_page=None, page_num=None, project_id=None, results=None, total_count=None)

A collection of values returned by getCloudProviderSnapshots.

property id

The provider-assigned unique ID for this managed resource.

property results

Includes cloudProviderSnapshot object for each item detailed in the results array section.

class pulumi_mongodbatlas.GetClusterResult(auto_scaling_compute_enabled=None, auto_scaling_compute_scale_down_enabled=None, auto_scaling_disk_gb_enabled=None, backing_provider_name=None, backup_enabled=None, bi_connector=None, cluster_type=None, connection_strings=None, container_id=None, disk_size_gb=None, encryption_at_rest_provider=None, id=None, labels=None, mongo_db_major_version=None, mongo_db_version=None, mongo_uri=None, mongo_uri_updated=None, mongo_uri_with_options=None, name=None, num_shards=None, paused=None, pit_enabled=None, project_id=None, provider_auto_scaling_compute_max_instance_size=None, provider_auto_scaling_compute_min_instance_size=None, provider_backup_enabled=None, provider_disk_iops=None, provider_disk_type_name=None, provider_encrypt_ebs_volume=None, provider_instance_size_name=None, provider_name=None, provider_region_name=None, provider_volume_type=None, replication_factor=None, replication_specs=None, snapshot_backup_policies=None, srv_address=None, state_name=None)

A collection of values returned by getCluster.

property auto_scaling_compute_enabled

(Optional) Specifies whether cluster tier auto-scaling is enabled. The default is false.

property auto_scaling_compute_scale_down_enabled

(Optional) Set to true to enable the cluster tier to scale down.

property auto_scaling_disk_gb_enabled

Indicates whether disk auto-scaling is enabled.

property backing_provider_name

Indicates Cloud service provider on which the server for a multi-tenant cluster is provisioned.

property backup_enabled

Legacy Option, Indicates whether Atlas continuous backups are enabled for the cluster.

property bi_connector

Indicates BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.

property cluster_type

Indicates the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

property connection_strings

Set of connection strings that your applications use to connect to this cluster. More info in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

  • connection_strings.standard - Public mongodb:// connection string for this cluster.

  • connection_strings.standard_srv - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.standard.

  • connection_strings.aws_private_link - Private-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster.

  • connection_strings.aws_private_link_srv - Private-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.awsPrivateLink.

  • connection_strings.private - Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.

  • connection_strings.private_srv - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.

property container_id

The Network Peering Container ID.

property disk_size_gb

Indicates the size in gigabytes of the server’s root volume (AWS/GCP Only).

property encryption_at_rest_provider

Indicates whether Encryption at Rest is enabled or disabled.

property id

The provider-assigned unique ID for this managed resource.

property mongo_db_major_version

Indicates the version of the cluster to deploy.

property mongo_db_version

Version of MongoDB the cluster runs, in major-version.minor-version format.

property mongo_uri

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

property mongo_uri_updated

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

property mongo_uri_with_options

Describes connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.

property name

The name of the current plugin

property num_shards

Number of shards to deploy in the specified zone.

property paused

Flag that indicates whether the cluster is paused or not.

property pit_enabled

Flag that indicates if the cluster uses Continuous Cloud Backup.

property provider_auto_scaling_compute_max_instance_size

(Optional) Maximum instance size to which your cluster can automatically scale.

property provider_auto_scaling_compute_min_instance_size

(Optional) Minimum instance size to which your cluster can automatically scale.

property provider_backup_enabled

Flag indicating if the cluster uses Cloud Backup Snapshots for backups.

property provider_disk_iops

Indicates the maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected providerSettings.instanceSizeName and diskSizeGB.

property provider_disk_type_name

Describes Azure disk type of the server’s root volume (Azure Only).

property provider_encrypt_ebs_volume

Indicates whether the Amazon EBS encryption is enabled. This feature encrypts the server’s root volume for both data at rest within the volume and data moving between the volume and the instance.

property provider_instance_size_name

Atlas provides different instance sizes, each with a default storage capacity and RAM size.

property provider_name

Indicates the cloud service provider on which the servers are provisioned.

property provider_region_name

Indicates Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas Region name, see the reference list for AWS, GCP, Azure.

property provider_volume_type

Indicates the type of the volume. The possible values are: STANDARD and PROVISIONED.

property replication_factor

Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.

property replication_specs

Configuration for cluster regions. See Replication Spec below for more details.

property snapshot_backup_policies

current snapshot schedule and retention settings for the cluster.

property srv_address

Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.

property state_name

Indicates the current state of the cluster. The possible states are:

  • IDLE

  • CREATING

  • UPDATING

  • DELETING

  • DELETED

  • REPAIRING

class pulumi_mongodbatlas.GetClustersResult(id=None, project_id=None, results=None)

A collection of values returned by getClusters.

property id

The provider-assigned unique ID for this managed resource.

property results

A list where each represents a Cluster. See Cluster below for more details.

class pulumi_mongodbatlas.GetCustomDbRoleResult(actions=None, id=None, inherited_roles=None, project_id=None, role_name=None)

A collection of values returned by getCustomDbRole.

property id

The provider-assigned unique ID for this managed resource.

class pulumi_mongodbatlas.GetCustomDbRolesResult(id=None, project_id=None, results=None)

A collection of values returned by getCustomDbRoles.

property id

The provider-assigned unique ID for this managed resource.

property results

A list where each represents a custom db roles.

class pulumi_mongodbatlas.GetDatabaseUserResult(auth_database_name=None, aws_iam_type=None, database_name=None, id=None, labels=None, project_id=None, roles=None, scopes=None, username=None, x509_type=None)

A collection of values returned by getDatabaseUser.

property aws_iam_type

The new database user authenticates with AWS IAM credentials. Default is NONE, USER means user has AWS IAM user credentials, ROLE - means user has credentials associated with an AWS IAM role.

property database_name

Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

property id

The provider-assigned unique ID for this managed resource.

property roles

List of user’s roles and the databases / collections on which the roles apply. A role allows the user to perform particular actions on the specified database. A role on the admin database can include privileges that apply to the other databases as well. See Roles below for more details.

property scopes

Array of clusters and Atlas Data Lakes that this user has access to.

property x509_type

X.509 method by which the provided username is authenticated.

class pulumi_mongodbatlas.GetDatabaseUsersResult(id=None, project_id=None, results=None)

A collection of values returned by getDatabaseUsers.

property id

The provider-assigned unique ID for this managed resource.

property project_id

ID of the Atlas project the user belongs to.

property results

A list where each represents a Database user.

class pulumi_mongodbatlas.GetGlobalClusterConfigResult(cluster_name=None, custom_zone_mapping=None, id=None, managed_namespaces=None, project_id=None)

A collection of values returned by getGlobalClusterConfig.

property custom_zone_mapping

A map of all custom zone mappings defined for the Global Cluster. Atlas automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. If your Global Cluster does not have any custom zone mappings, this document is empty.

property id

The provider-assigned unique ID for this managed resource.

property managed_namespaces

Add a managed namespaces to a Global Cluster. For more information about managed namespaces, see Global Clusters. See Managed Namespace below for more details.

class pulumi_mongodbatlas.GetMaintenanceWindowResult(day_of_week=None, hour_of_day=None, id=None, number_of_deferrals=None, project_id=None, start_asap=None)

A collection of values returned by getMaintenanceWindow.

property day_of_week

Day of the week when you would like the maintenance window to start as a 1-based integer: S=1, M=2, T=3, W=4, T=5, F=6, S=7.

property hour_of_day

Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12 (Time zone is UTC).

property id

The provider-assigned unique ID for this managed resource.

property number_of_deferrals

Number of times the current maintenance event for this project has been deferred, you can set a maximum of 2 deferrals.

property start_asap

Flag indicating whether project maintenance has been directed to start immediately. If you request that maintenance begin immediately, this field returns true from the time the request was made until the time the maintenance event completes.

class pulumi_mongodbatlas.GetNetworkContainerResult(atlas_cidr_block=None, azure_subscription_id=None, container_id=None, gcp_project_id=None, id=None, network_name=None, project_id=None, provider_name=None, provisioned=None, region=None, region_name=None, vnet_name=None, vpc_id=None)

A collection of values returned by getNetworkContainer.

property atlas_cidr_block

CIDR block that Atlas uses for your clusters. Atlas uses the specified CIDR block for all other Network Peering connections created in the project. The Atlas CIDR block must be at least a /24 and at most a /21 in one of the following private networks.

property azure_subscription_id

Unique identifer of the Azure subscription in which the VNet resides.

property gcp_project_id

Unique identifier of the GCP project in which the Network Peering connection resides.

property id

The provider-assigned unique ID for this managed resource.

property network_name

Name of the Network Peering connection in the Atlas project.

property provider_name

Cloud provider for this Network Peering connection. If omitted, Atlas sets this parameter to AWS.

property provisioned

Indicates whether the project has Network Peering connections deployed in the container.

property region

The Atlas Azure region name for where this container will exist.

property region_name

The Atlas AWS region name for where this container will exist.

property vnet_name

The name of the Azure VNet. This value is null until you provision an Azure VNet in the container.

property vpc_id

Unique identifier of the project’s VPC.

class pulumi_mongodbatlas.GetNetworkContainersResult(id=None, project_id=None, provider_name=None, results=None)

A collection of values returned by getNetworkContainers.

property id

The provider-assigned unique ID for this managed resource.

property provider_name

Cloud provider for this Network Peering connection. If omitted, Atlas sets this parameter to AWS.

property results

A list where each represents a Network Peering Container.

class pulumi_mongodbatlas.GetNetworkPeeringResult(accepter_region_name=None, atlas_cidr_block=None, atlas_id=None, aws_account_id=None, azure_directory_id=None, azure_subscription_id=None, connection_id=None, container_id=None, error_message=None, error_state=None, error_state_name=None, gcp_project_id=None, id=None, network_name=None, peering_id=None, project_id=None, provider_name=None, resource_group_name=None, route_table_cidr_block=None, status=None, status_name=None, vnet_name=None, vpc_id=None)

A collection of values returned by getNetworkPeering.

property accepter_region_name

Specifies the region where the peer VPC resides. For complete lists of supported regions, see Amazon Web Services.

property atlas_cidr_block

Unique identifier for an Azure AD directory.

property aws_account_id

Account ID of the owner of the peer VPC.

property azure_directory_id

Unique identifier for an Azure AD directory.

property azure_subscription_id

Unique identifer of the Azure subscription in which the VNet resides.

property connection_id

Unique identifier for the peering connection.

property error_message

When "status" : "FAILED", Atlas provides a description of the error.

property error_state

Description of the Atlas error when status is Failed, Otherwise, Atlas returns null.

property error_state_name

Error state, if any. The VPC peering connection error state value can be one of the following: REJECTED, EXPIRED, INVALID_ARGUMENT.

property gcp_project_id

GCP project ID of the owner of the network peer.

property id

The provider-assigned unique ID for this managed resource.

property network_name

Name of the network peer to which Atlas connects.

property provider_name

Cloud provider for this VPC peering connection. If omitted, Atlas sets this parameter to AWS. (Possible Values AWS, AZURE, GCP).

property resource_group_name

Name of your Azure resource group.

property route_table_cidr_block

Peer VPC CIDR block or subnet.

property status

Status of the Atlas network peering connection: ADDING_PEER, AVAILABLE, FAILED, DELETING, WAITING_FOR_USER.

property status_name

The VPC peering connection status value can be one of the following: INITIATING, PENDING_ACCEPTANCE, FAILED, FINALIZING, AVAILABLE, TERMINATING.

property vnet_name

Name of your Azure VNet.

property vpc_id

Unique identifier of the peer VPC.

class pulumi_mongodbatlas.GetNetworkPeeringsResult(id=None, project_id=None, results=None)

A collection of values returned by getNetworkPeerings.

property id

The provider-assigned unique ID for this managed resource.

property results

A list where each represents a Network Peering Connection.

class pulumi_mongodbatlas.GetPrivateEndpointInterfaceLinkResult(connection_status=None, delete_requested=None, error_message=None, id=None, interface_endpoint_id=None, private_link_id=None, project_id=None)

A collection of values returned by getPrivateEndpointInterfaceLink.

property connection_status

Status of the interface endpoint. Returns one of the following values:

property delete_requested

Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.

property error_message

Error message pertaining to the interface endpoint. Returns null if there are no errors.

property id

The provider-assigned unique ID for this managed resource.

class pulumi_mongodbatlas.GetPrivateEndpointResult(endpoint_service_name=None, error_message=None, id=None, interface_endpoints=None, private_link_id=None, project_id=None, status=None)

A collection of values returned by getPrivateEndpoint.

property endpoint_service_name

Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.

property error_message

Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors.

property id

The provider-assigned unique ID for this managed resource.

property interface_endpoints

Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.

property status

Status of the AWS PrivateLink connection. Returns one of the following values:

class pulumi_mongodbatlas.GetProjectIpWhitelistResult(aws_security_group=None, cidr_block=None, comment=None, id=None, ip_address=None, project_id=None)

A collection of values returned by getProjectIpWhitelist.

property comment

Comment to add to the whitelist entry.

property id

The provider-assigned unique ID for this managed resource.

class pulumi_mongodbatlas.GetProjectResult(cluster_count=None, created=None, id=None, name=None, org_id=None, project_id=None, teams=None)

A collection of values returned by getProject.

property id

The provider-assigned unique ID for this managed resource.

property name

The name of the project you want to create. (Cannot be changed via this Provider after creation.)

property org_id

The ID of the organization you want to create the project within. ``cluster_count`` - The number of Atlas clusters deployed in the project.created - The ISO-8601-formatted timestamp of when Atlas created the project.

  • teams.#.team_id - The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.

  • teams.#.role_names - Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The following are valid roles:

  • GROUP_OWNER

  • GROUP_READ_ONLY

  • GROUP_DATA_ACCESS_ADMIN

  • GROUP_DATA_ACCESS_READ_WRITE

  • GROUP_DATA_ACCESS_READ_ONLY

  • GROUP_CLUSTER_MANAGER

class pulumi_mongodbatlas.GetProjectsResult(id=None, items_per_page=None, page_num=None, results=None, total_count=None)

A collection of values returned by getProjects.

property id

The provider-assigned unique ID for this managed resource.

class pulumi_mongodbatlas.GetTeamResult(id=None, name=None, org_id=None, team_id=None, usernames=None)

A collection of values returned by getTeam.

property id

The provider-assigned unique ID for this managed resource.

property name

The name of the team you want to create.

property team_id

The unique identifier for the team.

property usernames

The users who are part of the organization.

class pulumi_mongodbatlas.GetTeamsResult(id=None, name=None, org_id=None, team_id=None, usernames=None)

A collection of values returned by getTeams.

property id

The provider-assigned unique ID for this managed resource.

class pulumi_mongodbatlas.GlobalClusterConfig(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, cluster_name: Union[str, Awaitable[str], Output[T], None] = None, custom_zone_mappings: Union[Sequence[Union[GlobalClusterConfigCustomZoneMappingArgs, Mapping[str, Any], Awaitable[Union[GlobalClusterConfigCustomZoneMappingArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[GlobalClusterConfigCustomZoneMappingArgs, Mapping[str, Any], Awaitable[Union[GlobalClusterConfigCustomZoneMappingArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, managed_namespaces: Union[Sequence[Union[GlobalClusterConfigManagedNamespaceArgs, Mapping[str, Any], Awaitable[Union[GlobalClusterConfigManagedNamespaceArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[GlobalClusterConfigManagedNamespaceArgs, Mapping[str, Any], Awaitable[Union[GlobalClusterConfigManagedNamespaceArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

GlobalClusterConfig provides a Global Cluster Configuration resource.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.Cluster("test",
    project_id="<YOUR-PROJECT-ID>",
    disk_size_gb=80,
    backup_enabled=False,
    provider_backup_enabled=True,
    cluster_type="GEOSHARDED",
    provider_name="AWS",
    provider_disk_iops=240,
    provider_instance_size_name="M30",
    replication_specs=[
        mongodbatlas.ClusterReplicationSpecArgs(
            zone_name="Zone 1",
            num_shards=1,
            regions_configs=[mongodbatlas.ClusterReplicationSpecRegionsConfigArgs(
                region_name="EU_CENTRAL_1",
                electable_nodes=3,
                priority=7,
                read_only_nodes=0,
            )],
        ),
        mongodbatlas.ClusterReplicationSpecArgs(
            zone_name="Zone 2",
            num_shards=1,
            regions_configs=[mongodbatlas.ClusterReplicationSpecRegionsConfigArgs(
                region_name="US_EAST_2",
                electable_nodes=3,
                priority=7,
                read_only_nodes=0,
            )],
        ),
    ])
config = mongodbatlas.GlobalClusterConfig("config",
    project_id=test.project_id,
    cluster_name=test.name,
    managed_namespaces=[mongodbatlas.GlobalClusterConfigManagedNamespaceArgs(
        db="mydata",
        collection="publishers",
        custom_shard_key="city",
    )],
    custom_zone_mappings=[mongodbatlas.GlobalClusterConfigCustomZoneMappingArgs(
        location="CA",
        zone="Zone 1",
    )])
import pulumi
import pulumi_mongodbatlas as mongodbatlas

cluster_test = mongodbatlas.Cluster("cluster-test",
    project_id="<YOUR-PROJECT-ID>",
    num_shards=1,
    replication_factor=3,
    backup_enabled=True,
    auto_scaling_disk_gb_enabled=True,
    mongo_db_major_version="4.0",
    provider_name="AWS",
    disk_size_gb=100,
    provider_disk_iops=300,
    provider_encrypt_ebs_volume=False,
    provider_instance_size_name="M40",
    provider_region_name="US_EAST_1")
config = mongodbatlas.GlobalClusterConfig("config",
    project_id=mongodbatlas_cluster["test"]["project_id"],
    cluster_name=mongodbatlas_cluster["test"]["name"],
    managed_namespaces=[mongodbatlas.GlobalClusterConfigManagedNamespaceArgs(
        db="mydata",
        collection="publishers",
        custom_shard_key="city",
    )],
    custom_zone_mappings=[mongodbatlas.GlobalClusterConfigCustomZoneMappingArgs(
        location="CA",
        zone="Zone 1",
    )])
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • custom_zone_mappings (pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['GlobalClusterConfigCustomZoneMappingArgs']]]]) – Each element in the list maps one ISO location code to a zone in your Global Cluster. See Custom Zone Mapping below for more details.

  • managed_namespaces (pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['GlobalClusterConfigManagedNamespaceArgs']]]]) –

    Add a managed namespaces to a Global Cluster. For more information about managed namespaces, see Global Clusters. See Managed Namespace below for more details.

  • project_id (pulumi.Input[str]) – The unique ID for the project to create the database user.

* `cluster_name - (Required) The name of the Global Cluster.
static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, cluster_name: Union[str, Awaitable[str], Output[T], None] = None, custom_zone_mapping: Union[Mapping[str, Any], Awaitable[Mapping[str, Any]], Output[T], None] = None, custom_zone_mappings: Union[Sequence[Union[GlobalClusterConfigCustomZoneMappingArgs, Mapping[str, Any], Awaitable[Union[GlobalClusterConfigCustomZoneMappingArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[GlobalClusterConfigCustomZoneMappingArgs, Mapping[str, Any], Awaitable[Union[GlobalClusterConfigCustomZoneMappingArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, managed_namespaces: Union[Sequence[Union[GlobalClusterConfigManagedNamespaceArgs, Mapping[str, Any], Awaitable[Union[GlobalClusterConfigManagedNamespaceArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[GlobalClusterConfigManagedNamespaceArgs, Mapping[str, Any], Awaitable[Union[GlobalClusterConfigManagedNamespaceArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_mongodbatlas.global_cluster_config.GlobalClusterConfig

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • Any]] custom_zone_mapping (pulumi.Input[Mapping[str,) – A map of all custom zone mappings defined for the Global Cluster. Atlas automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. If your Global Cluster does not have any custom zone mappings, this document is empty.

  • custom_zone_mappings (pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['GlobalClusterConfigCustomZoneMappingArgs']]]]) – Each element in the list maps one ISO location code to a zone in your Global Cluster. See Custom Zone Mapping below for more details.

  • managed_namespaces (pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['GlobalClusterConfigManagedNamespaceArgs']]]]) –

    Add a managed namespaces to a Global Cluster. For more information about managed namespaces, see Global Clusters. See Managed Namespace below for more details.

  • project_id (pulumi.Input[str]) – The unique ID for the project to create the database user.

* `cluster_name - (Required) The name of the Global Cluster.
property custom_zone_mapping

A map of all custom zone mappings defined for the Global Cluster. Atlas automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. If your Global Cluster does not have any custom zone mappings, this document is empty.

property custom_zone_mappings

Each element in the list maps one ISO location code to a zone in your Global Cluster. See Custom Zone Mapping below for more details.

property managed_namespaces

Add a managed namespaces to a Global Cluster. For more information about managed namespaces, see Global Clusters. See Managed Namespace below for more details.

property project_id

The unique ID for the project to create the database user.

  • `cluster_name - (Required) The name of the Global Cluster.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.MaintenanceWindow(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, day_of_week: Union[int, Awaitable[int], Output[T], None] = None, defer: Union[bool, Awaitable[bool], Output[T], None] = None, hour_of_day: Union[int, Awaitable[int], Output[T], None] = None, number_of_deferrals: Union[int, Awaitable[int], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

MaintenanceWindow provides a resource to schedule a maintenance window for your MongoDB Atlas Project and/or set to defer a scheduled maintenance up to two times.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

  • Urgent Maintenance Activities Cannot Wait: Urgent maintenance activities such as security patches cannot wait for your chosen window. Atlas will start those maintenance activities when needed.

Once maintenance is scheduled for your cluster, you cannot change your maintenance window until the current maintenance efforts have completed.

  • Maintenance Requires Replica Set Elections: Atlas performs maintenance the same way as the manual maintenance procedure. This requires at least one replica set election during the maintenance window per replica set.

  • Maintenance Starts As Close to the Hour As Possible: Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or expected system issues could delay the start time.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.MaintenanceWindow("test",
    day_of_week=3,
    hour_of_day=4,
    project_id="<your-project-id>")
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.MaintenanceWindow("test",
    defer=True,
    project_id="<your-project-id>")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • day_of_week (pulumi.Input[int]) – Day of the week when you would like the maintenance window to start as a 1-based integer: S=1, M=2, T=3, W=4, T=5, F=6, S=7.

  • defer (pulumi.Input[bool]) – Defer maintenance for the given project for one week.

  • hour_of_day (pulumi.Input[int]) – Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12 (Time zone is UTC).

  • number_of_deferrals (pulumi.Input[int]) – Number of times the current maintenance event for this project has been deferred, you can set a maximum of 2 deferrals.

  • project_id (pulumi.Input[str]) – The unique identifier of the project for the Maintenance Window.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, day_of_week: Union[int, Awaitable[int], Output[T], None] = None, defer: Union[bool, Awaitable[bool], Output[T], None] = None, hour_of_day: Union[int, Awaitable[int], Output[T], None] = None, number_of_deferrals: Union[int, Awaitable[int], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, start_asap: Union[bool, Awaitable[bool], Output[T], None] = None) → pulumi_mongodbatlas.maintenance_window.MaintenanceWindow

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • day_of_week (pulumi.Input[int]) – Day of the week when you would like the maintenance window to start as a 1-based integer: S=1, M=2, T=3, W=4, T=5, F=6, S=7.

  • defer (pulumi.Input[bool]) – Defer maintenance for the given project for one week.

  • hour_of_day (pulumi.Input[int]) – Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12 (Time zone is UTC).

  • number_of_deferrals (pulumi.Input[int]) – Number of times the current maintenance event for this project has been deferred, you can set a maximum of 2 deferrals.

  • project_id (pulumi.Input[str]) – The unique identifier of the project for the Maintenance Window.

  • start_asap (pulumi.Input[bool]) – Flag indicating whether project maintenance has been directed to start immediately. If you request that maintenance begin immediately, this field returns true from the time the request was made until the time the maintenance event completes.

property day_of_week

Day of the week when you would like the maintenance window to start as a 1-based integer: S=1, M=2, T=3, W=4, T=5, F=6, S=7.

property defer

Defer maintenance for the given project for one week.

property hour_of_day

Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12 (Time zone is UTC).

property number_of_deferrals

Number of times the current maintenance event for this project has been deferred, you can set a maximum of 2 deferrals.

property project_id

The unique identifier of the project for the Maintenance Window.

property start_asap

Flag indicating whether project maintenance has been directed to start immediately. If you request that maintenance begin immediately, this field returns true from the time the request was made until the time the maintenance event completes.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.NetworkContainer(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, atlas_cidr_block: Union[str, Awaitable[str], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, provider_name: Union[str, Awaitable[str], Output[T], None] = None, region: Union[str, Awaitable[str], Output[T], None] = None, region_name: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

NetworkContainer provides a Network Peering Container resource. The resource lets you create, edit and delete network peering containers. The resource requires your Project ID. Each cloud provider requires slightly different attributes so read the argument reference carefully.

Network peering container is a general term used to describe any cloud providers’ VPC/VNet concept. Containers only need to be created if the peering connection to the cloud provider will be created before the first cluster that requires the container. If the cluster has been/will be created first Atlas automatically creates the required container per the “containers per cloud provider” information that follows (in this case you can obtain the container id from the cluster resource attribute container_id).

The following is the maximum number of Network Peering containers per cloud provider:
&#8226; GCP - One container per project.
&#8226; AWS and Azure - One container per cloud provider region.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.NetworkContainer("test",
    atlas_cidr_block="10.8.0.0/21",
    project_id="<YOUR-PROJECT-ID>",
    provider_name="AWS",
    region_name="US_EAST_1")
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.NetworkContainer("test",
    atlas_cidr_block="10.8.0.0/21",
    project_id="<YOUR-PROJECT-ID>",
    provider_name="GCP")
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.NetworkContainer("test",
    atlas_cidr_block="10.8.0.0/21",
    project_id="<YOUR-PROJECT-ID>",
    provider_name="AZURE",
    region="US_EAST_2")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • atlas_cidr_block (pulumi.Input[str]) –

    CIDR block that Atlas uses for the Network Peering containers in your project. Atlas uses the specified CIDR block for all other Network Peering connections created in the project. The Atlas CIDR block must be at least a /24 and at most a /21 in one of the following private networks:

* Lower bound: 10.0.0.0 -        Upper bound: 10.255.255.255 -   Prefix: 10/8
* Lower bound: 172.16.0.0 -      Upper bound:172.31.255.255 -    Prefix: 172.16/12
* Lower bound: 192.168.0.0 -     Upper bound:192.168.255.255 -   Prefix: 192.168/16
Parameters
  • project_id (pulumi.Input[str]) – Unique identifier for the Atlas project for this Network Peering Container.

  • provider_name (pulumi.Input[str]) – Cloud provider for this Network Peering connection. Accepted values are GCP, AWS, AZURE. If omitted, Atlas sets this parameter to AWS.

  • region (pulumi.Input[str]) –

    Atlas region where the container resides, see the reference list for Atlas Azure region names Azure.

  • region_name (pulumi.Input[str]) –

    The Atlas AWS region name for where this container will exist, see the reference list for Atlas AWS region names AWS.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, atlas_cidr_block: Union[str, Awaitable[str], Output[T], None] = None, azure_subscription_id: Union[str, Awaitable[str], Output[T], None] = None, container_id: Union[str, Awaitable[str], Output[T], None] = None, gcp_project_id: Union[str, Awaitable[str], Output[T], None] = None, network_name: Union[str, Awaitable[str], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, provider_name: Union[str, Awaitable[str], Output[T], None] = None, provisioned: Union[bool, Awaitable[bool], Output[T], None] = None, region: Union[str, Awaitable[str], Output[T], None] = None, region_name: Union[str, Awaitable[str], Output[T], None] = None, vnet_name: Union[str, Awaitable[str], Output[T], None] = None, vpc_id: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_mongodbatlas.network_container.NetworkContainer

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • atlas_cidr_block (pulumi.Input[str]) –

    CIDR block that Atlas uses for the Network Peering containers in your project. Atlas uses the specified CIDR block for all other Network Peering connections created in the project. The Atlas CIDR block must be at least a /24 and at most a /21 in one of the following private networks:

* Lower bound: 10.0.0.0 -        Upper bound: 10.255.255.255 -   Prefix: 10/8
* Lower bound: 172.16.0.0 -      Upper bound:172.31.255.255 -    Prefix: 172.16/12
* Lower bound: 192.168.0.0 -     Upper bound:192.168.255.255 -   Prefix: 192.168/16
Parameters

azure_subscription_id (pulumi.Input[str]) – Unique identifier of the Azure subscription in which the VNet resides.

* * `vnet_name` -        The name of the Azure VNet. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
Parameters
  • container_id (pulumi.Input[str]) – The Network Peering Container ID.

  • gcp_project_id (pulumi.Input[str]) – Unique identifier of the GCP project in which the network peer resides. Returns null. This value is populated once you create a new network peering connection with the network peering resource.

  • network_name (pulumi.Input[str]) – Unique identifier of the Network Peering connection in the Atlas project. Returns null. This value is populated once you create a new network peering connection with the network peering resource. AZURE ONLY:

  • project_id (pulumi.Input[str]) – Unique identifier for the Atlas project for this Network Peering Container.

  • provider_name (pulumi.Input[str]) – Cloud provider for this Network Peering connection. Accepted values are GCP, AWS, AZURE. If omitted, Atlas sets this parameter to AWS.

  • provisioned (pulumi.Input[bool]) – Indicates whether the project has Network Peering connections deployed in the container. AWS ONLY:

  • region (pulumi.Input[str]) –

    Atlas region where the container resides, see the reference list for Atlas Azure region names Azure.

  • region_name (pulumi.Input[str]) –

    The Atlas AWS region name for where this container will exist, see the reference list for Atlas AWS region names AWS.

  • vpc_id (pulumi.Input[str]) – Unique identifier of Atlas’ AWS VPC. CGP ONLY:

property atlas_cidr_block

CIDR block that Atlas uses for the Network Peering containers in your project. Atlas uses the specified CIDR block for all other Network Peering connections created in the project. The Atlas CIDR block must be at least a /24 and at most a /21 in one of the following private networks:

  • Lower bound: 10.0.0.0 - Upper bound: 10.255.255.255 - Prefix: 10/8

  • Lower bound: 172.16.0.0 - Upper bound:172.31.255.255 - Prefix: 172.16/12

  • Lower bound: 192.168.0.0 - Upper bound:192.168.255.255 - Prefix: 192.168/16

property azure_subscription_id

Unique identifier of the Azure subscription in which the VNet resides.

    • vnet_name - The name of the Azure VNet. Returns null. This value is populated once you create a new network peering connection with the network peering resource.

property container_id

The Network Peering Container ID.

property gcp_project_id

Unique identifier of the GCP project in which the network peer resides. Returns null. This value is populated once you create a new network peering connection with the network peering resource.

property network_name

Unique identifier of the Network Peering connection in the Atlas project. Returns null. This value is populated once you create a new network peering connection with the network peering resource. AZURE ONLY:

property project_id

Unique identifier for the Atlas project for this Network Peering Container.

property provider_name

Cloud provider for this Network Peering connection. Accepted values are GCP, AWS, AZURE. If omitted, Atlas sets this parameter to AWS.

property provisioned

Indicates whether the project has Network Peering connections deployed in the container. AWS ONLY:

property region

Atlas region where the container resides, see the reference list for Atlas Azure region names Azure.

property region_name

The Atlas AWS region name for where this container will exist, see the reference list for Atlas AWS region names AWS.

property vpc_id

Unique identifier of Atlas’ AWS VPC. CGP ONLY:

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.NetworkPeering(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, accepter_region_name: Union[str, Awaitable[str], Output[T], None] = None, atlas_cidr_block: Union[str, Awaitable[str], Output[T], None] = None, atlas_gcp_project_id: Union[str, Awaitable[str], Output[T], None] = None, atlas_vpc_name: Union[str, Awaitable[str], Output[T], None] = None, aws_account_id: Union[str, Awaitable[str], Output[T], None] = None, azure_directory_id: Union[str, Awaitable[str], Output[T], None] = None, azure_subscription_id: Union[str, Awaitable[str], Output[T], None] = None, container_id: Union[str, Awaitable[str], Output[T], None] = None, gcp_project_id: Union[str, Awaitable[str], Output[T], None] = None, network_name: Union[str, Awaitable[str], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, provider_name: Union[str, Awaitable[str], Output[T], None] = None, resource_group_name: Union[str, Awaitable[str], Output[T], None] = None, route_table_cidr_block: Union[str, Awaitable[str], Output[T], None] = None, vnet_name: Union[str, Awaitable[str], Output[T], None] = None, vpc_id: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Create a NetworkPeering resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] accepter_region_name: Specifies the AWS region where the peer VPC resides. For complete lists of supported regions, see Amazon Web Services. :param pulumi.Input[str] atlas_gcp_project_id: The Atlas GCP Project ID for the GCP VPC used by your atlas cluster that it is need to set up the reciprocal connection. :param pulumi.Input[str] aws_account_id: AWS Account ID of the owner of the peer VPC. :param pulumi.Input[str] azure_directory_id: Unique identifier for an Azure AD directory. :param pulumi.Input[str] azure_subscription_id: Unique identifier of the Azure subscription in which the VNet resides. :param pulumi.Input[str] container_id: Unique identifier of the MongoDB Atlas container for the provider (GCP) or provider/region (AWS, AZURE). You can create an MongoDB Atlas container using the network_container resource or it can be obtained from the cluster returned values if a cluster has been created before the first container. :param pulumi.Input[str] gcp_project_id: GCP project ID of the owner of the network peer. :param pulumi.Input[str] network_name: Name of the network peer to which Atlas connects. :param pulumi.Input[str] project_id: The unique ID for the MongoDB Atlas project to create the database user. :param pulumi.Input[str] provider_name: Cloud provider to whom the peering connection is being made. (Possible Values AWS, AZURE, GCP). :param pulumi.Input[str] resource_group_name: Name of your Azure resource group. :param pulumi.Input[str] route_table_cidr_block: AWS VPC CIDR block or subnet. :param pulumi.Input[str] vnet_name: Name of your Azure VNet. :param pulumi.Input[str] vpc_id: Unique identifier of the AWS peer VPC (Note: this is not the same as the Atlas AWS VPC that is returned by the network_container resource).

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, accepter_region_name: Union[str, Awaitable[str], Output[T], None] = None, atlas_cidr_block: Union[str, Awaitable[str], Output[T], None] = None, atlas_gcp_project_id: Union[str, Awaitable[str], Output[T], None] = None, atlas_id: Union[str, Awaitable[str], Output[T], None] = None, atlas_vpc_name: Union[str, Awaitable[str], Output[T], None] = None, aws_account_id: Union[str, Awaitable[str], Output[T], None] = None, azure_directory_id: Union[str, Awaitable[str], Output[T], None] = None, azure_subscription_id: Union[str, Awaitable[str], Output[T], None] = None, connection_id: Union[str, Awaitable[str], Output[T], None] = None, container_id: Union[str, Awaitable[str], Output[T], None] = None, error_message: Union[str, Awaitable[str], Output[T], None] = None, error_state: Union[str, Awaitable[str], Output[T], None] = None, error_state_name: Union[str, Awaitable[str], Output[T], None] = None, gcp_project_id: Union[str, Awaitable[str], Output[T], None] = None, network_name: Union[str, Awaitable[str], Output[T], None] = None, peer_id: Union[str, Awaitable[str], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, provider_name: Union[str, Awaitable[str], Output[T], None] = None, resource_group_name: Union[str, Awaitable[str], Output[T], None] = None, route_table_cidr_block: Union[str, Awaitable[str], Output[T], None] = None, status: Union[str, Awaitable[str], Output[T], None] = None, status_name: Union[str, Awaitable[str], Output[T], None] = None, vnet_name: Union[str, Awaitable[str], Output[T], None] = None, vpc_id: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_mongodbatlas.network_peering.NetworkPeering

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • accepter_region_name (pulumi.Input[str]) –

    Specifies the AWS region where the peer VPC resides. For complete lists of supported regions, see Amazon Web Services.

  • atlas_gcp_project_id (pulumi.Input[str]) – The Atlas GCP Project ID for the GCP VPC used by your atlas cluster that it is need to set up the reciprocal connection.

  • aws_account_id (pulumi.Input[str]) – AWS Account ID of the owner of the peer VPC.

  • azure_directory_id (pulumi.Input[str]) – Unique identifier for an Azure AD directory.

  • azure_subscription_id (pulumi.Input[str]) – Unique identifier of the Azure subscription in which the VNet resides.

  • connection_id (pulumi.Input[str]) – Unique identifier of the Atlas network peering container.

  • container_id (pulumi.Input[str]) – Unique identifier of the MongoDB Atlas container for the provider (GCP) or provider/region (AWS, AZURE). You can create an MongoDB Atlas container using the network_container resource or it can be obtained from the cluster returned values if a cluster has been created before the first container.

  • error_message (pulumi.Input[str]) – When "status" : "FAILED", Atlas provides a description of the error.

  • error_state (pulumi.Input[str]) – Description of the Atlas error when status is Failed, Otherwise, Atlas returns null.

  • error_state_name (pulumi.Input[str]) – Error state, if any. The VPC peering connection error state value can be one of the following: REJECTED, EXPIRED, INVALID_ARGUMENT.

  • gcp_project_id (pulumi.Input[str]) – GCP project ID of the owner of the network peer.

  • network_name (pulumi.Input[str]) – Name of the network peer to which Atlas connects.

  • peer_id (pulumi.Input[str]) – Unique identifier of the Atlas network peer.

  • project_id (pulumi.Input[str]) – The unique ID for the MongoDB Atlas project to create the database user.

  • provider_name (pulumi.Input[str]) – Cloud provider to whom the peering connection is being made. (Possible Values AWS, AZURE, GCP).

  • resource_group_name (pulumi.Input[str]) – Name of your Azure resource group.

  • route_table_cidr_block (pulumi.Input[str]) – AWS VPC CIDR block or subnet.

  • status (pulumi.Input[str]) – Status of the Atlas network peering connection. Azure/GCP: ADDING_PEER, AVAILABLE, FAILED, DELETING GCP Only: WAITING_FOR_USER.

  • status_name (pulumi.Input[str]) – (AWS Only) The VPC peering connection status value can be one of the following: INITIATING, PENDING_ACCEPTANCE, FAILED, FINALIZING, AVAILABLE, TERMINATING.

  • vnet_name (pulumi.Input[str]) – Name of your Azure VNet.

  • vpc_id (pulumi.Input[str]) – Unique identifier of the AWS peer VPC (Note: this is not the same as the Atlas AWS VPC that is returned by the network_container resource).

property accepter_region_name

Specifies the AWS region where the peer VPC resides. For complete lists of supported regions, see Amazon Web Services.

property atlas_gcp_project_id

The Atlas GCP Project ID for the GCP VPC used by your atlas cluster that it is need to set up the reciprocal connection.

property aws_account_id

AWS Account ID of the owner of the peer VPC.

property azure_directory_id

Unique identifier for an Azure AD directory.

property azure_subscription_id

Unique identifier of the Azure subscription in which the VNet resides.

property connection_id

Unique identifier of the Atlas network peering container.

property container_id

Unique identifier of the MongoDB Atlas container for the provider (GCP) or provider/region (AWS, AZURE). You can create an MongoDB Atlas container using the network_container resource or it can be obtained from the cluster returned values if a cluster has been created before the first container.

property error_message

When "status" : "FAILED", Atlas provides a description of the error.

property error_state

Description of the Atlas error when status is Failed, Otherwise, Atlas returns null.

property error_state_name

Error state, if any. The VPC peering connection error state value can be one of the following: REJECTED, EXPIRED, INVALID_ARGUMENT.

property gcp_project_id

GCP project ID of the owner of the network peer.

property network_name

Name of the network peer to which Atlas connects.

property peer_id

Unique identifier of the Atlas network peer.

property project_id

The unique ID for the MongoDB Atlas project to create the database user.

property provider_name

Cloud provider to whom the peering connection is being made. (Possible Values AWS, AZURE, GCP).

property resource_group_name

Name of your Azure resource group.

property route_table_cidr_block

AWS VPC CIDR block or subnet.

property status

Status of the Atlas network peering connection. Azure/GCP: ADDING_PEER, AVAILABLE, FAILED, DELETING GCP Only: WAITING_FOR_USER.

property status_name

(AWS Only) The VPC peering connection status value can be one of the following: INITIATING, PENDING_ACCEPTANCE, FAILED, FINALIZING, AVAILABLE, TERMINATING.

property vnet_name

Name of your Azure VNet.

property vpc_id

Unique identifier of the AWS peer VPC (Note: this is not the same as the Atlas AWS VPC that is returned by the network_container resource).

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.PrivateEndpoint(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, provider_name: Union[str, Awaitable[str], Output[T], None] = None, region: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

PrivateEndpoint provides a Private Endpoint resource. This represents a Private Endpoint Connection that can be created in an Atlas project.

IMPORTANT:You must have one of the following roles to successfully handle the resource:

  • Organization Owner

  • Project Owner

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

NOTE: A network container is created for a private endpoint to reside in if one does not yet exist in the project.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.PrivateEndpoint("test",
    project_id="<PROJECT-ID>",
    provider_name="AWS",
    region="us-east-1")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project_id (pulumi.Input[str]) – Required Unique identifier for the project.

  • region (pulumi.Input[str]) – Cloud provider region in which you want to create the private endpoint connection. Accepted values are:

* `us-east-1`
* `us-east-2`
* `us-west-1`
* `us-west-2`
* `ca-central-1`
* `sa-east-1`
* `eu-north-1`
* `eu-west-1`
* `eu-west-2`
* `eu-west-3`
* `eu-central-1`
* `me-south-1`
* `ap-northeast-1`
* `ap-northeast-2`
* `ap-south-1`
* `ap-southeast-1`
* `ap-southeast-2`
* `ap-east-1`
static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, endpoint_service_name: Union[str, Awaitable[str], Output[T], None] = None, error_message: Union[str, Awaitable[str], Output[T], None] = None, interface_endpoints: Union[Sequence[Union[str, Awaitable[str], Output[T]]], Awaitable[Sequence[Union[str, Awaitable[str], Output[T]]]], Output[T], None] = None, private_link_id: Union[str, Awaitable[str], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, provider_name: Union[str, Awaitable[str], Output[T], None] = None, region: Union[str, Awaitable[str], Output[T], None] = None, status: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_mongodbatlas.private_endpoint.PrivateEndpoint

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • endpoint_service_name (pulumi.Input[str]) – Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.

  • error_message (pulumi.Input[str]) – Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors.

  • interface_endpoints (pulumi.Input[Sequence[pulumi.Input[str]]]) – Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.

  • private_link_id (pulumi.Input[str]) – Unique identifier of the AWS PrivateLink connection.

  • project_id (pulumi.Input[str]) – Required Unique identifier for the project.

  • region (pulumi.Input[str]) – Cloud provider region in which you want to create the private endpoint connection. Accepted values are:

* `us-east-1`
* `us-east-2`
* `us-west-1`
* `us-west-2`
* `ca-central-1`
* `sa-east-1`
* `eu-north-1`
* `eu-west-1`
* `eu-west-2`
* `eu-west-3`
* `eu-central-1`
* `me-south-1`
* `ap-northeast-1`
* `ap-northeast-2`
* `ap-south-1`
* `ap-southeast-1`
* `ap-southeast-2`
* `ap-east-1`
Parameters

status (pulumi.Input[str]) – Status of the AWS PrivateLink connection. Returns one of the following values:

property endpoint_service_name

Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.

property error_message

Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors.

property interface_endpoints

Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.

Unique identifier of the AWS PrivateLink connection.

property project_id

Required Unique identifier for the project.

property region

Cloud provider region in which you want to create the private endpoint connection. Accepted values are:

  • us-east-1

  • us-east-2

  • us-west-1

  • us-west-2

  • ca-central-1

  • sa-east-1

  • eu-north-1

  • eu-west-1

  • eu-west-2

  • eu-west-3

  • eu-central-1

  • me-south-1

  • ap-northeast-1

  • ap-northeast-2

  • ap-south-1

  • ap-southeast-1

  • ap-southeast-2

  • ap-east-1

property status

Status of the AWS PrivateLink connection. Returns one of the following values:

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

PrivateEndpointInterfaceLink provides a Private Endpoint Interface Link resource. This represents a Private Endpoint Interface Link, which adds one interface endpoint to a private endpoint connection in an Atlas project.

IMPORTANT:You must have one of the following roles to successfully handle the resource:

  • Organization Owner

  • Project Owner

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

import pulumi
import pulumi_aws as aws
import pulumi_mongodbatlas as mongodbatlas

test_private_endpoint = mongodbatlas.PrivateEndpoint("testPrivateEndpoint",
    project_id="<PROJECT_ID>",
    provider_name="AWS",
    region="us-east-1")
ptfe_service = aws.ec2.VpcEndpoint("ptfeService",
    security_group_ids=["sg-3f238186"],
    service_name=test_private_endpoint.endpoint_service_name,
    subnet_ids=["subnet-de0406d2"],
    vpc_endpoint_type="Interface",
    vpc_id="vpc-7fc0a543")
test_private_endpoint_interface_link = mongodbatlas.PrivateEndpointInterfaceLink("testPrivateEndpointInterfaceLink",
    interface_endpoint_id=ptfe_service.id,
    private_link_id=test_private_endpoint.private_link_id,
    project_id=test_private_endpoint.project_id)
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • interface_endpoint_id (pulumi.Input[str]) – Unique identifier of the interface endpoint you created in your VPC with the AWS resource.

  • private_link_id (pulumi.Input[str]) – Unique identifier of the AWS PrivateLink connection which is created by PrivateEndpoint resource.

  • project_id (pulumi.Input[str]) – Unique identifier for the project.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, connection_status: Union[str, Awaitable[str], Output[T], None] = None, delete_requested: Union[bool, Awaitable[bool], Output[T], None] = None, error_message: Union[str, Awaitable[str], Output[T], None] = None, interface_endpoint_id: Union[str, Awaitable[str], Output[T], None] = None, private_link_id: Union[str, Awaitable[str], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_mongodbatlas.private_endpoint_interface_link.PrivateEndpointInterfaceLink

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • connection_status (pulumi.Input[str]) – Status of the interface endpoint. Returns one of the following values:

  • delete_requested (pulumi.Input[bool]) – Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.

  • error_message (pulumi.Input[str]) – Error message pertaining to the interface endpoint. Returns null if there are no errors.

  • interface_endpoint_id (pulumi.Input[str]) – Unique identifier of the interface endpoint you created in your VPC with the AWS resource.

  • private_link_id (pulumi.Input[str]) – Unique identifier of the AWS PrivateLink connection which is created by PrivateEndpoint resource.

  • project_id (pulumi.Input[str]) – Unique identifier for the project.

property connection_status

Status of the interface endpoint. Returns one of the following values:

property delete_requested

Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.

property error_message

Error message pertaining to the interface endpoint. Returns null if there are no errors.

property interface_endpoint_id

Unique identifier of the interface endpoint you created in your VPC with the AWS resource.

Unique identifier of the AWS PrivateLink connection which is created by PrivateEndpoint resource.

property project_id

Unique identifier for the project.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.PrivateIpMode(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, enabled: Union[bool, Awaitable[bool], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

PrivateIpMode provides a Private IP Mode resource. This allows one to disable Connect via Peering Only mode for a MongoDB Atlas Project.

Deprecated Feature:
This feature has been deprecated. Use Split Horizon connection strings to connect to your cluster. These connection strings allow you to connect using both VPC/VNet Peering and whitelisted public IP addresses. To learn more about support for Split Horizon, see this FAQ. You need this endpoint to disable Peering Only.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

my_private_ip_mode = mongodbatlas.PrivateIpMode("myPrivateIpMode",
    enabled=False,
    project_id="<YOUR PROJECT ID>")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • enabled (pulumi.Input[bool]) – Indicates whether Connect via Peering Only mode is enabled or disabled for an Atlas project

  • project_id (pulumi.Input[str]) – The unique ID for the project to enable Only Private IP Mode.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, enabled: Union[bool, Awaitable[bool], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_mongodbatlas.private_ip_mode.PrivateIpMode

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • enabled (pulumi.Input[bool]) – Indicates whether Connect via Peering Only mode is enabled or disabled for an Atlas project

  • project_id (pulumi.Input[str]) – The unique ID for the project to enable Only Private IP Mode.

property enabled

Indicates whether Connect via Peering Only mode is enabled or disabled for an Atlas project

property project_id

The unique ID for the project to enable Only Private IP Mode.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.Project(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, name: Union[str, Awaitable[str], Output[T], None] = None, org_id: Union[str, Awaitable[str], Output[T], None] = None, teams: Union[Sequence[Union[ProjectTeamArgs, Mapping[str, Any], Awaitable[Union[ProjectTeamArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[ProjectTeamArgs, Mapping[str, Any], Awaitable[Union[ProjectTeamArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Create a Project resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] name: The name of the project you want to create. (Cannot be changed via this Provider after creation.) :param pulumi.Input[str] org_id: The ID of the organization you want to create the project within.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, cluster_count: Union[int, Awaitable[int], Output[T], None] = None, created: Union[str, Awaitable[str], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None, org_id: Union[str, Awaitable[str], Output[T], None] = None, teams: Union[Sequence[Union[ProjectTeamArgs, Mapping[str, Any], Awaitable[Union[ProjectTeamArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[ProjectTeamArgs, Mapping[str, Any], Awaitable[Union[ProjectTeamArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None) → pulumi_mongodbatlas.project.Project

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cluster_count (pulumi.Input[int]) – The number of Atlas clusters deployed in the project..

  • created (pulumi.Input[str]) – The ISO-8601-formatted timestamp of when Atlas created the project..

  • name (pulumi.Input[str]) – The name of the project you want to create. (Cannot be changed via this Provider after creation.)

  • org_id (pulumi.Input[str]) – The ID of the organization you want to create the project within.

property cluster_count

The number of Atlas clusters deployed in the project..

property created

The ISO-8601-formatted timestamp of when Atlas created the project..

property name

The name of the project you want to create. (Cannot be changed via this Provider after creation.)

property org_id

The ID of the organization you want to create the project within.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.ProjectIpWhitelist(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, aws_security_group: Union[str, Awaitable[str], Output[T], None] = None, cidr_block: Union[str, Awaitable[str], Output[T], None] = None, comment: Union[str, Awaitable[str], Output[T], None] = None, ip_address: Union[str, Awaitable[str], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

ProjectIpWhitelist provides an IP Whitelist entry resource. The whitelist grants access from IPs, CIDRs or AWS Security Groups (if VPC Peering is enabled) to clusters within the Project.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

IMPORTANT: When you remove an entry from the whitelist, existing connections from the removed address(es) may remain open for a variable amount of time. How much time passes before Atlas closes the connection depends on several factors, including how the connection was established, the particular behavior of the application or driver using the address, and the connection protocol (e.g., TCP or UDP). This is particularly important to consider when changing an existing IP address or CIDR block as they cannot be updated via the Provider (comments can however), hence a change will force the destruction and recreation of entries.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.ProjectIpWhitelist("test",
    cidr_block="1.2.3.4/32",
    comment="cidr block for tf acc testing",
    project_id="<PROJECT-ID>")
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.ProjectIpWhitelist("test",
    comment="ip address for tf acc testing",
    ip_address="2.3.4.5",
    project_id="<PROJECT-ID>")
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_network_container = mongodbatlas.NetworkContainer("testNetworkContainer",
    project_id="<PROJECT-ID>",
    atlas_cidr_block="192.168.208.0/21",
    provider_name="AWS",
    region_name="US_EAST_1")
test_network_peering = mongodbatlas.NetworkPeering("testNetworkPeering",
    project_id="<PROJECT-ID>",
    container_id=test_network_container.container_id,
    accepter_region_name="us-east-1",
    provider_name="AWS",
    route_table_cidr_block="172.31.0.0/16",
    vpc_id="vpc-0d93d6f69f1578bd8",
    aws_account_id="232589400519")
test_project_ip_whitelist = mongodbatlas.ProjectIpWhitelist("testProjectIpWhitelist",
    project_id="<PROJECT-ID>",
    aws_security_group="sg-0026348ec11780bd1",
    comment="TestAcc for awsSecurityGroup",
    opts=ResourceOptions(depends_on=["mongodbatlas_network_peering.test"]))

IMPORTANT: In order to use AWS Security Group(s) VPC Peering must be enabled like above example.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • aws_security_group (pulumi.Input[str]) – ID of the whitelisted AWS security group. Mutually exclusive with cidr_block and ip_address.

  • cidr_block (pulumi.Input[str]) – Whitelist entry in Classless Inter-Domain Routing (CIDR) notation. Mutually exclusive with aws_security_group and ip_address.

  • comment (pulumi.Input[str]) – Comment to add to the whitelist entry.

  • ip_address (pulumi.Input[str]) – Whitelisted IP address. Mutually exclusive with aws_security_group and cidr_block.

  • project_id (pulumi.Input[str]) – The ID of the project in which to add the whitelist entry.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, aws_security_group: Union[str, Awaitable[str], Output[T], None] = None, cidr_block: Union[str, Awaitable[str], Output[T], None] = None, comment: Union[str, Awaitable[str], Output[T], None] = None, ip_address: Union[str, Awaitable[str], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_mongodbatlas.project_ip_whitelist.ProjectIpWhitelist

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • aws_security_group (pulumi.Input[str]) – ID of the whitelisted AWS security group. Mutually exclusive with cidr_block and ip_address.

  • cidr_block (pulumi.Input[str]) – Whitelist entry in Classless Inter-Domain Routing (CIDR) notation. Mutually exclusive with aws_security_group and ip_address.

  • comment (pulumi.Input[str]) – Comment to add to the whitelist entry.

  • ip_address (pulumi.Input[str]) – Whitelisted IP address. Mutually exclusive with aws_security_group and cidr_block.

  • project_id (pulumi.Input[str]) – The ID of the project in which to add the whitelist entry.

property aws_security_group

ID of the whitelisted AWS security group. Mutually exclusive with cidr_block and ip_address.

property cidr_block

Whitelist entry in Classless Inter-Domain Routing (CIDR) notation. Mutually exclusive with aws_security_group and ip_address.

property comment

Comment to add to the whitelist entry.

property ip_address

Whitelisted IP address. Mutually exclusive with aws_security_group and cidr_block.

property project_id

The ID of the project in which to add the whitelist entry.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.Provider(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, private_key: Union[str, Awaitable[str], Output[T], None] = None, public_key: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • private_key (pulumi.Input[str]) – MongoDB Atlas Programmatic Private Key

  • public_key (pulumi.Input[str]) – MongoDB Atlas Programmatic Public Key

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.Team(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, name: Union[str, Awaitable[str], Output[T], None] = None, org_id: Union[str, Awaitable[str], Output[T], None] = None, usernames: Union[Sequence[Union[str, Awaitable[str], Output[T]]], Awaitable[Sequence[Union[str, Awaitable[str], Output[T]]]], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Teams provides a Team resource. The resource lets you create, edit and delete Teams. Also, Teams can be assigned to multiple projects, and team members’ access to the project is determined by the team’s project role.

IMPORTANT: MongoDB Atlas Team limits: max 250 teams in an organization and max 100 teams per project.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

MongoDB Atlas Team limits: max 250 teams in an organization and max 100 teams per project.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.Teams("test",
    org_id="<ORGANIZATION-ID>",
    usernames=[
        "user1@email.com",
        "user2@email.com",
        "user3@email.com",
    ])
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the team you want to create.

  • org_id (pulumi.Input[str]) – The unique identifier for the organization you want to associate the team with.

  • usernames (pulumi.Input[Sequence[pulumi.Input[str]]]) – The Atlas usernames (email address). You can only add Atlas users who are part of the organization. Users who have not accepted an invitation to join the organization cannot be added as team members. There is a maximum of 250 Atlas users per team.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, name: Union[str, Awaitable[str], Output[T], None] = None, org_id: Union[str, Awaitable[str], Output[T], None] = None, team_id: Union[str, Awaitable[str], Output[T], None] = None, usernames: Union[Sequence[Union[str, Awaitable[str], Output[T]]], Awaitable[Sequence[Union[str, Awaitable[str], Output[T]]]], Output[T], None] = None) → pulumi_mongodbatlas.team.Team

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the team you want to create.

  • org_id (pulumi.Input[str]) – The unique identifier for the organization you want to associate the team with.

  • team_id (pulumi.Input[str]) – The unique identifier for the team.

  • usernames (pulumi.Input[Sequence[pulumi.Input[str]]]) – The Atlas usernames (email address). You can only add Atlas users who are part of the organization. Users who have not accepted an invitation to join the organization cannot be added as team members. There is a maximum of 250 Atlas users per team.

property name

The name of the team you want to create.

property org_id

The unique identifier for the organization you want to associate the team with.

property team_id

The unique identifier for the team.

property usernames

The Atlas usernames (email address). You can only add Atlas users who are part of the organization. Users who have not accepted an invitation to join the organization cannot be added as team members. There is a maximum of 250 Atlas users per team.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.Teams(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, name: Union[str, Awaitable[str], Output[T], None] = None, org_id: Union[str, Awaitable[str], Output[T], None] = None, usernames: Union[Sequence[Union[str, Awaitable[str], Output[T]]], Awaitable[Sequence[Union[str, Awaitable[str], Output[T]]]], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Create a Teams resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, name: Union[str, Awaitable[str], Output[T], None] = None, org_id: Union[str, Awaitable[str], Output[T], None] = None, team_id: Union[str, Awaitable[str], Output[T], None] = None, usernames: Union[Sequence[Union[str, Awaitable[str], Output[T]]], Awaitable[Sequence[Union[str, Awaitable[str], Output[T]]]], Output[T], None] = None) → pulumi_mongodbatlas.teams.Teams

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_mongodbatlas.X509AuthenticationDatabaseUser(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, customer_x509_cas: Union[str, Awaitable[str], Output[T], None] = None, months_until_expiration: Union[int, Awaitable[int], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, username: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

X509AuthenticationDatabaseUser provides a X509 Authentication Database User resource. The X509AuthenticationDatabaseUser resource lets you manage MongoDB users who authenticate using X.509 certificates. You can manage these X.509 certificates or let Atlas do it for you.

Management

Description

Atlas

Atlas manages your Certificate Authority and can generate certificates for your MongoDB users. No additional X.509 configuration is required.

Customer

You must provide a Certificate Authority and generate certificates for your MongoDB users.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

user = mongodbatlas.DatabaseUser("user",
    database_name="$external",
    labels=[mongodbatlas.DatabaseUserLabelArgs(
        key="My Key",
        value="My Value",
    )],
    project_id="<PROJECT-ID>",
    roles=[mongodbatlas.DatabaseUserRoleArgs(
        database_name="admin",
        role_name="atlasAdmin",
    )],
    username="myUsername",
    x509_type="MANAGED")
test = mongodbatlas.X509AuthenticationDatabaseUser("test",
    months_until_expiration=2,
    project_id=user.project_id,
    username=user.username)
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.X509AuthenticationDatabaseUser("test",
    customer_x509_cas="""  -----BEGIN CERTIFICATE-----
  MIICmTCCAgICCQDZnHzklxsT9TANBgkqhkiG9w0BAQsFADCBkDELMAkGA1UEBhMC
  VVMxDjAMBgNVBAgMBVRleGFzMQ8wDQYDVQQHDAZBdXN0aW4xETAPBgNVBAoMCHRl
  c3QuY29tMQ0wCwYDVQQLDARUZXN0MREwDwYDVQQDDAh0ZXN0LmNvbTErMCkGCSqG
  SIb3DQEJARYcbWVsaXNzYS5wbHVua2V0dEBtb25nb2RiLmNvbTAeFw0yMDAyMDQy
  MDQ2MDFaFw0yMTAyMDMyMDQ2MDFaMIGQMQswCQYDVQQGEwJVUzEOMAwGA1UECAwF
  VGV4YXMxDzANBgNVBAcMBkF1c3RpbjERMA8GA1UECgwIdGVzdC5jb20xDTALBgNV
  BAsMBFRlc3QxETAPBgNVBAMMCHRlc3QuY29tMSswKQYJKoZIhvcNAQkBFhxtZWxp
  c3NhLnBsdW5rZXR0QG1vbmdvZGIuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCB
  iQKBgQCf1LRqr1zftzdYx2Aj9G76tb0noMPtj6faGLlPji1+m6Rn7RWD9L0ntWAr
  cURxvypa9jZ9MXFzDtLevvd3tHEmfrUT3ukNDX6+Jtc4kWm+Dh2A70Pd+deKZ2/O
  Fh8audEKAESGXnTbeJCeQa1XKlIkjqQHBNwES5h1b9vJtFoLJwIDAQABMA0GCSqG
  SIb3DQEBCwUAA4GBADMUncjEPV/MiZUcVNGmktP6BPmEqMXQWUDpdGW2+Tg2JtUA
  7MMILtepBkFzLO+GlpZxeAlXO0wxiNgEmCRONgh4+t2w3e7a8GFijYQ99FHrAC5A
  iul59bdl18gVqXia1Yeq/iK7Ohfy/Jwd7Hsm530elwkM/ZEkYDjBlZSXYdyz
  -----END CERTIFICATE-----"

""",
    project_id="<PROJECT-ID>")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • customer_x509_cas (pulumi.Input[str]) – PEM string containing one or more customer CAs for database user authentication.

  • months_until_expiration (pulumi.Input[int]) – A number of months that the created certificate is valid for before expiry, up to 24 months. By default is 3.

  • project_id (pulumi.Input[str]) – Identifier for the Atlas project associated with the X.509 configuration.

  • username (pulumi.Input[str]) – Username of the database user to create a certificate for.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, certificates: Union[Sequence[Union[X509AuthenticationDatabaseUserCertificateArgs, Mapping[str, Any], Awaitable[Union[X509AuthenticationDatabaseUserCertificateArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[X509AuthenticationDatabaseUserCertificateArgs, Mapping[str, Any], Awaitable[Union[X509AuthenticationDatabaseUserCertificateArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, current_certificate: Union[str, Awaitable[str], Output[T], None] = None, customer_x509_cas: Union[str, Awaitable[str], Output[T], None] = None, months_until_expiration: Union[int, Awaitable[int], Output[T], None] = None, project_id: Union[str, Awaitable[str], Output[T], None] = None, username: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_mongodbatlas.x509_authentication_database_user.X509AuthenticationDatabaseUser

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • certificates (pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['X509AuthenticationDatabaseUserCertificateArgs']]]]) – Array of objects where each details one unexpired database user certificate.

  • current_certificate (pulumi.Input[str]) – Contains the last X.509 certificate and private key created for a database user.

  • customer_x509_cas (pulumi.Input[str]) – PEM string containing one or more customer CAs for database user authentication.

  • months_until_expiration (pulumi.Input[int]) – A number of months that the created certificate is valid for before expiry, up to 24 months. By default is 3.

  • project_id (pulumi.Input[str]) – Identifier for the Atlas project associated with the X.509 configuration.

  • username (pulumi.Input[str]) – Username of the database user to create a certificate for.

property certificates

Array of objects where each details one unexpired database user certificate.

property current_certificate

Contains the last X.509 certificate and private key created for a database user.

property customer_x509_cas

PEM string containing one or more customer CAs for database user authentication.

property months_until_expiration

A number of months that the created certificate is valid for before expiry, up to 24 months. By default is 3.

property project_id

Identifier for the Atlas project associated with the X.509 configuration.

property username

Username of the database user to create a certificate for.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_mongodbatlas.get509_authentication_database_user(project_id: Optional[str] = None, username: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get509_authentication_database_user.AwaitableGet509AuthenticationDatabaseUserResult

X509AuthenticationDatabaseUser describe a X509 Authentication Database User. This represents a X509 Authentication Database User.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

user = mongodbatlas.DatabaseUser("user",
    database_name="$external",
    labels=[mongodbatlas.DatabaseUserLabelArgs(
        key="My Key",
        value="My Value",
    )],
    project_id="<PROJECT-ID>",
    roles=[mongodbatlas.DatabaseUserRoleArgs(
        database_name="admin",
        role_name="atlasAdmin",
    )],
    username="myUsername",
    x509_type="MANAGED")
test_x509_authentication_database_user = mongodbatlas.X509AuthenticationDatabaseUser("testX509AuthenticationDatabaseUser",
    months_until_expiration=2,
    project_id=user.project_id,
    username=user.username)
test509_authentication_database_user = pulumi.Output.all(test_x509_authentication_database_user.project_id, test_x509_authentication_database_user.username).apply(lambda project_id, username: mongodbatlas.get509_authentication_database_user(project_id=project_id,
    username=username))
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_x509_authentication_database_user = mongodbatlas.X509AuthenticationDatabaseUser("testX509AuthenticationDatabaseUser",
    customer_x509_cas="""  -----BEGIN CERTIFICATE-----
  MIICmTCCAgICCQDZnHzklxsT9TANBgkqhkiG9w0BAQsFADCBkDELMAkGA1UEBhMC
  VVMxDjAMBgNVBAgMBVRleGFzMQ8wDQYDVQQHDAZBdXN0aW4xETAPBgNVBAoMCHRl
  c3QuY29tMQ0wCwYDVQQLDARUZXN0MREwDwYDVQQDDAh0ZXN0LmNvbTErMCkGCSqG
  SIb3DQEJARYcbWVsaXNzYS5wbHVua2V0dEBtb25nb2RiLmNvbTAeFw0yMDAyMDQy
  MDQ2MDFaFw0yMTAyMDMyMDQ2MDFaMIGQMQswCQYDVQQGEwJVUzEOMAwGA1UECAwF
  VGV4YXMxDzANBgNVBAcMBkF1c3RpbjERMA8GA1UECgwIdGVzdC5jb20xDTALBgNV
  BAsMBFRlc3QxETAPBgNVBAMMCHRlc3QuY29tMSswKQYJKoZIhvcNAQkBFhxtZWxp
  c3NhLnBsdW5rZXR0QG1vbmdvZGIuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCB
  iQKBgQCf1LRqr1zftzdYx2Aj9G76tb0noMPtj6faGLlPji1+m6Rn7RWD9L0ntWAr
  cURxvypa9jZ9MXFzDtLevvd3tHEmfrUT3ukNDX6+Jtc4kWm+Dh2A70Pd+deKZ2/O
  Fh8audEKAESGXnTbeJCeQa1XKlIkjqQHBNwES5h1b9vJtFoLJwIDAQABMA0GCSqG
  SIb3DQEBCwUAA4GBADMUncjEPV/MiZUcVNGmktP6BPmEqMXQWUDpdGW2+Tg2JtUA
  7MMILtepBkFzLO+GlpZxeAlXO0wxiNgEmCRONgh4+t2w3e7a8GFijYQ99FHrAC5A
  iul59bdl18gVqXia1Yeq/iK7Ohfy/Jwd7Hsm530elwkM/ZEkYDjBlZSXYdyz
  -----END CERTIFICATE-----"

""",
    project_id="<PROJECT-ID>")
test509_authentication_database_user = test_x509_authentication_database_user.project_id.apply(lambda project_id: mongodbatlas.get509_authentication_database_user(project_id=project_id))
Parameters
  • project_id (str) – Identifier for the Atlas project associated with the X.509 configuration.

  • username (str) – Username of the database user to create a certificate for.

pulumi_mongodbatlas.get_alert_configuration(alert_configuration_id: Optional[str] = None, project_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_alert_configuration.AwaitableGetAlertConfigurationResult

AlertConfiguration describes an Alert Configuration.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

Parameters
  • alert_configuration_id (str) – Unique identifier for the alert configuration.

  • project_id (str) – The ID of the project where the alert configuration will create.

pulumi_mongodbatlas.get_auditing(project_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_auditing.AwaitableGetAuditingResult

Auditing describes a Auditing.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

Parameters

project_id (str) – The unique ID for the project to create the database user.

pulumi_mongodbatlas.get_cloud_provider_snapshot(cluster_name: Optional[str] = None, project_id: Optional[str] = None, snapshot_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_cloud_provider_snapshot.AwaitableGetCloudProviderSnapshotResult

CloudProviderSnapshot provides an Cloud Backup Snapshot datasource. Atlas Cloud Backup Snapshots provide localized backup storage using the native snapshot functionality of the cluster’s cloud service.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

Parameters
  • cluster_name (str) – The name of the Atlas cluster that contains the snapshot you want to retrieve.

  • snapshot_id (str) – The unique identifier of the snapshot you want to retrieve.

pulumi_mongodbatlas.get_cloud_provider_snapshot_backup_policy(cluster_name: Optional[str] = None, project_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_cloud_provider_snapshot_backup_policy.AwaitableGetCloudProviderSnapshotBackupPolicyResult

CloudProviderSnapshotBackupPolicy provides a Cloud Backup Snapshot Backup Policy datasource. An Atlas Cloud Backup Snapshot Policy provides the current snapshot schedule and retention settings for the cluster.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

Parameters
  • cluster_name (str) – The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.

  • project_id (str) – The unique identifier of the project for the Atlas cluster.

pulumi_mongodbatlas.get_cloud_provider_snapshot_restore_job(cluster_name: Optional[str] = None, job_id: Optional[str] = None, project_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_cloud_provider_snapshot_restore_job.AwaitableGetCloudProviderSnapshotRestoreJobResult

CloudProviderSnapshotRestoreJob provides a Cloud Backup Snapshot Restore Job datasource. Gets all the cloud backup snapshot restore jobs for the specified cluster.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

Parameters
  • cluster_name (str) – The name of the Atlas cluster for which you want to retrieve the restore job.

  • job_id (str) – The unique identifier of the restore job to retrieve.

  • project_id (str) – The unique identifier of the project for the Atlas cluster.

pulumi_mongodbatlas.get_cloud_provider_snapshot_restore_jobs(cluster_name: Optional[str] = None, items_per_page: Optional[int] = None, page_num: Optional[int] = None, project_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_cloud_provider_snapshot_restore_jobs.AwaitableGetCloudProviderSnapshotRestoreJobsResult

getCloudProviderSnapshotRestoreJobs provides a Cloud Backup Snapshot Restore Jobs datasource. Gets all the cloud backup snapshot restore jobs for the specified cluster.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

First create a snapshot of the desired cluster. Then request that snapshot be restored in an automated fashion to the designated cluster and project.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_cloud_provider_snapshot = mongodbatlas.CloudProviderSnapshot("testCloudProviderSnapshot",
    cluster_name="MyCluster",
    description="MyDescription",
    project_id="5cf5a45a9ccf6400e60981b6",
    retention_in_days=1)
test_cloud_provider_snapshot_restore_job = mongodbatlas.CloudProviderSnapshotRestoreJob("testCloudProviderSnapshotRestoreJob",
    cluster_name="MyCluster",
    delivery_type=mongodbatlas.CloudProviderSnapshotRestoreJobDeliveryTypeArgs(
        automated=True,
        target_cluster_name="MyCluster",
        target_project_id="5cf5a45a9ccf6400e60981b6",
    ),
    project_id="5cf5a45a9ccf6400e60981b6",
    snapshot_id=test_cloud_provider_snapshot.id)
test_cloud_provider_snapshot_restore_jobs = pulumi.Output.all(test_cloud_provider_snapshot_restore_job.cluster_name, test_cloud_provider_snapshot_restore_job.project_id).apply(lambda cluster_name, project_id: mongodbatlas.get_cloud_provider_snapshot_restore_jobs(cluster_name=cluster_name,
    items_per_page=5,
    page_num=1,
    project_id=project_id))
Parameters
  • cluster_name (str) – The name of the Atlas cluster for which you want to retrieve restore jobs.

  • items_per_page (int) – Number of items to return per page, up to a maximum of 500. Defaults to 100.

  • page_num (int) – The page to return. Defaults to 1.

  • project_id (str) – The unique identifier of the project for the Atlas cluster.

pulumi_mongodbatlas.get_cloud_provider_snapshots(cluster_name: Optional[str] = None, items_per_page: Optional[int] = None, page_num: Optional[int] = None, project_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_cloud_provider_snapshots.AwaitableGetCloudProviderSnapshotsResult

getCloudProviderSnapshots provides an Cloud Backup Snapshot datasource. Atlas Cloud Backup Snapshots provide localized backup storage using the native snapshot functionality of the cluster’s cloud service.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

Parameters
  • cluster_name (str) – The name of the Atlas cluster that contains the snapshot you want to retrieve.

  • items_per_page (int) – Number of items to return per page, up to a maximum of 500. Defaults to 100.

  • page_num (int) – The page to return. Defaults to 1.

pulumi_mongodbatlas.get_cluster(name: Optional[str] = None, project_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_cluster.AwaitableGetClusterResult

Cluster describes a Cluster. The. The data source requires your Project ID.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

IMPORTANT:
&#8226; Changes to cluster configurations can affect costs. Before making changes, please see Billing.
&#8226; If your Atlas project contains a custom role that uses actions introduced in a specific MongoDB version, you cannot create a cluster with a MongoDB version less than that version unless you delete the custom role.

Parameters
  • name (str) – Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

  • project_id (str) – The unique ID for the project to create the database user.

pulumi_mongodbatlas.get_clusters(project_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_clusters.AwaitableGetClustersResult

Cluster describes all Clusters by the provided project_id. The data source requires your Project ID.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

IMPORTANT:
&#8226; Changes to cluster configurations can affect costs. Before making changes, please see Billing.
&#8226; If your Atlas project contains a custom role that uses actions introduced in a specific MongoDB version, you cannot create a cluster with a MongoDB version less than that version unless you delete the custom role.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_cluster = mongodbatlas.Cluster("testCluster",
    project_id="<YOUR-PROJECT-ID>",
    disk_size_gb=100,
    num_shards=1,
    replication_factor=3,
    provider_backup_enabled=True,
    auto_scaling_disk_gb_enabled=True,
    provider_name="AWS",
    provider_disk_iops=300,
    provider_volume_type="STANDARD",
    provider_encrypt_ebs_volume=True,
    provider_instance_size_name="M40",
    provider_region_name="US_EAST_1")
test_clusters = test_cluster.project_id.apply(lambda project_id: mongodbatlas.get_clusters(project_id=project_id))
Parameters

project_id (str) – The unique ID for the project to get the clusters.

pulumi_mongodbatlas.get_custom_db_role(inherited_roles: Optional[Sequence[Union[GetCustomDbRoleInheritedRoleArgs, Mapping[str, Any]]]] = None, project_id: Optional[str] = None, role_name: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_custom_db_role.AwaitableGetCustomDbRoleResult

CustomDbRole describe a Custom DB Role. This represents a custom db role.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_role = mongodbatlas.CustomDbRole("testRole",
    actions=[
        mongodbatlas.CustomDbRoleActionArgs(
            action="UPDATE",
            resources=[mongodbatlas.CustomDbRoleActionResourceArgs(
                collection_name="",
                database_name="anyDatabase",
            )],
        ),
        mongodbatlas.CustomDbRoleActionArgs(
            action="INSERT",
            resources=[mongodbatlas.CustomDbRoleActionResourceArgs(
                collection_name="",
                database_name="anyDatabase",
            )],
        ),
    ],
    project_id="<PROJECT-ID>",
    role_name="myCustomRole")
test = pulumi.Output.all(test_role.project_id, test_role.role_name).apply(lambda project_id, role_name: mongodbatlas.get_custom_db_role(project_id=project_id,
    role_name=role_name))
Parameters
  • project_id (str) – The unique ID for the project to create the database user.

  • role_name (str) – Name of the custom role.

pulumi_mongodbatlas.get_custom_db_roles(project_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_custom_db_roles.AwaitableGetCustomDbRolesResult

getCustomDbRoles describe all Custom DB Roles. This represents a custom db roles.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_database_user = mongodbatlas.DatabaseUser("testDatabaseUser",
    database_name="admin",
    password="test-acc-password",
    project_id="<PROJECT-ID>",
    roles=[
        mongodbatlas.DatabaseUserRoleArgs(
            database_name="admin",
            role_name="readWrite",
        ),
        mongodbatlas.DatabaseUserRoleArgs(
            database_name="admin",
            role_name="atlasAdmin",
        ),
    ],
    username="test-acc-username")
test_custom_db_roles = mongodbatlas.get_custom_db_roles(project_id=mongodbatlas_custom_db_role["test"]["project_id"])
Parameters

project_id (str) – The unique ID for the project to get all custom db roles.

pulumi_mongodbatlas.get_database_user(auth_database_name: Optional[str] = None, database_name: Optional[str] = None, project_id: Optional[str] = None, username: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_database_user.AwaitableGetDatabaseUserResult

DatabaseUser describe a Database User. This represents a database user which will be applied to all clusters within the project.

Each user has a set of roles that provide access to the project’s databases. User’s roles apply to all the clusters in the project: if two clusters have a products database and a user has a role granting read access on the products database, the user has that access on both clusters.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

Parameters
  • auth_database_name (str) – The user’s authentication database. A user must provide both a username and authentication database to log into MongoDB. In Atlas deployments of MongoDB, the authentication database is almost always the admin database, for X509 it is $external.

  • database_name (str) – Database on which the user has the specified role. A role on the admin database can include privileges that apply to the other databases.

  • project_id (str) – The unique ID for the project to create the database user.

  • username (str) – Username for authenticating to MongoDB.

pulumi_mongodbatlas.get_database_users(project_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_database_users.AwaitableGetDatabaseUsersResult

getDatabaseUsers describe all Database Users. This represents a database user which will be applied to all clusters within the project.

Each user has a set of roles that provide access to the project’s databases. User’s roles apply to all the clusters in the project: if two clusters have a products database and a user has a role granting read access on the products database, the user has that access on both clusters.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_database_user = mongodbatlas.DatabaseUser("testDatabaseUser",
    username="test-acc-username",
    password="test-acc-password",
    project_id="<PROJECT-ID>",
    auth_database_name="admin",
    roles=[
        mongodbatlas.DatabaseUserRoleArgs(
            role_name="readWrite",
            database_name="admin",
        ),
        mongodbatlas.DatabaseUserRoleArgs(
            role_name="atlasAdmin",
            database_name="admin",
        ),
    ],
    labels=[
        mongodbatlas.DatabaseUserLabelArgs(
            key="key 1",
            value="value 1",
        ),
        mongodbatlas.DatabaseUserLabelArgs(
            key="key 2",
            value="value 2",
        ),
    ])
test_database_users = test_database_user.project_id.apply(lambda project_id: mongodbatlas.get_database_users(project_id=project_id))
Parameters

project_id (str) – The unique ID for the project to get all database users.

pulumi_mongodbatlas.get_global_cluster_config(cluster_name: Optional[str] = None, managed_namespaces: Optional[Sequence[Union[GetGlobalClusterConfigManagedNamespaceArgs, Mapping[str, Any]]]] = None, project_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_global_cluster_config.AwaitableGetGlobalClusterConfigResult

GlobalClusterConfig describes all managed namespaces and custom zone mappings associated with the specified Global Cluster.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

Parameters
  • managed_namespaces (Sequence[pulumi.InputType['GetGlobalClusterConfigManagedNamespaceArgs']]) –

    Add a managed namespaces to a Global Cluster. For more information about managed namespaces, see Global Clusters. See Managed Namespace below for more details.

  • project_id (str) – The unique ID for the project to create the database user.

* `cluster_name - (Required) The name of the Global Cluster.
pulumi_mongodbatlas.get_maintenance_window(project_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_maintenance_window.AwaitableGetMaintenanceWindowResult

MaintenanceWindow provides a Maintenance Window entry datasource. Gets information regarding the configured maintenance window for a MongoDB Atlas project.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

Parameters

project_id (str) – The unique identifier of the project for the Maintenance Window.

pulumi_mongodbatlas.get_network_container(container_id: Optional[str] = None, project_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_network_container.AwaitableGetNetworkContainerResult

NetworkContainer describes a Network Peering Container. The resource requires your Project ID and container ID.

IMPORTANT: This resource creates one Network Peering container into which Atlas can deploy Network Peering connections. An Atlas project can have a maximum of one container for each cloud provider. You must have either the Project Owner or Organization Owner role to successfully call this endpoint.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

Parameters
  • container_id (str) – The Network Peering Container ID.

  • project_id (str) – The unique ID for the project to create the database user.

pulumi_mongodbatlas.get_network_containers(project_id: Optional[str] = None, provider_name: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_network_containers.AwaitableGetNetworkContainersResult

getNetworkContainers describes all Network Peering Containers. The data source requires your Project ID.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_network_container = mongodbatlas.NetworkContainer("testNetworkContainer",
    project_id="<YOUR-PROJECT-ID>",
    atlas_cidr_block="10.8.0.0/21",
    provider_name="AWS",
    region_name="US_EAST_1")
test_network_containers = pulumi.Output.all(test_network_container.project_id, test_network_container.provider_name).apply(lambda project_id, provider_name: mongodbatlas.get_network_containers(project_id=project_id,
    provider_name=provider_name))
Parameters
  • project_id (str) – The unique ID for the project to create the database user.

  • provider_name (str) – Cloud provider for this Network peering container. Accepted values are AWS, GCP, and Azure.

pulumi_mongodbatlas.get_network_peering(peering_id: Optional[str] = None, project_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_network_peering.AwaitableGetNetworkPeeringResult

NetworkPeering describes a Network Peering Connection.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

Parameters
  • peering_id (str) – Atlas assigned unique ID for the peering connection.

  • project_id (str) – The unique ID for the project to create the database user.

pulumi_mongodbatlas.get_network_peerings(project_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_network_peerings.AwaitableGetNetworkPeeringsResult

getNetworkPeerings describes all Network Peering Connections.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_network_peering = mongodbatlas.NetworkPeering("testNetworkPeering",
    accepter_region_name="us-east-1",
    project_id="<YOUR-PROJEC-ID>",
    container_id="507f1f77bcf86cd799439011",
    provider_name="AWS",
    route_table_cidr_block="192.168.0.0/24",
    vpc_id="vpc-abc123abc123",
    aws_account_id="abc123abc123")
test_network_peerings = test_network_peering.project_id.apply(lambda project_id: mongodbatlas.get_network_peerings(project_id=project_id))
Parameters

project_id (str) – The unique ID for the project to create the database user.

pulumi_mongodbatlas.get_private_endpoint(private_link_id: Optional[str] = None, project_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_private_endpoint.AwaitableGetPrivateEndpointResult

PrivateEndpoint describe a Private Endpoint. This represents a Private Endpoint Connection to retrieve details regarding a private endpoint by id in an Atlas project

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

Parameters
  • private_link_id (str) – Unique identifier of the AWS PrivateLink connection.

  • project_id (str) – Unique identifier for the project.

mongodbatlas_private_endpoint_link describe a Private Endpoint Link. This represents a Private Endpoint Link Connection that wants to retrieve details in an Atlas project.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

Parameters
  • private_link_id (str) – Unique identifier of the AWS PrivateLink connection.

  • project_id (str) – Unique identifier for the project.

pulumi_mongodbatlas.get_project(name: Optional[str] = None, project_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_project.AwaitableGetProjectResult

Project describes a MongoDB Atlas Project. This represents a project that has been created.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

Parameters
  • name (str) – The unique ID for the project.

  • project_id (str) – The unique ID for the project.

pulumi_mongodbatlas.get_project_ip_whitelist(aws_security_group: Optional[str] = None, cidr_block: Optional[str] = None, ip_address: Optional[str] = None, project_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_project_ip_whitelist.AwaitableGetProjectIpWhitelistResult

ProjectIpWhitelist describes an IP Whitelist entry resource. The whitelist grants access from IPs, CIDRs or AWS Security Groups (if VPC Peering is enabled) to clusters within the Project.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

IMPORTANT: When you remove an entry from the whitelist, existing connections from the removed address(es) may remain open for a variable amount of time. How much time passes before Atlas closes the connection depends on several factors, including how the connection was established, the particular behavior of the application or driver using the address, and the connection protocol (e.g., TCP or UDP). This is particularly important to consider when changing an existing IP address or CIDR block as they cannot be updated via the Provider (comments can however), hence a change will force the destruction and recreation of entries.

Parameters
  • aws_security_group (str) – ID of the whitelisted AWS security group. Mutually exclusive with cidr_block and ip_address.

  • cidr_block (str) – Whitelist entry in Classless Inter-Domain Routing (CIDR) notation. Mutually exclusive with aws_security_group and ip_address.

  • ip_address (str) – Whitelisted IP address. Mutually exclusive with aws_security_group and cidr_block.

  • project_id (str) – The ID of the project in which to add the whitelist entry.

pulumi_mongodbatlas.get_projects(items_per_page: Optional[int] = None, page_num: Optional[int] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_projects.AwaitableGetProjectsResult

getProjects describe all Projects. This represents projects that have been created.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

Parameters
  • items_per_page (int) – Number of items to return per page, up to a maximum of 500. Defaults to 100.

  • page_num (int) – The page to return. Defaults to 1.

pulumi_mongodbatlas.get_team(name: Optional[str] = None, org_id: Optional[str] = None, team_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_team.AwaitableGetTeamResult

Teams describes a Team. The resource requires your Organization ID, Project ID and Team ID.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

Parameters
  • name (str) – The team name.

  • org_id (str) – The unique identifier for the organization you want to associate the team with.

  • team_id (str) – The unique identifier for the team.

pulumi_mongodbatlas.get_teams(name: Optional[str] = None, org_id: Optional[str] = None, team_id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_mongodbatlas.get_teams.AwaitableGetTeamsResult

Use this data source to access information about an existing resource.