Documentation ¶
Overview ¶
+kubebuilder:object:generate=true +groupName=sm.opensearch.upbound.io +versionName=v1alpha1
Index ¶
- Constants
- Variables
- type Policy
- func (in *Policy) DeepCopy() *Policy
- func (in *Policy) DeepCopyInto(out *Policy)
- func (in *Policy) DeepCopyObject() runtime.Object
- func (mg *Policy) GetCondition(ct xpv1.ConditionType) xpv1.Condition
- func (tr *Policy) GetConnectionDetailsMapping() map[string]string
- func (mg *Policy) GetDeletionPolicy() xpv1.DeletionPolicy
- func (tr *Policy) GetID() string
- func (tr *Policy) GetInitParameters() (map[string]any, error)
- func (mg *Policy) GetManagementPolicies() xpv1.ManagementPolicies
- func (tr *Policy) GetMergedParameters(shouldMergeInitProvider bool) (map[string]any, error)
- func (tr *Policy) GetObservation() (map[string]any, error)
- func (tr *Policy) GetParameters() (map[string]any, error)
- func (mg *Policy) GetProviderConfigReference() *xpv1.Reference
- func (mg *Policy) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
- func (mg *Policy) GetTerraformResourceType() string
- func (tr *Policy) GetTerraformSchemaVersion() int
- func (mg *Policy) GetWriteConnectionSecretToReference() *xpv1.SecretReference
- func (tr *Policy) Hub()
- func (tr *Policy) LateInitialize(attrs []byte) (bool, error)
- func (mg *Policy) SetConditions(c ...xpv1.Condition)
- func (mg *Policy) SetDeletionPolicy(r xpv1.DeletionPolicy)
- func (mg *Policy) SetManagementPolicies(r xpv1.ManagementPolicies)
- func (tr *Policy) SetObservation(obs map[string]any) error
- func (tr *Policy) SetParameters(params map[string]any) error
- func (mg *Policy) SetProviderConfigReference(r *xpv1.Reference)
- func (mg *Policy) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
- func (mg *Policy) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
- type PolicyInitParameters
- type PolicyList
- type PolicyObservation
- type PolicyParameters
- type PolicySpec
- type PolicyStatus
Constants ¶
const ( CRDGroup = "sm.opensearch.upbound.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 ( Policy_Kind = "Policy" Policy_GroupKind = schema.GroupKind{Group: CRDGroup, Kind: Policy_Kind}.String() Policy_KindAPIVersion = Policy_Kind + "." + CRDGroupVersion.String() Policy_GroupVersionKind = CRDGroupVersion.WithKind(Policy_Kind) )
Repository type metadata.
Functions ¶
This section is empty.
Types ¶
type Policy ¶
type Policy struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` // +kubebuilder:validation:XValidation:rule="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.body) || (has(self.initProvider) && has(self.initProvider.body))",message="spec.forProvider.body is a required parameter" // +kubebuilder:validation:XValidation:rule="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.policyName) || (has(self.initProvider) && has(self.initProvider.policyName))",message="spec.forProvider.policyName is a required parameter" Spec PolicySpec `json:"spec"` Status PolicyStatus `json:"status,omitempty"` }
Policy is the Schema for the Policys API. Provides an OpenSearch Snapshot Management (SM) policy. Please refer to the OpenSearch SM documentation for details. +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].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:resource:scope=Cluster,categories={crossplane,managed,opensearch}
func (*Policy) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Policy.
func (*Policy) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Policy) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Policy) GetCondition ¶
func (mg *Policy) GetCondition(ct xpv1.ConditionType) xpv1.Condition
GetCondition of this Policy.
func (*Policy) GetConnectionDetailsMapping ¶
GetConnectionDetailsMapping for this Policy
func (*Policy) GetDeletionPolicy ¶
func (mg *Policy) GetDeletionPolicy() xpv1.DeletionPolicy
GetDeletionPolicy of this Policy.
func (*Policy) GetInitParameters ¶
GetInitParameters of this Policy
func (*Policy) GetManagementPolicies ¶
func (mg *Policy) GetManagementPolicies() xpv1.ManagementPolicies
GetManagementPolicies of this Policy.
func (*Policy) GetMergedParameters ¶
GetInitParameters of this Policy
func (*Policy) GetObservation ¶
GetObservation of this Policy
func (*Policy) GetParameters ¶
GetParameters of this Policy
func (*Policy) GetProviderConfigReference ¶
GetProviderConfigReference of this Policy.
func (*Policy) GetPublishConnectionDetailsTo ¶
func (mg *Policy) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
GetPublishConnectionDetailsTo of this Policy.
func (*Policy) GetTerraformResourceType ¶
GetTerraformResourceType returns Terraform resource type for this Policy
func (*Policy) GetTerraformSchemaVersion ¶
GetTerraformSchemaVersion returns the associated Terraform schema version
func (*Policy) GetWriteConnectionSecretToReference ¶
func (mg *Policy) GetWriteConnectionSecretToReference() *xpv1.SecretReference
GetWriteConnectionSecretToReference of this Policy.
func (*Policy) LateInitialize ¶
LateInitialize this Policy using its observed tfState. returns True if there are any spec changes for the resource.
func (*Policy) SetConditions ¶
SetConditions of this Policy.
func (*Policy) SetDeletionPolicy ¶
func (mg *Policy) SetDeletionPolicy(r xpv1.DeletionPolicy)
SetDeletionPolicy of this Policy.
func (*Policy) SetManagementPolicies ¶
func (mg *Policy) SetManagementPolicies(r xpv1.ManagementPolicies)
SetManagementPolicies of this Policy.
func (*Policy) SetObservation ¶
SetObservation for this Policy
func (*Policy) SetParameters ¶
SetParameters for this Policy
func (*Policy) SetProviderConfigReference ¶
SetProviderConfigReference of this Policy.
func (*Policy) SetPublishConnectionDetailsTo ¶
func (mg *Policy) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
SetPublishConnectionDetailsTo of this Policy.
func (*Policy) SetWriteConnectionSecretToReference ¶
func (mg *Policy) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
SetWriteConnectionSecretToReference of this Policy.
type PolicyInitParameters ¶
type PolicyInitParameters struct { // (String) The policy document. // The policy document. Body *string `json:"body,omitempty" tf:"body,omitempty"` // (String) The name of the SM policy. // The name of the SM policy. PolicyName *string `json:"policyName,omitempty" tf:"policy_name,omitempty"` // (Number) The primary term of the SM policy version. // The primary term of the SM policy version. PrimaryTerm *float64 `json:"primaryTerm,omitempty" tf:"primary_term,omitempty"` // (Number) The sequence number of the SM policy version. // The sequence number of the SM policy version. SeqNo *float64 `json:"seqNo,omitempty" tf:"seq_no,omitempty"` }
func (*PolicyInitParameters) DeepCopy ¶
func (in *PolicyInitParameters) DeepCopy() *PolicyInitParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolicyInitParameters.
func (*PolicyInitParameters) DeepCopyInto ¶
func (in *PolicyInitParameters) DeepCopyInto(out *PolicyInitParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PolicyList ¶
type PolicyList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Policy `json:"items"` }
PolicyList contains a list of Policys
func (*PolicyList) DeepCopy ¶
func (in *PolicyList) DeepCopy() *PolicyList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolicyList.
func (*PolicyList) DeepCopyInto ¶
func (in *PolicyList) DeepCopyInto(out *PolicyList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*PolicyList) DeepCopyObject ¶
func (in *PolicyList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*PolicyList) GetItems ¶
func (l *PolicyList) GetItems() []resource.Managed
GetItems of this PolicyList.
type PolicyObservation ¶
type PolicyObservation struct { // (String) The policy document. // The policy document. Body *string `json:"body,omitempty" tf:"body,omitempty"` // (String) The ID of this resource. ID *string `json:"id,omitempty" tf:"id,omitempty"` // (String) The name of the SM policy. // The name of the SM policy. PolicyName *string `json:"policyName,omitempty" tf:"policy_name,omitempty"` // (Number) The primary term of the SM policy version. // The primary term of the SM policy version. PrimaryTerm *float64 `json:"primaryTerm,omitempty" tf:"primary_term,omitempty"` // (Number) The sequence number of the SM policy version. // The sequence number of the SM policy version. SeqNo *float64 `json:"seqNo,omitempty" tf:"seq_no,omitempty"` }
func (*PolicyObservation) DeepCopy ¶
func (in *PolicyObservation) DeepCopy() *PolicyObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolicyObservation.
func (*PolicyObservation) DeepCopyInto ¶
func (in *PolicyObservation) DeepCopyInto(out *PolicyObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PolicyParameters ¶
type PolicyParameters struct { // (String) The policy document. // The policy document. // +kubebuilder:validation:Optional Body *string `json:"body,omitempty" tf:"body,omitempty"` // (String) The name of the SM policy. // The name of the SM policy. // +kubebuilder:validation:Optional PolicyName *string `json:"policyName,omitempty" tf:"policy_name,omitempty"` // (Number) The primary term of the SM policy version. // The primary term of the SM policy version. // +kubebuilder:validation:Optional PrimaryTerm *float64 `json:"primaryTerm,omitempty" tf:"primary_term,omitempty"` // (Number) The sequence number of the SM policy version. // The sequence number of the SM policy version. // +kubebuilder:validation:Optional SeqNo *float64 `json:"seqNo,omitempty" tf:"seq_no,omitempty"` }
func (*PolicyParameters) DeepCopy ¶
func (in *PolicyParameters) DeepCopy() *PolicyParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolicyParameters.
func (*PolicyParameters) DeepCopyInto ¶
func (in *PolicyParameters) DeepCopyInto(out *PolicyParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PolicySpec ¶
type PolicySpec struct { v1.ResourceSpec `json:",inline"` ForProvider PolicyParameters `json:"forProvider"` // THIS IS A BETA FIELD. It will be honored // unless the Management Policies feature flag is disabled. // InitProvider holds the same fields as ForProvider, with the exception // of Identifier and other resource reference fields. The fields that are // in InitProvider are merged into ForProvider when the resource is created. // The same fields are also added to the terraform ignore_changes hook, to // avoid updating them after creation. This is useful for fields that are // required on creation, but we do not desire to update them after creation, // for example because of an external controller is managing them, like an // autoscaler. InitProvider PolicyInitParameters `json:"initProvider,omitempty"` }
PolicySpec defines the desired state of Policy
func (*PolicySpec) DeepCopy ¶
func (in *PolicySpec) DeepCopy() *PolicySpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolicySpec.
func (*PolicySpec) DeepCopyInto ¶
func (in *PolicySpec) DeepCopyInto(out *PolicySpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PolicyStatus ¶
type PolicyStatus struct { v1.ResourceStatus `json:",inline"` AtProvider PolicyObservation `json:"atProvider,omitempty"` }
PolicyStatus defines the observed state of Policy.
func (*PolicyStatus) DeepCopy ¶
func (in *PolicyStatus) DeepCopy() *PolicyStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolicyStatus.
func (*PolicyStatus) DeepCopyInto ¶
func (in *PolicyStatus) DeepCopyInto(out *PolicyStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.