1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. getGlobalClusterConfig
MongoDB Atlas v3.14.1 published on Thursday, Feb 8, 2024 by Pulumi

mongodbatlas.getGlobalClusterConfig

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.14.1 published on Thursday, Feb 8, 2024 by Pulumi

    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

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGlobalClusterConfig(args: GetGlobalClusterConfigArgs, opts?: InvokeOptions): Promise<GetGlobalClusterConfigResult>
    function getGlobalClusterConfigOutput(args: GetGlobalClusterConfigOutputArgs, opts?: InvokeOptions): Output<GetGlobalClusterConfigResult>
    def get_global_cluster_config(cluster_name: Optional[str] = None,
                                  managed_namespaces: Optional[Sequence[GetGlobalClusterConfigManagedNamespace]] = None,
                                  project_id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetGlobalClusterConfigResult
    def get_global_cluster_config_output(cluster_name: Optional[pulumi.Input[str]] = None,
                                  managed_namespaces: Optional[pulumi.Input[Sequence[pulumi.Input[GetGlobalClusterConfigManagedNamespaceArgs]]]] = None,
                                  project_id: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetGlobalClusterConfigResult]
    func LookupGlobalClusterConfig(ctx *Context, args *LookupGlobalClusterConfigArgs, opts ...InvokeOption) (*LookupGlobalClusterConfigResult, error)
    func LookupGlobalClusterConfigOutput(ctx *Context, args *LookupGlobalClusterConfigOutputArgs, opts ...InvokeOption) LookupGlobalClusterConfigResultOutput

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

    public static class GetGlobalClusterConfig 
    {
        public static Task<GetGlobalClusterConfigResult> InvokeAsync(GetGlobalClusterConfigArgs args, InvokeOptions? opts = null)
        public static Output<GetGlobalClusterConfigResult> Invoke(GetGlobalClusterConfigInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetGlobalClusterConfigResult> getGlobalClusterConfig(GetGlobalClusterConfigArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: mongodbatlas:index/getGlobalClusterConfig:getGlobalClusterConfig
      arguments:
        # arguments dictionary

    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<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.
    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<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[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 List<Property Map>
    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 Map<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 {[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
    clusterName String
    customZoneMapping Map<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 List<Property Map>
    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

    Supporting Types

    GetGlobalClusterConfigManagedNamespace

    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.
    IsCustomShardKeyHashed bool
    Specifies whether the custom shard key for the collection is hashed. If omitted, defaults to false. If false, Atlas uses ranged sharding. This is only available for Atlas clusters with MongoDB v4.4 and later.
    IsShardKeyUnique bool
    Specifies whether the underlying index enforces a unique constraint. If omitted, defaults to false. You cannot specify true when using hashed shard keys.
    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.
    IsCustomShardKeyHashed bool
    Specifies whether the custom shard key for the collection is hashed. If omitted, defaults to false. If false, Atlas uses ranged sharding. This is only available for Atlas clusters with MongoDB v4.4 and later.
    IsShardKeyUnique bool
    Specifies whether the underlying index enforces a unique constraint. If omitted, defaults to false. You cannot specify true when using hashed shard keys.
    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.
    isCustomShardKeyHashed Boolean
    Specifies whether the custom shard key for the collection is hashed. If omitted, defaults to false. If false, Atlas uses ranged sharding. This is only available for Atlas clusters with MongoDB v4.4 and later.
    isShardKeyUnique Boolean
    Specifies whether the underlying index enforces a unique constraint. If omitted, defaults to false. You cannot specify true when using hashed shard keys.
    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.
    isCustomShardKeyHashed boolean
    Specifies whether the custom shard key for the collection is hashed. If omitted, defaults to false. If false, Atlas uses ranged sharding. This is only available for Atlas clusters with MongoDB v4.4 and later.
    isShardKeyUnique boolean
    Specifies whether the underlying index enforces a unique constraint. If omitted, defaults to false. You cannot specify true when using hashed shard keys.
    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.
    is_custom_shard_key_hashed bool
    Specifies whether the custom shard key for the collection is hashed. If omitted, defaults to false. If false, Atlas uses ranged sharding. This is only available for Atlas clusters with MongoDB v4.4 and later.
    is_shard_key_unique bool
    Specifies whether the underlying index enforces a unique constraint. If omitted, defaults to false. You cannot specify true when using hashed shard keys.
    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.
    isCustomShardKeyHashed Boolean
    Specifies whether the custom shard key for the collection is hashed. If omitted, defaults to false. If false, Atlas uses ranged sharding. This is only available for Atlas clusters with MongoDB v4.4 and later.
    isShardKeyUnique Boolean
    Specifies whether the underlying index enforces a unique constraint. If omitted, defaults to false. You cannot specify true when using hashed shard keys.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.14.1 published on Thursday, Feb 8, 2024 by Pulumi