Class GetClusterResult

Inheritance

System.Object

GetClusterResult

Inherited Members

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 sealed class GetClusterResult

Fields

AutoScalingDiskGbEnabled

Indicates whether disk auto-scaling is enabled.

Declaration

public readonly bool AutoScalingDiskGbEnabled

Field Value

Type	Description
System.Boolean

BackingProviderName

Indicates Cloud service provider on which the server for a multi-tenant cluster is provisioned.

Declaration

public readonly string BackingProviderName

Field Value

Type	Description
System.String

BackupEnabled

Legacy Option, Indicates whether Atlas continuous backups are enabled for the cluster.

Declaration

public readonly bool BackupEnabled

Field Value

Type	Description
System.Boolean

BiConnector

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

Declaration

public readonly GetClusterBiConnectorResult BiConnector

Field Value

Type	Description
GetClusterBiConnectorResult

ClusterType

Indicates the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

Declaration

public readonly string ClusterType

Field Value

Type	Description
System.String

ConnectionStrings

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.

• connection_strings.standard - Public mongodb:// connection string for this cluster.
• connection_strings.standard_srv - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.standard.
• connection_strings.aws_private_link - Private-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster.
• connection_strings.aws_private_link_srv - Private-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.awsPrivateLink.
• connection_strings.private - Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.
• connection_strings.private_srv - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.

Declaration

public readonly GetClusterConnectionStringsResult ConnectionStrings

Field Value

Type	Description
GetClusterConnectionStringsResult

DiskSizeGb

Indicates the size in gigabytes of the server’s root volume (AWS/GCP Only).

Declaration

public readonly double DiskSizeGb

Field Value

Type	Description
System.Double

EncryptionAtRestProvider

Indicates whether Encryption at Rest is enabled or disabled.

Declaration

public readonly string EncryptionAtRestProvider

Field Value

Type	Description
System.String

Id

The provider-assigned unique ID for this managed resource.

Declaration

public readonly string Id

Field Value

Type	Description
System.String

Labels

Declaration

public readonly ImmutableArray<GetClusterLabelResult> Labels

Field Value

Type	Description
System.Collections.Immutable.ImmutableArray<GetClusterLabelResult>

MongoDbMajorVersion

Indicates the version of the cluster to deploy.

Declaration

public readonly string MongoDbMajorVersion

Field Value

Type	Description
System.String

MongoDbVersion

Version of MongoDB the cluster runs, in major-version.minor-version format.

Declaration

public readonly string MongoDbVersion

Field Value

Type	Description
System.String

MongoUri

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

Declaration

public readonly string MongoUri

Field Value

Type	Description
System.String

MongoUriUpdated

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

Declaration

public readonly string MongoUriUpdated

Field Value

Type	Description
System.String

MongoUriWithOptions

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

Declaration

public readonly string MongoUriWithOptions

Field Value

Type	Description
System.String

Name

The name of the current plugin

Declaration

public readonly string Name

Field Value

Type	Description
System.String

NumShards

Number of shards to deploy in the specified zone.

Declaration

public readonly int NumShards

Field Value

Type	Description
System.Int32

Paused

Flag that indicates whether the cluster is paused or not.

Declaration

public readonly bool Paused

Field Value

Type	Description
System.Boolean

PitEnabled

Flag that indicates if the cluster uses Point-in-Time backups.

Declaration

public readonly bool PitEnabled

Field Value

Type	Description
System.Boolean

ProjectId

Declaration

public readonly string ProjectId

Field Value

Type	Description
System.String

ProviderBackupEnabled

Flag indicating if the cluster uses Cloud Provider Snapshots for backups.

Declaration

public readonly bool ProviderBackupEnabled

Field Value

Type	Description
System.Boolean

ProviderDiskIops

Indicates the maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected providerSettings.instanceSizeName and diskSizeGB.

Declaration

public readonly int ProviderDiskIops

Field Value

Type	Description
System.Int32

ProviderDiskTypeName

Describes Azure disk type of the server’s root volume (Azure Only).

Declaration

public readonly string ProviderDiskTypeName

Field Value

Type	Description
System.String

ProviderEncryptEbsVolume

Indicates whether the Amazon EBS encryption is enabled. This feature encrypts the server’s root volume for both data at rest within the volume and data moving between the volume and the instance.

Declaration

public readonly bool ProviderEncryptEbsVolume

Field Value

Type	Description
System.Boolean

ProviderInstanceSizeName

Atlas provides different instance sizes, each with a default storage capacity and RAM size.

Declaration

public readonly string ProviderInstanceSizeName

Field Value

Type	Description
System.String

ProviderName

Indicates the cloud service provider on which the servers are provisioned.

Declaration

public readonly string ProviderName

Field Value

Type	Description
System.String

ProviderRegionName

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

Declaration

public readonly string ProviderRegionName

Field Value

Type	Description
System.String

ProviderVolumeType

Indicates the type of the volume. The possible values are: STANDARD and PROVISIONED.

Declaration

public readonly string ProviderVolumeType

Field Value

Type	Description
System.String

ReplicationFactor

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.

Declaration

public readonly int ReplicationFactor

Field Value

Type	Description
System.Int32

ReplicationSpecs

Configuration for cluster regions. See Replication Spec below for more details.

Declaration

public readonly ImmutableArray<GetClusterReplicationSpecResult> ReplicationSpecs

Field Value

Type	Description
System.Collections.Immutable.ImmutableArray<GetClusterReplicationSpecResult>

SnapshotBackupPolicies

current snapshot schedule and retention settings for the cluster.

Declaration

public readonly ImmutableArray<GetClusterSnapshotBackupPolicyResult> SnapshotBackupPolicies

Field Value

Type	Description
System.Collections.Immutable.ImmutableArray<GetClusterSnapshotBackupPolicyResult>

SrvAddress

Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.

Declaration

public readonly string SrvAddress

Field Value

Type	Description
System.String

StateName

Indicates the current state of the cluster. The possible states are:

• IDLE
• CREATING
• UPDATING
• DELETING
• DELETED
• REPAIRING

Declaration

public readonly string StateName

Field Value

Type	Description
System.String