Get started with Pulumi in a free one hour introductory workshop. Register Now

GetGlobalClusterConfig

mongodbatlas.GlobalClusterConfig describes all managed namespaces and custom zone mappings associated with the specified Global Cluster.

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

Using GetGlobalClusterConfig

function getGlobalClusterConfig(args: GetGlobalClusterConfigArgs, opts?: InvokeOptions): Promise<GetGlobalClusterConfigResult>
def get_global_cluster_config(cluster_name: Optional[str] = None, managed_namespaces: Optional[Sequence[GetGlobalClusterConfigManagedNamespaceArgs]] = None, project_id: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetGlobalClusterConfigResult
func LookupGlobalClusterConfig(ctx *Context, args *LookupGlobalClusterConfigArgs, opts ...InvokeOption) (*LookupGlobalClusterConfigResult, error)

Note: This function is named LookupGlobalClusterConfig in the Go SDK.

public static class GetGlobalClusterConfig {
    public static Task<GetGlobalClusterConfigResult> InvokeAsync(GetGlobalClusterConfigArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ClusterName string
ProjectId string

The unique ID for the project to create the database user. * `cluster_name - (Required) The name of the Global Cluster.

ManagedNamespaces List<GetGlobalClusterConfigManagedNamespaceArgs>

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

ClusterName string
ProjectId string

The unique ID for the project to create the database user. * `cluster_name - (Required) The name of the Global Cluster.

ManagedNamespaces []GetGlobalClusterConfigManagedNamespace

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

clusterName string
projectId string

The unique ID for the project to create the database user. * `cluster_name - (Required) The name of the Global Cluster.

managedNamespaces GetGlobalClusterConfigManagedNamespace[]

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

cluster_name str
project_id str

The unique ID for the project to create the database user. * `cluster_name - (Required) The name of the Global Cluster.

managed_namespaces Sequence[GetGlobalClusterConfigManagedNamespaceArgs]

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

GetGlobalClusterConfig Result

The following output properties are available:

ClusterName string
CustomZoneMapping Dictionary<string, object>

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

Id string

The provider-assigned unique ID for this managed resource.

ManagedNamespaces List<GetGlobalClusterConfigManagedNamespace>

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

ProjectId string
ClusterName string
CustomZoneMapping map[string]interface{}

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

Id string

The provider-assigned unique ID for this managed resource.

ManagedNamespaces []GetGlobalClusterConfigManagedNamespace

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

ProjectId string
clusterName string
customZoneMapping {[key: string]: any}

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

id string

The provider-assigned unique ID for this managed resource.

managedNamespaces GetGlobalClusterConfigManagedNamespace[]

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

projectId string
cluster_name str
custom_zone_mapping Mapping[str, Any]

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

id str

The provider-assigned unique ID for this managed resource.

managed_namespaces Sequence[GetGlobalClusterConfigManagedNamespace]

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

project_id str

Supporting Types

GetGlobalClusterConfigManagedNamespace

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Collection string

(Required) The name of the collection associated with the managed namespace.

CustomShardKey string

(Required) The custom shard key for the collection. Global Clusters require a compound shard key consisting of a location field and a user-selected second key, the custom shard key.

Db string

(Required) The name of the database containing the collection.

Collection string

(Required) The name of the collection associated with the managed namespace.

CustomShardKey string

(Required) The custom shard key for the collection. Global Clusters require a compound shard key consisting of a location field and a user-selected second key, the custom shard key.

Db string

(Required) The name of the database containing the collection.

collection string

(Required) The name of the collection associated with the managed namespace.

customShardKey string

(Required) The custom shard key for the collection. Global Clusters require a compound shard key consisting of a location field and a user-selected second key, the custom shard key.

db string

(Required) The name of the database containing the collection.

collection str

(Required) The name of the collection associated with the managed namespace.

custom_shard_key str

(Required) The custom shard key for the collection. Global Clusters require a compound shard key consisting of a location field and a user-selected second key, the custom shard key.

db str

(Required) The name of the database containing the collection.

Package Details

Repository
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes
This Pulumi package is based on the mongodbatlas Terraform Provider.