v1

package
v1.4.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 4, 2022 License: Apache-2.0 Imports: 20 Imported by: 3

Documentation

Overview

Package v1 contains API Schema definitions for the mongodb.com v1 API group +kubebuilder:object:generate=true +groupName=mongodb.com

Index

Constants

This section is empty.

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "atlas.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 Action added in v1.4.1 

type Action struct {
	// Human-readable label that identifies the privilege action.
	Name string `json:"name"`
	// List of resources on which you grant the action.
	Resources []Resource `json:"resources"`
}

func (*Action) DeepCopy added in v1.4.1 

func (in *Action) DeepCopy() *Action

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Action.

func (*Action) DeepCopyInto added in v1.4.1 

func (in *Action) DeepCopyInto(out *Action)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AdvancedAutoScalingSpec added in v1.2.0 

type AdvancedAutoScalingSpec struct {
	// Flag that indicates whether disk auto-scaling is enabled. The default is true.
	// +optional
	DiskGB *DiskGB `json:"diskGB,omitempty"`

	// Collection of settings that configure how a deployment might scale its deployment tier and whether the deployment can scale down.
	// +optional
	Compute *ComputeSpec `json:"compute,omitempty"`
}

AdvancedAutoScalingSpec configures your deployment to automatically scale its storage

func (*AdvancedAutoScalingSpec) DeepCopy added in v1.2.0 

func (in *AdvancedAutoScalingSpec) DeepCopy() *AdvancedAutoScalingSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AdvancedAutoScalingSpec.

func (*AdvancedAutoScalingSpec) DeepCopyInto added in v1.2.0 

func (in *AdvancedAutoScalingSpec) DeepCopyInto(out *AdvancedAutoScalingSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AdvancedDeploymentSpec added in v1.0.0 

type AdvancedDeploymentSpec struct {
	BackupEnabled            *bool              `json:"backupEnabled,omitempty"`
	BiConnector              *BiConnectorSpec   `json:"biConnector,omitempty"`
	ClusterType              string             `json:"clusterType,omitempty"`
	DiskSizeGB               *int               `json:"diskSizeGB,omitempty"`
	EncryptionAtRestProvider string             `json:"encryptionAtRestProvider,omitempty"`
	Labels                   []common.LabelSpec `json:"labels,omitempty"`
	MongoDBMajorVersion      string             `json:"mongoDBMajorVersion,omitempty"`
	MongoDBVersion           string             `json:"mongoDBVersion,omitempty"`
	// Name of the advanced deployment as it appears in Atlas.
	// After Atlas creates the deployment, you can't change its name.
	// Can only contain ASCII letters, numbers, and hyphens.
	// +kubebuilder:validation:Pattern:=^[a-zA-Z0-9][a-zA-Z0-9-]*$
	Name                 string                     `json:"name,omitempty"`
	Paused               *bool                      `json:"paused,omitempty"`
	PitEnabled           *bool                      `json:"pitEnabled,omitempty"`
	ReplicationSpecs     []*AdvancedReplicationSpec `json:"replicationSpecs,omitempty"`
	RootCertType         string                     `json:"rootCertType,omitempty"`
	VersionReleaseSystem string                     `json:"versionReleaseSystem,omitempty"`
}

func (*AdvancedDeploymentSpec) DeepCopy added in v1.0.0 

func (in *AdvancedDeploymentSpec) DeepCopy() *AdvancedDeploymentSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AdvancedDeploymentSpec.

func (*AdvancedDeploymentSpec) DeepCopyInto added in v1.0.0 

func (in *AdvancedDeploymentSpec) DeepCopyInto(out *AdvancedDeploymentSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AdvancedDeploymentSpec) ToAtlas added in v1.2.0 

func (s *AdvancedDeploymentSpec) ToAtlas() (*mongodbatlas.AdvancedCluster, error)

ToAtlas converts the AdvancedDeploymentSpec to native Atlas client ToAtlas format.

type AdvancedRegionConfig added in v0.8.0 

type AdvancedRegionConfig struct {
	AnalyticsSpecs      *Specs                   `json:"analyticsSpecs,omitempty"`
	ElectableSpecs      *Specs                   `json:"electableSpecs,omitempty"`
	ReadOnlySpecs       *Specs                   `json:"readOnlySpecs,omitempty"`
	AutoScaling         *AdvancedAutoScalingSpec `json:"autoScaling,omitempty"`
	BackingProviderName string                   `json:"backingProviderName,omitempty"`
	Priority            *int                     `json:"priority,omitempty"`
	ProviderName        string                   `json:"providerName,omitempty"`
	RegionName          string                   `json:"regionName,omitempty"`
}

func (*AdvancedRegionConfig) DeepCopy added in v0.8.0 

func (in *AdvancedRegionConfig) DeepCopy() *AdvancedRegionConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AdvancedRegionConfig.

func (*AdvancedRegionConfig) DeepCopyInto added in v0.8.0 

func (in *AdvancedRegionConfig) DeepCopyInto(out *AdvancedRegionConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AdvancedReplicationSpec added in v0.8.0 

type AdvancedReplicationSpec struct {
	NumShards     int                     `json:"numShards,omitempty"`
	ZoneName      string                  `json:"zoneName,omitempty"`
	RegionConfigs []*AdvancedRegionConfig `json:"regionConfigs,omitempty"`
}

func (*AdvancedReplicationSpec) DeepCopy added in v0.8.0 

func (in *AdvancedReplicationSpec) DeepCopy() *AdvancedReplicationSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AdvancedReplicationSpec.

func (*AdvancedReplicationSpec) DeepCopyInto added in v0.8.0 

func (in *AdvancedReplicationSpec) DeepCopyInto(out *AdvancedReplicationSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AlertConfiguration added in v1.4.0 

type AlertConfiguration struct {
	// If omitted, the configuration is disabled.
	Enabled bool `json:"enabled,omitempty"`
	// The type of event that will trigger an alert.
	EventTypeName string `json:"eventTypeName,omitempty"`
	// You can filter using the matchers array only when the EventTypeName specifies an event for a host, replica set, or sharded cluster.
	Matchers []Matcher `json:"matchers,omitempty"`
	// Threshold  causes an alert to be triggered.
	Threshold *Threshold `json:"threshold,omitempty"`
	// Notifications are sending when an alert condition is detected.
	Notifications []Notification `json:"notifications,omitempty"`
	// MetricThreshold  causes an alert to be triggered.
	MetricThreshold *MetricThreshold `json:"metricThreshold,omitempty"`
}

func (*AlertConfiguration) DeepCopy added in v1.4.0 

func (in *AlertConfiguration) DeepCopy() *AlertConfiguration

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AlertConfiguration.

func (*AlertConfiguration) DeepCopyInto added in v1.4.0 

func (in *AlertConfiguration) DeepCopyInto(out *AlertConfiguration)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AlertConfiguration) ToAtlas added in v1.4.0 

func (in *AlertConfiguration) ToAtlas() (*mongodbatlas.AlertConfiguration, error)

type AtlasBackupExportSpec added in v1.0.0 

type AtlasBackupExportSpec struct {
	// Unique identifier of the AWS bucket to export the cloud backup snapshot to.
	ExportBucketID string `json:"exportBucketId"`
	// +kubebuilder:validation:Enum:=MONTHLY
	// +kubebuilder:default:=MONTHLY
	FrequencyType string `json:"frequencyType"`
}

func (*AtlasBackupExportSpec) DeepCopy added in v1.0.0 

func (in *AtlasBackupExportSpec) DeepCopy() *AtlasBackupExportSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasBackupExportSpec.

func (*AtlasBackupExportSpec) DeepCopyInto added in v1.0.0 

func (in *AtlasBackupExportSpec) DeepCopyInto(out *AtlasBackupExportSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AtlasBackupPolicy added in v1.0.0 

type AtlasBackupPolicy struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   AtlasBackupPolicySpec   `json:"spec,omitempty"`
	Status AtlasBackupPolicyStatus `json:"status,omitempty"`
}

AtlasBackupPolicy is the Schema for the atlasbackuppolicies API +kubebuilder:object:root=true +kubebuilder:subresource:status

func (*AtlasBackupPolicy) DeepCopy added in v1.0.0 

func (in *AtlasBackupPolicy) DeepCopy() *AtlasBackupPolicy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasBackupPolicy.

func (*AtlasBackupPolicy) DeepCopyInto added in v1.0.0 

func (in *AtlasBackupPolicy) DeepCopyInto(out *AtlasBackupPolicy)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AtlasBackupPolicy) DeepCopyObject added in v1.0.0 

func (in *AtlasBackupPolicy) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type AtlasBackupPolicyItem added in v1.0.0 

type AtlasBackupPolicyItem struct {
	// Frequency associated with the backup policy item. One of the following values: hourly, daily, weekly or monthly. You cannot specify multiple hourly and daily backup policy items.
	// +kubebuilder:validation:Enum:=hourly;daily;weekly;monthly
	FrequencyType string `json:"frequencyType"`

	// Desired frequency of the new backup policy item specified by FrequencyType. A value of 1 specifies the first instance of the corresponding FrequencyType.
	// The only accepted value you can set for frequency interval with NVMe clusters is 12.
	// +kubebuilder:validation:Enum:=1;2;3;4;5;6;7;8;9;10;11;12;13;14;15;16;17;18;19;20;21;22;23;24;25;26;27;28;40
	FrequencyInterval int `json:"frequencyInterval"`

	// Scope of the backup policy item: days, weeks, or months
	// +kubebuilder:validation:Enum:=days;weeks;months
	RetentionUnit string `json:"retentionUnit"`

	// Value to associate with RetentionUnit
	RetentionValue int `json:"retentionValue"`
}

func (*AtlasBackupPolicyItem) DeepCopy added in v1.0.0 

func (in *AtlasBackupPolicyItem) DeepCopy() *AtlasBackupPolicyItem

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasBackupPolicyItem.

func (*AtlasBackupPolicyItem) DeepCopyInto added in v1.0.0 

func (in *AtlasBackupPolicyItem) DeepCopyInto(out *AtlasBackupPolicyItem)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AtlasBackupPolicyList added in v1.0.0 

type AtlasBackupPolicyList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []AtlasBackupPolicy `json:"items"`
}

AtlasBackupPolicyList contains a list of AtlasBackupPolicy

func (*AtlasBackupPolicyList) DeepCopy added in v1.0.0 

func (in *AtlasBackupPolicyList) DeepCopy() *AtlasBackupPolicyList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasBackupPolicyList.

func (*AtlasBackupPolicyList) DeepCopyInto added in v1.0.0 

func (in *AtlasBackupPolicyList) DeepCopyInto(out *AtlasBackupPolicyList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AtlasBackupPolicyList) DeepCopyObject added in v1.0.0 

func (in *AtlasBackupPolicyList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type AtlasBackupPolicySpec added in v1.0.0 

type AtlasBackupPolicySpec struct {
	// A list of BackupPolicy items
	Items []AtlasBackupPolicyItem `json:"items"`
}

AtlasBackupPolicySpec defines the desired state of AtlasBackupPolicy

func (*AtlasBackupPolicySpec) DeepCopy added in v1.0.0 

func (in *AtlasBackupPolicySpec) DeepCopy() *AtlasBackupPolicySpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasBackupPolicySpec.

func (*AtlasBackupPolicySpec) DeepCopyInto added in v1.0.0 

func (in *AtlasBackupPolicySpec) DeepCopyInto(out *AtlasBackupPolicySpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AtlasBackupPolicyStatus added in v1.0.0 

type AtlasBackupPolicyStatus struct {
}

func (*AtlasBackupPolicyStatus) DeepCopy added in v1.0.0 

func (in *AtlasBackupPolicyStatus) DeepCopy() *AtlasBackupPolicyStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasBackupPolicyStatus.

func (*AtlasBackupPolicyStatus) DeepCopyInto added in v1.0.0 

func (in *AtlasBackupPolicyStatus) DeepCopyInto(out *AtlasBackupPolicyStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AtlasBackupSchedule added in v1.0.0 

type AtlasBackupSchedule struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec AtlasBackupScheduleSpec `json:"spec,omitempty"`

	Status AtlasBackupScheduleStatus `json:"status,omitempty"`
}

AtlasBackupSchedule is the Schema for the atlasbackupschedules API +kubebuilder:object:root=true +kubebuilder:subresource:status

func (*AtlasBackupSchedule) DeepCopy added in v1.0.0 

func (in *AtlasBackupSchedule) DeepCopy() *AtlasBackupSchedule

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasBackupSchedule.

func (*AtlasBackupSchedule) DeepCopyInto added in v1.0.0 

func (in *AtlasBackupSchedule) DeepCopyInto(out *AtlasBackupSchedule)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AtlasBackupSchedule) DeepCopyObject added in v1.0.0 

func (in *AtlasBackupSchedule) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type AtlasBackupScheduleList added in v1.0.0 

type AtlasBackupScheduleList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []AtlasBackupSchedule `json:"items"`
}

AtlasBackupScheduleList contains a list of AtlasBackupSchedule

func (*AtlasBackupScheduleList) DeepCopy added in v1.0.0 

func (in *AtlasBackupScheduleList) DeepCopy() *AtlasBackupScheduleList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasBackupScheduleList.

func (*AtlasBackupScheduleList) DeepCopyInto added in v1.0.0 

func (in *AtlasBackupScheduleList) DeepCopyInto(out *AtlasBackupScheduleList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AtlasBackupScheduleList) DeepCopyObject added in v1.0.0 

func (in *AtlasBackupScheduleList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type AtlasBackupScheduleSpec added in v1.0.0 

type AtlasBackupScheduleSpec struct {
	// Specify true to enable automatic export of cloud backup snapshots to the AWS bucket. You must also define the export policy using export. If omitted, defaults to false.
	// +optional
	// +kubebuilder:default:=true
	AutoExportEnabled bool `json:"autoExportEnabled,omitempty"`

	// Export policy for automatically exporting cloud backup snapshots to AWS bucket.
	// +optional
	Export *AtlasBackupExportSpec `json:"export,omitempty"`

	// A reference (name & namespace) for backup policy in the desired updated backup policy.
	PolicyRef common.ResourceRefNamespaced `json:"policy"`

	// UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items
	// +kubebuilder:validation:Minimum:=0
	// +kubebuilder:validation:Maximum:=23
	// +optional
	ReferenceHourOfDay int64 `json:"referenceHourOfDay,omitempty"`

	// UTC Minutes after ReferenceHourOfDay that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.
	// +kubebuilder:validation:Minimum:=0
	// +kubebuilder:validation:Maximum:=59
	// +optional
	ReferenceMinuteOfHour int64 `json:"referenceMinuteOfHour,omitempty"`

	// Number of days back in time you can restore to with Continuous Cloud Backup accuracy. Must be a positive, non-zero integer. Applies to continuous cloud backups only.
	// +optional
	// +kubebuilder:default:=1
	RestoreWindowDays int64 `json:"restoreWindowDays,omitempty"`

	// Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.
	// +optional
	UpdateSnapshots bool `json:"updateSnapshots,omitempty"`

	// Specify true to use organization and project names instead of organization and project UUIDs in the path for the metadata files that Atlas uploads to your S3 bucket after it finishes exporting the snapshots
	// +optional
	UseOrgAndGroupNamesInExportPrefix bool `json:"useOrgAndGroupNamesInExportPrefix,omitempty"`
}

AtlasBackupScheduleSpec defines the desired state of AtlasBackupSchedule

func (*AtlasBackupScheduleSpec) DeepCopy added in v1.0.0 

func (in *AtlasBackupScheduleSpec) DeepCopy() *AtlasBackupScheduleSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasBackupScheduleSpec.

func (*AtlasBackupScheduleSpec) DeepCopyInto added in v1.0.0 

func (in *AtlasBackupScheduleSpec) DeepCopyInto(out *AtlasBackupScheduleSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AtlasBackupScheduleStatus added in v1.0.0 

type AtlasBackupScheduleStatus struct {
}

func (*AtlasBackupScheduleStatus) DeepCopy added in v1.0.0 

func (in *AtlasBackupScheduleStatus) DeepCopy() *AtlasBackupScheduleStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasBackupScheduleStatus.

func (*AtlasBackupScheduleStatus) DeepCopyInto added in v1.0.0 

func (in *AtlasBackupScheduleStatus) DeepCopyInto(out *AtlasBackupScheduleStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AtlasCustomResource 

type AtlasCustomResource interface {
	metav1.Object
	runtime.Object
	status.Reader
	status.Writer
}

AtlasCustomResource is the interface common for all Atlas entities

type AtlasDatabaseUser 

type AtlasDatabaseUser struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   AtlasDatabaseUserSpec          `json:"spec,omitempty"`
	Status status.AtlasDatabaseUserStatus `json:"status,omitempty"`
}

AtlasDatabaseUser is the Schema for the Atlas Database User API

func DefaultDBUser 

func DefaultDBUser(namespace, username, projectName string) *AtlasDatabaseUser

func NewDBUser 

func NewDBUser(namespace, name, dbUserName, projectName string) *AtlasDatabaseUser

func (AtlasDatabaseUser) AtlasProjectObjectKey 

func (p AtlasDatabaseUser) AtlasProjectObjectKey() client.ObjectKey

func (*AtlasDatabaseUser) ClearScopes added in v0.5.0 

func (p *AtlasDatabaseUser) ClearScopes() *AtlasDatabaseUser

func (*AtlasDatabaseUser) DeepCopy 

func (in *AtlasDatabaseUser) DeepCopy() *AtlasDatabaseUser

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasDatabaseUser.

func (*AtlasDatabaseUser) DeepCopyInto 

func (in *AtlasDatabaseUser) DeepCopyInto(out *AtlasDatabaseUser)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AtlasDatabaseUser) DeepCopyObject 

func (in *AtlasDatabaseUser) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (AtlasDatabaseUser) GetScopes 

func (p AtlasDatabaseUser) GetScopes(scopeType ScopeType) []string

func (*AtlasDatabaseUser) GetStatus 

func (p *AtlasDatabaseUser) GetStatus() status.Status

func (AtlasDatabaseUser) PasswordSecretObjectKey added in v0.5.0 

func (p AtlasDatabaseUser) PasswordSecretObjectKey() *client.ObjectKey

func (*AtlasDatabaseUser) ReadPassword 

func (p *AtlasDatabaseUser) ReadPassword(kubeClient client.Client) (string, error)

func (AtlasDatabaseUser) ToAtlas 

func (p AtlasDatabaseUser) ToAtlas(kubeClient client.Client) (*mongodbatlas.DatabaseUser, error)

ToAtlas converts the AtlasDatabaseUser to native Atlas client format. Reads the password from the Secret

func (*AtlasDatabaseUser) UpdateStatus 

func (p *AtlasDatabaseUser) UpdateStatus(conditions []status.Condition, options ...status.Option)

func (*AtlasDatabaseUser) WithAtlasUserName 

func (p *AtlasDatabaseUser) WithAtlasUserName(name string) *AtlasDatabaseUser

func (*AtlasDatabaseUser) WithDeleteAfterDate added in v0.5.0 

func (p *AtlasDatabaseUser) WithDeleteAfterDate(date string) *AtlasDatabaseUser

func (*AtlasDatabaseUser) WithName 

func (p *AtlasDatabaseUser) WithName(name string) *AtlasDatabaseUser

func (*AtlasDatabaseUser) WithPasswordSecret 

func (p *AtlasDatabaseUser) WithPasswordSecret(name string) *AtlasDatabaseUser

func (*AtlasDatabaseUser) WithRole 

func (p *AtlasDatabaseUser) WithRole(roleName, databaseName, collectionName string) *AtlasDatabaseUser

func (*AtlasDatabaseUser) WithScope 

func (p *AtlasDatabaseUser) WithScope(scopeType ScopeType, name string) *AtlasDatabaseUser

type AtlasDatabaseUserList 

type AtlasDatabaseUserList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []AtlasDatabaseUser `json:"items"`
}

AtlasDatabaseUserList contains a list of AtlasDatabaseUser

func (*AtlasDatabaseUserList) DeepCopy 

func (in *AtlasDatabaseUserList) DeepCopy() *AtlasDatabaseUserList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasDatabaseUserList.

func (*AtlasDatabaseUserList) DeepCopyInto 

func (in *AtlasDatabaseUserList) DeepCopyInto(out *AtlasDatabaseUserList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AtlasDatabaseUserList) DeepCopyObject 

func (in *AtlasDatabaseUserList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type AtlasDatabaseUserSpec 

type AtlasDatabaseUserSpec struct {
	// Project is a reference to AtlasProject resource the user belongs to
	Project common.ResourceRefNamespaced `json:"projectRef"`

	// DatabaseName is a Database against which Atlas authenticates the user. Default value is 'admin'.
	// +kubebuilder:default=admin
	DatabaseName string `json:"databaseName,omitempty"`

	// DeleteAfterDate is a timestamp in ISO 8601 date and time format in UTC after which Atlas deletes the user.
	// The specified date must be in the future and within one week.
	DeleteAfterDate string `json:"deleteAfterDate,omitempty"`

	// Labels is an array containing key-value pairs that tag and categorize the database user.
	// Each key and value has a maximum length of 255 characters.
	Labels []common.LabelSpec `json:"labels,omitempty"`

	// Roles is an array of this user's roles and the databases / collections on which the roles apply. A role allows
	// the user to perform particular actions on the specified database.
	// +kubebuilder:validation:MinItems=1
	Roles []RoleSpec `json:"roles"`

	// Scopes is an array of clusters and Atlas Data Lakes that this user has access to.
	Scopes []ScopeSpec `json:"scopes,omitempty"`

	// PasswordSecret is a reference to the Secret keeping the user password.
	PasswordSecret *common.ResourceRef `json:"passwordSecretRef,omitempty"`

	// Username is a username for authenticating to MongoDB.
	Username string `json:"username"`

	// X509Type is X.509 method by which the database authenticates the provided username
	X509Type string `json:"x509Type,omitempty"`
}

AtlasDatabaseUserSpec defines the desired state of Database User in Atlas

func (*AtlasDatabaseUserSpec) DeepCopy 

func (in *AtlasDatabaseUserSpec) DeepCopy() *AtlasDatabaseUserSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasDatabaseUserSpec.

func (*AtlasDatabaseUserSpec) DeepCopyInto 

func (in *AtlasDatabaseUserSpec) DeepCopyInto(out *AtlasDatabaseUserSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AtlasDeployment added in v1.0.0 

type AtlasDeployment struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   AtlasDeploymentSpec          `json:"spec,omitempty"`
	Status status.AtlasDeploymentStatus `json:"status,omitempty"`
}

AtlasDeployment is the Schema for the atlasdeployments API

func DefaultAWSDeployment added in v1.1.0 

func DefaultAWSDeployment(namespace, projectName string) *AtlasDeployment

func DefaultAwsAdvancedDeployment added in v1.0.0 

func DefaultAwsAdvancedDeployment(namespace, projectName string) *AtlasDeployment

func DefaultAzureDeployment added in v1.1.0 

func DefaultAzureDeployment(namespace, projectName string) *AtlasDeployment

func DefaultGCPDeployment added in v1.1.0 

func DefaultGCPDeployment(namespace, projectName string) *AtlasDeployment

func NewAwsAdvancedDeployment added in v1.0.0 

func NewAwsAdvancedDeployment(namespace, name, nameInAtlas string) *AtlasDeployment

func NewDefaultAWSServerlessInstance added in v1.0.0 

func NewDefaultAWSServerlessInstance(namespace, projectName string) *AtlasDeployment

func NewDeployment added in v1.1.0 

func NewDeployment(namespace, name, nameInAtlas string) *AtlasDeployment

func (*AtlasDeployment) AtlasName added in v1.4.0 

func (c *AtlasDeployment) AtlasName() string

func (AtlasDeployment) AtlasProjectObjectKey added in v1.0.0 

func (c AtlasDeployment) AtlasProjectObjectKey() client.ObjectKey

func (*AtlasDeployment) DeepCopy added in v1.0.0 

func (in *AtlasDeployment) DeepCopy() *AtlasDeployment

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasDeployment.

func (*AtlasDeployment) DeepCopyInto added in v1.0.0 

func (in *AtlasDeployment) DeepCopyInto(out *AtlasDeployment)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AtlasDeployment) DeepCopyObject added in v1.0.0 

func (in *AtlasDeployment) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*AtlasDeployment) GetDeploymentName added in v1.1.0 

func (c *AtlasDeployment) GetDeploymentName() string

func (*AtlasDeployment) GetStatus added in v1.0.0 

func (c *AtlasDeployment) GetStatus() status.Status

func (*AtlasDeployment) IsAdvancedDeployment added in v1.0.0 

func (c *AtlasDeployment) IsAdvancedDeployment() bool

IsAdvancedDeployment returns true if the AtlasDeployment is configured to be an advanced deployment.

func (*AtlasDeployment) IsServerless added in v1.0.0 

func (c *AtlasDeployment) IsServerless() bool

IsServerless returns true if the AtlasDeployment is configured to be a serverless instance

func (*AtlasDeployment) Lightweight added in v1.0.0 

func (c *AtlasDeployment) Lightweight() *AtlasDeployment

Lightweight makes the deployment work with small shared instance M2. This is useful for non-deployment tests (e.g. database users) and saves some money for the company.

func (*AtlasDeployment) UpdateStatus added in v1.0.0 

func (c *AtlasDeployment) UpdateStatus(conditions []status.Condition, options ...status.Option)

func (*AtlasDeployment) WithAtlasName added in v1.0.0 

func (c *AtlasDeployment) WithAtlasName(name string) *AtlasDeployment

func (*AtlasDeployment) WithAutoscalingDisabled added in v1.2.0 

func (c *AtlasDeployment) WithAutoscalingDisabled() *AtlasDeployment

func (*AtlasDeployment) WithBackingProvider added in v1.0.0 

func (c *AtlasDeployment) WithBackingProvider(name string) *AtlasDeployment

func (*AtlasDeployment) WithBackupScheduleRef added in v1.0.0 

func (c *AtlasDeployment) WithBackupScheduleRef(ref common.ResourceRefNamespaced) *AtlasDeployment

func (*AtlasDeployment) WithDiskSizeGB added in v1.2.0 

func (c *AtlasDeployment) WithDiskSizeGB(size int) *AtlasDeployment

func (*AtlasDeployment) WithInstanceSize added in v1.0.0 

func (c *AtlasDeployment) WithInstanceSize(name string) *AtlasDeployment

func (*AtlasDeployment) WithName added in v1.0.0 

func (c *AtlasDeployment) WithName(name string) *AtlasDeployment

func (*AtlasDeployment) WithProjectName added in v1.0.0 

func (c *AtlasDeployment) WithProjectName(projectName string) *AtlasDeployment

func (*AtlasDeployment) WithProviderName added in v1.0.0 

func (c *AtlasDeployment) WithProviderName(name provider.ProviderName) *AtlasDeployment

func (*AtlasDeployment) WithRegionName added in v1.0.0 

func (c *AtlasDeployment) WithRegionName(name string) *AtlasDeployment

type AtlasDeploymentList added in v1.0.0 

type AtlasDeploymentList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []AtlasDeployment `json:"items"`
}

AtlasDeploymentList contains a list of AtlasDeployment

func (*AtlasDeploymentList) DeepCopy added in v1.0.0 

func (in *AtlasDeploymentList) DeepCopy() *AtlasDeploymentList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasDeploymentList.

func (*AtlasDeploymentList) DeepCopyInto added in v1.0.0 

func (in *AtlasDeploymentList) DeepCopyInto(out *AtlasDeploymentList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AtlasDeploymentList) DeepCopyObject added in v1.0.0 

func (in *AtlasDeploymentList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type AtlasDeploymentSpec added in v1.0.0 

type AtlasDeploymentSpec struct {
	// Project is a reference to AtlasProject resource the deployment belongs to
	Project common.ResourceRefNamespaced `json:"projectRef"`

	// Configuration for the normal (v1) deployment API https://www.mongodb.com/docs/atlas/reference/api/clusters/
	// +optional
	DeploymentSpec *DeploymentSpec `json:"deploymentSpec,omitempty"`

	// Configuration for the advanced (v1.5) deployment API https://www.mongodb.com/docs/atlas/reference/api/clusters-advanced/
	// +optional
	AdvancedDeploymentSpec *AdvancedDeploymentSpec `json:"advancedDeploymentSpec,omitempty"`

	// Backup schedule for the AtlasDeployment
	// +optional
	BackupScheduleRef common.ResourceRefNamespaced `json:"backupRef"`

	// Configuration for the serverless deployment API. https://www.mongodb.com/docs/atlas/reference/api/serverless-instances/
	// +optional
	ServerlessSpec *ServerlessSpec `json:"serverlessSpec,omitempty"`

	// ProcessArgs allows to modify Advanced Configuration Options
	// +optional
	ProcessArgs *ProcessArgs `json:"processArgs,omitempty"`
}

AtlasDeploymentSpec defines the desired state of AtlasDeployment Only one of DeploymentSpec, AdvancedDeploymentSpec and ServerlessSpec should be defined

func (*AtlasDeploymentSpec) DeepCopy added in v1.0.0 

func (in *AtlasDeploymentSpec) DeepCopy() *AtlasDeploymentSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasDeploymentSpec.

func (*AtlasDeploymentSpec) DeepCopyInto added in v1.0.0 

func (in *AtlasDeploymentSpec) DeepCopyInto(out *AtlasDeploymentSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AtlasDeploymentSpec) Deployment added in v1.1.0 

func (spec *AtlasDeploymentSpec) Deployment() (*mongodbatlas.Cluster, error)

Deployment converts the Spec to native Atlas client format.

type AtlasProject 

type AtlasProject struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   AtlasProjectSpec          `json:"spec,omitempty"`
	Status status.AtlasProjectStatus `json:"status,omitempty"`
}

AtlasProject is the Schema for the atlasprojects API

func DefaultProject 

func DefaultProject(namespace, connectionSecretName string) *AtlasProject

func NewProject 

func NewProject(namespace, name, nameInAtlas string) *AtlasProject

func (*AtlasProject) ConnectionSecretObjectKey 

func (p *AtlasProject) ConnectionSecretObjectKey() *client.ObjectKey

func (*AtlasProject) DeepCopy 

func (in *AtlasProject) DeepCopy() *AtlasProject

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasProject.

func (*AtlasProject) DeepCopyInto 

func (in *AtlasProject) DeepCopyInto(out *AtlasProject)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AtlasProject) DeepCopyObject 

func (in *AtlasProject) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*AtlasProject) GetStatus 

func (p *AtlasProject) GetStatus() status.Status

func (AtlasProject) ID 

func (p AtlasProject) ID() string

ID is just a shortcut for ID from the status

func (*AtlasProject) UpdateStatus 

func (p *AtlasProject) UpdateStatus(conditions []status.Condition, options ...status.Option)

func (*AtlasProject) WithAtlasName 

func (p *AtlasProject) WithAtlasName(name string) *AtlasProject

func (*AtlasProject) WithConnectionSecret 

func (p *AtlasProject) WithConnectionSecret(name string) *AtlasProject

func (*AtlasProject) WithIPAccessList 

func (p *AtlasProject) WithIPAccessList(ipAccess project.IPAccessList) *AtlasProject

func (*AtlasProject) WithMaintenanceWindow added in v1.1.0 

func (p *AtlasProject) WithMaintenanceWindow(window project.MaintenanceWindow) *AtlasProject

func (*AtlasProject) WithName 

func (p *AtlasProject) WithName(name string) *AtlasProject

func (*AtlasProject) X509SecretObjectKey added in v0.8.0 

func (p *AtlasProject) X509SecretObjectKey() *client.ObjectKey

type AtlasProjectList 

type AtlasProjectList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []AtlasProject `json:"items"`
}

AtlasProjectList contains a list of AtlasProject

func (*AtlasProjectList) DeepCopy 

func (in *AtlasProjectList) DeepCopy() *AtlasProjectList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasProjectList.

func (*AtlasProjectList) DeepCopyInto 

func (in *AtlasProjectList) DeepCopyInto(out *AtlasProjectList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*AtlasProjectList) DeepCopyObject 

func (in *AtlasProjectList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type AtlasProjectSpec 

type AtlasProjectSpec struct {

	// Name is the name of the Project that is created in Atlas by the Operator if it doesn't exist yet.
	Name string `json:"name"`

	// ConnectionSecret is the name of the Kubernetes Secret which contains the information about the way to connect to
	// Atlas (organization ID, API keys). The default Operator connection configuration will be used if not provided.
	// +optional
	ConnectionSecret *common.ResourceRef `json:"connectionSecretRef,omitempty"`

	// ProjectIPAccessList allows to enable the IP Access List for the Project. See more information at
	// https://docs.atlas.mongodb.com/reference/api/ip-access-list/add-entries-to-access-list/
	// +optional
	ProjectIPAccessList []project.IPAccessList `json:"projectIpAccessList,omitempty"`

	// MaintenanceWindow allows to specify a preferred time in the week to run maintenance operations. See more
	// information at https://www.mongodb.com/docs/atlas/reference/api/maintenance-windows/
	// +optional
	MaintenanceWindow project.MaintenanceWindow `json:"maintenanceWindow,omitempty"`

	// PrivateEndpoints is a list of Private Endpoints configured for the current Project.
	PrivateEndpoints []PrivateEndpoint `json:"privateEndpoints,omitempty"`
	// CloudProviderAccessRoles is a list of Cloud Provider Access Roles configured for the current Project.
	CloudProviderAccessRoles []CloudProviderAccessRole `json:"cloudProviderAccessRoles,omitempty"`

	// AlertConfiguration is a list of Alert Configurations configured for the current Project.
	AlertConfigurations []AlertConfiguration `json:"alertConfigurations,omitempty"`

	// AlertConfigurationSyncEnabled is a flag that enables/disables Alert Configurations sync for the current Project.
	// If true - project alert configurations will be synced according to AlertConfigurations.
	// If not - alert configurations will not be modified by the operator. They can be managed through API, cli, UI.
	//kubebuilder:default:=false
	// +optional
	AlertConfigurationSyncEnabled bool `json:"alertConfigurationSyncEnabled,omitempty"`

	// NetworkPeers is a list of Network Peers configured for the current Project.
	NetworkPeers []NetworkPeer `json:"networkPeers,omitempty"`

	// Flag that indicates whether to create the new project with the default alert settings enabled. This parameter defaults to true
	// +kubebuilder:default:=true
	// +optional
	WithDefaultAlertsSettings bool `json:"withDefaultAlertsSettings,omitempty"`

	// X509CertRef is the name of the Kubernetes Secret which contains PEM-encoded CA certificate
	X509CertRef *common.ResourceRefNamespaced `json:"x509CertRef,omitempty"`

	// Integrations is a list of MongoDB Atlas integrations for the project
	// +optional
	Integrations []project.Integration `json:"integrations,omitempty"`

	// EncryptionAtRest allows to set encryption for AWS, Azure and GCP providers
	// +optional
	EncryptionAtRest *EncryptionAtRest `json:"encryptionAtRest,omitempty"`

	// Auditing represents MongoDB Maintenance Windows
	// +optional
	Auditing *Auditing `json:"auditing,omitempty"`

	// Settings allow to set Project Settings for the project
	// +optional
	Settings *ProjectSettings `json:"settings,omitempty"`

	// The customRoles lets you create, and change custom roles in your cluster. Use custom roles to specify custom sets of actions that the Atlas built-in roles can't describe.
	// +optional
	CustomRoles []CustomRole `json:"customRoles,omitempty"`
}

AtlasProjectSpec defines the desired state of Project in Atlas

func (*AtlasProjectSpec) DeepCopy 

func (in *AtlasProjectSpec) DeepCopy() *AtlasProjectSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AtlasProjectSpec.

func (*AtlasProjectSpec) DeepCopyInto 

func (in *AtlasProjectSpec) DeepCopyInto(out *AtlasProjectSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Auditing added in v1.4.0 

type Auditing struct {
	// Indicates whether the auditing system captures successful authentication attempts for audit filters using the "atype" : "authCheck" auditing event. For more information, see auditAuthorizationSuccess
	// +optional
	AuditAuthorizationSuccess *bool `json:"auditAuthorizationSuccess,omitempty"`
	// JSON-formatted audit filter used by the project
	// +optional
	AuditFilter string `json:"auditFilter,omitempty"`
	// Denotes whether or not the project associated with the {GROUP-ID} has database auditing enabled.
	// +optional
	Enabled *bool `json:"enabled,omitempty"`
}

Auditing represents MongoDB Maintenance Windows

func (*Auditing) DeepCopy added in v1.4.0 

func (in *Auditing) DeepCopy() *Auditing

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Auditing.

func (*Auditing) DeepCopyInto added in v1.4.0 

func (in *Auditing) DeepCopyInto(out *Auditing)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (Auditing) ToAtlas added in v1.4.0 

func (a Auditing) ToAtlas() *mongodbatlas.Auditing

type AutoScalingSpec 

type AutoScalingSpec struct {
	// Flag that indicates whether autopilot mode for Performance Advisor is enabled.
	// The default is false.
	AutoIndexingEnabled *bool `json:"autoIndexingEnabled,omitempty"`
	// Flag that indicates whether disk auto-scaling is enabled. The default is true.
	// +optional
	DiskGBEnabled *bool `json:"diskGBEnabled,omitempty"`

	// Collection of settings that configure how a deployment might scale its deployment tier and whether the deployment can scale down.
	// +optional
	Compute *ComputeSpec `json:"compute,omitempty"`
}

AutoScalingSpec configures your deployment to automatically scale its storage

func (*AutoScalingSpec) DeepCopy 

func (in *AutoScalingSpec) DeepCopy() *AutoScalingSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AutoScalingSpec.

func (*AutoScalingSpec) DeepCopyInto 

func (in *AutoScalingSpec) DeepCopyInto(out *AutoScalingSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AwsKms added in v1.3.0 

type AwsKms struct {
	Enabled             *bool  `json:"enabled,omitempty"`             // Specifies whether Encryption at Rest is enabled for an Atlas project, To disable Encryption at Rest, pass only this parameter with a value of false, When you disable Encryption at Rest, Atlas also removes the configuration details.
	AccessKeyID         string `json:"accessKeyID,omitempty"`         // The IAM access key ID with permissions to access the customer master key specified by customerMasterKeyID.
	SecretAccessKey     string `json:"secretAccessKey,omitempty"`     // The IAM secret access key with permissions to access the customer master key specified by customerMasterKeyID.
	CustomerMasterKeyID string `json:"customerMasterKeyID,omitempty"` // The AWS customer master key used to encrypt and decrypt the MongoDB master keys.
	Region              string `json:"region,omitempty"`              // The AWS region in which the AWS customer master key exists: CA_CENTRAL_1, US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, SA_EAST_1
	RoleID              string `json:"roleId,omitempty"`              // ID of an AWS IAM role authorized to manage an AWS customer master key.
	Valid               *bool  `json:"valid,omitempty"`               // Specifies whether the encryption key set for the provider is valid and may be used to encrypt and decrypt data.
}

AwsKms specifies AWS KMS configuration details and whether Encryption at Rest is enabled for an Atlas project.

func (*AwsKms) DeepCopy added in v1.3.0 

func (in *AwsKms) DeepCopy() *AwsKms

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AwsKms.

func (*AwsKms) DeepCopyInto added in v1.3.0 

func (in *AwsKms) DeepCopyInto(out *AwsKms)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AzureKeyVault added in v1.3.0 

type AzureKeyVault struct {
	Enabled           *bool  `json:"enabled,omitempty"`           // Specifies whether Encryption at Rest is enabled for an Atlas project. To disable Encryption at Rest, pass only this parameter with a value of false. When you disable Encryption at Rest, Atlas also removes the configuration details.
	ClientID          string `json:"clientID,omitempty"`          // The Client ID, also known as the application ID, for an Azure application associated with the Azure AD tenant.
	AzureEnvironment  string `json:"azureEnvironment,omitempty"`  // The Azure environment where the Azure account credentials reside. Valid values are the following: AZURE, AZURE_CHINA, AZURE_GERMANY
	SubscriptionID    string `json:"subscriptionID,omitempty"`    // The unique identifier associated with an Azure subscription.
	ResourceGroupName string `json:"resourceGroupName,omitempty"` // The name of the Azure Resource group that contains an Azure Key Vault.
	KeyVaultName      string `json:"keyVaultName,omitempty"`      // The name of an Azure Key Vault containing your key.
	KeyIdentifier     string `json:"keyIdentifier,omitempty"`     // The unique identifier of a key in an Azure Key Vault.
	Secret            string `json:"secret,omitempty"`            // The secret associated with the Azure Key Vault specified by azureKeyVault.tenantID.
	TenantID          string `json:"tenantID,omitempty"`          // The unique identifier for an Azure AD tenant within an Azure subscription.
}

AzureKeyVault specifies Azure Key Vault configuration details and whether Encryption at Rest is enabled for an Atlas project.

func (*AzureKeyVault) DeepCopy added in v1.3.0 

func (in *AzureKeyVault) DeepCopy() *AzureKeyVault

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureKeyVault.

func (*AzureKeyVault) DeepCopyInto added in v1.3.0 

func (in *AzureKeyVault) DeepCopyInto(out *AzureKeyVault)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BiConnector added in v0.8.0 

type BiConnector struct {
	Enabled        *bool  `json:"enabled,omitempty"`
	ReadPreference string `json:"readPreference,omitempty"`
}

BiConnector specifies BI Connector for Atlas configuration on this deployment.

func (*BiConnector) DeepCopy added in v0.8.0 

func (in *BiConnector) DeepCopy() *BiConnector

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BiConnector.

func (*BiConnector) DeepCopyInto added in v0.8.0 

func (in *BiConnector) DeepCopyInto(out *BiConnector)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BiConnectorSpec 

type BiConnectorSpec struct {
	// Flag that indicates whether or not BI Connector for Atlas is enabled on the deployment.
	// +optional
	Enabled *bool `json:"enabled,omitempty"`

	// Source from which the BI Connector for Atlas reads data. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options.
	// +optional
	ReadPreference string `json:"readPreference,omitempty"`
}

BiConnectorSpec specifies BI Connector for Atlas configuration on this deployment

func (*BiConnectorSpec) DeepCopy 

func (in *BiConnectorSpec) DeepCopy() *BiConnectorSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BiConnectorSpec.

func (*BiConnectorSpec) DeepCopyInto 

func (in *BiConnectorSpec) DeepCopyInto(out *BiConnectorSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CloudProviderAccessRole added in v1.3.0 

type CloudProviderAccessRole struct {
	// ProviderName is the name of the cloud provider. Currently only AWS is supported.
	ProviderName string `json:"providerName"`
	// IamAssumedRoleArn is the ARN of the IAM role that is assumed by the Atlas cluster.
	// +optional
	IamAssumedRoleArn string `json:"iamAssumedRoleArn"`
}

func (*CloudProviderAccessRole) DeepCopy added in v1.3.0 

func (in *CloudProviderAccessRole) DeepCopy() *CloudProviderAccessRole

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CloudProviderAccessRole.

func (*CloudProviderAccessRole) DeepCopyInto added in v1.3.0 

func (in *CloudProviderAccessRole) DeepCopyInto(out *CloudProviderAccessRole)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ComputeSpec 

type ComputeSpec struct {
	// Flag that indicates whether deployment tier auto-scaling is enabled. The default is false.
	// +optional
	Enabled *bool `json:"enabled,omitempty"`

	// Flag that indicates whether the deployment tier may scale down. Atlas requires this parameter if "autoScaling.compute.enabled" : true.
	// +optional
	ScaleDownEnabled *bool `json:"scaleDownEnabled,omitempty"`

	// Minimum instance size to which your deployment can automatically scale (such as M10). Atlas requires this parameter if "autoScaling.compute.scaleDownEnabled" : true.
	// +optional
	MinInstanceSize string `json:"minInstanceSize,omitempty"`

	// Maximum instance size to which your deployment can automatically scale (such as M40). Atlas requires this parameter if "autoScaling.compute.enabled" : true.
	// +optional
	MaxInstanceSize string `json:"maxInstanceSize,omitempty"`
}

ComputeSpec Specifies whether the deployment automatically scales its deployment tier and whether the deployment can scale down.

func (*ComputeSpec) DeepCopy 

func (in *ComputeSpec) DeepCopy() *ComputeSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ComputeSpec.

func (*ComputeSpec) DeepCopyInto 

func (in *ComputeSpec) DeepCopyInto(out *ComputeSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConnectionStrings added in v0.8.0 

type ConnectionStrings struct {
	Standard          string                `json:"standard,omitempty"`
	StandardSrv       string                `json:"standardSrv,omitempty"`
	PrivateEndpoint   []PrivateEndpointSpec `json:"privateEndpoint,omitempty"`
	AwsPrivateLink    map[string]string     `json:"awsPrivateLink,omitempty"`
	AwsPrivateLinkSrv map[string]string     `json:"awsPrivateLinkSrv,omitempty"`
	Private           string                `json:"private,omitempty"`
	PrivateSrv        string                `json:"privateSrv,omitempty"`
}

ConnectionStrings configuration for applications use to connect to this deployment.

func (*ConnectionStrings) DeepCopy added in v0.8.0 

func (in *ConnectionStrings) DeepCopy() *ConnectionStrings

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionStrings.

func (*ConnectionStrings) DeepCopyInto added in v0.8.0 

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 added in v1.4.1 

type CustomRole struct {
	// Human-readable label that identifies the role. This name must be unique for this custom role in this project.
	Name string `json:"name"`
	// List of the built-in roles that this custom role inherits.
	// +optional
	InheritedRoles []Role `json:"inheritedRoles,omitempty"`
	// List of the individual privilege actions that the role grants.
	// +optional
	Actions []Action `json:"actions,omitempty"`
}

func (*CustomRole) DeepCopy added in v1.4.1 

func (in *CustomRole) DeepCopy() *CustomRole

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomRole.

func (*CustomRole) DeepCopyInto added in v1.4.1 

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) ToAtlas added in v1.4.1 

func (in *CustomRole) ToAtlas() *mongodbatlas.CustomDBRole

type DeploymentSpec added in v1.0.0 

type DeploymentSpec struct {
	// Collection of settings that configures auto-scaling information for the deployment.
	// If you specify the autoScaling object, you must also specify the providerSettings.autoScaling object.
	// +optional
	AutoScaling *AutoScalingSpec `json:"autoScaling,omitempty"`

	// Configuration of BI Connector for Atlas on this deployment.
	// The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger deployments.
	// +optional
	BIConnector *BiConnectorSpec `json:"biConnector,omitempty"`

	// Type of the deployment that you want to create.
	// The parameter is required if replicationSpecs are set or if Global Deployments are deployed.
	// +kubebuilder:validation:Enum=REPLICASET;SHARDED;GEOSHARDED
	// +optional
	ClusterType DeploymentType `json:"clusterType,omitempty"`

	// Capacity, in gigabytes, of the host's root volume.
	// Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB).
	// This value must be a positive integer.
	// The parameter is required if replicationSpecs are configured.
	// +kubebuilder:validation:Minimum=0
	// +kubebuilder:validation:Maximum=4096
	// +optional
	DiskSizeGB *int `json:"diskSizeGB,omitempty"` // TODO: may cause issues due to mongodb/go-client-mongodb-atlas#140

	// Cloud service provider that offers Encryption at Rest.
	// +kubebuilder:validation:Enum=AWS;GCP;AZURE;NONE
	// +optional
	EncryptionAtRestProvider string `json:"encryptionAtRestProvider,omitempty"`

	// Collection of key-value pairs that tag and categorize the deployment.
	// Each key and value has a maximum length of 255 characters.
	// +optional
	Labels []common.LabelSpec `json:"labels,omitempty"`

	// Version of the deployment to deploy.
	MongoDBMajorVersion string `json:"mongoDBMajorVersion,omitempty"`

	// Name of the deployment as it appears in Atlas.
	// After Atlas creates the deployment, you can't change its name.
	// Can only contain ASCII letters, numbers, and hyphens.
	// +kubebuilder:validation:Pattern:=^[a-zA-Z0-9][a-zA-Z0-9-]*$
	Name string `json:"name"`

	// Positive integer that specifies the number of shards to deploy for a sharded deployment.
	// The parameter is required if replicationSpecs are configured
	// +kubebuilder:validation:Minimum=1
	// +kubebuilder:validation:Maximum=50
	// +optional
	NumShards *int `json:"numShards,omitempty"`

	// Flag that indicates whether the deployment should be paused.
	Paused *bool `json:"paused,omitempty"`

	// Flag that indicates the deployment uses continuous cloud backups.
	// +optional
	PitEnabled *bool `json:"pitEnabled,omitempty"`

	// Applicable only for M10+ deployments.
	// Flag that indicates if the deployment uses Cloud Backups for backups.
	// +optional
	ProviderBackupEnabled *bool `json:"providerBackupEnabled,omitempty"`

	// Configuration for the provisioned hosts on which MongoDB runs. The available options are specific to the cloud service provider.
	ProviderSettings *ProviderSettingsSpec `json:"providerSettings"`

	// Configuration for deployment regions.
	// +optional
	ReplicationSpecs []ReplicationSpec `json:"replicationSpecs,omitempty"`
}

func (*DeploymentSpec) DeepCopy added in v1.0.0 

func (in *DeploymentSpec) DeepCopy() *DeploymentSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DeploymentSpec.

func (*DeploymentSpec) DeepCopyInto added in v1.0.0 

func (in *DeploymentSpec) DeepCopyInto(out *DeploymentSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type DeploymentType added in v1.1.0 

type DeploymentType string
const (
	TypeReplicaSet DeploymentType = "REPLICASET"
	TypeSharded    DeploymentType = "SHARDED"
	TypeGeoSharded DeploymentType = "GEOSHARDED"
)

type DiskGB added in v1.2.0 

type DiskGB struct {
	Enabled *bool `json:"enabled,omitempty"`
}

DiskGB specifies whether disk auto-scaling is enabled. The default is true.

func (*DiskGB) DeepCopy added in v1.2.0 

func (in *DiskGB) DeepCopy() *DiskGB

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DiskGB.

func (*DiskGB) DeepCopyInto added in v1.2.0 

func (in *DiskGB) DeepCopyInto(out *DiskGB)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type EncryptionAtRest added in v1.3.0 

type EncryptionAtRest struct {
	AwsKms         AwsKms         `json:"awsKms,omitempty"`         // AwsKms specifies AWS KMS configuration details and whether Encryption at Rest is enabled for an Atlas project.
	AzureKeyVault  AzureKeyVault  `json:"azureKeyVault,omitempty"`  // AzureKeyVault specifies Azure Key Vault configuration details and whether Encryption at Rest is enabled for an Atlas project.
	GoogleCloudKms GoogleCloudKms `json:"googleCloudKms,omitempty"` // Specifies GCP KMS configuration details and whether Encryption at Rest is enabled for an Atlas project.
}

EncryptionAtRest allows to specify the Encryption at Rest for AWS, Azure and GCP providers

func (*EncryptionAtRest) DeepCopy added in v1.3.0 

func (in *EncryptionAtRest) DeepCopy() *EncryptionAtRest

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EncryptionAtRest.

func (*EncryptionAtRest) DeepCopyInto added in v1.3.0 

func (in *EncryptionAtRest) DeepCopyInto(out *EncryptionAtRest)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (EncryptionAtRest) ToAtlas added in v1.3.0 

func (e EncryptionAtRest) ToAtlas(projectID string) (*mongodbatlas.EncryptionAtRest, error)

type EndpointSpec added in v0.8.0 

type EndpointSpec struct {
	EndpointID   string `json:"endpointId,omitempty"`
	ProviderName string `json:"providerName,omitempty"`
	Region       string `json:"region,omitempty"`
}

EndpointSpec through which you connect to Atlas.

func (*EndpointSpec) DeepCopy added in v0.8.0 

func (in *EndpointSpec) DeepCopy() *EndpointSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EndpointSpec.

func (*EndpointSpec) DeepCopyInto added in v0.8.0 

func (in *EndpointSpec) DeepCopyInto(out *EndpointSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GCPEndpoint added in v1.0.0 

type GCPEndpoint struct {
	// Forwarding rule that corresponds to the endpoint you created in Google Cloud.
	EndpointName string `json:"endpointName,omitempty"`
	// Private IP address of the endpoint you created in Google Cloud.
	IPAddress string `json:"ipAddress,omitempty"`
}

func (*GCPEndpoint) DeepCopy added in v1.0.0 

func (in *GCPEndpoint) DeepCopy() *GCPEndpoint

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GCPEndpoint.

func (*GCPEndpoint) DeepCopyInto added in v1.0.0 

func (in *GCPEndpoint) DeepCopyInto(out *GCPEndpoint)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GCPEndpoints added in v1.0.0 

type GCPEndpoints []GCPEndpoint

func (GCPEndpoints) ConvertToAtlas added in v1.0.0 

func (endpoints GCPEndpoints) ConvertToAtlas() ([]*mongodbatlas.GCPEndpoint, error)

func (GCPEndpoints) DeepCopy added in v1.0.0 

func (in GCPEndpoints) DeepCopy() GCPEndpoints

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GCPEndpoints.

func (GCPEndpoints) DeepCopyInto added in v1.0.0 

func (in GCPEndpoints) DeepCopyInto(out *GCPEndpoints)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GoogleCloudKms added in v1.3.0 

type GoogleCloudKms struct {
	Enabled              *bool  `json:"enabled,omitempty"`              // Specifies whether Encryption at Rest is enabled for an Atlas project. To disable Encryption at Rest, pass only this parameter with a value of false. When you disable Encryption at Rest, Atlas also removes the configuration details.
	ServiceAccountKey    string `json:"serviceAccountKey,omitempty"`    // String-formatted JSON object containing GCP KMS credentials from your GCP account.
	KeyVersionResourceID string `json:"keyVersionResourceID,omitempty"` // 	The Key Version Resource ID from your GCP account.
}

GoogleCloudKms specifies GCP KMS configuration details and whether Encryption at Rest is enabled for an Atlas project.

func (*GoogleCloudKms) DeepCopy added in v1.3.0 

func (in *GoogleCloudKms) DeepCopy() *GoogleCloudKms

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GoogleCloudKms.

func (*GoogleCloudKms) DeepCopyInto added in v1.3.0 

func (in *GoogleCloudKms) DeepCopyInto(out *GoogleCloudKms)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Matcher added in v1.4.0 

type Matcher struct {
	// Name of the field in the target object to match on.
	FieldName string `json:"fieldName,omitempty"`
	// The operator to test the field’s value.
	Operator string `json:"operator,omitempty"`
	// Value to test with the specified operator.
	Value string `json:"value,omitempty"`
}

func (*Matcher) DeepCopy added in v1.4.0 

func (in *Matcher) DeepCopy() *Matcher

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Matcher.

func (*Matcher) DeepCopyInto added in v1.4.0 

func (in *Matcher) DeepCopyInto(out *Matcher)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Matcher) IsEqual added in v1.4.0 

func (in *Matcher) IsEqual(matcher mongodbatlas.Matcher) bool

type MetricThreshold added in v1.4.0 

type MetricThreshold struct {
	// Name of the metric to check.
	MetricName string `json:"metricName,omitempty"`
	// Operator to apply when checking the current metric value against the threshold value.
	Operator string `json:"operator,omitempty"`
	// Threshold value outside which an alert will be triggered.
	Threshold string `json:"threshold"`
	// The units for the threshold value.
	Units string `json:"units,omitempty"`
	// This must be set to AVERAGE. Atlas computes the current metric value as an average.
	Mode string `json:"mode,omitempty"`
}

MetricThreshold causes an alert to be triggered. Required if "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD".

func (*MetricThreshold) DeepCopy added in v1.4.0 

func (in *MetricThreshold) DeepCopy() *MetricThreshold

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricThreshold.

func (*MetricThreshold) DeepCopyInto added in v1.4.0 

func (in *MetricThreshold) DeepCopyInto(out *MetricThreshold)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*MetricThreshold) IsEqual added in v1.4.0 

func (in *MetricThreshold) IsEqual(threshold *mongodbatlas.MetricThreshold) bool

func (*MetricThreshold) ToAtlas added in v1.4.0 

func (in *MetricThreshold) ToAtlas() (*mongodbatlas.MetricThreshold, error)

type NetworkPeer added in v1.3.0 

type NetworkPeer struct {
	//AccepterRegionName is the provider region name of user's vpc.
	// +optional
	AccepterRegionName string `json:"accepterRegionName"`
	// ContainerRegion is the provider region name of Atlas network peer container. If not set, AccepterRegionName is used.
	// +optional
	ContainerRegion string `json:"containerRegion"`
	// AccountID of the user's vpc.
	// +optional
	AWSAccountID string `json:"awsAccountId,omitempty"`
	// ID of the network peer container. If not set, operator will create a new container with ContainerRegion and AtlasCIDRBlock input.
	// +optional
	ContainerID string `json:"containerId"`
	//ProviderName is the name of the provider. If not set, it will be set to "AWS".
	// +optional
	ProviderName provider.ProviderName `json:"providerName,omitempty"`
	//User VPC CIDR.
	// +optional
	RouteTableCIDRBlock string `json:"routeTableCidrBlock,omitempty"`
	//AWS VPC ID.
	// +optional
	VpcID string `json:"vpcId,omitempty"`
	//Atlas CIDR. It needs to be set if ContainerID is not set.
	// +optional
	AtlasCIDRBlock string `json:"atlasCidrBlock"`
	//AzureDirectoryID is the unique identifier for an Azure AD directory.
	// +optional
	AzureDirectoryID string `json:"azureDirectoryId,omitempty"`
	// AzureSubscriptionID is the unique identifier of the Azure subscription in which the VNet resides.
	// +optional
	AzureSubscriptionID string `json:"azureSubscriptionId,omitempty"`
	//ResourceGroupName is the name of your Azure resource group.
	// +optional
	ResourceGroupName string `json:"resourceGroupName,omitempty"`
	// VNetName is name of your Azure VNet. Its applicable only for Azure.
	// +optional
	VNetName string `json:"vnetName,omitempty"`
	// +optional
	// User GCP Project ID. Its applicable only for GCP.
	GCPProjectID string `json:"gcpProjectId,omitempty"`
	// GCP Network Peer Name. Its applicable only for GCP.
	// +optional
	NetworkName string `json:"networkName,omitempty"`
}

func (*NetworkPeer) DeepCopy added in v1.3.0 

func (in *NetworkPeer) DeepCopy() *NetworkPeer

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new NetworkPeer.

func (*NetworkPeer) DeepCopyInto added in v1.3.0 

func (in *NetworkPeer) DeepCopyInto(out *NetworkPeer)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*NetworkPeer) GetContainerRegion added in v1.3.0 

func (in *NetworkPeer) GetContainerRegion() string

func (*NetworkPeer) ToAtlas added in v1.3.0 

func (in *NetworkPeer) ToAtlas() (*mongodbatlas.Peer, error)

type Notification added in v1.4.0 

type Notification struct {
	// Slack API token or Bot token. Populated for the SLACK notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.
	APIToken string `json:"apiToken,omitempty"`
	// Slack channel name. Populated for the SLACK notifications type.
	ChannelName string `json:"channelName,omitempty"`
	// Datadog API Key. Found in the Datadog dashboard. Populated for the DATADOG notifications type.
	DatadogAPIKey string `json:"datadogApiKey,omitempty"`
	// Region that indicates which API URL to use
	DatadogRegion string `json:"datadogRegion,omitempty"`
	// Number of minutes to wait after an alert condition is detected before sending out the first notification.
	DelayMin *int `json:"delayMin,omitempty"`
	// Email address to which alert notifications are sent. Populated for the EMAIL notifications type.
	EmailAddress string `json:"emailAddress,omitempty"`
	// Flag indicating if email notifications should be sent. Populated for ORG, GROUP, and USER notifications types.
	EmailEnabled *bool `json:"emailEnabled,omitempty"`
	// The Flowdock personal API token. Populated for the FLOWDOCK notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.
	FlowdockAPIToken string `json:"flowdockApiToken,omitempty"`
	// Flowdock flow namse in lower-case letters.
	FlowName string `json:"flowName,omitempty"`
	// Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved.
	IntervalMin int `json:"intervalMin,omitempty"`
	// Mobile number to which alert notifications are sent. Populated for the SMS notifications type.
	MobileNumber string `json:"mobileNumber,omitempty"`
	// Opsgenie API Key. Populated for the OPS_GENIE notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.
	OpsGenieAPIKey string `json:"opsGenieApiKey,omitempty"`
	// Region that indicates which API URL to use.
	OpsGenieRegion string `json:"opsGenieRegion,omitempty"`
	// Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the URL string. Populated for the FLOWDOCK notifications type.
	OrgName string `json:"orgName,omitempty"`
	// PagerDuty service key. Populated for the PAGER_DUTY notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
	ServiceKey string `json:"serviceKey,omitempty"`
	// Flag indicating if text message notifications should be sent. Populated for ORG, GROUP, and USER notifications types.
	SMSEnabled *bool `json:"smsEnabled,omitempty"`
	// Unique identifier of a team.
	TeamID string `json:"teamId,omitempty"`
	// Label for the team that receives this notification.
	TeamName string `json:"teamName,omitempty"`
	// Type of alert notification.
	TypeName string `json:"typeName,omitempty"`
	// Name of the Atlas user to which to send notifications. Only a user in the project that owns the alert configuration is allowed here. Populated for the USER notifications type.
	Username string `json:"username,omitempty"`
	// VictorOps API key. Populated for the VICTOR_OPS notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
	VictorOpsAPIKey string `json:"victorOpsApiKey,omitempty"`
	// VictorOps routing key. Populated for the VICTOR_OPS notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
	VictorOpsRoutingKey string `json:"victorOpsRoutingKey,omitempty"`
	// The following roles grant privileges within a project.
	Roles []string `json:"roles,omitempty"`
}

func (*Notification) DeepCopy added in v1.4.0 

func (in *Notification) DeepCopy() *Notification

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Notification.

func (*Notification) DeepCopyInto added in v1.4.0 

func (in *Notification) DeepCopyInto(out *Notification)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Notification) IsEqual added in v1.4.0 

func (in *Notification) IsEqual(notification mongodbatlas.Notification) bool

type PrivateEndpoint added in v1.0.0 

type PrivateEndpoint struct {
	// Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS or AZURE.
	// +kubebuilder:validation:Enum=AWS;GCP;AZURE;TENANT
	Provider provider.ProviderName `json:"provider"`
	// Cloud provider region for which you want to create the private endpoint service.
	Region string `json:"region"`
	// Unique identifier of the private endpoint you created in your AWS VPC or Azure Vnet.
	// +optional
	ID string `json:"id,omitempty"`
	// Private IP address of the private endpoint network interface you created in your Azure VNet.
	// +optional
	IP string `json:"ip,omitempty"`
	// Unique identifier of the Google Cloud project in which you created your endpoints.
	// +optional
	GCPProjectID string `json:"gcpProjectId,omitempty"`
	// Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in Google Cloud.
	// +optional
	EndpointGroupName string `json:"endpointGroupName,omitempty"`
	// Collection of individual private endpoints that comprise your endpoint group.
	// +optional
	Endpoints GCPEndpoints `json:"endpoints,omitempty"`
}

func (*PrivateEndpoint) DeepCopy added in v1.0.0 

func (in *PrivateEndpoint) DeepCopy() *PrivateEndpoint

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PrivateEndpoint.

func (*PrivateEndpoint) DeepCopyInto added in v1.0.0 

func (in *PrivateEndpoint) DeepCopyInto(out *PrivateEndpoint)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (PrivateEndpoint) Identifier added in v1.0.0 

func (i PrivateEndpoint) Identifier() interface{}

Identifier is required to satisfy "Identifiable" iterface

func (PrivateEndpoint) ToAtlas added in v1.0.0 

func (i PrivateEndpoint) ToAtlas() (*mongodbatlas.PrivateEndpoint, error)

ToAtlas converts the PrivateEndpoint to native Atlas client format.

type PrivateEndpointSpec added in v0.8.0 

type PrivateEndpointSpec struct {
	ConnectionString    string         `json:"connectionString,omitempty"`
	Endpoints           []EndpointSpec `json:"endpoints,omitempty"`
	SRVConnectionString string         `json:"srvConnectionString,omitempty"`
	Type                string         `json:"type,omitempty"`
}

PrivateEndpointSpec connection strings. Each object describes the connection strings you can use to connect to this deployment through a private endpoint. Atlas returns this parameter only if you deployed a private endpoint to all regions to which you deployed this deployment's nodes.

func (*PrivateEndpointSpec) DeepCopy added in v0.8.0 

func (in *PrivateEndpointSpec) DeepCopy() *PrivateEndpointSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PrivateEndpointSpec.

func (*PrivateEndpointSpec) DeepCopyInto added in v0.8.0 

func (in *PrivateEndpointSpec) DeepCopyInto(out *PrivateEndpointSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ProcessArgs added in v1.0.0 

type ProcessArgs struct {
	DefaultReadConcern               string `json:"defaultReadConcern,omitempty"`
	DefaultWriteConcern              string `json:"defaultWriteConcern,omitempty"`
	MinimumEnabledTLSProtocol        string `json:"minimumEnabledTlsProtocol,omitempty"`
	FailIndexKeyTooLong              *bool  `json:"failIndexKeyTooLong,omitempty"`
	JavascriptEnabled                *bool  `json:"javascriptEnabled,omitempty"`
	NoTableScan                      *bool  `json:"noTableScan,omitempty"`
	OplogSizeMB                      *int64 `json:"oplogSizeMB,omitempty"`
	SampleSizeBIConnector            *int64 `json:"sampleSizeBIConnector,omitempty"`
	SampleRefreshIntervalBIConnector *int64 `json:"sampleRefreshIntervalBIConnector,omitempty"`
	OplogMinRetentionHours           string `json:"oplogMinRetentionHours,omitempty"`
}

func (*ProcessArgs) DeepCopy added in v1.0.0 

func (in *ProcessArgs) DeepCopy() *ProcessArgs

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProcessArgs.

func (*ProcessArgs) DeepCopyInto added in v1.0.0 

func (in *ProcessArgs) DeepCopyInto(out *ProcessArgs)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (ProcessArgs) IsEqual added in v1.0.0 

func (specArgs ProcessArgs) IsEqual(newArgs interface{}) bool

func (ProcessArgs) ToAtlas added in v1.4.0 

func (specArgs ProcessArgs) ToAtlas() (*mongodbatlas.ProcessArgs, error)

type ProjectSettings added in v1.4.0 

type ProjectSettings struct {
	IsCollectDatabaseSpecificsStatisticsEnabled *bool `json:"isCollectDatabaseSpecificsStatisticsEnabled,omitempty"`
	IsDataExplorerEnabled                       *bool `json:"isDataExplorerEnabled,omitempty"`
	IsPerformanceAdvisorEnabled                 *bool `json:"isPerformanceAdvisorEnabled,omitempty"`
	IsRealtimePerformancePanelEnabled           *bool `json:"isRealtimePerformancePanelEnabled,omitempty"`
	IsSchemaAdvisorEnabled                      *bool `json:"isSchemaAdvisorEnabled,omitempty"`
}

func (*ProjectSettings) DeepCopy added in v1.4.0 

func (in *ProjectSettings) DeepCopy() *ProjectSettings

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProjectSettings.

func (*ProjectSettings) DeepCopyInto added in v1.4.0 

func (in *ProjectSettings) DeepCopyInto(out *ProjectSettings)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (ProjectSettings) ToAtlas added in v1.4.0 

func (s ProjectSettings) ToAtlas() (*mongodbatlas.ProjectSettings, error)

type ProviderSettingsSpec 

type ProviderSettingsSpec struct {
	// Cloud service provider on which the host for a multi-tenant deployment is provisioned.
	// This setting only works when "providerSetting.providerName" : "TENANT" and "providerSetting.instanceSizeName" : M2 or M5.
	// +kubebuilder:validation:Enum=AWS;GCP;AZURE
	// +optional
	BackingProviderName string `json:"backingProviderName,omitempty"`

	// Disk IOPS setting for AWS storage.
	// Set only if you selected AWS as your cloud service provider.
	// +optional
	DiskIOPS *int64 `json:"diskIOPS,omitempty"`

	// Type of disk if you selected Azure as your cloud service provider.
	// +optional
	DiskTypeName string `json:"diskTypeName,omitempty"`

	// Flag that indicates whether the Amazon EBS encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the deployment.
	// +optional
	EncryptEBSVolume *bool `json:"encryptEBSVolume,omitempty"`

	// Atlas provides different deployment tiers, each with a default storage capacity and RAM size. The deployment you select is used for all the data-bearing hosts in your deployment tier.
	// +optional
	InstanceSizeName string `json:"instanceSizeName,omitempty"`

	// Cloud service provider on which Atlas provisions the hosts.
	// +kubebuilder:validation:Enum=AWS;GCP;AZURE;TENANT;SERVERLESS
	ProviderName provider.ProviderName `json:"providerName"`

	// Physical location of your MongoDB deployment.
	// The region you choose can affect network latency for clients accessing your databases.
	// +optional
	RegionName string `json:"regionName,omitempty"`

	// Disk IOPS setting for AWS storage.
	// Set only if you selected AWS as your cloud service provider.
	// +kubebuilder:validation:Enum=STANDARD;PROVISIONED
	VolumeType string `json:"volumeType,omitempty"`

	// Range of instance sizes to which your deployment can scale.
	AutoScaling *AutoScalingSpec `json:"autoScaling,omitempty"`
}

ProviderSettingsSpec configuration for the provisioned servers on which MongoDB runs. The available options are specific to the cloud service provider.

func (*ProviderSettingsSpec) DeepCopy 

func (in *ProviderSettingsSpec) DeepCopy() *ProviderSettingsSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderSettingsSpec.

func (*ProviderSettingsSpec) DeepCopyInto 

func (in *ProviderSettingsSpec) DeepCopyInto(out *ProviderSettingsSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RegionsConfig 

type RegionsConfig struct {
	// The number of analytics nodes for Atlas to deploy to the region.
	// Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas.
	// Analytics nodes are read-only, and can never become the primary.
	// If you do not specify this option, no analytics nodes are deployed to the region.
	// +optional
	AnalyticsNodes *int64 `json:"analyticsNodes,omitempty"`

	// Number of electable nodes for Atlas to deploy to the region.
	// Electable nodes can become the primary and can facilitate local reads.
	// +optional
	ElectableNodes *int64 `json:"electableNodes,omitempty"`

	// Election priority of the region.
	// For regions with only replicationSpecs[n].regionsConfig.<region>.readOnlyNodes, set this value to 0.
	// +optional
	Priority *int64 `json:"priority,omitempty"`

	// Number of read-only nodes for Atlas to deploy to the region.
	// Read-only nodes can never become the primary, but can facilitate local-reads.
	// +optional
	ReadOnlyNodes *int64 `json:"readOnlyNodes,omitempty"`
}

RegionsConfig describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region.

func (*RegionsConfig) DeepCopy 

func (in *RegionsConfig) DeepCopy() *RegionsConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RegionsConfig.

func (*RegionsConfig) DeepCopyInto 

func (in *RegionsConfig) DeepCopyInto(out *RegionsConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ReplicationSpec 

type ReplicationSpec struct {
	// Number of shards to deploy in each specified zone.
	// The default value is 1.
	NumShards *int64 `json:"numShards,omitempty"`

	// Name for the zone in a Global Deployment.
	// Don't provide this value if deploymentType is not GEOSHARDED.
	// +optional
	ZoneName string `json:"zoneName,omitempty"`

	// Configuration for a region.
	// Each regionsConfig object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region.
	// +optional
	RegionsConfig map[string]RegionsConfig `json:"regionsConfig,omitempty"`
}

ReplicationSpec represents a configuration for deployment regions

func (*ReplicationSpec) DeepCopy 

func (in *ReplicationSpec) DeepCopy() *ReplicationSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReplicationSpec.

func (*ReplicationSpec) DeepCopyInto 

func (in *ReplicationSpec) DeepCopyInto(out *ReplicationSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Resource added in v1.4.1 

type Resource struct {
	// Flag that indicates whether to grant the action on the cluster resource. If true, MongoDB Cloud ignores Database and Collection parameters.
	Cluster *bool `json:"cluster,omitempty"`
	// Human-readable label that identifies the database on which you grant the action to one MongoDB user.
	Database *string `json:"database,omitempty"`
	// Human-readable label that identifies the collection on which you grant the action to one MongoDB user.
	Collection *string `json:"collection,omitempty"`
}

func (*Resource) DeepCopy added in v1.4.1 

func (in *Resource) DeepCopy() *Resource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Resource.

func (*Resource) DeepCopyInto added in v1.4.1 

func (in *Resource) DeepCopyInto(out *Resource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Role added in v1.4.1 

type Role struct {
	// Human-readable label that identifies the role inherited.
	Name string `json:"name"`
	// Human-readable label that identifies the database on which someone grants the action to one MongoDB user.
	Database string `json:"database"`
}

func (*Role) DeepCopy added in v1.4.1 

func (in *Role) DeepCopy() *Role

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Role.

func (*Role) DeepCopyInto added in v1.4.1 

func (in *Role) DeepCopyInto(out *Role)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RoleSpec 

type RoleSpec struct {
	// RoleName is a name of the role. This value can either be a built-in role or a custom role.
	RoleName string `json:"roleName"`

	// DatabaseName is a database on which the user has the specified role. A role on the admin database can include
	// privileges that apply to the other databases.
	DatabaseName string `json:"databaseName"`

	// CollectionName is a collection for which the role applies.
	CollectionName string `json:"collectionName,omitempty"`
}

RoleSpec allows the user to perform particular actions on the specified database. A role on the admin database can include privileges that apply to the other databases as well.

func (*RoleSpec) DeepCopy 

func (in *RoleSpec) DeepCopy() *RoleSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RoleSpec.

func (*RoleSpec) DeepCopyInto 

func (in *RoleSpec) DeepCopyInto(out *RoleSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ScopeSpec 

type ScopeSpec struct {
	// Name is a name of the cluster or Atlas Data Lake that the user has access to.
	Name string `json:"name"`
	// Type is a type of resource that the user has access to.
	// +kubebuilder:validation:Enum=CLUSTER;DATA_LAKE
	Type ScopeType `json:"type"`
}

ScopeSpec if present a database user only have access to the indicated resource (Cluster or Atlas Data Lake) if none is given then it has access to all. It's highly recommended to restrict the access of the database users only to a limited set of resources.

func (*ScopeSpec) DeepCopy 

func (in *ScopeSpec) DeepCopy() *ScopeSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScopeSpec.

func (*ScopeSpec) DeepCopyInto 

func (in *ScopeSpec) DeepCopyInto(out *ScopeSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ScopeType 

type ScopeType string
const (
	DeploymentScopeType ScopeType = "CLUSTER" // todo: potentially rename to "DEPLOYMENT"
	DataLakeScopeType   ScopeType = "DATA_LAKE"
)

type ServerlessSpec added in v1.0.0 

type ServerlessSpec struct {
	// Name of the serverless deployment as it appears in Atlas.
	// After Atlas creates the deployment, you can't change its name.
	// Can only contain ASCII letters, numbers, and hyphens.
	// +kubebuilder:validation:Pattern:=^[a-zA-Z0-9][a-zA-Z0-9-]*$
	Name string `json:"name"`
	// Configuration for the provisioned hosts on which MongoDB runs. The available options are specific to the cloud service provider.
	ProviderSettings *ProviderSettingsSpec `json:"providerSettings"`
}

ServerlessSpec defines the desired state of Atlas Serverless Instance

func (*ServerlessSpec) DeepCopy added in v1.0.0 

func (in *ServerlessSpec) DeepCopy() *ServerlessSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServerlessSpec.

func (*ServerlessSpec) DeepCopyInto added in v1.0.0 

func (in *ServerlessSpec) DeepCopyInto(out *ServerlessSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Specs added in v0.8.0 

type Specs struct {
	DiskIOPS      *int64 `json:"diskIOPS,omitempty"`
	EbsVolumeType string `json:"ebsVolumeType,omitempty"`
	InstanceSize  string `json:"instanceSize,omitempty"`
	NodeCount     *int   `json:"nodeCount,omitempty"`
}

func (*Specs) DeepCopy added in v0.8.0 

func (in *Specs) DeepCopy() *Specs

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Specs.

func (*Specs) DeepCopyInto added in v0.8.0 

func (in *Specs) DeepCopyInto(out *Specs)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Threshold added in v1.4.0 

type Threshold struct {
	// Operator to apply when checking the current metric value against the threshold value. it accepts the following values: GREATER_THAN, LESS_THAN
	Operator string `json:"operator,omitempty"`
	// The units for the threshold value
	Units string `json:"units,omitempty"`
	// Threshold value outside which an alert will be triggered.
	Threshold string `json:"threshold,omitempty"`
}

func (*Threshold) DeepCopy added in v1.4.0 

func (in *Threshold) DeepCopy() *Threshold

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Threshold.

func (*Threshold) DeepCopyInto added in v1.4.0 

func (in *Threshold) DeepCopyInto(out *Threshold)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Threshold) IsEqual added in v1.4.0 

func (in *Threshold) IsEqual(threshold *mongodbatlas.Threshold) bool

func (*Threshold) ToAtlas added in v1.4.0 

func (in *Threshold) ToAtlas() (*mongodbatlas.Threshold, error)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.