Documentation
¶
Overview ¶
+kubebuilder:object:generate=true +groupName=storage.boundary.upbound.io +versionName=v1alpha1
Index ¶
- Constants
- Variables
- type Bucket
- func (in *Bucket) DeepCopy() *Bucket
- func (in *Bucket) DeepCopyInto(out *Bucket)
- func (in *Bucket) DeepCopyObject() runtime.Object
- func (mg *Bucket) GetCondition(ct xpv1.ConditionType) xpv1.Condition
- func (tr *Bucket) GetConnectionDetailsMapping() map[string]string
- func (mg *Bucket) GetDeletionPolicy() xpv1.DeletionPolicy
- func (tr *Bucket) GetID() string
- func (tr *Bucket) GetInitParameters() (map[string]any, error)
- func (mg *Bucket) GetManagementPolicies() xpv1.ManagementPolicies
- func (tr *Bucket) GetMergedParameters(shouldMergeInitProvider bool) (map[string]any, error)
- func (tr *Bucket) GetObservation() (map[string]any, error)
- func (tr *Bucket) GetParameters() (map[string]any, error)
- func (mg *Bucket) GetProviderConfigReference() *xpv1.Reference
- func (mg *Bucket) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
- func (mg *Bucket) GetTerraformResourceType() string
- func (tr *Bucket) GetTerraformSchemaVersion() int
- func (mg *Bucket) GetWriteConnectionSecretToReference() *xpv1.SecretReference
- func (tr *Bucket) Hub()
- func (tr *Bucket) LateInitialize(attrs []byte) (bool, error)
- func (mg *Bucket) SetConditions(c ...xpv1.Condition)
- func (mg *Bucket) SetDeletionPolicy(r xpv1.DeletionPolicy)
- func (mg *Bucket) SetManagementPolicies(r xpv1.ManagementPolicies)
- func (tr *Bucket) SetObservation(obs map[string]any) error
- func (tr *Bucket) SetParameters(params map[string]any) error
- func (mg *Bucket) SetProviderConfigReference(r *xpv1.Reference)
- func (mg *Bucket) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
- func (mg *Bucket) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
- type BucketInitParameters
- type BucketList
- type BucketObservation
- type BucketParameters
- type BucketSpec
- type BucketStatus
Constants ¶
const ( CRDGroup = "storage.boundary.upbound.io" CRDVersion = "v1alpha1" )
Package type metadata.
Variables ¶
var ( Bucket_Kind = "Bucket" Bucket_GroupKind = schema.GroupKind{Group: CRDGroup, Kind: Bucket_Kind}.String() Bucket_KindAPIVersion = Bucket_Kind + "." + CRDGroupVersion.String() Bucket_GroupVersionKind = CRDGroupVersion.WithKind(Bucket_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 Bucket ¶
type Bucket 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.bucketName) || (has(self.initProvider) && has(self.initProvider.bucketName))",message="spec.forProvider.bucketName is a required parameter" // +kubebuilder:validation:XValidation:rule="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.scopeId) || (has(self.initProvider) && has(self.initProvider.scopeId))",message="spec.forProvider.scopeId is a required parameter" // +kubebuilder:validation:XValidation:rule="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.workerFilter) || (has(self.initProvider) && has(self.initProvider.workerFilter))",message="spec.forProvider.workerFilter is a required parameter" Spec BucketSpec `json:"spec"` Status BucketStatus `json:"status,omitempty"` }
Bucket is the Schema for the Buckets API. The storage bucket resource allows you to configure a Boundary storage bucket. A storage bucket can only belong to the Global scope or an Org scope. At this time, the only supported storage for storage buckets is AWS S3. This feature requires Boundary Enterprise or Boundary HCP. +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,boundary}
func (*Bucket) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Bucket.
func (*Bucket) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Bucket) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Bucket) GetCondition ¶
func (mg *Bucket) GetCondition(ct xpv1.ConditionType) xpv1.Condition
GetCondition of this Bucket.
func (*Bucket) GetConnectionDetailsMapping ¶
GetConnectionDetailsMapping for this Bucket
func (*Bucket) GetDeletionPolicy ¶
func (mg *Bucket) GetDeletionPolicy() xpv1.DeletionPolicy
GetDeletionPolicy of this Bucket.
func (*Bucket) GetInitParameters ¶
GetInitParameters of this Bucket
func (*Bucket) GetManagementPolicies ¶
func (mg *Bucket) GetManagementPolicies() xpv1.ManagementPolicies
GetManagementPolicies of this Bucket.
func (*Bucket) GetMergedParameters ¶ added in v1.1.0
GetInitParameters of this Bucket
func (*Bucket) GetObservation ¶
GetObservation of this Bucket
func (*Bucket) GetParameters ¶
GetParameters of this Bucket
func (*Bucket) GetProviderConfigReference ¶
GetProviderConfigReference of this Bucket.
func (*Bucket) GetPublishConnectionDetailsTo ¶
func (mg *Bucket) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
GetPublishConnectionDetailsTo of this Bucket.
func (*Bucket) GetTerraformResourceType ¶
GetTerraformResourceType returns Terraform resource type for this Bucket
func (*Bucket) GetTerraformSchemaVersion ¶
GetTerraformSchemaVersion returns the associated Terraform schema version
func (*Bucket) GetWriteConnectionSecretToReference ¶
func (mg *Bucket) GetWriteConnectionSecretToReference() *xpv1.SecretReference
GetWriteConnectionSecretToReference of this Bucket.
func (*Bucket) Hub ¶ added in v1.1.0
func (tr *Bucket) Hub()
Hub marks this type as a conversion hub.
func (*Bucket) LateInitialize ¶
LateInitialize this Bucket using its observed tfState. returns True if there are any spec changes for the resource.
func (*Bucket) SetConditions ¶
SetConditions of this Bucket.
func (*Bucket) SetDeletionPolicy ¶
func (mg *Bucket) SetDeletionPolicy(r xpv1.DeletionPolicy)
SetDeletionPolicy of this Bucket.
func (*Bucket) SetManagementPolicies ¶
func (mg *Bucket) SetManagementPolicies(r xpv1.ManagementPolicies)
SetManagementPolicies of this Bucket.
func (*Bucket) SetObservation ¶
SetObservation for this Bucket
func (*Bucket) SetParameters ¶
SetParameters for this Bucket
func (*Bucket) SetProviderConfigReference ¶
SetProviderConfigReference of this Bucket.
func (*Bucket) SetPublishConnectionDetailsTo ¶
func (mg *Bucket) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
SetPublishConnectionDetailsTo of this Bucket.
func (*Bucket) SetWriteConnectionSecretToReference ¶
func (mg *Bucket) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
SetWriteConnectionSecretToReference of this Bucket.
type BucketInitParameters ¶
type BucketInitParameters struct { // escaped JSON string, or a file:// or env:// path. Set to a string "null" or remove the block to clear all attributes in the storage bucket. // The attributes for the storage bucket. The "region" attribute field is required when creating an AWS storage bucket. Values are either encoded with the "jsonencode" function, pre-escaped JSON string, or a file:// or env:// path. Set to a string "null" or remove the block to clear all attributes in the storage bucket. AttributesJSON *string `json:"attributesJson,omitempty" tf:"attributes_json,omitempty"` // (String) The name of the bucket within the external object store service. // The name of the bucket within the external object store service. BucketName *string `json:"bucketName,omitempty" tf:"bucket_name,omitempty"` // (String) The prefix used to organize the data held within the external object store. // The prefix used to organize the data held within the external object store. BucketPrefix *string `json:"bucketPrefix,omitempty" tf:"bucket_prefix,omitempty"` // (String) The storage bucket description. // The storage bucket description. Description *string `json:"description,omitempty" tf:"description,omitempty"` // (String) The storage bucket name. Defaults to the resource name. // The storage bucket name. Defaults to the resource name. Name *string `json:"name,omitempty" tf:"name,omitempty"` // (String) The ID of the plugin that should back the resource. This or plugin_name must be defined. // The ID of the plugin that should back the resource. This or plugin_name must be defined. PluginID *string `json:"pluginId,omitempty" tf:"plugin_id,omitempty"` // (String) The name of the plugin that should back the resource. This or plugin_id must be defined. // The name of the plugin that should back the resource. This or plugin_id must be defined. PluginName *string `json:"pluginName,omitempty" tf:"plugin_name,omitempty"` // (String) The scope for this storage bucket. // The scope for this storage bucket. ScopeID *string `json:"scopeId,omitempty" tf:"scope_id,omitempty"` // escaped JSON string, or a file:// or env:// path. Set to a string "null" to clear any existing values. NOTE: Unlike "attributes_json", removing this block will NOT clear secrets from the storage bucket; this allows injecting secrets for one call, then removing them for storage. // The secrets for the storage bucket. Either values encoded with the "jsonencode" function, pre-escaped JSON string, or a file:// or env:// path. Set to a string "null" to clear any existing values. NOTE: Unlike "attributes_json", removing this block will NOT clear secrets from the storage bucket; this allows injecting secrets for one call, then removing them for storage. SecretsJSONSecretRef *v1.SecretKeySelector `json:"secretsJsonSecretRef,omitempty" tf:"-"` // (String) Filters to the worker(s) that can handle requests for this storage bucket. The filter must match an existing worker in order to create a storage bucket. // Filters to the worker(s) that can handle requests for this storage bucket. The filter must match an existing worker in order to create a storage bucket. WorkerFilter *string `json:"workerFilter,omitempty" tf:"worker_filter,omitempty"` }
func (*BucketInitParameters) DeepCopy ¶
func (in *BucketInitParameters) DeepCopy() *BucketInitParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BucketInitParameters.
func (*BucketInitParameters) DeepCopyInto ¶
func (in *BucketInitParameters) DeepCopyInto(out *BucketInitParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BucketList ¶
type BucketList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Bucket `json:"items"` }
BucketList contains a list of Buckets
func (*BucketList) DeepCopy ¶
func (in *BucketList) DeepCopy() *BucketList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BucketList.
func (*BucketList) DeepCopyInto ¶
func (in *BucketList) DeepCopyInto(out *BucketList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BucketList) DeepCopyObject ¶
func (in *BucketList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*BucketList) GetItems ¶
func (l *BucketList) GetItems() []resource.Managed
GetItems of this BucketList.
type BucketObservation ¶
type BucketObservation struct { // escaped JSON string, or a file:// or env:// path. Set to a string "null" or remove the block to clear all attributes in the storage bucket. // The attributes for the storage bucket. The "region" attribute field is required when creating an AWS storage bucket. Values are either encoded with the "jsonencode" function, pre-escaped JSON string, or a file:// or env:// path. Set to a string "null" or remove the block to clear all attributes in the storage bucket. AttributesJSON *string `json:"attributesJson,omitempty" tf:"attributes_json,omitempty"` // (String) The name of the bucket within the external object store service. // The name of the bucket within the external object store service. BucketName *string `json:"bucketName,omitempty" tf:"bucket_name,omitempty"` // (String) The prefix used to organize the data held within the external object store. // The prefix used to organize the data held within the external object store. BucketPrefix *string `json:"bucketPrefix,omitempty" tf:"bucket_prefix,omitempty"` // (String) The storage bucket description. // The storage bucket description. Description *string `json:"description,omitempty" tf:"description,omitempty"` // (String) The ID of the storage bucket. ID *string `json:"id,omitempty" tf:"id,omitempty"` // (String) Internal only. Used to force update so that we can always check the value of secrets. // Internal only. Used to force update so that we can always check the value of secrets. InternalForceUpdate *string `json:"internalForceUpdate,omitempty" tf:"internal_force_update,omitempty"` // provided HMAC used to calculate the current value of the HMAC'd config. Used for drift detection. // Internal only. The Boundary-provided HMAC used to calculate the current value of the HMAC'd config. Used for drift detection. InternalHMACUsedForSecretsConfigHMAC *string `json:"internalHmacUsedForSecretsConfigHmac,omitempty" tf:"internal_hmac_used_for_secrets_config_hmac,omitempty"` // (String) Internal only. HMAC of (serverSecretsHmac + config secrets). Used for proper secrets handling. // Internal only. HMAC of (serverSecretsHmac + config secrets). Used for proper secrets handling. InternalSecretsConfigHMAC *string `json:"internalSecretsConfigHmac,omitempty" tf:"internal_secrets_config_hmac,omitempty"` // (String) The storage bucket name. Defaults to the resource name. // The storage bucket name. Defaults to the resource name. Name *string `json:"name,omitempty" tf:"name,omitempty"` // (String) The ID of the plugin that should back the resource. This or plugin_name must be defined. // The ID of the plugin that should back the resource. This or plugin_name must be defined. PluginID *string `json:"pluginId,omitempty" tf:"plugin_id,omitempty"` // (String) The name of the plugin that should back the resource. This or plugin_id must be defined. // The name of the plugin that should back the resource. This or plugin_id must be defined. PluginName *string `json:"pluginName,omitempty" tf:"plugin_name,omitempty"` // (String) The scope for this storage bucket. // The scope for this storage bucket. ScopeID *string `json:"scopeId,omitempty" tf:"scope_id,omitempty"` // (String) The HMAC'd secrets value returned from the server. // The HMAC'd secrets value returned from the server. SecretsHMAC *string `json:"secretsHmac,omitempty" tf:"secrets_hmac,omitempty"` // (String) Filters to the worker(s) that can handle requests for this storage bucket. The filter must match an existing worker in order to create a storage bucket. // Filters to the worker(s) that can handle requests for this storage bucket. The filter must match an existing worker in order to create a storage bucket. WorkerFilter *string `json:"workerFilter,omitempty" tf:"worker_filter,omitempty"` }
func (*BucketObservation) DeepCopy ¶
func (in *BucketObservation) DeepCopy() *BucketObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BucketObservation.
func (*BucketObservation) DeepCopyInto ¶
func (in *BucketObservation) DeepCopyInto(out *BucketObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BucketParameters ¶
type BucketParameters struct { // escaped JSON string, or a file:// or env:// path. Set to a string "null" or remove the block to clear all attributes in the storage bucket. // The attributes for the storage bucket. The "region" attribute field is required when creating an AWS storage bucket. Values are either encoded with the "jsonencode" function, pre-escaped JSON string, or a file:// or env:// path. Set to a string "null" or remove the block to clear all attributes in the storage bucket. // +kubebuilder:validation:Optional AttributesJSON *string `json:"attributesJson,omitempty" tf:"attributes_json,omitempty"` // (String) The name of the bucket within the external object store service. // The name of the bucket within the external object store service. // +kubebuilder:validation:Optional BucketName *string `json:"bucketName,omitempty" tf:"bucket_name,omitempty"` // (String) The prefix used to organize the data held within the external object store. // The prefix used to organize the data held within the external object store. // +kubebuilder:validation:Optional BucketPrefix *string `json:"bucketPrefix,omitempty" tf:"bucket_prefix,omitempty"` // (String) The storage bucket description. // The storage bucket description. // +kubebuilder:validation:Optional Description *string `json:"description,omitempty" tf:"description,omitempty"` // (String) The storage bucket name. Defaults to the resource name. // The storage bucket name. Defaults to the resource name. // +kubebuilder:validation:Optional Name *string `json:"name,omitempty" tf:"name,omitempty"` // (String) The ID of the plugin that should back the resource. This or plugin_name must be defined. // The ID of the plugin that should back the resource. This or plugin_name must be defined. // +kubebuilder:validation:Optional PluginID *string `json:"pluginId,omitempty" tf:"plugin_id,omitempty"` // (String) The name of the plugin that should back the resource. This or plugin_id must be defined. // The name of the plugin that should back the resource. This or plugin_id must be defined. // +kubebuilder:validation:Optional PluginName *string `json:"pluginName,omitempty" tf:"plugin_name,omitempty"` // (String) The scope for this storage bucket. // The scope for this storage bucket. // +kubebuilder:validation:Optional ScopeID *string `json:"scopeId,omitempty" tf:"scope_id,omitempty"` // escaped JSON string, or a file:// or env:// path. Set to a string "null" to clear any existing values. NOTE: Unlike "attributes_json", removing this block will NOT clear secrets from the storage bucket; this allows injecting secrets for one call, then removing them for storage. // The secrets for the storage bucket. Either values encoded with the "jsonencode" function, pre-escaped JSON string, or a file:// or env:// path. Set to a string "null" to clear any existing values. NOTE: Unlike "attributes_json", removing this block will NOT clear secrets from the storage bucket; this allows injecting secrets for one call, then removing them for storage. // +kubebuilder:validation:Optional SecretsJSONSecretRef *v1.SecretKeySelector `json:"secretsJsonSecretRef,omitempty" tf:"-"` // (String) Filters to the worker(s) that can handle requests for this storage bucket. The filter must match an existing worker in order to create a storage bucket. // Filters to the worker(s) that can handle requests for this storage bucket. The filter must match an existing worker in order to create a storage bucket. // +kubebuilder:validation:Optional WorkerFilter *string `json:"workerFilter,omitempty" tf:"worker_filter,omitempty"` }
func (*BucketParameters) DeepCopy ¶
func (in *BucketParameters) DeepCopy() *BucketParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BucketParameters.
func (*BucketParameters) DeepCopyInto ¶
func (in *BucketParameters) DeepCopyInto(out *BucketParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BucketSpec ¶
type BucketSpec struct { v1.ResourceSpec `json:",inline"` ForProvider BucketParameters `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 BucketInitParameters `json:"initProvider,omitempty"` }
BucketSpec defines the desired state of Bucket
func (*BucketSpec) DeepCopy ¶
func (in *BucketSpec) DeepCopy() *BucketSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BucketSpec.
func (*BucketSpec) DeepCopyInto ¶
func (in *BucketSpec) DeepCopyInto(out *BucketSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BucketStatus ¶
type BucketStatus struct { v1.ResourceStatus `json:",inline"` AtProvider BucketObservation `json:"atProvider,omitempty"` }
BucketStatus defines the observed state of Bucket.
func (*BucketStatus) DeepCopy ¶
func (in *BucketStatus) DeepCopy() *BucketStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BucketStatus.
func (*BucketStatus) DeepCopyInto ¶
func (in *BucketStatus) DeepCopyInto(out *BucketStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.