You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api/v1/atlasdatabaseuser_types.go
+5-7Lines changed: 5 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,7 @@ const (
52
52
// +kubebuilder:validation:XValidation:rule="(has(self.externalProjectRef) && !has(self.projectRef)) || (!has(self.externalProjectRef) && has(self.projectRef))",message="must define only one project reference through externalProjectRef or projectRef"
53
53
// +kubebuilder:validation:XValidation:rule="(has(self.externalProjectRef) && has(self.connectionSecret)) || !has(self.externalProjectRef)",message="must define a local connection secret when referencing an external project"
54
54
typeAtlasDatabaseUserSpecstruct {
55
-
// ProjectReference is the dual external or kubernetes reference with access credentials
55
+
// ProjectReference is the dual external or kubernetes reference with access credentials.
56
56
ProjectDualReference`json:",inline"`
57
57
58
58
// DatabaseName is a Database against which Atlas authenticates the user.
@@ -89,7 +89,7 @@ type AtlasDatabaseUserSpec struct {
89
89
// Human-readable label that represents the user that authenticates to MongoDB. The format of this label depends on the method of authentication:
90
90
// In case of AWS IAM: the value should be AWS ARN for the IAM User/Role;
91
91
// In case of OIDC Workload or Workforce: the value should be the Atlas OIDC IdP ID, followed by a '/', followed by the IdP group name;
92
-
// In case of Plain text auth: the value can be anything
92
+
// In case of Plain text auth: the value can be anything.
93
93
// +kubebuilder:validation:MaxLength:=1024
94
94
Usernamestring`json:"username"`
95
95
@@ -101,16 +101,14 @@ type AtlasDatabaseUserSpec struct {
101
101
// +optional
102
102
OIDCAuthTypestring`json:"oidcAuthType,omitempty"`
103
103
104
-
// Human-readable label that indicates whether the new database
105
-
// user authenticates with the Amazon Web Services (AWS)
106
-
// Identity and Access Management (IAM) credentials associated with
107
-
// the user or the user's role
104
+
// Human-readable label that indicates whether the new database user authenticates with Amazon Web Services (AWS).
105
+
// Identity and Access Management (IAM) credentials associated with the user or the user's role
108
106
// +kubebuilder:default:=NONE
109
107
// +kubebuilder:validation:Enum:=NONE;USER;ROLE
110
108
// +optional
111
109
AWSIAMTypestring`json:"awsIamType,omitempty"`
112
110
113
-
// X509Type is X.509 method by which the database authenticates the provided username
111
+
// X509Type is X.509 method by which the database authenticates the provided username.
// Human-readable label that identifies the collection to which MongoDB Atlas maps the data in the data stores.
96
+
Namestring`json:"name,omitempty"`
80
97
}
81
98
82
99
typeViewstruct {
83
-
Namestring`json:"name,omitempty"`
100
+
// Human-readable label that identifies the view, which corresponds to an aggregation pipeline on a collection.
101
+
Namestring`json:"name,omitempty"`
102
+
// Aggregation pipeline stages to apply to the source collection.
84
103
Pipelinestring`json:"pipeline,omitempty"`
85
-
Sourcestring`json:"source,omitempty"`
104
+
// Human-readable label that identifies the source collection for the view.
105
+
Sourcestring`json:"source,omitempty"`
86
106
}
87
107
88
108
typeDataSourcestruct {
89
-
AllowInsecurebool`json:"allowInsecure,omitempty"`
90
-
Collectionstring`json:"collection,omitempty"`
109
+
// Flag that validates the scheme in the specified URLs.
110
+
// If true, allows insecure HTTP scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server.
111
+
// If false, allows secure HTTPS scheme only.
112
+
AllowInsecurebool`json:"allowInsecure,omitempty"`
113
+
// Human-readable label that identifies the collection in the database. For creating a wildcard (*) collection, you must omit this parameter.
114
+
Collectionstring`json:"collection,omitempty"`
115
+
// Regex pattern to use for creating the wildcard (*) collection.
// Human-readable label that identifies the database, which contains the collection in the cluster. You must omit this parameter to generate wildcard (*) collections for dynamically generated databases.
118
+
Databasestring`json:"database,omitempty"`
119
+
// Regex pattern to use for creating the wildcard (*) database.
// File path that controls how MongoDB Cloud searches for and parses files in the storeName before mapping them to a collection.
125
+
// Specify / to capture all files and folders from the prefix path.
126
+
Pathstring`json:"path,omitempty"`
127
+
// Name for the field that includes the provenance of the documents in the results. MongoDB Atlas returns different fields in the results for each supported provider.
// Human-readable label that identifies the AWS S3 bucket.
146
+
// This label must exactly match the name of an S3 bucket that the data lake can access with the configured AWS Identity and Access Management (IAM) credentials.
147
+
Bucketstring`json:"bucket,omitempty"`
148
+
// The delimiter that separates path segments in the data store.
149
+
// MongoDB Atlas uses the delimiter to efficiently traverse S3 buckets with a hierarchical directory structure. You can specify any character supported by the S3 object keys as the delimiter.
150
+
Delimiterstring`json:"delimiter,omitempty"`
151
+
// Flag that indicates whether to use S3 tags on the files in the given path as additional partition attributes.
152
+
// If set to true, data lake adds the S3 tags as additional partition attributes and adds new top-level BSON elements associating each tag to each document.
153
+
IncludeTagsbool`json:"includeTags,omitempty"`
154
+
// Prefix that MongoDB Cloud applies when searching for files in the S3 bucket.
155
+
// The data store prepends the value of prefix to the path to create the full path for files to ingest.
156
+
// If omitted, MongoDB Cloud searches all files from the root of the S3 bucket.
157
+
Prefixstring`json:"prefix,omitempty"`
158
+
// Flag that indicates whether the bucket is public.
159
+
// If set to true, MongoDB Cloud doesn't use the configured AWS Identity and Access Management (IAM) role to access the S3 bucket.
160
+
// If set to false, the configured AWS IAM role must include permissions to access the S3 bucket.
161
+
Publicbool`json:"public,omitempty"`
162
+
// Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases.
163
+
// When MongoDB Atlas deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Atlas creates them as part of the deployment.
164
+
// To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.
165
+
Regionstring`json:"region,omitempty"`
112
166
}
113
167
114
168
typeDataFederationPEstruct {
169
+
// Unique 22-character alphanumeric string that identifies the private endpoint.
115
170
EndpointIDstring`json:"endpointId,omitempty"`
116
-
Providerstring`json:"provider,omitempty"`
117
-
Typestring`json:"type,omitempty"`
171
+
// Human-readable label that identifies the cloud service provider. Atlas Data Lake supports Amazon Web Services only.
172
+
Providerstring`json:"provider,omitempty"`
173
+
// Human-readable label that identifies the resource type associated with this private endpoint.
0 commit comments