Documentation
¶
Index ¶
- Variables
- type Actions
- type AdvancedConfiguration
- type AnalyticsAutoScaling
- type AnalyticsSpecs
- type BiConnector
- type Cluster
- type ClusterList
- type ClusterSpec
- type ClusterSpecV20250312
- type ClusterStatus
- type ClusterStatusV20250312
- type Compute
- type ConnectionStrings
- type CustomRole
- type CustomRoleList
- type CustomRoleSpec
- type CustomRoleSpecV20250312
- type CustomRoleSpecV20250312Entry
- type CustomRoleStatus
- type DatabaseUser
- type DatabaseUserList
- type DatabaseUserSpec
- type DatabaseUserSpecV20250312
- type DatabaseUserSpecV20250312Entry
- type DatabaseUserStatus
- type DiskGB
- type ElectableSpecs
- type Endpoints
- type Entry
- type FlexCluster
- type FlexClusterList
- type FlexClusterSpec
- type FlexClusterSpecV20250312
- type FlexClusterSpecV20250312Entry
- type FlexClusterStatus
- type FlexClusterStatusV20250312
- type Group
- type GroupList
- type GroupSpec
- type GroupStatus
- type GroupStatusV20250312
- type InheritedRoles
- type Links
- type MongoDBEmployeeAccessGrant
- type PrivateEndpoint
- type ProviderSettings
- type RegionConfigs
- type ReplicationSpecs
- type Resources
- type Roles
- type Scopes
- type Tags
- type Team
- type TeamList
- type TeamSpec
- type TeamSpecV20250312
- type TeamSpecV20250312Entry
- type TeamStatus
- type TeamStatusV20250312
- type V20250312
- type V20250312ConnectionStrings
- type V20250312Entry
- type V20250312ProviderSettings
- type V20250312ReplicationSpecs
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{ Group: "atlas.generated.mongodb.com", Version: "v1", } // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type Actions ¶
type Actions struct {
// Action Human-readable label that identifies the privilege action.
Action string `json:"action"`
// Resources List of resources on which you grant the action.
Resources *[]Resources `json:"resources,omitempty"`
}
func (*Actions) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Actions.
func (*Actions) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AdvancedConfiguration ¶
type AdvancedConfiguration struct {
// CustomOpensslCipherConfigTls12 The custom OpenSSL cipher suite list for TLS 1.2.
// This field is only valid when `tlsCipherConfigMode` is set to `CUSTOM`.
CustomOpensslCipherConfigTls12 *[]string `json:"customOpensslCipherConfigTls12,omitempty"`
// MinimumEnabledTlsProtocol Minimum Transport Layer Security (TLS) version that
// the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1
// should consider setting TLS 1.2 as the minimum TLS protocol version.
MinimumEnabledTlsProtocol *string `json:"minimumEnabledTlsProtocol,omitempty"`
// TlsCipherConfigMode The TLS cipher suite configuration mode. The default mode
// uses the default cipher suites. The custom mode allows you to specify custom
// cipher suites for both TLS 1.2 and TLS 1.3.
TlsCipherConfigMode *string `json:"tlsCipherConfigMode,omitempty"`
}
func (*AdvancedConfiguration) DeepCopy ¶
func (in *AdvancedConfiguration) DeepCopy() *AdvancedConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AdvancedConfiguration.
func (*AdvancedConfiguration) DeepCopyInto ¶
func (in *AdvancedConfiguration) DeepCopyInto(out *AdvancedConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AnalyticsAutoScaling ¶
type AnalyticsAutoScaling struct {
// Compute Options that determine how this cluster handles CPU scaling.
Compute *Compute `json:"compute,omitempty"`
// DiskGB Setting that enables disk auto-scaling.
DiskGB *DiskGB `json:"diskGB,omitempty"`
}
func (*AnalyticsAutoScaling) DeepCopy ¶
func (in *AnalyticsAutoScaling) DeepCopy() *AnalyticsAutoScaling
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AnalyticsAutoScaling.
func (*AnalyticsAutoScaling) DeepCopyInto ¶
func (in *AnalyticsAutoScaling) DeepCopyInto(out *AnalyticsAutoScaling)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type AnalyticsSpecs ¶
type AnalyticsSpecs struct {
/*
DiskIOPS Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:
- set `"replicationSpecs[n].regionConfigs[m].providerName" : "Azure"`.
- set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M40"` or greater not including `Mxx_NVME` tiers.
The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.
This parameter defaults to the cluster tier's standard IOPS value.
Changing this value impacts cluster cost.
*/
DiskIOPS *int `json:"diskIOPS,omitempty"`
/*
DiskSizeGB Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.
This value must be equal for all shards and node types.
This value is not configurable on M0/M2/M5 clusters.
MongoDB Cloud requires this parameter if you set **replicationSpecs**.
If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value.
Storage charge calculations depend on whether you choose the default value or a custom value.
The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.
*/
DiskSizeGB *float64 `json:"diskSizeGB,omitempty"`
/*
EbsVolumeType Type of storage you want to attach to your AWS-provisioned cluster.
- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size.
- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.
*/
EbsVolumeType *string `json:"ebsVolumeType,omitempty"`
// InstanceSize Hardware specification for the instance sizes in this region in
// this shard. Each instance size has a default storage and memory capacity.
// Electable nodes and read-only nodes (known as "base nodes") within a single
// shard must use the same instance size. Analytics nodes can scale independently
// from base nodes within a shard. Both base nodes and analytics nodes can scale
// independently from their equivalents in other shards.
InstanceSize *string `json:"instanceSize,omitempty"`
// NodeCount Number of nodes of the given type for MongoDB Cloud to deploy to the
// region.
NodeCount *int `json:"nodeCount,omitempty"`
}
func (*AnalyticsSpecs) DeepCopy ¶
func (in *AnalyticsSpecs) DeepCopy() *AnalyticsSpecs
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AnalyticsSpecs.
func (*AnalyticsSpecs) DeepCopyInto ¶
func (in *AnalyticsSpecs) DeepCopyInto(out *AnalyticsSpecs)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BiConnector ¶
type BiConnector struct {
// Enabled Flag that indicates whether MongoDB Connector for Business Intelligence
// is enabled on the specified cluster.
Enabled *bool `json:"enabled,omitempty"`
// ReadPreference Data source node designated for the MongoDB Connector for
// Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business
// Intelligence on MongoDB Cloud reads data from the primary, secondary, or
// analytics node based on your read preferences. Defaults to `ANALYTICS` node, or
// `SECONDARY` if there are no `ANALYTICS` nodes.
ReadPreference *string `json:"readPreference,omitempty"`
}
func (*BiConnector) DeepCopy ¶
func (in *BiConnector) DeepCopy() *BiConnector
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BiConnector.
func (*BiConnector) DeepCopyInto ¶
func (in *BiConnector) DeepCopyInto(out *BiConnector)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Cluster ¶
type Cluster struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ClusterSpec `json:"spec,omitempty"`
Status ClusterStatus `json:"status,omitempty"`
}
func (*Cluster) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Cluster.
func (*Cluster) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Cluster) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Cluster) GetConditions ¶
GetConditions for Cluster
type ClusterList ¶
type ClusterList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Cluster `json:"items"`
}
+kubebuilder:object:root=true
func (*ClusterList) DeepCopy ¶
func (in *ClusterList) DeepCopy() *ClusterList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterList.
func (*ClusterList) DeepCopyInto ¶
func (in *ClusterList) DeepCopyInto(out *ClusterList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterList) DeepCopyObject ¶
func (in *ClusterList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterSpec ¶
type ClusterSpec struct {
/*
ConnectionSecretRef SENSITIVE FIELD
Reference to a secret containing the credentials to setup the connection to Atlas.
*/
ConnectionSecretRef *k8s.LocalReference `json:"connectionSecretRef,omitempty"`
// V20250312 The spec of the cluster resource for version v20250312.
V20250312 *ClusterSpecV20250312 `json:"v20250312,omitempty"`
}
func (*ClusterSpec) DeepCopy ¶
func (in *ClusterSpec) DeepCopy() *ClusterSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterSpec.
func (*ClusterSpec) DeepCopyInto ¶
func (in *ClusterSpec) DeepCopyInto(out *ClusterSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterSpecV20250312 ¶
type ClusterSpecV20250312 struct {
// Entry The entry fields of the cluster resource spec. These fields can be set for
// creating and updating clusters.
Entry *V20250312Entry `json:"entry,omitempty"`
/*
GroupId Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
*/
GroupId *string `json:"groupId,omitempty"`
/*
GroupRef A reference to a "Group" resource.
The value of "$.status.v20250312.id" will be used to set "groupId".
Mutually exclusive with the "groupId" property.
*/
GroupRef *k8s.LocalReference `json:"groupRef,omitempty"`
}
func (*ClusterSpecV20250312) DeepCopy ¶
func (in *ClusterSpecV20250312) DeepCopy() *ClusterSpecV20250312
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterSpecV20250312.
func (*ClusterSpecV20250312) DeepCopyInto ¶
func (in *ClusterSpecV20250312) DeepCopyInto(out *ClusterSpecV20250312)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterStatus ¶
type ClusterStatus struct {
// Conditions Represents the latest available observations of a resource's current
// state.
Conditions *[]metav1.Condition `json:"conditions,omitempty"`
// V20250312 The last observed Atlas state of the cluster resource for version
// v20250312.
V20250312 *ClusterStatusV20250312 `json:"v20250312,omitempty"`
}
func (*ClusterStatus) DeepCopy ¶
func (in *ClusterStatus) DeepCopy() *ClusterStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterStatus.
func (*ClusterStatus) DeepCopyInto ¶
func (in *ClusterStatus) DeepCopyInto(out *ClusterStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterStatusV20250312 ¶
type ClusterStatusV20250312 struct {
// AdvancedConfiguration Group of settings that configures a subset of the advanced
// configuration details.
AdvancedConfiguration *AdvancedConfiguration `json:"advancedConfiguration,omitempty"`
/*
ConfigServerManagementMode Config Server Management Mode for creating or updating a sharded cluster.
When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.
When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.
*/
ConfigServerManagementMode *string `json:"configServerManagementMode,omitempty"`
// ConfigServerType Describes a sharded cluster's config server type.
ConfigServerType *string `json:"configServerType,omitempty"`
// ConnectionStrings Collection of Uniform Resource Locators that point to the
// MongoDB database.
ConnectionStrings *ConnectionStrings `json:"connectionStrings,omitempty"`
// CreateDate Date and time when MongoDB Cloud created this cluster. This parameter
// expresses its value in ISO 8601 format in UTC.
CreateDate *string `json:"createDate,omitempty"`
// FeatureCompatibilityVersion Feature compatibility version of the cluster. This
// will always appear regardless of whether FCV is pinned.
FeatureCompatibilityVersion *string `json:"featureCompatibilityVersion,omitempty"`
// FeatureCompatibilityVersionExpirationDate Feature compatibility version
// expiration date. Will only appear if FCV is pinned. This parameter expresses its
// value in the ISO 8601 timestamp format in UTC.
FeatureCompatibilityVersionExpirationDate *string `json:"featureCompatibilityVersionExpirationDate,omitempty"`
/*
GlobalClusterSelfManagedSharding Set this field to configure the Sharding Management Mode when creating a new Global Cluster.
When set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.
When set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.
This setting cannot be changed once the cluster is deployed.
*/
GlobalClusterSelfManagedSharding *bool `json:"globalClusterSelfManagedSharding,omitempty"`
// GroupId Unique 24-hexadecimal character string that identifies the project.
GroupId *string `json:"groupId,omitempty"`
// Id Unique 24-hexadecimal digit string that identifies the cluster.
Id *string `json:"id,omitempty"`
// MongoDBEmployeeAccessGrant MongoDB employee granted access level and expiration
// for a cluster.
MongoDBEmployeeAccessGrant *MongoDBEmployeeAccessGrant `json:"mongoDBEmployeeAccessGrant,omitempty"`
// MongoDBVersion Version of MongoDB that the cluster runs.
MongoDBVersion *string `json:"mongoDBVersion,omitempty"`
/*
RedactClientLogData Enable or disable log redaction.
This setting configures the “mongod“ or “mongos“ to redact any document field contents from a message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs.
Use “redactClientLogData“ in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements.
*Note*: changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
*/
RedactClientLogData *bool `json:"redactClientLogData,omitempty"`
/*
ReplicaSetScalingStrategy Set this field to configure the replica set scaling mode for your cluster.
By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.
When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.
When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.
*/
ReplicaSetScalingStrategy *string `json:"replicaSetScalingStrategy,omitempty"`
// ReplicationSpecs List of settings that configure your cluster regions. This
// array has one object per shard representing node configurations in each shard.
// For replica sets there is only one object representing node configurations.
ReplicationSpecs *[]V20250312ReplicationSpecs `json:"replicationSpecs,omitempty"`
/*
StateName Human-readable label that indicates any current activity being taken on this cluster by the Atlas control plane. With the exception of CREATING and DELETING states, clusters should always be available and have a Primary node even when in states indicating ongoing activity.
- `IDLE`: Atlas is making no changes to this cluster and all changes requested via the UI or API can be assumed to have been applied.
- `CREATING`: A cluster being provisioned for the very first time returns state CREATING until it is ready for connections. Ensure IP Access List and DB Users are configured before attempting to connect.
- `UPDATING`: A change requested via the UI, API, AutoScaling, or other scheduled activity is taking place.
- `DELETING`: The cluster is in the process of deletion and will soon be deleted.
- `REPAIRING`: One or more nodes in the cluster are being returned to service by the Atlas control plane. Other nodes should continue to provide service as normal.
*/
StateName *string `json:"stateName,omitempty"`
}
func (*ClusterStatusV20250312) DeepCopy ¶
func (in *ClusterStatusV20250312) DeepCopy() *ClusterStatusV20250312
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterStatusV20250312.
func (*ClusterStatusV20250312) DeepCopyInto ¶
func (in *ClusterStatusV20250312) DeepCopyInto(out *ClusterStatusV20250312)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Compute ¶
type Compute struct {
/*
Enabled Flag that indicates whether instance size reactive auto-scaling is enabled.
- Set to `true` to enable instance size reactive auto-scaling. If enabled, you must specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize**.
- Set to `false` to disable instance size reactive auto-scaling.
*/
Enabled *bool `json:"enabled,omitempty"`
// MaxInstanceSize Instance size boundary to which your cluster can automatically
// scale.
MaxInstanceSize *string `json:"maxInstanceSize,omitempty"`
// MinInstanceSize Instance size boundary to which your cluster can automatically
// scale.
MinInstanceSize *string `json:"minInstanceSize,omitempty"`
/*
PredictiveEnabled Flag that indicates whether predictive instance size auto-scaling is enabled.
- Set to `true` to enable predictive instance size auto-scaling. MongoDB Cloud requires **replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled** to be `true` in order to enable this feature.
- Set to `false` to disable predictive instance size auto-scaling.
*/
PredictiveEnabled *bool `json:"predictiveEnabled,omitempty"`
// ScaleDownEnabled Flag that indicates whether the instance size may scale down
// via reactive auto-scaling. MongoDB Cloud requires this parameter if
// **replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled** is `true`.
// If you enable this option, specify a value for
// **replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize**.
ScaleDownEnabled *bool `json:"scaleDownEnabled,omitempty"`
}
func (*Compute) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Compute.
func (*Compute) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ConnectionStrings ¶
type ConnectionStrings struct {
// AwsPrivateLink Private endpoint-aware connection strings that use AWS-hosted
// clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an
// Amazon Web Services (AWS) interface endpoint. Each value identifies the related
// `mongodb://` connection string that you use to connect to MongoDB Cloud through
// the interface endpoint that the key names.
AwsPrivateLink *map[string]string `json:"awsPrivateLink,omitempty"`
// AwsPrivateLinkSrv Private endpoint-aware connection strings that use AWS-hosted
// clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an
// Amazon Web Services (AWS) interface endpoint. Each value identifies the related
// `mongodb://` connection string that you use to connect to Atlas through the
// interface endpoint that the key names. If the cluster uses an optimized
// connection string, `awsPrivateLinkSrv` contains the optimized connection string.
// If the cluster has the non-optimized (legacy) connection string,
// `awsPrivateLinkSrv` contains the non-optimized connection string even if an
// optimized connection string is also present.
AwsPrivateLinkSrv *map[string]string `json:"awsPrivateLinkSrv,omitempty"`
// Private Network peering connection strings for each interface Virtual Private
// Cloud (VPC) endpoint that you configured to connect to this cluster. This
// connection string uses the `mongodb+srv://` protocol. The resource returns this
// parameter once someone creates a network peering connection to this cluster.
// This protocol tells the application to look up the host seed list in the Domain
// Name System (DNS). This list synchronizes with the nodes in a cluster. If the
// connection string uses this Uniform Resource Identifier (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.private.
// For Amazon Web Services (AWS) clusters, this resource returns this parameter
// only if you enable custom DNS.
Private *string `json:"private,omitempty"`
// PrivateEndpoint List of private endpoint-aware connection strings that you can
// use to connect to this cluster through a private endpoint. This parameter
// returns only if you deployed a private endpoint to all regions to which you
// deployed this clusters' nodes.
PrivateEndpoint *[]PrivateEndpoint `json:"privateEndpoint,omitempty"`
// PrivateSrv Network peering connection strings for each interface Virtual Private
// Cloud (VPC) endpoint that you configured to connect to this cluster. This
// connection string uses the `mongodb+srv://` protocol. The resource returns this
// parameter when someone creates a network peering connection to this cluster.
// This protocol tells the application to look up the host seed list in the Domain
// Name System (DNS). This list synchronizes with the nodes in a cluster. If the
// connection string uses this Uniform Resource Identifier (URI) format, you don't
// need to append the seed list or change the Uniform Resource Identifier (URI) if
// the nodes change. Use this Uniform Resource Identifier (URI) format if your
// driver supports it. If it doesn't, use `connectionStrings.private`. For Amazon
// Web Services (AWS) clusters, this parameter returns only if you [enable custom
// DNS](https://docs.atlas.mongodb.com/reference/api/aws-custom-dns-update/).
PrivateSrv *string `json:"privateSrv,omitempty"`
// Standard Public connection string that you can use to connect to this cluster.
// This connection string uses the `mongodb://` protocol.
Standard *string `json:"standard,omitempty"`
// StandardSrv Public connection string that you can use to connect to this
// cluster. This connection string uses the `mongodb+srv://` protocol.
StandardSrv *string `json:"standardSrv,omitempty"`
}
func (*ConnectionStrings) DeepCopy ¶
func (in *ConnectionStrings) DeepCopy() *ConnectionStrings
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionStrings.
func (*ConnectionStrings) DeepCopyInto ¶
func (in *ConnectionStrings) DeepCopyInto(out *ConnectionStrings)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CustomRole ¶
type CustomRole struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec CustomRoleSpec `json:"spec,omitempty"`
Status CustomRoleStatus `json:"status,omitempty"`
}
func (*CustomRole) DeepCopy ¶
func (in *CustomRole) DeepCopy() *CustomRole
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomRole.
func (*CustomRole) DeepCopyInto ¶
func (in *CustomRole) DeepCopyInto(out *CustomRole)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CustomRole) DeepCopyObject ¶
func (in *CustomRole) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CustomRoleList ¶
type CustomRoleList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []CustomRole `json:"items"`
}
+kubebuilder:object:root=true
func (*CustomRoleList) DeepCopy ¶
func (in *CustomRoleList) DeepCopy() *CustomRoleList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomRoleList.
func (*CustomRoleList) DeepCopyInto ¶
func (in *CustomRoleList) DeepCopyInto(out *CustomRoleList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*CustomRoleList) DeepCopyObject ¶
func (in *CustomRoleList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type CustomRoleSpec ¶
type CustomRoleSpec struct {
/*
ConnectionSecretRef SENSITIVE FIELD
Reference to a secret containing the credentials to setup the connection to Atlas.
*/
ConnectionSecretRef *k8s.LocalReference `json:"connectionSecretRef,omitempty"`
// V20250312 The spec of the customrole resource for version v20250312.
V20250312 *CustomRoleSpecV20250312 `json:"v20250312,omitempty"`
}
func (*CustomRoleSpec) DeepCopy ¶
func (in *CustomRoleSpec) DeepCopy() *CustomRoleSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomRoleSpec.
func (*CustomRoleSpec) DeepCopyInto ¶
func (in *CustomRoleSpec) DeepCopyInto(out *CustomRoleSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CustomRoleSpecV20250312 ¶
type CustomRoleSpecV20250312 struct {
// Entry The entry fields of the customrole resource spec. These fields can be set
// for creating and updating customroles.
Entry *CustomRoleSpecV20250312Entry `json:"entry,omitempty"`
/*
GroupId Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
*/
GroupId *string `json:"groupId,omitempty"`
/*
GroupRef A reference to a "Group" resource.
The value of "$.status.v20250312.id" will be used to set "groupId".
Mutually exclusive with the "groupId" property.
*/
GroupRef *k8s.LocalReference `json:"groupRef,omitempty"`
}
func (*CustomRoleSpecV20250312) DeepCopy ¶
func (in *CustomRoleSpecV20250312) DeepCopy() *CustomRoleSpecV20250312
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomRoleSpecV20250312.
func (*CustomRoleSpecV20250312) DeepCopyInto ¶
func (in *CustomRoleSpecV20250312) DeepCopyInto(out *CustomRoleSpecV20250312)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CustomRoleSpecV20250312Entry ¶
type CustomRoleSpecV20250312Entry struct {
// Actions List of the individual privilege actions that the role grants.
Actions *[]Actions `json:"actions,omitempty"`
// InheritedRoles List of the built-in roles that this custom role inherits.
InheritedRoles *[]InheritedRoles `json:"inheritedRoles,omitempty"`
// RoleName Human-readable label that identifies the role for the request. This
// name must be unique for this custom role in this project.
RoleName string `json:"roleName"`
}
func (*CustomRoleSpecV20250312Entry) DeepCopy ¶
func (in *CustomRoleSpecV20250312Entry) DeepCopy() *CustomRoleSpecV20250312Entry
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomRoleSpecV20250312Entry.
func (*CustomRoleSpecV20250312Entry) DeepCopyInto ¶
func (in *CustomRoleSpecV20250312Entry) DeepCopyInto(out *CustomRoleSpecV20250312Entry)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CustomRoleStatus ¶
type CustomRoleStatus struct {
// Conditions Represents the latest available observations of a resource's current
// state.
Conditions *[]metav1.Condition `json:"conditions,omitempty"`
}
func (*CustomRoleStatus) DeepCopy ¶
func (in *CustomRoleStatus) DeepCopy() *CustomRoleStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomRoleStatus.
func (*CustomRoleStatus) DeepCopyInto ¶
func (in *CustomRoleStatus) DeepCopyInto(out *CustomRoleStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DatabaseUser ¶
type DatabaseUser struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec DatabaseUserSpec `json:"spec,omitempty"`
Status DatabaseUserStatus `json:"status,omitempty"`
}
func (*DatabaseUser) DeepCopy ¶
func (in *DatabaseUser) DeepCopy() *DatabaseUser
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DatabaseUser.
func (*DatabaseUser) DeepCopyInto ¶
func (in *DatabaseUser) DeepCopyInto(out *DatabaseUser)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DatabaseUser) DeepCopyObject ¶
func (in *DatabaseUser) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*DatabaseUser) GetConditions ¶
func (du *DatabaseUser) GetConditions() []metav1.Condition
GetConditions for DatabaseUser
type DatabaseUserList ¶
type DatabaseUserList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []DatabaseUser `json:"items"`
}
+kubebuilder:object:root=true
func (*DatabaseUserList) DeepCopy ¶
func (in *DatabaseUserList) DeepCopy() *DatabaseUserList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DatabaseUserList.
func (*DatabaseUserList) DeepCopyInto ¶
func (in *DatabaseUserList) DeepCopyInto(out *DatabaseUserList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DatabaseUserList) DeepCopyObject ¶
func (in *DatabaseUserList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type DatabaseUserSpec ¶
type DatabaseUserSpec struct {
/*
ConnectionSecretRef SENSITIVE FIELD
Reference to a secret containing the credentials to setup the connection to Atlas.
*/
ConnectionSecretRef *k8s.LocalReference `json:"connectionSecretRef,omitempty"`
// V20250312 The spec of the databaseuser resource for version v20250312.
V20250312 *DatabaseUserSpecV20250312 `json:"v20250312,omitempty"`
}
func (*DatabaseUserSpec) DeepCopy ¶
func (in *DatabaseUserSpec) DeepCopy() *DatabaseUserSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DatabaseUserSpec.
func (*DatabaseUserSpec) DeepCopyInto ¶
func (in *DatabaseUserSpec) DeepCopyInto(out *DatabaseUserSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DatabaseUserSpecV20250312 ¶
type DatabaseUserSpecV20250312 struct {
// Entry The entry fields of the databaseuser resource spec. These fields can be
// set for creating and updating databaseusers.
Entry *DatabaseUserSpecV20250312Entry `json:"entry,omitempty"`
/*
GroupId Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
*/
GroupId *string `json:"groupId,omitempty"`
/*
GroupRef A reference to a "Group" resource.
The value of "$.status.v20250312.id" will be used to set "groupId".
Mutually exclusive with the "groupId" property.
*/
GroupRef *k8s.LocalReference `json:"groupRef,omitempty"`
}
func (*DatabaseUserSpecV20250312) DeepCopy ¶
func (in *DatabaseUserSpecV20250312) DeepCopy() *DatabaseUserSpecV20250312
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DatabaseUserSpecV20250312.
func (*DatabaseUserSpecV20250312) DeepCopyInto ¶
func (in *DatabaseUserSpecV20250312) DeepCopyInto(out *DatabaseUserSpecV20250312)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DatabaseUserSpecV20250312Entry ¶
type DatabaseUserSpecV20250312Entry struct {
// AwsIAMType Human-readable label that indicates whether the new database user
// authenticates with the Amazon Web Services (AWS) Identity and Access Management
// (IAM) credentials associated with the user or the user's role.
AwsIAMType *string `json:"awsIAMType,omitempty"`
// DatabaseName The database against which the database user authenticates.
// Database users must provide both a username and authentication database to log
// into MongoDB. If the user authenticates with AWS IAM, x.509, LDAP, or OIDC
// Workload this value should be `$external`. If the user authenticates with
// SCRAM-SHA or OIDC Workforce, this value should be `admin`.
DatabaseName string `json:"databaseName"`
// DeleteAfterDate Date and time when MongoDB Cloud deletes the user. This
// parameter expresses its value in the ISO 8601 timestamp format in UTC and can
// include the time zone designation. You must specify a future date that falls
// within one week of making the Application Programming Interface (API) request.
DeleteAfterDate *string `json:"deleteAfterDate,omitempty"`
// Description Description of this database user.
Description *string `json:"description,omitempty"`
// GroupId Unique 24-hexadecimal digit string that identifies the project.
GroupId string `json:"groupId"`
// Labels List that contains the key-value pairs for tagging and categorizing the
// MongoDB database user. The labels that you define do not appear in the console.
Labels *[]Tags `json:"labels,omitempty"`
// LdapAuthType Part of the Lightweight Directory Access Protocol (LDAP) record
// that the database uses to authenticate this database user on the LDAP host.
LdapAuthType *string `json:"ldapAuthType,omitempty"`
// OidcAuthType Human-readable label that indicates whether the new database user
// or group authenticates with OIDC federated authentication. To create a federated
// authentication user, specify the value of USER in this field. To create a
// federated authentication group, specify the value of IDP_GROUP in this field.
OidcAuthType *string `json:"oidcAuthType,omitempty"`
// Password Alphanumeric string that authenticates this database user against the
// database specified in `databaseName`. To authenticate with SCRAM-SHA, you must
// specify this parameter. This parameter doesn't appear in this response.
Password *string `json:"password,omitempty"`
// Roles List that provides the pairings of one role with one applicable database.
Roles *[]Roles `json:"roles,omitempty"`
// Scopes List that contains clusters, MongoDB Atlas Data Lakes, and MongoDB Atlas
// Streams Instances that this database user can access. If omitted, MongoDB Cloud
// grants the database user access to all the clusters, MongoDB Atlas Data Lakes,
// and MongoDB Atlas Streams Instances in the project.
Scopes *[]Scopes `json:"scopes,omitempty"`
/*
Username Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:
| Authentication Method | Parameter Needed | Parameter Value | username Format |
|---|---|---|---|
| AWS IAM | awsIAMType | ROLE | <abbr title="Amazon Resource Name">ARN</abbr> |
| AWS IAM | awsIAMType | USER | <abbr title="Amazon Resource Name">ARN</abbr> |
| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |
| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |
| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |
| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |
*/
Username string `json:"username"`
/*
X509Type X.509 method that MongoDB Cloud uses to authenticate the database user.
- For application-managed X.509, specify `MANAGED`.
- For self-managed X.509, specify `CUSTOMER`.
Users created with the `CUSTOMER` method require a Common Name (CN) in the **username** parameter. You must create externally authenticated users on the `$external` database.
*/
X509Type *string `json:"x509Type,omitempty"`
}
func (*DatabaseUserSpecV20250312Entry) DeepCopy ¶
func (in *DatabaseUserSpecV20250312Entry) DeepCopy() *DatabaseUserSpecV20250312Entry
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DatabaseUserSpecV20250312Entry.
func (*DatabaseUserSpecV20250312Entry) DeepCopyInto ¶
func (in *DatabaseUserSpecV20250312Entry) DeepCopyInto(out *DatabaseUserSpecV20250312Entry)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DatabaseUserStatus ¶
type DatabaseUserStatus struct {
// Conditions Represents the latest available observations of a resource's current
// state.
Conditions *[]metav1.Condition `json:"conditions,omitempty"`
}
func (*DatabaseUserStatus) DeepCopy ¶
func (in *DatabaseUserStatus) DeepCopy() *DatabaseUserStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DatabaseUserStatus.
func (*DatabaseUserStatus) DeepCopyInto ¶
func (in *DatabaseUserStatus) DeepCopyInto(out *DatabaseUserStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DiskGB ¶
type DiskGB struct {
// Enabled Flag that indicates whether this cluster enables disk auto-scaling. The
// maximum memory allowed for the selected cluster tier and the oplog size can
// limit storage auto-scaling.
Enabled *bool `json:"enabled,omitempty"`
}
func (*DiskGB) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DiskGB.
func (*DiskGB) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ElectableSpecs ¶
type ElectableSpecs struct {
/*
DiskIOPS Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:
- set `"replicationSpecs[n].regionConfigs[m].providerName" : "Azure"`.
- set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M40"` or greater not including `Mxx_NVME` tiers.
The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.
This parameter defaults to the cluster tier's standard IOPS value.
Changing this value impacts cluster cost.
*/
DiskIOPS *int `json:"diskIOPS,omitempty"`
/*
DiskSizeGB Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.
This value must be equal for all shards and node types.
This value is not configurable on M0/M2/M5 clusters.
MongoDB Cloud requires this parameter if you set **replicationSpecs**.
If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value.
Storage charge calculations depend on whether you choose the default value or a custom value.
The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.
*/
DiskSizeGB *float64 `json:"diskSizeGB,omitempty"`
/*
EbsVolumeType Type of storage you want to attach to your AWS-provisioned cluster.
- `STANDARD` volume types can't exceed the default input/output operations per second (IOPS) rate for the selected volume size.
- `PROVISIONED` volume types must fall within the allowable IOPS range for the selected volume size. You must set this value to (`PROVISIONED`) for NVMe clusters.
*/
EbsVolumeType *string `json:"ebsVolumeType,omitempty"`
// EffectiveInstanceSize The true tenant instance size. This is present to support
// backwards compatibility for deprecated provider types and/or instance sizes.
EffectiveInstanceSize *string `json:"effectiveInstanceSize,omitempty"`
// InstanceSize Hardware specification for the instances in this M0/M2/M5 tier
// cluster.
InstanceSize *string `json:"instanceSize,omitempty"`
// NodeCount Number of nodes of the given type for MongoDB Cloud to deploy to the
// region.
NodeCount *int `json:"nodeCount,omitempty"`
}
func (*ElectableSpecs) DeepCopy ¶
func (in *ElectableSpecs) DeepCopy() *ElectableSpecs
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ElectableSpecs.
func (*ElectableSpecs) DeepCopyInto ¶
func (in *ElectableSpecs) DeepCopyInto(out *ElectableSpecs)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Endpoints ¶
type Endpoints struct {
// EndpointId Unique string that the cloud provider uses to identify the private
// endpoint.
EndpointId *string `json:"endpointId,omitempty"`
// ProviderName Cloud provider in which MongoDB Cloud deploys the private endpoint.
ProviderName *string `json:"providerName,omitempty"`
// Region Region where the private endpoint is deployed.
Region *string `json:"region,omitempty"`
}
func (*Endpoints) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Endpoints.
func (*Endpoints) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Entry ¶
type Entry struct {
// Name Human-readable label that identifies the project included in the MongoDB
// Cloud organization.
Name string `json:"name"`
// OrgId Unique 24-hexadecimal digit string that identifies the MongoDB Cloud
// organization to which the project belongs.
OrgId string `json:"orgId"`
/*
RegionUsageRestrictions Applies to Atlas for Government only.
In Commercial Atlas, this field will be rejected in requests and missing in responses.
This field sets restrictions on available regions in the project.
`COMMERCIAL_FEDRAMP_REGIONS_ONLY`: Only allows deployments in FedRAMP Moderate regions.
`GOV_REGIONS_ONLY`: Only allows deployments in GovCloud regions.
*/
RegionUsageRestrictions *string `json:"regionUsageRestrictions,omitempty"`
// Tags List that contains key-value pairs between 1 to 255 characters in length
// for tagging and categorizing the project.
Tags *[]Tags `json:"tags,omitempty"`
// WithDefaultAlertsSettings Flag that indicates whether to create the project with
// default alert settings. This setting cannot be updated after project creation.
WithDefaultAlertsSettings *bool `json:"withDefaultAlertsSettings,omitempty"`
}
func (*Entry) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Entry.
func (*Entry) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FlexCluster ¶
type FlexCluster struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec FlexClusterSpec `json:"spec,omitempty"`
Status FlexClusterStatus `json:"status,omitempty"`
}
func (*FlexCluster) DeepCopy ¶
func (in *FlexCluster) DeepCopy() *FlexCluster
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FlexCluster.
func (*FlexCluster) DeepCopyInto ¶
func (in *FlexCluster) DeepCopyInto(out *FlexCluster)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*FlexCluster) DeepCopyObject ¶
func (in *FlexCluster) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*FlexCluster) GetConditions ¶
func (fc *FlexCluster) GetConditions() []metav1.Condition
GetConditions for FlexCluster
type FlexClusterList ¶
type FlexClusterList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []FlexCluster `json:"items"`
}
+kubebuilder:object:root=true
func (*FlexClusterList) DeepCopy ¶
func (in *FlexClusterList) DeepCopy() *FlexClusterList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FlexClusterList.
func (*FlexClusterList) DeepCopyInto ¶
func (in *FlexClusterList) DeepCopyInto(out *FlexClusterList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*FlexClusterList) DeepCopyObject ¶
func (in *FlexClusterList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type FlexClusterSpec ¶
type FlexClusterSpec struct {
/*
ConnectionSecretRef SENSITIVE FIELD
Reference to a secret containing the credentials to setup the connection to Atlas.
*/
ConnectionSecretRef *k8s.LocalReference `json:"connectionSecretRef,omitempty"`
// V20250312 The spec of the flexcluster resource for version v20250312.
V20250312 *FlexClusterSpecV20250312 `json:"v20250312,omitempty"`
}
func (*FlexClusterSpec) DeepCopy ¶
func (in *FlexClusterSpec) DeepCopy() *FlexClusterSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FlexClusterSpec.
func (*FlexClusterSpec) DeepCopyInto ¶
func (in *FlexClusterSpec) DeepCopyInto(out *FlexClusterSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FlexClusterSpecV20250312 ¶
type FlexClusterSpecV20250312 struct {
// Entry The entry fields of the flexcluster resource spec. These fields can be set
// for creating and updating flexclusters.
Entry *FlexClusterSpecV20250312Entry `json:"entry,omitempty"`
/*
GroupId Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
*/
GroupId *string `json:"groupId,omitempty"`
/*
GroupRef A reference to a "Group" resource.
The value of "$.status.v20250312.id" will be used to set "groupId".
Mutually exclusive with the "groupId" property.
*/
GroupRef *k8s.LocalReference `json:"groupRef,omitempty"`
}
func (*FlexClusterSpecV20250312) DeepCopy ¶
func (in *FlexClusterSpecV20250312) DeepCopy() *FlexClusterSpecV20250312
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FlexClusterSpecV20250312.
func (*FlexClusterSpecV20250312) DeepCopyInto ¶
func (in *FlexClusterSpecV20250312) DeepCopyInto(out *FlexClusterSpecV20250312)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FlexClusterSpecV20250312Entry ¶
type FlexClusterSpecV20250312Entry struct {
// Name Human-readable label that identifies the instance.
Name string `json:"name"`
// ProviderSettings Group of cloud provider settings that configure the provisioned
// MongoDB flex cluster.
ProviderSettings ProviderSettings `json:"providerSettings"`
// Tags List that contains key-value pairs between 1 to 255 characters in length
// for tagging and categorizing the instance.
Tags *[]Tags `json:"tags,omitempty"`
// TerminationProtectionEnabled Flag that indicates whether termination protection
// is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the
// cluster. If set to `false`, MongoDB Cloud will delete the cluster.
TerminationProtectionEnabled *bool `json:"terminationProtectionEnabled,omitempty"`
}
func (*FlexClusterSpecV20250312Entry) DeepCopy ¶
func (in *FlexClusterSpecV20250312Entry) DeepCopy() *FlexClusterSpecV20250312Entry
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FlexClusterSpecV20250312Entry.
func (*FlexClusterSpecV20250312Entry) DeepCopyInto ¶
func (in *FlexClusterSpecV20250312Entry) DeepCopyInto(out *FlexClusterSpecV20250312Entry)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FlexClusterStatus ¶
type FlexClusterStatus struct {
// Conditions Represents the latest available observations of a resource's current
// state.
Conditions *[]metav1.Condition `json:"conditions,omitempty"`
// V20250312 The last observed Atlas state of the flexcluster resource for version
// v20250312.
V20250312 *FlexClusterStatusV20250312 `json:"v20250312,omitempty"`
}
func (*FlexClusterStatus) DeepCopy ¶
func (in *FlexClusterStatus) DeepCopy() *FlexClusterStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FlexClusterStatus.
func (*FlexClusterStatus) DeepCopyInto ¶
func (in *FlexClusterStatus) DeepCopyInto(out *FlexClusterStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FlexClusterStatusV20250312 ¶
type FlexClusterStatusV20250312 struct {
// BackupSettings Flex backup configuration.
BackupSettings *DiskGB `json:"backupSettings,omitempty"`
// ClusterType Flex cluster topology.
ClusterType *string `json:"clusterType,omitempty"`
// ConnectionStrings Collection of Uniform Resource Locators that point to the
// MongoDB database.
ConnectionStrings *V20250312ConnectionStrings `json:"connectionStrings,omitempty"`
// CreateDate Date and time when MongoDB Cloud created this instance. This
// parameter expresses its value in ISO 8601 format in UTC.
CreateDate *string `json:"createDate,omitempty"`
// GroupId Unique 24-hexadecimal character string that identifies the project.
GroupId *string `json:"groupId,omitempty"`
// Id Unique 24-hexadecimal digit string that identifies the instance.
Id *string `json:"id,omitempty"`
// MongoDBVersion Version of MongoDB that the instance runs.
MongoDBVersion *string `json:"mongoDBVersion,omitempty"`
// Name Human-readable label that identifies the instance.
Name *string `json:"name,omitempty"`
// ProviderSettings Group of cloud provider settings that configure the provisioned
// MongoDB flex cluster.
ProviderSettings V20250312ProviderSettings `json:"providerSettings"`
/*
StateName Human-readable label that indicates any current activity being taken on this cluster by the Atlas control plane. With the exception of CREATING and DELETING states, clusters should always be available and have a Primary node even when in states indicating ongoing activity.
- `IDLE`: Atlas is making no changes to this cluster and all changes requested via the UI or API can be assumed to have been applied.
- `CREATING`: A cluster being provisioned for the very first time returns state CREATING until it is ready for connections. Ensure IP Access List and DB Users are configured before attempting to connect.
- `UPDATING`: A change requested via the UI, API, AutoScaling, or other scheduled activity is taking place.
- `DELETING`: The cluster is in the process of deletion and will soon be deleted.
- `REPAIRING`: One or more nodes in the cluster are being returned to service by the Atlas control plane. Other nodes should continue to provide service as normal.
*/
StateName *string `json:"stateName,omitempty"`
// VersionReleaseSystem Method by which the cluster maintains the MongoDB versions.
VersionReleaseSystem *string `json:"versionReleaseSystem,omitempty"`
}
func (*FlexClusterStatusV20250312) DeepCopy ¶
func (in *FlexClusterStatusV20250312) DeepCopy() *FlexClusterStatusV20250312
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FlexClusterStatusV20250312.
func (*FlexClusterStatusV20250312) DeepCopyInto ¶
func (in *FlexClusterStatusV20250312) DeepCopyInto(out *FlexClusterStatusV20250312)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Group ¶
type Group struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec GroupSpec `json:"spec,omitempty"`
Status GroupStatus `json:"status,omitempty"`
}
func (*Group) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Group.
func (*Group) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Group) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Group) GetConditions ¶
GetConditions for Group
type GroupList ¶
type GroupList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Group `json:"items"`
}
+kubebuilder:object:root=true
func (*GroupList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupList.
func (*GroupList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*GroupList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type GroupSpec ¶
type GroupSpec struct {
/*
ConnectionSecretRef SENSITIVE FIELD
Reference to a secret containing the credentials to setup the connection to Atlas.
*/
ConnectionSecretRef *k8s.LocalReference `json:"connectionSecretRef,omitempty"`
// V20250312 The spec of the group resource for version v20250312.
V20250312 *V20250312 `json:"v20250312,omitempty"`
}
func (*GroupSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupSpec.
func (*GroupSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GroupStatus ¶
type GroupStatus struct {
// Conditions Represents the latest available observations of a resource's current
// state.
Conditions *[]metav1.Condition `json:"conditions,omitempty"`
// V20250312 The last observed Atlas state of the group resource for version
// v20250312.
V20250312 *GroupStatusV20250312 `json:"v20250312,omitempty"`
}
func (*GroupStatus) DeepCopy ¶
func (in *GroupStatus) DeepCopy() *GroupStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupStatus.
func (*GroupStatus) DeepCopyInto ¶
func (in *GroupStatus) DeepCopyInto(out *GroupStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type GroupStatusV20250312 ¶
type GroupStatusV20250312 struct {
// ClusterCount Quantity of MongoDB Cloud clusters deployed in this project.
ClusterCount int `json:"clusterCount"`
// Created Date and time when MongoDB Cloud created this project. This parameter
// expresses its value in the ISO 8601 timestamp format in UTC.
Created string `json:"created"`
// Id Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.
Id *string `json:"id,omitempty"`
}
func (*GroupStatusV20250312) DeepCopy ¶
func (in *GroupStatusV20250312) DeepCopy() *GroupStatusV20250312
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GroupStatusV20250312.
func (*GroupStatusV20250312) DeepCopyInto ¶
func (in *GroupStatusV20250312) DeepCopyInto(out *GroupStatusV20250312)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type InheritedRoles ¶
type InheritedRoles struct {
// Db Human-readable label that identifies the database on which someone grants the
// action to one MongoDB user.
Db string `json:"db"`
// Role Human-readable label that identifies the role inherited. Set this value to
// `admin` for every role except `read` or `readWrite`.
Role string `json:"role"`
}
func (*InheritedRoles) DeepCopy ¶
func (in *InheritedRoles) DeepCopy() *InheritedRoles
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InheritedRoles.
func (*InheritedRoles) DeepCopyInto ¶
func (in *InheritedRoles) DeepCopyInto(out *InheritedRoles)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Links ¶
type Links struct {
// Href Uniform Resource Locator (URL) that points another API resource to which
// this response has some relationship. This URL often begins with
// `https://cloud.mongodb.com/api/atlas`.
Href *string `json:"href,omitempty"`
// Rel Uniform Resource Locator (URL) that defines the semantic relationship
// between this resource and another API resource. This URL often begins with
// `https://cloud.mongodb.com/api/atlas`.
Rel *string `json:"rel,omitempty"`
}
func (*Links) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Links.
func (*Links) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MongoDBEmployeeAccessGrant ¶
type MongoDBEmployeeAccessGrant struct {
// ExpirationTime Expiration date for the employee access grant. This parameter
// expresses its value in the ISO 8601 timestamp format in UTC.
ExpirationTime string `json:"expirationTime"`
// GrantType Level of access to grant to MongoDB Employees.
GrantType string `json:"grantType"`
// Links List of one or more Uniform Resource Locators (URLs) that point to API
// sub-resources, related API resources, or both. RFC 5988 outlines these
// relationships.
Links *[]Links `json:"links,omitempty"`
}
func (*MongoDBEmployeeAccessGrant) DeepCopy ¶
func (in *MongoDBEmployeeAccessGrant) DeepCopy() *MongoDBEmployeeAccessGrant
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MongoDBEmployeeAccessGrant.
func (*MongoDBEmployeeAccessGrant) DeepCopyInto ¶
func (in *MongoDBEmployeeAccessGrant) DeepCopyInto(out *MongoDBEmployeeAccessGrant)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PrivateEndpoint ¶
type PrivateEndpoint struct {
// ConnectionString Private endpoint-aware connection string that uses the
// `mongodb://` protocol to connect to MongoDB Cloud through a private endpoint.
ConnectionString *string `json:"connectionString,omitempty"`
// Endpoints List that contains the private endpoints through which you connect to
// MongoDB Cloud when you use
// **connectionStrings.privateEndpoint[n].connectionString** or
// **connectionStrings.privateEndpoint[n].srvConnectionString**.
Endpoints *[]Endpoints `json:"endpoints,omitempty"`
// SrvConnectionString Private endpoint-aware connection string that uses the
// `mongodb+srv://` protocol to connect to MongoDB Cloud through a private
// endpoint. The `mongodb+srv` protocol tells the driver to look up the seed list
// of hosts in the Domain Name System (DNS). This list synchronizes with the nodes
// in a cluster. If the connection string uses this Uniform Resource Identifier
// (URI) format, you don't need to append the seed list or change the Uniform
// Resource Identifier (URI) if the nodes change. Use this Uniform Resource
// Identifier (URI) format if your application supports it. If it doesn't, use
// connectionStrings.privateEndpoint[n].connectionString.
SrvConnectionString *string `json:"srvConnectionString,omitempty"`
// SrvShardOptimizedConnectionString Private endpoint-aware connection string
// optimized for sharded clusters that uses the `mongodb+srv://` protocol to
// connect to MongoDB Cloud through a private endpoint. If the connection string
// uses this Uniform Resource Identifier (URI) format, you don't need to change the
// Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource
// Identifier (URI) format if your application and Atlas cluster supports it. If it
// doesn't, use and consult the documentation for
// connectionStrings.privateEndpoint[n].srvConnectionString.
SrvShardOptimizedConnectionString *string `json:"srvShardOptimizedConnectionString,omitempty"`
// Type MongoDB process type to which your application connects. Use `MONGOD` for
// replica sets and `MONGOS` for sharded clusters.
Type *string `json:"type,omitempty"`
}
func (*PrivateEndpoint) DeepCopy ¶
func (in *PrivateEndpoint) DeepCopy() *PrivateEndpoint
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PrivateEndpoint.
func (*PrivateEndpoint) DeepCopyInto ¶
func (in *PrivateEndpoint) DeepCopyInto(out *PrivateEndpoint)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ProviderSettings ¶
type ProviderSettings struct {
// BackingProviderName Cloud service provider on which MongoDB Cloud provisioned
// the flex cluster.
BackingProviderName string `json:"backingProviderName"`
// RegionName Human-readable label that identifies the geographic location of your
// MongoDB flex cluster. The region you choose can affect network latency for
// clients accessing your databases. For a complete list of region names, see
// [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),
// [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and
// [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).
RegionName string `json:"regionName"`
}
func (*ProviderSettings) DeepCopy ¶
func (in *ProviderSettings) DeepCopy() *ProviderSettings
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderSettings.
func (*ProviderSettings) DeepCopyInto ¶
func (in *ProviderSettings) DeepCopyInto(out *ProviderSettings)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RegionConfigs ¶
type RegionConfigs struct {
// AnalyticsAutoScaling Options that determine how this cluster handles resource
// scaling.
AnalyticsAutoScaling *AnalyticsAutoScaling `json:"analyticsAutoScaling,omitempty"`
// AnalyticsSpecs Hardware specifications for read-only nodes in the region.
// Read-only nodes can never become the primary member, but can enable local reads.
// If you don't specify this parameter, no read-only nodes are deployed to the
// region.
AnalyticsSpecs *AnalyticsSpecs `json:"analyticsSpecs,omitempty"`
// AutoScaling Options that determine how this cluster handles resource scaling.
AutoScaling *AnalyticsAutoScaling `json:"autoScaling,omitempty"`
/*
BackingProviderName Cloud service provider on which MongoDB Cloud provisioned the multi-tenant cluster. The resource returns this parameter when **providerName** is `TENANT` and **electableSpecs.instanceSize** is `M0`, `M2` or `M5`.
Please note that using an instanceSize of M2 or M5 will create a Flex cluster instead. Support for the instanceSize of M2 or M5 will be discontinued in January 2026. We recommend using the createFlexCluster API for such configurations moving forward.
*/
BackingProviderName *string `json:"backingProviderName,omitempty"`
// ElectableSpecs Hardware specifications for all electable nodes deployed in the
// region. Electable nodes can become the primary and can enable local reads. If
// you don't specify this option, MongoDB Cloud deploys no electable nodes to the
// region.
ElectableSpecs *ElectableSpecs `json:"electableSpecs,omitempty"`
/*
Priority Precedence is given to this region when a primary election occurs. If your **regionConfigs** has only **readOnlySpecs**, **analyticsSpecs**, or both, set this value to `0`. If you have multiple **regionConfigs** objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is `7`.
**Example:** If you have three regions, their priorities would be `7`, `6`, and `5` respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be `4` and `3` respectively.
*/
Priority *int `json:"priority,omitempty"`
// ProviderName Cloud service provider on which MongoDB Cloud provisions the hosts.
// Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`.
ProviderName *string `json:"providerName,omitempty"`
// ReadOnlySpecs Hardware specifications for read-only nodes in the region.
// Read-only nodes can never become the primary member, but can enable local reads.
// If you don't specify this parameter, no read-only nodes are deployed to the
// region.
ReadOnlySpecs *AnalyticsSpecs `json:"readOnlySpecs,omitempty"`
// RegionName Physical location of your MongoDB cluster nodes. The region you
// choose can affect network latency for clients accessing your databases. The
// region name is only returned in the response for single-region clusters. When
// MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection
// exists for that provider and region. If not, MongoDB Cloud creates them as part
// of the deployment. It assigns the VPC a Classless Inter-Domain Routing (CIDR)
// block. To limit a new VPC peering connection to one Classless Inter-Domain
// Routing (CIDR) block and region, create the connection first. Deploy the cluster
// after the connection starts. GCP Clusters and Multi-region clusters require one
// VPC peering connection for each region. MongoDB nodes can use only the peering
// connection that resides in the same region as the nodes to communicate with the
// peered VPC.
RegionName *string `json:"regionName,omitempty"`
}
func (*RegionConfigs) DeepCopy ¶
func (in *RegionConfigs) DeepCopy() *RegionConfigs
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RegionConfigs.
func (*RegionConfigs) DeepCopyInto ¶
func (in *RegionConfigs) DeepCopyInto(out *RegionConfigs)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReplicationSpecs ¶
type ReplicationSpecs struct {
/*
RegionConfigs Hardware specifications for nodes set for a given region. Each **regionConfigs** object must be unique by region and cloud provider within the **replicationSpec**. Each **regionConfigs** object describes the region's priority in elections and the number and type of MongoDB nodes that MongoDB Cloud deploys to the region. Each **regionConfigs** object must have either an **analyticsSpecs** object, **electableSpecs** object, or **readOnlySpecs** object. Tenant clusters only require **electableSpecs. Dedicated** clusters can specify any of these specifications, but must have at least one **electableSpecs** object within a **replicationSpec**.
**Example:**
If you set `"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize" : "M30"`, set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : `"M30"` if you have electable nodes and `"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize" : `"M30"` if you have read-only nodes.
*/
RegionConfigs *[]RegionConfigs `json:"regionConfigs,omitempty"`
// ZoneId Unique 24-hexadecimal digit string that identifies the zone in a Global
// Cluster. This value can be used to configure Global Cluster backup policies.
ZoneId *string `json:"zoneId,omitempty"`
// ZoneName Human-readable label that describes the zone this shard belongs to in a
// Global Cluster. Provide this value only if "clusterType" : "GEOSHARDED" but not
// "selfManagedSharding" : true.
ZoneName *string `json:"zoneName,omitempty"`
}
func (*ReplicationSpecs) DeepCopy ¶
func (in *ReplicationSpecs) DeepCopy() *ReplicationSpecs
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReplicationSpecs.
func (*ReplicationSpecs) DeepCopyInto ¶
func (in *ReplicationSpecs) DeepCopyInto(out *ReplicationSpecs)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Resources ¶
type Resources struct {
// Cluster Flag that indicates whether to grant the action on the cluster resource.
// If `true`, MongoDB Cloud ignores the **actions.resources.collection** and
// **actions.resources.db** parameters.
Cluster bool `json:"cluster"`
// Collection Human-readable label that identifies the collection on which you
// grant the action to one MongoDB user. If you don't set this parameter, you grant
// the action to all collections in the database specified in the
// **actions.resources.db** parameter. If you set `"actions.resources.cluster" :
// true`, MongoDB Cloud ignores this parameter.
Collection string `json:"collection"`
// Db Human-readable label that identifies the database on which you grant the
// action to one MongoDB user. If you set `"actions.resources.cluster" : true`,
// MongoDB Cloud ignores this parameter.
Db string `json:"db"`
}
func (*Resources) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Resources.
func (*Resources) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Roles ¶
type Roles struct {
// CollectionName Collection on which this role applies.
CollectionName *string `json:"collectionName,omitempty"`
// DatabaseName Database to which the user is granted access privileges.
DatabaseName string `json:"databaseName"`
// RoleName Human-readable label that identifies a group of privileges assigned to
// a database user. This value can either be a built-in role or a custom role.
RoleName string `json:"roleName"`
}
func (*Roles) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Roles.
func (*Roles) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Scopes ¶
type Scopes struct {
// Name Human-readable label that identifies the cluster or MongoDB Atlas Data Lake
// that this database user can access.
Name string `json:"name"`
// Type Category of resource that this database user can access.
Type string `json:"type"`
}
func (*Scopes) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Scopes.
func (*Scopes) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Tags ¶
type Tags struct {
// Key Constant that defines the set of the tag. For example, `environment` in the
// `environment : production` tag.
Key string `json:"key"`
// Value Variable that belongs to the set of the tag. For example, `production` in
// the `environment : production` tag.
Value string `json:"value"`
}
func (*Tags) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Tags.
func (*Tags) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Team ¶
type Team struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec TeamSpec `json:"spec,omitempty"`
Status TeamStatus `json:"status,omitempty"`
}
func (*Team) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Team.
func (*Team) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Team) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TeamList ¶
type TeamList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Team `json:"items"`
}
+kubebuilder:object:root=true
func (*TeamList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TeamList.
func (*TeamList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TeamList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TeamSpec ¶
type TeamSpec struct {
/*
ConnectionSecretRef SENSITIVE FIELD
Reference to a secret containing the credentials to setup the connection to Atlas.
*/
ConnectionSecretRef *k8s.LocalReference `json:"connectionSecretRef,omitempty"`
// V20250312 The spec of the team resource for version v20250312.
V20250312 *TeamSpecV20250312 `json:"v20250312,omitempty"`
}
func (*TeamSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TeamSpec.
func (*TeamSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TeamSpecV20250312 ¶
type TeamSpecV20250312 struct {
// Entry The entry fields of the team resource spec. These fields can be set for
// creating and updating teams.
Entry *TeamSpecV20250312Entry `json:"entry,omitempty"`
// OrgId Unique 24-hexadecimal digit string that identifies the organization that
// contains your projects. Use the
// [/orgs](#tag/Organizations/operation/listOrganizations) endpoint to retrieve all
// organizations to which the authenticated user has access.
OrgId string `json:"orgId"`
}
func (*TeamSpecV20250312) DeepCopy ¶
func (in *TeamSpecV20250312) DeepCopy() *TeamSpecV20250312
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TeamSpecV20250312.
func (*TeamSpecV20250312) DeepCopyInto ¶
func (in *TeamSpecV20250312) DeepCopyInto(out *TeamSpecV20250312)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TeamSpecV20250312Entry ¶
type TeamSpecV20250312Entry struct {
// Name Human-readable label that identifies the team.
Name string `json:"name"`
// Usernames List that contains the MongoDB Cloud users in this team.
Usernames []string `json:"usernames"`
}
func (*TeamSpecV20250312Entry) DeepCopy ¶
func (in *TeamSpecV20250312Entry) DeepCopy() *TeamSpecV20250312Entry
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TeamSpecV20250312Entry.
func (*TeamSpecV20250312Entry) DeepCopyInto ¶
func (in *TeamSpecV20250312Entry) DeepCopyInto(out *TeamSpecV20250312Entry)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TeamStatus ¶
type TeamStatus struct {
// Conditions Represents the latest available observations of a resource's current
// state.
Conditions *[]metav1.Condition `json:"conditions,omitempty"`
// V20250312 The last observed Atlas state of the team resource for version
// v20250312.
V20250312 *TeamStatusV20250312 `json:"v20250312,omitempty"`
}
func (*TeamStatus) DeepCopy ¶
func (in *TeamStatus) DeepCopy() *TeamStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TeamStatus.
func (*TeamStatus) DeepCopyInto ¶
func (in *TeamStatus) DeepCopyInto(out *TeamStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TeamStatusV20250312 ¶
type TeamStatusV20250312 struct {
// Id Unique 24-hexadecimal digit string that identifies this team.
Id *string `json:"id,omitempty"`
}
func (*TeamStatusV20250312) DeepCopy ¶
func (in *TeamStatusV20250312) DeepCopy() *TeamStatusV20250312
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TeamStatusV20250312.
func (*TeamStatusV20250312) DeepCopyInto ¶
func (in *TeamStatusV20250312) DeepCopyInto(out *TeamStatusV20250312)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type V20250312 ¶
type V20250312 struct {
// Entry The entry fields of the group resource spec. These fields can be set for
// creating and updating groups.
Entry *Entry `json:"entry,omitempty"`
// ProjectOwnerId Unique 24-hexadecimal digit string that identifies the MongoDB
// Cloud user to whom to grant the Project Owner role on the specified project. If
// you set this parameter, it overrides the default value of the oldest
// Organization Owner.
ProjectOwnerId *string `json:"projectOwnerId,omitempty"`
}
func (*V20250312) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new V20250312.
func (*V20250312) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type V20250312ConnectionStrings ¶
type V20250312ConnectionStrings struct {
// Standard Public connection string that you can use to connect to this cluster.
// This connection string uses the mongodb:// protocol.
Standard *string `json:"standard,omitempty"`
// StandardSrv Public connection string that you can use to connect to this flex
// cluster. This connection string uses the `mongodb+srv://` protocol.
StandardSrv *string `json:"standardSrv,omitempty"`
}
func (*V20250312ConnectionStrings) DeepCopy ¶
func (in *V20250312ConnectionStrings) DeepCopy() *V20250312ConnectionStrings
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new V20250312ConnectionStrings.
func (*V20250312ConnectionStrings) DeepCopyInto ¶
func (in *V20250312ConnectionStrings) DeepCopyInto(out *V20250312ConnectionStrings)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type V20250312Entry ¶
type V20250312Entry struct {
// AcceptDataRisksAndForceReplicaSetReconfig If reconfiguration is necessary to
// regain a primary due to a regional outage, submit this field alongside your
// topology reconfiguration to request a new regional outage resistant topology.
// Forced reconfigurations during an outage of the majority of electable nodes
// carry a risk of data loss if replicated writes (even majority committed writes)
// have not been replicated to the new primary node. MongoDB Atlas docs contain
// more information. To proceed with an operation which carries that risk, set
// **acceptDataRisksAndForceReplicaSetReconfig** to the current date. This
// parameter expresses its value in the ISO 8601 timestamp format in UTC.
AcceptDataRisksAndForceReplicaSetReconfig *string `json:"acceptDataRisksAndForceReplicaSetReconfig,omitempty"`
// AdvancedConfiguration Group of settings that configures a subset of the advanced
// configuration details.
AdvancedConfiguration *AdvancedConfiguration `json:"advancedConfiguration,omitempty"`
// BackupEnabled Flag that indicates whether the cluster can perform backups. If
// set to `true`, the cluster can perform backups. You must set this value to
// `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and
// [Shared Cluster
// Backups](https://docs.atlas.mongodb.com/backup/shared-tier/overview/) for tenant
// clusters. If set to `false`, the cluster doesn't use backups.
BackupEnabled *bool `json:"backupEnabled,omitempty"`
// BiConnector Settings needed to configure the MongoDB Connector for Business
// Intelligence for this cluster.
BiConnector *BiConnector `json:"biConnector,omitempty"`
// ClusterType Configuration of nodes that comprise the cluster.
ClusterType *string `json:"clusterType,omitempty"`
/*
ConfigServerManagementMode Config Server Management Mode for creating or updating a sharded cluster.
When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.
When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.
*/
ConfigServerManagementMode *string `json:"configServerManagementMode,omitempty"`
// ConfigServerType Describes a sharded cluster's config server type.
ConfigServerType *string `json:"configServerType,omitempty"`
// DiskWarmingMode Disk warming mode selection.
DiskWarmingMode *string `json:"diskWarmingMode,omitempty"`
// EncryptionAtRestProvider Cloud service provider that manages your customer keys
// to provide an additional layer of encryption at rest for the cluster. To enable
// customer key management for encryption at rest, the cluster
// **replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize** setting must
// be `M10` or higher and `"backupEnabled" : false` or omitted entirely.
EncryptionAtRestProvider *string `json:"encryptionAtRestProvider,omitempty"`
// FeatureCompatibilityVersion Feature compatibility version of the cluster. This
// will always appear regardless of whether FCV is pinned.
FeatureCompatibilityVersion *string `json:"featureCompatibilityVersion,omitempty"`
// FeatureCompatibilityVersionExpirationDate Feature compatibility version
// expiration date. Will only appear if FCV is pinned. This parameter expresses its
// value in the ISO 8601 timestamp format in UTC.
FeatureCompatibilityVersionExpirationDate *string `json:"featureCompatibilityVersionExpirationDate,omitempty"`
/*
GlobalClusterSelfManagedSharding Set this field to configure the Sharding Management Mode when creating a new Global Cluster.
When set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.
When set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.
This setting cannot be changed once the cluster is deployed.
*/
GlobalClusterSelfManagedSharding *bool `json:"globalClusterSelfManagedSharding,omitempty"`
/*
Labels Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.
Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use Resource Tags instead.
*/
Labels *[]Tags `json:"labels,omitempty"`
// MongoDBEmployeeAccessGrant MongoDB employee granted access level and expiration
// for a cluster.
MongoDBEmployeeAccessGrant *MongoDBEmployeeAccessGrant `json:"mongoDBEmployeeAccessGrant,omitempty"`
/*
MongoDBMajorVersion MongoDB major version of the cluster. Set to the binary major version.
On creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLtsVersions).
On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.
*/
MongoDBMajorVersion *string `json:"mongoDBMajorVersion,omitempty"`
// Name Human-readable label that identifies the cluster.
Name *string `json:"name,omitempty"`
// Paused Flag that indicates whether the cluster is paused.
Paused *bool `json:"paused,omitempty"`
// PitEnabled Flag that indicates whether the cluster uses continuous cloud
// backups.
PitEnabled *bool `json:"pitEnabled,omitempty"`
/*
RedactClientLogData Enable or disable log redaction.
This setting configures the “mongod“ or “mongos“ to redact any document field contents from a message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs.
Use “redactClientLogData“ in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements.
*Note*: changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.
*/
RedactClientLogData *bool `json:"redactClientLogData,omitempty"`
/*
ReplicaSetScalingStrategy Set this field to configure the replica set scaling mode for your cluster.
By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.
When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.
When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.
*/
ReplicaSetScalingStrategy *string `json:"replicaSetScalingStrategy,omitempty"`
// ReplicationSpecs List of settings that configure your cluster regions. This
// array has one object per shard representing node configurations in each shard.
// For replica sets there is only one object representing node configurations.
ReplicationSpecs *[]ReplicationSpecs `json:"replicationSpecs,omitempty"`
// RootCertType Root Certificate Authority that MongoDB Atlas cluster uses. MongoDB
// Cloud supports Internet Security Research Group.
RootCertType *string `json:"rootCertType,omitempty"`
// Tags List that contains key-value pairs between 1 to 255 characters in length
// for tagging and categorizing the cluster.
Tags *[]Tags `json:"tags,omitempty"`
// TerminationProtectionEnabled Flag that indicates whether termination protection
// is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the
// cluster. If set to `false`, MongoDB Cloud will delete the cluster.
TerminationProtectionEnabled *bool `json:"terminationProtectionEnabled,omitempty"`
// VersionReleaseSystem Method by which the cluster maintains the MongoDB versions.
// If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.
VersionReleaseSystem *string `json:"versionReleaseSystem,omitempty"`
}
func (*V20250312Entry) DeepCopy ¶
func (in *V20250312Entry) DeepCopy() *V20250312Entry
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new V20250312Entry.
func (*V20250312Entry) DeepCopyInto ¶
func (in *V20250312Entry) DeepCopyInto(out *V20250312Entry)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type V20250312ProviderSettings ¶
type V20250312ProviderSettings struct {
// BackingProviderName Cloud service provider on which MongoDB Cloud provisioned
// the flex cluster.
BackingProviderName *string `json:"backingProviderName,omitempty"`
// DiskSizeGB Storage capacity available to the flex cluster expressed in
// gigabytes.
DiskSizeGB *float64 `json:"diskSizeGB,omitempty"`
// ProviderName Human-readable label that identifies the provider type.
ProviderName *string `json:"providerName,omitempty"`
// RegionName Human-readable label that identifies the geographic location of your
// MongoDB flex cluster. The region you choose can affect network latency for
// clients accessing your databases. For a complete list of region names, see
// [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),
// [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and
// [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).
RegionName *string `json:"regionName,omitempty"`
}
func (*V20250312ProviderSettings) DeepCopy ¶
func (in *V20250312ProviderSettings) DeepCopy() *V20250312ProviderSettings
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new V20250312ProviderSettings.
func (*V20250312ProviderSettings) DeepCopyInto ¶
func (in *V20250312ProviderSettings) DeepCopyInto(out *V20250312ProviderSettings)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type V20250312ReplicationSpecs ¶
type V20250312ReplicationSpecs struct {
// Id Unique 24-hexadecimal digit string that identifies the replication object for
// a shard in a Cluster. If you include existing shard replication configurations
// in the request, you must specify this parameter. If you add a new shard to an
// existing Cluster, you may specify this parameter. The request deletes any
// existing shards in the Cluster that you exclude from the request. This
// corresponds to Shard ID displayed in the UI.
Id *string `json:"id,omitempty"`
// ZoneId Unique 24-hexadecimal digit string that identifies the zone in a Global
// Cluster. This value can be used to configure Global Cluster backup policies.
ZoneId *string `json:"zoneId,omitempty"`
}
func (*V20250312ReplicationSpecs) DeepCopy ¶
func (in *V20250312ReplicationSpecs) DeepCopy() *V20250312ReplicationSpecs
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new V20250312ReplicationSpecs.
func (*V20250312ReplicationSpecs) DeepCopyInto ¶
func (in *V20250312ReplicationSpecs) DeepCopyInto(out *V20250312ReplicationSpecs)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.