You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
doc: Add azure federated database instance example and docs (#3521)
* Add aws directory to federated database instance examples
* Add azure cloud provider example to data federated instance resource
* Modify minimal example and add README
* Add documentation for azure cloud provider in federated database instances
* Decrease mongodbatlas version provider for tests
* Correct format
* Add newline to example files
* Add computed attributes on docs for azure cloud provider resouce
* Update outdated provider source path for example
* Fix indentation for attributes and add format to avoid spaces on field values
* Address PR review comments for wording
* Follow-up to correct wording on README example
*`project_id` - (Required) The unique ID for the project to create a Federated Database Instance.
104
150
*`name` - (Required) Name of the Atlas Federated Database Instance.
105
151
*`cloud_provider_config` - (Optional) Cloud provider linked to this data federated instance.
106
-
*`cloud_provider_config.aws` - (Required) AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket. Note this parameter is only required if using `cloud_provider_config` since AWS is currently the only supported Cloud vendor on this feature at this time.
152
+
*`cloud_provider_config.aws` - AWS provider of the cloud service where the Federated Database Instance can access the S3 Bucket.
107
153
*`cloud_provider_config.aws.role_id` - (Required) Unique identifier of the role that the Federated Instance can use to access the data stores. If necessary, use the Atlas [UI](https://docs.atlas.mongodb.com/security/manage-iam-roles/) or [API](https://docs.atlas.mongodb.com/reference/api/cloud-provider-access-get-roles/) to retrieve the role ID. You must also specify the `test_s3_bucket`.
108
154
*`cloud_provider_config.aws.test_s3_bucket` - (Required) Name of the S3 data bucket that the provided role ID is authorized to access. You must also specify the `role_id`.
155
+
*`cloud_provider_config.azure` - Microsoft Azure provider of the cloud service where the Federated Database Instance can access Blob Storage.
156
+
*`cloud_provider_config.azure.role_id` - (Required) Unique identifier of the role that the Federated Database Instance can use to access the data stores.
109
157
*`data_process_region` - (Optional) The cloud provider region to which the Federated Instance routes client connections for data processing.
110
-
*`data_process_region.cloud_provider` - (Required) Name of the cloud service provider. Atlas Federated Database only supports AWS.
111
-
*`data_process_region.region` - (Required) Name of the region to which the Federanted Instnace routes client connections for data processing. See the [documention](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Data-Federation/operation/createFederatedDatabase) for the available region.
158
+
*`data_process_region.cloud_provider` - (Required) Name of the cloud service provider. Supported providers: `AWS`, `AZURE`.
159
+
*`data_process_region.region` - (Required) Name of the region to which the Federated Instance routes client connections for data processing. See the [documentation](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#tag/Data-Federation/operation/createFederatedDatabase) for the available region.
112
160
*`storage_databases` - Configuration details for mapping each data store to queryable databases and collections. For complete documentation on this object and its nested fields, see [databases](https://docs.mongodb.com/datalake/reference/format/data-lake-configuration#std-label-datalake-databases-reference). An empty object indicates that the Federated Database Instance has no mapping configuration for any data store.
113
161
*`storage_databases.#.name` - Name of the database to which the Federated Database Instance maps the data contained in the data store.
114
162
*`storage_databases.#.collections` - Array of objects where each object represents a collection and data sources that map to a [stores](https://docs.mongodb.com/datalake/reference/format/data-lake-configuration#mongodb-datalakeconf-datalakeconf.stores) data store.
@@ -167,10 +215,13 @@ In addition to all arguments above, the following attributes are exported:
167
215
*`s3:GetObjectVersion`
168
216
169
217
For more information on S3 actions, see [Actions, Resources, and Condition Keys for Amazon S3](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html).
170
-
*`iam_user_arn` - Amazon Resource Name (ARN) of the user that the Federated Database Instance assumes when accessing S3 Bucket data stores.
171
-
*`external_id` - Unique identifier associated with the IAM Role that the Federated Database Instance assumes when accessing the data stores.
172
-
218
+
* `iam_user_arn` - Amazon Resource Name (ARN) of the user that the Federated Database Instance assumes when accessing S3 Bucket data stores.
219
+
* `external_id` - Unique identifier associated with the IAM Role that the Federated Database Instance assumes when accessing the data stores.
173
220
221
+
*`cloud_provider_config.azure` - Microsoft Azure cloud service configuration.
222
+
*`atlas_azure_app_id` - Unique identifier of the Azure Active Directory application associated with the service principal.
223
+
*`service_principal_id` - Unique identifier of the Azure service principal that the Federated Database instance uses to access Azure Blob Storage.
224
+
*`tenant_id` - Unique identifier of the Azure Active Directory tenant where the service principal resides.
# Example - MongoDB Atlas Federated Database Instance with Microsoft Azure Blob Storage and MongoDB Cluster as storage databases
2
+
3
+
This project aims to provide an example of using [MongoDB Atlas Federated Database Instance](https://www.mongodb.com/docs/atlas/data-federation/overview/).
0 commit comments