Documentation ¶
Overview ¶
+kubebuilder:object:generate=true +groupName=global.mongodbatlas.crossplane.io +versionName=v1alpha1
Index ¶
- Constants
- Variables
- type ClusterConfig
- func (in *ClusterConfig) DeepCopy() *ClusterConfig
- func (in *ClusterConfig) DeepCopyInto(out *ClusterConfig)
- func (in *ClusterConfig) DeepCopyObject() runtime.Object
- func (mg *ClusterConfig) GetCondition(ct xpv1.ConditionType) xpv1.Condition
- func (tr *ClusterConfig) GetConnectionDetailsMapping() map[string]string
- func (mg *ClusterConfig) GetDeletionPolicy() xpv1.DeletionPolicy
- func (tr *ClusterConfig) GetID() string
- func (mg *ClusterConfig) GetManagementPolicy() xpv1.ManagementPolicy
- func (tr *ClusterConfig) GetObservation() (map[string]any, error)
- func (tr *ClusterConfig) GetParameters() (map[string]any, error)
- func (mg *ClusterConfig) GetProviderConfigReference() *xpv1.Reference
- func (mg *ClusterConfig) GetProviderReference() *xpv1.Reference
- func (mg *ClusterConfig) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
- func (mg *ClusterConfig) GetTerraformResourceType() string
- func (tr *ClusterConfig) GetTerraformSchemaVersion() int
- func (mg *ClusterConfig) GetWriteConnectionSecretToReference() *xpv1.SecretReference
- func (tr *ClusterConfig) LateInitialize(attrs []byte) (bool, error)
- func (mg *ClusterConfig) SetConditions(c ...xpv1.Condition)
- func (mg *ClusterConfig) SetDeletionPolicy(r xpv1.DeletionPolicy)
- func (mg *ClusterConfig) SetManagementPolicy(r xpv1.ManagementPolicy)
- func (tr *ClusterConfig) SetObservation(obs map[string]any) error
- func (tr *ClusterConfig) SetParameters(params map[string]any) error
- func (mg *ClusterConfig) SetProviderConfigReference(r *xpv1.Reference)
- func (mg *ClusterConfig) SetProviderReference(r *xpv1.Reference)
- func (mg *ClusterConfig) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
- func (mg *ClusterConfig) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
- type ClusterConfigList
- type ClusterConfigObservation
- type ClusterConfigParameters
- type ClusterConfigSpec
- type ClusterConfigStatus
- type CustomZoneMappingsObservation
- type CustomZoneMappingsParameters
- type ManagedNamespacesObservation
- type ManagedNamespacesParameters
Constants ¶
const ( CRDGroup = "global.mongodbatlas.crossplane.io" CRDVersion = "v1alpha1" )
Package type metadata.
Variables ¶
var ( ClusterConfig_Kind = "ClusterConfig" ClusterConfig_GroupKind = schema.GroupKind{Group: CRDGroup, Kind: ClusterConfig_Kind}.String() ClusterConfig_KindAPIVersion = ClusterConfig_Kind + "." + CRDGroupVersion.String() ClusterConfig_GroupVersionKind = CRDGroupVersion.WithKind(ClusterConfig_Kind) )
Repository type metadata.
var ( // CRDGroupVersion is the API Group Version used to register the objects CRDGroupVersion = schema.GroupVersion{Group: CRDGroup, Version: CRDVersion} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: CRDGroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type ClusterConfig ¶
type ClusterConfig struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` // +kubebuilder:validation:XValidation:rule="self.managementPolicy == 'ObserveOnly' || has(self.forProvider.clusterName)",message="clusterName is a required parameter" // +kubebuilder:validation:XValidation:rule="self.managementPolicy == 'ObserveOnly' || has(self.forProvider.projectId)",message="projectId is a required parameter" Spec ClusterConfigSpec `json:"spec"` Status ClusterConfigStatus `json:"status,omitempty"` }
ClusterConfig is the Schema for the ClusterConfigs API. Provides a Global Cluster Configuration resource. +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,mongodbatlas}
func (*ClusterConfig) DeepCopy ¶
func (in *ClusterConfig) DeepCopy() *ClusterConfig
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterConfig.
func (*ClusterConfig) DeepCopyInto ¶
func (in *ClusterConfig) DeepCopyInto(out *ClusterConfig)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterConfig) DeepCopyObject ¶
func (in *ClusterConfig) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*ClusterConfig) GetCondition ¶
func (mg *ClusterConfig) GetCondition(ct xpv1.ConditionType) xpv1.Condition
GetCondition of this ClusterConfig.
func (*ClusterConfig) GetConnectionDetailsMapping ¶
func (tr *ClusterConfig) GetConnectionDetailsMapping() map[string]string
GetConnectionDetailsMapping for this ClusterConfig
func (*ClusterConfig) GetDeletionPolicy ¶
func (mg *ClusterConfig) GetDeletionPolicy() xpv1.DeletionPolicy
GetDeletionPolicy of this ClusterConfig.
func (*ClusterConfig) GetID ¶
func (tr *ClusterConfig) GetID() string
GetID returns ID of underlying Terraform resource of this ClusterConfig
func (*ClusterConfig) GetManagementPolicy ¶
func (mg *ClusterConfig) GetManagementPolicy() xpv1.ManagementPolicy
GetManagementPolicy of this ClusterConfig.
func (*ClusterConfig) GetObservation ¶
func (tr *ClusterConfig) GetObservation() (map[string]any, error)
GetObservation of this ClusterConfig
func (*ClusterConfig) GetParameters ¶
func (tr *ClusterConfig) GetParameters() (map[string]any, error)
GetParameters of this ClusterConfig
func (*ClusterConfig) GetProviderConfigReference ¶
func (mg *ClusterConfig) GetProviderConfigReference() *xpv1.Reference
GetProviderConfigReference of this ClusterConfig.
func (*ClusterConfig) GetProviderReference ¶
func (mg *ClusterConfig) GetProviderReference() *xpv1.Reference
GetProviderReference of this ClusterConfig. Deprecated: Use GetProviderConfigReference.
func (*ClusterConfig) GetPublishConnectionDetailsTo ¶
func (mg *ClusterConfig) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
GetPublishConnectionDetailsTo of this ClusterConfig.
func (*ClusterConfig) GetTerraformResourceType ¶
func (mg *ClusterConfig) GetTerraformResourceType() string
GetTerraformResourceType returns Terraform resource type for this ClusterConfig
func (*ClusterConfig) GetTerraformSchemaVersion ¶
func (tr *ClusterConfig) GetTerraformSchemaVersion() int
GetTerraformSchemaVersion returns the associated Terraform schema version
func (*ClusterConfig) GetWriteConnectionSecretToReference ¶
func (mg *ClusterConfig) GetWriteConnectionSecretToReference() *xpv1.SecretReference
GetWriteConnectionSecretToReference of this ClusterConfig.
func (*ClusterConfig) LateInitialize ¶
func (tr *ClusterConfig) LateInitialize(attrs []byte) (bool, error)
LateInitialize this ClusterConfig using its observed tfState. returns True if there are any spec changes for the resource.
func (*ClusterConfig) SetConditions ¶
func (mg *ClusterConfig) SetConditions(c ...xpv1.Condition)
SetConditions of this ClusterConfig.
func (*ClusterConfig) SetDeletionPolicy ¶
func (mg *ClusterConfig) SetDeletionPolicy(r xpv1.DeletionPolicy)
SetDeletionPolicy of this ClusterConfig.
func (*ClusterConfig) SetManagementPolicy ¶
func (mg *ClusterConfig) SetManagementPolicy(r xpv1.ManagementPolicy)
SetManagementPolicy of this ClusterConfig.
func (*ClusterConfig) SetObservation ¶
func (tr *ClusterConfig) SetObservation(obs map[string]any) error
SetObservation for this ClusterConfig
func (*ClusterConfig) SetParameters ¶
func (tr *ClusterConfig) SetParameters(params map[string]any) error
SetParameters for this ClusterConfig
func (*ClusterConfig) SetProviderConfigReference ¶
func (mg *ClusterConfig) SetProviderConfigReference(r *xpv1.Reference)
SetProviderConfigReference of this ClusterConfig.
func (*ClusterConfig) SetProviderReference ¶
func (mg *ClusterConfig) SetProviderReference(r *xpv1.Reference)
SetProviderReference of this ClusterConfig. Deprecated: Use SetProviderConfigReference.
func (*ClusterConfig) SetPublishConnectionDetailsTo ¶
func (mg *ClusterConfig) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
SetPublishConnectionDetailsTo of this ClusterConfig.
func (*ClusterConfig) SetWriteConnectionSecretToReference ¶
func (mg *ClusterConfig) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
SetWriteConnectionSecretToReference of this ClusterConfig.
type ClusterConfigList ¶
type ClusterConfigList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []ClusterConfig `json:"items"` }
ClusterConfigList contains a list of ClusterConfigs
func (*ClusterConfigList) DeepCopy ¶
func (in *ClusterConfigList) DeepCopy() *ClusterConfigList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterConfigList.
func (*ClusterConfigList) DeepCopyInto ¶
func (in *ClusterConfigList) DeepCopyInto(out *ClusterConfigList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterConfigList) DeepCopyObject ¶
func (in *ClusterConfigList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*ClusterConfigList) GetItems ¶
func (l *ClusterConfigList) GetItems() []resource.Managed
GetItems of this ClusterConfigList.
type ClusterConfigObservation ¶
type ClusterConfigObservation struct { // The name of the Global Cluster. ClusterName *string `json:"clusterName,omitempty" tf:"cluster_name,omitempty"` // A map of all custom zone mappings defined for the Global Cluster. Atlas automatically maps each location code to the closest geographical zone. Custom zone mappings allow administrators to override these automatic mappings. If your Global Cluster does not have any custom zone mappings, this document is empty. CustomZoneMapping map[string]*string `json:"customZoneMapping,omitempty" tf:"custom_zone_mapping,omitempty"` // Each element in the list maps one ISO location code to a zone in your Global Cluster. See Custom Zone Mapping below for more details. CustomZoneMappings []CustomZoneMappingsObservation `json:"customZoneMappings,omitempty" tf:"custom_zone_mappings,omitempty"` ID *string `json:"id,omitempty" tf:"id,omitempty"` // Add a managed namespaces to a Global Cluster. For more information about managed namespaces, see Global Clusters. See Managed Namespace below for more details. ManagedNamespaces []ManagedNamespacesObservation `json:"managedNamespaces,omitempty" tf:"managed_namespaces,omitempty"` // The unique ID for the project to create the database user. ProjectID *string `json:"projectId,omitempty" tf:"project_id,omitempty"` }
func (*ClusterConfigObservation) DeepCopy ¶
func (in *ClusterConfigObservation) DeepCopy() *ClusterConfigObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterConfigObservation.
func (*ClusterConfigObservation) DeepCopyInto ¶
func (in *ClusterConfigObservation) DeepCopyInto(out *ClusterConfigObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterConfigParameters ¶
type ClusterConfigParameters struct { // The name of the Global Cluster. // +kubebuilder:validation:Optional ClusterName *string `json:"clusterName,omitempty" tf:"cluster_name,omitempty"` // Each element in the list maps one ISO location code to a zone in your Global Cluster. See Custom Zone Mapping below for more details. // +kubebuilder:validation:Optional CustomZoneMappings []CustomZoneMappingsParameters `json:"customZoneMappings,omitempty" tf:"custom_zone_mappings,omitempty"` // Add a managed namespaces to a Global Cluster. For more information about managed namespaces, see Global Clusters. See Managed Namespace below for more details. // +kubebuilder:validation:Optional ManagedNamespaces []ManagedNamespacesParameters `json:"managedNamespaces,omitempty" tf:"managed_namespaces,omitempty"` // The unique ID for the project to create the database user. // +kubebuilder:validation:Optional ProjectID *string `json:"projectId,omitempty" tf:"project_id,omitempty"` }
func (*ClusterConfigParameters) DeepCopy ¶
func (in *ClusterConfigParameters) DeepCopy() *ClusterConfigParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterConfigParameters.
func (*ClusterConfigParameters) DeepCopyInto ¶
func (in *ClusterConfigParameters) DeepCopyInto(out *ClusterConfigParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterConfigSpec ¶
type ClusterConfigSpec struct { v1.ResourceSpec `json:",inline"` ForProvider ClusterConfigParameters `json:"forProvider"` }
ClusterConfigSpec defines the desired state of ClusterConfig
func (*ClusterConfigSpec) DeepCopy ¶
func (in *ClusterConfigSpec) DeepCopy() *ClusterConfigSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterConfigSpec.
func (*ClusterConfigSpec) DeepCopyInto ¶
func (in *ClusterConfigSpec) DeepCopyInto(out *ClusterConfigSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterConfigStatus ¶
type ClusterConfigStatus struct { v1.ResourceStatus `json:",inline"` AtProvider ClusterConfigObservation `json:"atProvider,omitempty"` }
ClusterConfigStatus defines the observed state of ClusterConfig.
func (*ClusterConfigStatus) DeepCopy ¶
func (in *ClusterConfigStatus) DeepCopy() *ClusterConfigStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterConfigStatus.
func (*ClusterConfigStatus) DeepCopyInto ¶
func (in *ClusterConfigStatus) DeepCopyInto(out *ClusterConfigStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CustomZoneMappingsObservation ¶
type CustomZoneMappingsObservation struct { // The ISO location code to which you want to map a zone in your Global Cluster. You can find a list of all supported location codes here. Location *string `json:"location,omitempty" tf:"location,omitempty"` // The name of the zone in your Global Cluster that you want to map to location. Zone *string `json:"zone,omitempty" tf:"zone,omitempty"` }
func (*CustomZoneMappingsObservation) DeepCopy ¶
func (in *CustomZoneMappingsObservation) DeepCopy() *CustomZoneMappingsObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomZoneMappingsObservation.
func (*CustomZoneMappingsObservation) DeepCopyInto ¶
func (in *CustomZoneMappingsObservation) DeepCopyInto(out *CustomZoneMappingsObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type CustomZoneMappingsParameters ¶
type CustomZoneMappingsParameters struct { // The ISO location code to which you want to map a zone in your Global Cluster. You can find a list of all supported location codes here. // +kubebuilder:validation:Optional Location *string `json:"location,omitempty" tf:"location,omitempty"` // The name of the zone in your Global Cluster that you want to map to location. // +kubebuilder:validation:Optional Zone *string `json:"zone,omitempty" tf:"zone,omitempty"` }
func (*CustomZoneMappingsParameters) DeepCopy ¶
func (in *CustomZoneMappingsParameters) DeepCopy() *CustomZoneMappingsParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomZoneMappingsParameters.
func (*CustomZoneMappingsParameters) DeepCopyInto ¶
func (in *CustomZoneMappingsParameters) DeepCopyInto(out *CustomZoneMappingsParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ManagedNamespacesObservation ¶
type ManagedNamespacesObservation struct { // The name of the collection associated with the managed namespace. Collection *string `json:"collection,omitempty" tf:"collection,omitempty"` // The custom shard key for the collection. Global Clusters require a compound shard key consisting of a location field and a user-selected second key, the custom shard key. CustomShardKey *string `json:"customShardKey,omitempty" tf:"custom_shard_key,omitempty"` // The name of the database containing the collection. DB *string `json:"db,omitempty" tf:"db,omitempty"` // Specifies whether the custom shard key for the collection is hashed. If omitted, defaults to false. If false, Atlas uses ranged sharding. This is only available for Atlas clusters with MongoDB v4.4 and later. IsCustomShardKeyHashed *bool `json:"isCustomShardKeyHashed,omitempty" tf:"is_custom_shard_key_hashed,omitempty"` // Specifies whether the underlying index enforces a unique constraint. If omitted, defaults to false. You cannot specify true when using hashed shard keys. IsShardKeyUnique *bool `json:"isShardKeyUnique,omitempty" tf:"is_shard_key_unique,omitempty"` }
func (*ManagedNamespacesObservation) DeepCopy ¶
func (in *ManagedNamespacesObservation) DeepCopy() *ManagedNamespacesObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ManagedNamespacesObservation.
func (*ManagedNamespacesObservation) DeepCopyInto ¶
func (in *ManagedNamespacesObservation) DeepCopyInto(out *ManagedNamespacesObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ManagedNamespacesParameters ¶
type ManagedNamespacesParameters struct { // The name of the collection associated with the managed namespace. // +kubebuilder:validation:Required Collection *string `json:"collection" tf:"collection,omitempty"` // The custom shard key for the collection. Global Clusters require a compound shard key consisting of a location field and a user-selected second key, the custom shard key. // +kubebuilder:validation:Required CustomShardKey *string `json:"customShardKey" tf:"custom_shard_key,omitempty"` // The name of the database containing the collection. // +kubebuilder:validation:Required DB *string `json:"db" tf:"db,omitempty"` // Specifies whether the custom shard key for the collection is hashed. If omitted, defaults to false. If false, Atlas uses ranged sharding. This is only available for Atlas clusters with MongoDB v4.4 and later. // +kubebuilder:validation:Optional IsCustomShardKeyHashed *bool `json:"isCustomShardKeyHashed,omitempty" tf:"is_custom_shard_key_hashed,omitempty"` // Specifies whether the underlying index enforces a unique constraint. If omitted, defaults to false. You cannot specify true when using hashed shard keys. // +kubebuilder:validation:Optional IsShardKeyUnique *bool `json:"isShardKeyUnique,omitempty" tf:"is_shard_key_unique,omitempty"` }
func (*ManagedNamespacesParameters) DeepCopy ¶
func (in *ManagedNamespacesParameters) DeepCopy() *ManagedNamespacesParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ManagedNamespacesParameters.
func (*ManagedNamespacesParameters) DeepCopyInto ¶
func (in *ManagedNamespacesParameters) DeepCopyInto(out *ManagedNamespacesParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.