Class GlobalClusterConfig

mongodbatlas..GlobalClusterConfig provides a Global Cluster Configuration resource.

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

Inheritance

System.Object

Resource

CustomResource

GlobalClusterConfig

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Mongodbatlas

Assembly: Pulumi.Mongodbatlas.dll

Syntax

public class GlobalClusterConfig : CustomResource

Constructors

View Source

GlobalClusterConfig(String, GlobalClusterConfigArgs, CustomResourceOptions)

Create a GlobalClusterConfig resource with the given unique name, arguments, and options.

Declaration

public GlobalClusterConfig(string name, GlobalClusterConfigArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
GlobalClusterConfigArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

ClusterName

Declaration

public Output<string> ClusterName { get; }

Property Value

Type	Description
Output<System.String>

View Source

CustomZoneMapping

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.

Declaration

public Output<ImmutableDictionary<string, object>> CustomZoneMapping { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

View Source

CustomZoneMappings

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

Declaration

public Output<ImmutableArray<GlobalClusterConfigCustomZoneMapping>> CustomZoneMappings { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<GlobalClusterConfigCustomZoneMapping>>

View Source

ManagedNamespaces

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

Declaration

public Output<ImmutableArray<GlobalClusterConfigManagedNamespace>> ManagedNamespaces { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<GlobalClusterConfigManagedNamespace>>

View Source

ProjectId

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

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

Declaration

public Output<string> ProjectId { get; }

Property Value

Type	Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, GlobalClusterConfigState, CustomResourceOptions)

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

Declaration

public static GlobalClusterConfig Get(string name, Input<string> id, GlobalClusterConfigState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
GlobalClusterConfigState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
GlobalClusterConfig