Documentation ¶
Overview ¶
+kubebuilder:object:generate=true +groupName=org.mongodbatlas.crossplane.io +versionName=v1alpha1
Index ¶
- Constants
- Variables
- type Invitation
- func (in *Invitation) DeepCopy() *Invitation
- func (in *Invitation) DeepCopyInto(out *Invitation)
- func (in *Invitation) DeepCopyObject() runtime.Object
- func (tr *Invitation) GetConnectionDetailsMapping() map[string]string
- func (tr *Invitation) GetID() string
- func (tr *Invitation) GetObservation() (map[string]any, error)
- func (tr *Invitation) GetParameters() (map[string]any, error)
- func (mg *Invitation) GetTerraformResourceType() string
- func (tr *Invitation) GetTerraformSchemaVersion() int
- func (tr *Invitation) LateInitialize(attrs []byte) (bool, error)
- func (tr *Invitation) SetObservation(obs map[string]any) error
- func (tr *Invitation) SetParameters(params map[string]any) error
- type InvitationList
- type InvitationObservation
- type InvitationParameters
- type InvitationSpec
- type InvitationStatus
Constants ¶
const ( CRDGroup = "org.mongodbatlas.crossplane.io" CRDVersion = "v1alpha1" )
Package type metadata.
Variables ¶
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 )
var ( Invitation_Kind = "Invitation" Invitation_GroupKind = schema.GroupKind{Group: CRDGroup, Kind: Invitation_Kind}.String() Invitation_KindAPIVersion = Invitation_Kind + "." + CRDGroupVersion.String() Invitation_GroupVersionKind = CRDGroupVersion.WithKind(Invitation_Kind) )
Repository type metadata.
Functions ¶
This section is empty.
Types ¶
type Invitation ¶
type Invitation struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` // +kubebuilder:validation:XValidation:rule="self.managementPolicy == 'ObserveOnly' || has(self.forProvider.orgId)",message="orgId is a required parameter" // +kubebuilder:validation:XValidation:rule="self.managementPolicy == 'ObserveOnly' || has(self.forProvider.roles)",message="roles is a required parameter" // +kubebuilder:validation:XValidation:rule="self.managementPolicy == 'ObserveOnly' || has(self.forProvider.username)",message="username is a required parameter" Spec InvitationSpec `json:"spec"` Status InvitationStatus `json:"status,omitempty"` }
Invitation is the Schema for the Invitations API. Provides an Atlas Organization Invitation 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 (*Invitation) DeepCopy ¶
func (in *Invitation) DeepCopy() *Invitation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Invitation.
func (*Invitation) DeepCopyInto ¶
func (in *Invitation) DeepCopyInto(out *Invitation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Invitation) DeepCopyObject ¶
func (in *Invitation) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Invitation) GetConnectionDetailsMapping ¶
func (tr *Invitation) GetConnectionDetailsMapping() map[string]string
GetConnectionDetailsMapping for this Invitation
func (*Invitation) GetID ¶
func (tr *Invitation) GetID() string
GetID returns ID of underlying Terraform resource of this Invitation
func (*Invitation) GetObservation ¶
func (tr *Invitation) GetObservation() (map[string]any, error)
GetObservation of this Invitation
func (*Invitation) GetParameters ¶
func (tr *Invitation) GetParameters() (map[string]any, error)
GetParameters of this Invitation
func (*Invitation) GetTerraformResourceType ¶
func (mg *Invitation) GetTerraformResourceType() string
GetTerraformResourceType returns Terraform resource type for this Invitation
func (*Invitation) GetTerraformSchemaVersion ¶
func (tr *Invitation) GetTerraformSchemaVersion() int
GetTerraformSchemaVersion returns the associated Terraform schema version
func (*Invitation) LateInitialize ¶
func (tr *Invitation) LateInitialize(attrs []byte) (bool, error)
LateInitialize this Invitation using its observed tfState. returns True if there are any spec changes for the resource.
func (*Invitation) SetObservation ¶
func (tr *Invitation) SetObservation(obs map[string]any) error
SetObservation for this Invitation
func (*Invitation) SetParameters ¶
func (tr *Invitation) SetParameters(params map[string]any) error
SetParameters for this Invitation
type InvitationList ¶
type InvitationList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Invitation `json:"items"` }
InvitationList contains a list of Invitations
func (*InvitationList) DeepCopy ¶
func (in *InvitationList) DeepCopy() *InvitationList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InvitationList.
func (*InvitationList) DeepCopyInto ¶
func (in *InvitationList) DeepCopyInto(out *InvitationList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*InvitationList) DeepCopyObject ¶
func (in *InvitationList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type InvitationObservation ¶
type InvitationObservation struct { // Timestamp in ISO 8601 date and time format in UTC when Atlas sent the invitation. CreatedAt *string `json:"createdAt,omitempty" tf:"created_at,omitempty"` // Timestamp in ISO 8601 date and time format in UTC when the invitation expires. Users have 30 days to accept an invitation. ExpiresAt *string `json:"expiresAt,omitempty" tf:"expires_at,omitempty"` // Autogenerated unique string that identifies this resource. ID *string `json:"id,omitempty" tf:"id,omitempty"` // Unique 24-hexadecimal digit string that identifies the invitation in Atlas. InvitationID *string `json:"invitationId,omitempty" tf:"invitation_id,omitempty"` // Atlas user who invited username to the organization. InviterUsername *string `json:"inviterUsername,omitempty" tf:"inviter_username,omitempty"` // Unique 24-hexadecimal digit string that identifies the organization to which you want to invite a user. OrgID *string `json:"orgId,omitempty" tf:"org_id,omitempty"` // Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. The MongoDB Documentation describes the roles a user can have. Roles []*string `json:"roles,omitempty" tf:"roles,omitempty"` // An array of unique 24-hexadecimal digit strings that identify the teams that the user was invited to join. TeamsIds []*string `json:"teamsIds,omitempty" tf:"teams_ids,omitempty"` // Email address of the invited user. This is the address to which Atlas sends the invite. If the user accepts the invitation, they log in to Atlas with this username. Username *string `json:"username,omitempty" tf:"username,omitempty"` }
func (*InvitationObservation) DeepCopy ¶
func (in *InvitationObservation) DeepCopy() *InvitationObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InvitationObservation.
func (*InvitationObservation) DeepCopyInto ¶
func (in *InvitationObservation) DeepCopyInto(out *InvitationObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type InvitationParameters ¶
type InvitationParameters struct { // Unique 24-hexadecimal digit string that identifies the organization to which you want to invite a user. // +kubebuilder:validation:Optional OrgID *string `json:"orgId,omitempty" tf:"org_id,omitempty"` // Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. The MongoDB Documentation describes the roles a user can have. // +kubebuilder:validation:Optional Roles []*string `json:"roles,omitempty" tf:"roles,omitempty"` // An array of unique 24-hexadecimal digit strings that identify the teams that the user was invited to join. // +kubebuilder:validation:Optional TeamsIds []*string `json:"teamsIds,omitempty" tf:"teams_ids,omitempty"` // Email address of the invited user. This is the address to which Atlas sends the invite. If the user accepts the invitation, they log in to Atlas with this username. // +kubebuilder:validation:Optional Username *string `json:"username,omitempty" tf:"username,omitempty"` }
func (*InvitationParameters) DeepCopy ¶
func (in *InvitationParameters) DeepCopy() *InvitationParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InvitationParameters.
func (*InvitationParameters) DeepCopyInto ¶
func (in *InvitationParameters) DeepCopyInto(out *InvitationParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type InvitationSpec ¶
type InvitationSpec struct { v1.ResourceSpec `json:",inline"` ForProvider InvitationParameters `json:"forProvider"` }
InvitationSpec defines the desired state of Invitation
func (*InvitationSpec) DeepCopy ¶
func (in *InvitationSpec) DeepCopy() *InvitationSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InvitationSpec.
func (*InvitationSpec) DeepCopyInto ¶
func (in *InvitationSpec) DeepCopyInto(out *InvitationSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type InvitationStatus ¶
type InvitationStatus struct { v1.ResourceStatus `json:",inline"` AtProvider InvitationObservation `json:"atProvider,omitempty"` }
InvitationStatus defines the observed state of Invitation.
func (*InvitationStatus) DeepCopy ¶
func (in *InvitationStatus) DeepCopy() *InvitationStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new InvitationStatus.
func (*InvitationStatus) DeepCopyInto ¶
func (in *InvitationStatus) DeepCopyInto(out *InvitationStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.