Class ClusterState

Inheritance

System.Object

InputArgs

ResourceArgs

ClusterState

Inherited Members

ResourceArgs.Empty

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 ClusterState : ResourceArgs

Constructors

ClusterState()

Declaration

public ClusterState()

Properties

AdvancedConfiguration

Declaration

public Input<ClusterAdvancedConfigurationGetArgs> AdvancedConfiguration { get; set; }

Property Value

Type	Description
Input<ClusterAdvancedConfigurationGetArgs>

AutoScalingDiskGbEnabled

Specifies whether disk auto-scaling is enabled. The default is true.

• Set to true to enable disk auto-scaling.
• Set to false to disable disk auto-scaling.

Declaration

public Input<bool> AutoScalingDiskGbEnabled { get; set; }

Property Value

Type	Description
Input<System.Boolean>

BackingProviderName

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

Declaration

public Input<string> BackingProviderName { get; set; }

Property Value

Type	Description
Input<System.String>

BackupEnabled

Legacy Option - Set to true to enable Atlas continuous backups for the cluster.

Declaration

public Input<bool> BackupEnabled { get; set; }

Property Value

Type	Description
Input<System.Boolean>

BiConnector

Specifies 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 Input<ClusterBiConnectorGetArgs> BiConnector { get; set; }

Property Value

Type	Description
Input<ClusterBiConnectorGetArgs>

ClusterId

The cluster ID.

Declaration

public Input<string> ClusterId { get; set; }

Property Value

Type	Description
Input<System.String>

ClusterType

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

Declaration

public Input<string> ClusterType { get; set; }

Property Value

Type	Description
Input<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 Input<ClusterConnectionStringsGetArgs> ConnectionStrings { get; set; }

Property Value

Type	Description
Input<ClusterConnectionStringsGetArgs>

DiskSizeGb

The size in gigabytes of the server’s root volume. You can add capacity by increasing this number, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive integer.

Declaration

public Input<double> DiskSizeGb { get; set; }

Property Value

Type	Description
Input<System.Double>

EncryptionAtRestProvider

Set the Encryption at Rest parameter. Possible values are AWS, GCP, AZURE or NONE. Requires M10 or greater and for backup_enabled to be false or omitted.

Declaration

public Input<string> EncryptionAtRestProvider { get; set; }

Property Value

Type	Description
Input<System.String>

Labels

Array containing key-value pairs that tag and categorize the cluster. Each key and value has a maximum length of 255 characters. You cannot set the key Infrastructure Tool, it is used for internal purposes to track aggregate usage.

Declaration

public InputList<ClusterLabelGetArgs> Labels { get; set; }

Property Value

Type	Description
InputList<ClusterLabelGetArgs>

MongoDbMajorVersion

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: 3.6, 4.0, or 4.2. You must set this value to 4.2 if provider_instance_size_name is either M2 or M5.

Declaration

public Input<string> MongoDbMajorVersion { get; set; }

Property Value

Type	Description
Input<System.String>

MongoDbVersion

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

Declaration

public Input<string> MongoDbVersion { get; set; }

Property Value

Type	Description
Input<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 Input<string> MongoUri { get; set; }

Property Value

Type	Description
Input<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 Input<string> MongoUriUpdated { get; set; }

Property Value

Type	Description
Input<System.String>

MongoUriWithOptions

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 Input<string> MongoUriWithOptions { get; set; }

Property Value

Type	Description
Input<System.String>

Name

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

Declaration

public Input<string> Name { get; set; }

Property Value

Type	Description
Input<System.String>

NumShards

Number of shards to deploy in the specified zone.

Declaration

public Input<int> NumShards { get; set; }

Property Value

Type	Description
Input<System.Int32>

Paused

Flag that indicates whether the cluster is paused or not.

Declaration

public Input<bool> Paused { get; set; }

Property Value

Type	Description
Input<System.Boolean>

PitEnabled

• Flag that indicates if the cluster uses Point-in-Time backups. If set to true, provider_backup_enabled must also be set to true.

Declaration

public Input<bool> PitEnabled { get; set; }

Property Value

Type	Description
Input<System.Boolean>

ProjectId

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

Declaration

public Input<string> ProjectId { get; set; }

Property Value

Type	Description
Input<System.String>

ProviderBackupEnabled

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

Declaration

public Input<bool> ProviderBackupEnabled { get; set; }

Property Value

Type	Description
Input<System.Boolean>

ProviderDiskIops

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 Input<int> ProviderDiskIops { get; set; }

Property Value

Type	Description
Input<System.Int32>

ProviderDiskTypeName

Azure disk type of the server’s root volume. If omitted, Atlas uses the default disk type for the selected providerSettings.instanceSizeName. Example disk types and associated storage sizes: P4 - 32GB, P6 - 64GB, P10 - 128GB, P20 - 512GB, P30 - 1024GB, P40 - 2048GB, P50 - 4095GB. More information and the most update to date disk types/storage sizes can be located at https://docs.atlas.mongodb.com/reference/api/clusters-create-one/.

Declaration

public Input<string> ProviderDiskTypeName { get; set; }

Property Value

Type	Description
Input<System.String>

ProviderEncryptEbsVolume

If enabled, the Amazon EBS encryption feature encrypts the server’s root volume for both data at rest within the volume and for data moving between the volume and the instance.

Declaration

public Input<bool> ProviderEncryptEbsVolume { get; set; }

Property Value

Type	Description
Input<System.Boolean>

ProviderInstanceSizeName

Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See Create a Cluster providerSettings.instanceSizeName for valid values and default resources.

Declaration

public Input<string> ProviderInstanceSizeName { get; set; }

Property Value

Type	Description
Input<System.String>

ProviderName

Cloud service provider on which the servers are provisioned.

Declaration

public Input<string> ProviderName { get; set; }

Property Value

Type	Description
Input<System.String>

ProviderRegionName

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. Do not specify this field when creating a multi-region cluster using the replicationSpec document or a Global Cluster with the replicationSpecs array.

Declaration

public Input<string> ProviderRegionName { get; set; }

Property Value

Type	Description
Input<System.String>

ProviderVolumeType

The type of the volume. The possible values are: STANDARD and PROVISIONED. PROVISIONED required if setting IOPS higher than the default instance IOPS.

Declaration

public Input<string> ProviderVolumeType { get; set; }

Property Value

Type	Description
Input<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 Input<int> ReplicationFactor { get; set; }

Property Value

Type	Description
Input<System.Int32>

ReplicationSpecs

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

Declaration

public InputList<ClusterReplicationSpecGetArgs> ReplicationSpecs { get; set; }

Property Value

Type	Description
InputList<ClusterReplicationSpecGetArgs>

SnapshotBackupPolicies

current snapshot schedule and retention settings for the cluster.

Declaration

public InputList<ClusterSnapshotBackupPolicyGetArgs> SnapshotBackupPolicies { get; set; }

Property Value

Type	Description
InputList<ClusterSnapshotBackupPolicyGetArgs>

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 Input<string> SrvAddress { get; set; }

Property Value

Type	Description
Input<System.String>

StateName

Current state of the cluster. The possible states are:

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

Declaration

public Input<string> StateName { get; set; }

Property Value

Type	Description
Input<System.String>