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",
    ))

Alert Configuration can be imported using the project_id-alert_configuration_id, e.g.

   $ pulumi import mongodbatlas:index/alertConfiguration:AlertConfiguration test 5d0f1f74cf09a29120e123cd-5d0f1f74cf09a29120e1fscg

For more information see\ `MongoDB Atlas API Reference. <https://docs.atlas.mongodb.com/reference/api/alert-configurations/>`_

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>")

Auditing must be imported using auditing ID, e.g.

   $ pulumi import mongodbatlas:index/auditing:Auditing my_auditing 5d09d6a59ccf6445652a444a

For more information see\ `MongoDB Atlas API Reference. <https://docs.atlas.mongodb.com/reference/api/auditing/>`_

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.AwaitableGetCloudProviderAccessResult(aws_iam_roles=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.AwaitableGetPrivateLinkEndpointResult(endpoint_service_name=None, error_message=None, id=None, interface_endpoints=None, private_endpoints=None, private_link_id=None, private_link_service_name=None, private_link_service_resource_id=None, project_id=None, provider_name=None, status=None)¶

class pulumi_mongodbatlas.AwaitableGetPrivateLinkEndpointServiceResult(connection_status=None, delete_requested=None, endpoint_service_id=None, error_message=None, id=None, interface_endpoint_id=None, private_endpoint_connection_name=None, private_endpoint_ip_address=None, private_endpoint_resource_id=None, private_link_id=None, project_id=None, provider_name=None)¶

class pulumi_mongodbatlas.AwaitableGetProjectIpAccessListResult(aws_security_group=None, cidr_block=None, comment=None, id=None, ip_address=None, project_id=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.AwaitableGetThirdPartyIntegrationResult(account_id=None, api_key=None, api_token=None, channel_name=None, flow_name=None, id=None, license_key=None, org_name=None, project_id=None, read_token=None, region=None, routing_key=None, secret=None, service_key=None, team_name=None, type=None, url=None, write_token=None)¶

class pulumi_mongodbatlas.AwaitableGetThirdPartyIntegrationsResult(id=None, project_id=None, results=None)¶

class pulumi_mongodbatlas.CloudProviderAccess(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, iam_assumed_role_arn: 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, __props__=None, __name__=None, __opts__=None)¶

The Cloud Provider Access resource can be imported using project ID and the provider name and mongodbatlas role id, in the format project_id-provider_name-role_id, e.g.

   $ pulumi import mongodbatlas:index/cloudProviderAccess:CloudProviderAccess my_role 1112222b3bf99403840e8934-AWS-5fc17d476f7a33224f5b224e

See `MongoDB Atlas API <https://docs.atlas.mongodb.com/reference/api/cloud-provider-access-create-one-role/>`_ Documentation for more information.

Parameters

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

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

• iam_assumed_role_arn (pulumi.Input[str]) –

  • ARN of the IAM Role that Atlas assumes when accessing resources in your AWS account. This value is required after the creation (register of the role) as part of Set Up Unified AWS Access.

• project_id (pulumi.Input[str]) – The unique ID for the project to get all Cloud Provider Access

• provider_name (pulumi.Input[str]) – The cloud provider for which to create a new role. Currently only AWS is supported.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, atlas_assumed_role_external_id: Union[str, Awaitable[str], Output[T], None] = None, atlas_aws_account_arn: Union[str, Awaitable[str], Output[T], None] = None, authorized_date: Union[str, Awaitable[str], Output[T], None] = None, created_date: Union[str, Awaitable[str], Output[T], None] = None, feature_usages: Union[Sequence[Union[CloudProviderAccessFeatureUsageArgs, Mapping[str, Any], Awaitable[Union[CloudProviderAccessFeatureUsageArgs, Mapping[str, Any]]], Output[T]]], Awaitable[Sequence[Union[CloudProviderAccessFeatureUsageArgs, Mapping[str, Any], Awaitable[Union[CloudProviderAccessFeatureUsageArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, iam_assumed_role_arn: 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, role_id: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_mongodbatlas.cloud_provider_access.CloudProviderAccess¶

Get an existing CloudProviderAccess 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_assumed_role_external_id (pulumi.Input[str]) – Unique external ID Atlas uses when assuming the IAM role in your AWS account.

• atlas_aws_account_arn (pulumi.Input[str]) – ARN associated with the Atlas AWS account used to assume IAM roles in your AWS account.

• authorized_date (pulumi.Input[str]) – Date on which this role was authorized.

• created_date (pulumi.Input[str]) – Date on which this role was created.

• feature_usages (pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['CloudProviderAccessFeatureUsageArgs']]]]) – Atlas features this AWS IAM role is linked to.

• iam_assumed_role_arn (pulumi.Input[str]) –

  • ARN of the IAM Role that Atlas assumes when accessing resources in your AWS account. This value is required after the creation (register of the role) as part of Set Up Unified AWS Access.

• project_id (pulumi.Input[str]) – The unique ID for the project to get all Cloud Provider Access

• provider_name (pulumi.Input[str]) – The cloud provider for which to create a new role. Currently only AWS is supported.

• role_id (pulumi.Input[str]) – Unique ID of this role.

property atlas_assumed_role_external_id¶

Unique external ID Atlas uses when assuming the IAM role in your AWS account.

property atlas_aws_account_arn¶

ARN associated with the Atlas AWS account used to assume IAM roles in your AWS account.

property authorized_date¶

Date on which this role was authorized.

property created_date¶

Date on which this role was created.

property feature_usages¶

Atlas features this AWS IAM role is linked to.

property iam_assumed_role_arn¶

• ARN of the IAM Role that Atlas assumes when accessing resources in your AWS account. This value is required after the creation (register of the role) as part of Set Up Unified AWS Access.

property project_id¶

The unique ID for the project to get all Cloud Provider Access

property provider_name¶

The cloud provider for which to create a new role. Currently only AWS is supported.

property role_id¶

Unique ID of this 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.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,
    ))

Cloud Backup Snapshot entries can be imported using project project_id, cluster_name and snapshot_id (Unique identifier of the snapshot), in the format PROJECTID-CLUSTERNAME-SNAPSHOTID, e.g.

   $ pulumi import mongodbatlas:index/cloudProviderSnapshot:CloudProviderSnapshot test 5d0f1f73cf09a29120e173cf-MyClusterTest-5d116d82014b764445b2f9b5

For more information see\ `MongoDB Atlas API Reference. <https://docs.atlas.mongodb.com/reference/api/cloud-backup/backup/backups/>`_

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)¶

Cloud Backup Snapshot Policy entries can be imported using project project_id and cluster_name, in the format PROJECTID-CLUSTERNAME, e.g.

   $ pulumi import mongodbatlas:index/cloudProviderSnapshotBackupPolicy:CloudProviderSnapshotBackupPolicy test 5d0f1f73cf09a29120e173cf-MyClusterTest

For more information see\ `MongoDB Atlas API Reference. <https://docs.atlas.mongodb.com/reference/api/cloud-backup/schedule/modify-one-schedule/>`_

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 snapshot backup policy you want to retrieve.

• 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.

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=pulumi.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,
    ))

Cloud Backup Snapshot Restore Job entries can be imported using project project_id, cluster_name and snapshot_id (Unique identifier of the snapshot), in the format PROJECTID-CLUSTERNAME-JOBID, e.g.

   $ pulumi import mongodbatlas:index/cloudProviderSnapshotRestoreJob:CloudProviderSnapshotRestoreJob test 5cf5a45a9ccf6400e60981b6-MyCluster-5d1b654ecf09a24b888f4c79

For more information see\ `MongoDB Atlas API Reference. <https://docs.atlas.mongodb.com/reference/api/cloud-backup/restore/restores/>`_

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:
• Free tier cluster creation (M0) is not supported via API or by this Provider.
• Shared tier clusters (M2, M5) cannot be upgraded to higher tiers via API or by this Provider.
• Changes to cluster configurations can affect costs. Before making changes, please see Billing.
• 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,
    cluster_type="REPLICASET",
    disk_size_gb=100,
    mongo_db_major_version="4.2",
    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_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",
        )],
    )])

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.Cluster("test",
    auto_scaling_disk_gb_enabled=True,
    cluster_type="REPLICASET",
    mongo_db_major_version="4.2",
    project_id="<YOUR-PROJECT-ID>",
    provider_backup_enabled=True,
    provider_disk_type_name="P6",
    provider_instance_size_name="M30",
    provider_name="AZURE",
    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",
        )],
    )])

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.Cluster("test",
    auto_scaling_disk_gb_enabled=True,
    cluster_type="REPLICASET",
    disk_size_gb=40,
    mongo_db_major_version="4.2",
    project_id="<YOUR-PROJECT-ID>",
    provider_backup_enabled=True,
    provider_instance_size_name="M30",
    provider_name="GCP",
    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",
        )],
    )])

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")

Clusters can be imported using project ID and cluster name, in the format PROJECTID-CLUSTERNAME, e.g.

   $ pulumi import mongodbatlas:index/cluster:Cluster my_cluster 1112222b3bf99403840e8934-Cluster0

See detailed information for arguments and attributes\ `MongoDB API Clusters <https://docs.atlas.mongodb.com/reference/api/clusters-create-one/>`_

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]) – The default value is true. Flag that indicates whether the Amazon EBS encryption feature encrypts the host’s root volume for both data at rest within the volume and for data moving between the volume and the cluster. Note: This setting is always enabled for clusters with local NVMe SSDs. 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]) – The default value is true. Flag that indicates whether the Amazon EBS encryption feature encrypts the host’s root volume for both data at rest within the volume and for data moving between the volume and the cluster. Note: This setting is always enabled for clusters with local NVMe SSDs. 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¶

The default value is true. Flag that indicates whether the Amazon EBS encryption feature encrypts the host’s root volume for both data at rest within the volume and for data moving between the volume and the cluster. Note: This setting is always enabled for clusters with local NVMe SSDs. 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")

Database users can be imported using project ID and username, in the format PROJECTID-ROLENAME, e.g.

   $ pulumi import mongodbatlas:index/customDbRole:CustomDbRole my_role 1112222b3bf99403840e8934-MyCustomRole

For more information see\ `MongoDB Atlas API Reference. <https://docs.atlas.mongodb.com/reference/api/custom-roles/>`_

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)¶

Database users can be imported using project ID and username, in the format project_id-username-auth_database_name, e.g.

$ pulumi import mongodbatlas:index/databaseUser:DatabaseUser my_user 1112222b3bf99403840e8934-my_user-admin

Parameters

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

• 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:

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