Documentation ¶
Overview ¶
+kubebuilder:object:generate=true +groupName=snapshot.mongodbatlas.crossplane.io +versionName=v1alpha1
Index ¶
- Constants
- Variables
- type BackupSnapshot
- func (in *BackupSnapshot) DeepCopy() *BackupSnapshot
- func (in *BackupSnapshot) DeepCopyInto(out *BackupSnapshot)
- func (in *BackupSnapshot) DeepCopyObject() runtime.Object
- func (tr *BackupSnapshot) GetConnectionDetailsMapping() map[string]string
- func (tr *BackupSnapshot) GetID() string
- func (tr *BackupSnapshot) GetObservation() (map[string]any, error)
- func (tr *BackupSnapshot) GetParameters() (map[string]any, error)
- func (mg *BackupSnapshot) GetTerraformResourceType() string
- func (tr *BackupSnapshot) GetTerraformSchemaVersion() int
- func (tr *BackupSnapshot) LateInitialize(attrs []byte) (bool, error)
- func (tr *BackupSnapshot) SetObservation(obs map[string]any) error
- func (tr *BackupSnapshot) SetParameters(params map[string]any) error
- type BackupSnapshotList
- type BackupSnapshotObservation
- type BackupSnapshotParameters
- type BackupSnapshotSpec
- type BackupSnapshotStatus
- type MembersObservation
- type MembersParameters
Constants ¶
const ( CRDGroup = "snapshot.mongodbatlas.crossplane.io" CRDVersion = "v1alpha1" )
Package type metadata.
Variables ¶
var ( BackupSnapshot_Kind = "BackupSnapshot" BackupSnapshot_GroupKind = schema.GroupKind{Group: CRDGroup, Kind: BackupSnapshot_Kind}.String() BackupSnapshot_KindAPIVersion = BackupSnapshot_Kind + "." + CRDGroupVersion.String() BackupSnapshot_GroupVersionKind = CRDGroupVersion.WithKind(BackupSnapshot_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 BackupSnapshot ¶
type BackupSnapshot 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.description)",message="description is a required parameter" // +kubebuilder:validation:XValidation:rule="self.managementPolicy == 'ObserveOnly' || has(self.forProvider.projectId)",message="projectId is a required parameter" // +kubebuilder:validation:XValidation:rule="self.managementPolicy == 'ObserveOnly' || has(self.forProvider.retentionInDays)",message="retentionInDays is a required parameter" Spec BackupSnapshotSpec `json:"spec"` Status BackupSnapshotStatus `json:"status,omitempty"` }
BackupSnapshot is the Schema for the BackupSnapshots API. Provides a Cloud Backup Snapshot 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 (*BackupSnapshot) DeepCopy ¶
func (in *BackupSnapshot) DeepCopy() *BackupSnapshot
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupSnapshot.
func (*BackupSnapshot) DeepCopyInto ¶
func (in *BackupSnapshot) DeepCopyInto(out *BackupSnapshot)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BackupSnapshot) DeepCopyObject ¶
func (in *BackupSnapshot) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*BackupSnapshot) GetConnectionDetailsMapping ¶
func (tr *BackupSnapshot) GetConnectionDetailsMapping() map[string]string
GetConnectionDetailsMapping for this BackupSnapshot
func (*BackupSnapshot) GetID ¶
func (tr *BackupSnapshot) GetID() string
GetID returns ID of underlying Terraform resource of this BackupSnapshot
func (*BackupSnapshot) GetObservation ¶
func (tr *BackupSnapshot) GetObservation() (map[string]any, error)
GetObservation of this BackupSnapshot
func (*BackupSnapshot) GetParameters ¶
func (tr *BackupSnapshot) GetParameters() (map[string]any, error)
GetParameters of this BackupSnapshot
func (*BackupSnapshot) GetTerraformResourceType ¶
func (mg *BackupSnapshot) GetTerraformResourceType() string
GetTerraformResourceType returns Terraform resource type for this BackupSnapshot
func (*BackupSnapshot) GetTerraformSchemaVersion ¶
func (tr *BackupSnapshot) GetTerraformSchemaVersion() int
GetTerraformSchemaVersion returns the associated Terraform schema version
func (*BackupSnapshot) LateInitialize ¶
func (tr *BackupSnapshot) LateInitialize(attrs []byte) (bool, error)
LateInitialize this BackupSnapshot using its observed tfState. returns True if there are any spec changes for the resource.
func (*BackupSnapshot) SetObservation ¶
func (tr *BackupSnapshot) SetObservation(obs map[string]any) error
SetObservation for this BackupSnapshot
func (*BackupSnapshot) SetParameters ¶
func (tr *BackupSnapshot) SetParameters(params map[string]any) error
SetParameters for this BackupSnapshot
type BackupSnapshotList ¶
type BackupSnapshotList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []BackupSnapshot `json:"items"` }
BackupSnapshotList contains a list of BackupSnapshots
func (*BackupSnapshotList) DeepCopy ¶
func (in *BackupSnapshotList) DeepCopy() *BackupSnapshotList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupSnapshotList.
func (*BackupSnapshotList) DeepCopyInto ¶
func (in *BackupSnapshotList) DeepCopyInto(out *BackupSnapshotList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BackupSnapshotList) DeepCopyObject ¶
func (in *BackupSnapshotList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BackupSnapshotObservation ¶
type BackupSnapshotObservation struct { // Cloud provider that stores this snapshot. Atlas returns this parameter when type is replicaSet. CloudProvider *string `json:"cloudProvider,omitempty" tf:"cloud_provider,omitempty"` // The name of the Atlas cluster that contains the snapshots you want to retrieve. ClusterName *string `json:"clusterName,omitempty" tf:"cluster_name,omitempty"` // UTC ISO 8601 formatted point in time when Atlas took the snapshot. CreatedAt *string `json:"createdAt,omitempty" tf:"created_at,omitempty"` // Description of the on-demand snapshot. Description *string `json:"description,omitempty" tf:"description,omitempty"` // UTC ISO 8601 formatted point in time when Atlas will delete the snapshot. ExpiresAt *string `json:"expiresAt,omitempty" tf:"expires_at,omitempty"` ID *string `json:"id,omitempty" tf:"id,omitempty"` // Unique ID of the AWS KMS Customer Master Key used to encrypt the snapshot. Only visible for clusters using Encryption at Rest via Customer KMS. MasterKeyUUID *string `json:"masterKeyUuid,omitempty" tf:"master_key_uuid,omitempty"` // Block of List of snapshots and the cloud provider where the snapshots are stored. Atlas returns this parameter when type is shardedCluster. See below Members []MembersObservation `json:"members,omitempty" tf:"members,omitempty"` // Version of the MongoDB server. MongodVersion *string `json:"mongodVersion,omitempty" tf:"mongod_version,omitempty"` // The unique identifier of the project for the Atlas cluster. ProjectID *string `json:"projectId,omitempty" tf:"project_id,omitempty"` // Label given to the replica set from which Atlas took this snapshot. Atlas returns this parameter when type is replicaSet. ReplicaSetName *string `json:"replicaSetName,omitempty" tf:"replica_set_name,omitempty"` // The number of days that Atlas should retain the on-demand snapshot. Must be at least 1. RetentionInDays *float64 `json:"retentionInDays,omitempty" tf:"retention_in_days,omitempty"` // Unique identifier of the snapshot. SnapshotID *string `json:"snapshotId,omitempty" tf:"snapshot_id,omitempty"` // Unique identifiers of the snapshots created for the shards and config server for a sharded cluster. Atlas returns this parameter when type is shardedCluster. These identifiers should match those given in the members[n].id parameters. This allows you to map a snapshot to its shard or config server name. SnapshotIds []*string `json:"snapshotIds,omitempty" tf:"snapshot_ids,omitempty"` // Specified the type of snapshot. Valid values are onDemand and scheduled. SnapshotType *string `json:"snapshotType,omitempty" tf:"snapshot_type,omitempty"` // Current status of the snapshot. One of the following values will be returned: queued, inProgress, completed, failed. Status *string `json:"status,omitempty" tf:"status,omitempty"` // Specifies the size of the snapshot in bytes. StorageSizeBytes *float64 `json:"storageSizeBytes,omitempty" tf:"storage_size_bytes,omitempty"` // Specifies the type of cluster: replicaSet or shardedCluster. Type *string `json:"type,omitempty" tf:"type,omitempty"` }
func (*BackupSnapshotObservation) DeepCopy ¶
func (in *BackupSnapshotObservation) DeepCopy() *BackupSnapshotObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupSnapshotObservation.
func (*BackupSnapshotObservation) DeepCopyInto ¶
func (in *BackupSnapshotObservation) DeepCopyInto(out *BackupSnapshotObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BackupSnapshotParameters ¶
type BackupSnapshotParameters struct { // The name of the Atlas cluster that contains the snapshots you want to retrieve. // +kubebuilder:validation:Optional ClusterName *string `json:"clusterName,omitempty" tf:"cluster_name,omitempty"` // Description of the on-demand snapshot. // +kubebuilder:validation:Optional Description *string `json:"description,omitempty" tf:"description,omitempty"` // The unique identifier of the project for the Atlas cluster. // +kubebuilder:validation:Optional ProjectID *string `json:"projectId,omitempty" tf:"project_id,omitempty"` // The number of days that Atlas should retain the on-demand snapshot. Must be at least 1. // +kubebuilder:validation:Optional RetentionInDays *float64 `json:"retentionInDays,omitempty" tf:"retention_in_days,omitempty"` }
func (*BackupSnapshotParameters) DeepCopy ¶
func (in *BackupSnapshotParameters) DeepCopy() *BackupSnapshotParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupSnapshotParameters.
func (*BackupSnapshotParameters) DeepCopyInto ¶
func (in *BackupSnapshotParameters) DeepCopyInto(out *BackupSnapshotParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BackupSnapshotSpec ¶
type BackupSnapshotSpec struct { v1.ResourceSpec `json:",inline"` ForProvider BackupSnapshotParameters `json:"forProvider"` }
BackupSnapshotSpec defines the desired state of BackupSnapshot
func (*BackupSnapshotSpec) DeepCopy ¶
func (in *BackupSnapshotSpec) DeepCopy() *BackupSnapshotSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupSnapshotSpec.
func (*BackupSnapshotSpec) DeepCopyInto ¶
func (in *BackupSnapshotSpec) DeepCopyInto(out *BackupSnapshotSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BackupSnapshotStatus ¶
type BackupSnapshotStatus struct { v1.ResourceStatus `json:",inline"` AtProvider BackupSnapshotObservation `json:"atProvider,omitempty"` }
BackupSnapshotStatus defines the observed state of BackupSnapshot.
func (*BackupSnapshotStatus) DeepCopy ¶
func (in *BackupSnapshotStatus) DeepCopy() *BackupSnapshotStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BackupSnapshotStatus.
func (*BackupSnapshotStatus) DeepCopyInto ¶
func (in *BackupSnapshotStatus) DeepCopyInto(out *BackupSnapshotStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MembersObservation ¶
type MembersObservation struct { // Cloud provider that stores this snapshot. CloudProvider *string `json:"cloudProvider,omitempty" tf:"cloud_provider,omitempty"` // Unique identifier for the sharded cluster snapshot. ID *string `json:"id,omitempty" tf:"id,omitempty"` // Label given to a shard or config server from which Atlas took this snapshot. ReplicaSetName *string `json:"replicaSetName,omitempty" tf:"replica_set_name,omitempty"` }
func (*MembersObservation) DeepCopy ¶
func (in *MembersObservation) DeepCopy() *MembersObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MembersObservation.
func (*MembersObservation) DeepCopyInto ¶
func (in *MembersObservation) DeepCopyInto(out *MembersObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MembersParameters ¶
type MembersParameters struct { }
func (*MembersParameters) DeepCopy ¶
func (in *MembersParameters) DeepCopy() *MembersParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MembersParameters.
func (*MembersParameters) DeepCopyInto ¶
func (in *MembersParameters) DeepCopyInto(out *MembersParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.