v1

package
v0.5.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 3, 2024 License: BSD-3-Clause Imports: 9 Imported by: 4

Documentation

Overview

Package v1 contains the v1 group cloudscale.crossplane.io resources of provider-cloudscale.

Index

Constants

View Source 
const (
	// AccessKeyIDName is the environment variable name for the S3 access key ("username")
	AccessKeyIDName = "AWS_ACCESS_KEY_ID"
	// SecretAccessKeyName is the environment variable name for the S3 secret key ("password")
	SecretAccessKeyName = "AWS_SECRET_ACCESS_KEY"
)
View Source 
const (
	Group   = "cloudscale.crossplane.io"
	Version = "v1"
)

Package type metadata.

Variables

View Source 
var (
	BucketKind             = reflect.TypeOf(Bucket{}).Name()
	BucketGroupKind        = schema.GroupKind{Group: Group, Kind: BucketKind}.String()
	BucketKindAPIVersion   = BucketKind + "." + SchemeGroupVersion.String()
	BucketGroupVersionKind = SchemeGroupVersion.WithKind(BucketKind)
)

Bucket type metadata.

View Source 
var (
	// SchemeGroupVersion is group version used to register these objects
	SchemeGroupVersion = schema.GroupVersion{Group: Group, Version: Version}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}
)
View Source 
var (
	ObjectsUserKind             = reflect.TypeOf(ObjectsUser{}).Name()
	ObjectsUserGroupKind        = schema.GroupKind{Group: Group, Kind: ObjectsUserKind}.String()
	ObjectsUserKindAPIVersion   = ObjectsUserKind + "." + SchemeGroupVersion.String()
	ObjectsUserGroupVersionKind = SchemeGroupVersion.WithKind(ObjectsUserKind)
)

ObjectsUser type metadata.

Functions

This section is empty.

Types

type Bucket 

type Bucket struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   BucketSpec   `json:"spec"`
	Status BucketStatus `json:"status,omitempty"`
}

Bucket is the API for creating S3 buckets.

func (*Bucket) DeepCopy 

func (in *Bucket) DeepCopy() *Bucket

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Bucket.

func (*Bucket) DeepCopyInto 

func (in *Bucket) DeepCopyInto(out *Bucket)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Bucket) DeepCopyObject 

func (in *Bucket) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Bucket) GetBucketName 

func (in *Bucket) GetBucketName() string

GetBucketName returns the spec.forProvider.bucketName if given, otherwise defaults to metadata.name.

func (*Bucket) GetCondition 

func (mg *Bucket) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this Bucket.

func (*Bucket) GetDeletionPolicy 

func (mg *Bucket) GetDeletionPolicy() xpv1.DeletionPolicy

GetDeletionPolicy of this Bucket.

func (*Bucket) GetManagementPolicies added in v0.5.1 

func (mg *Bucket) GetManagementPolicies() xpv1.ManagementPolicies

GetManagementPolicies of this Bucket.

func (*Bucket) GetProviderConfigReference 

func (mg *Bucket) GetProviderConfigReference() *xpv1.Reference

GetProviderConfigReference of this Bucket.

func (*Bucket) GetPublishConnectionDetailsTo 

func (mg *Bucket) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo

GetPublishConnectionDetailsTo of this Bucket.

func (*Bucket) GetWriteConnectionSecretToReference 

func (mg *Bucket) GetWriteConnectionSecretToReference() *xpv1.SecretReference

GetWriteConnectionSecretToReference of this Bucket.

func (*Bucket) SetConditions 

func (mg *Bucket) SetConditions(c ...xpv1.Condition)

SetConditions of this Bucket.

func (*Bucket) SetDeletionPolicy 

func (mg *Bucket) SetDeletionPolicy(r xpv1.DeletionPolicy)

SetDeletionPolicy of this Bucket.

func (*Bucket) SetManagementPolicies added in v0.5.1 

func (mg *Bucket) SetManagementPolicies(r xpv1.ManagementPolicies)

SetManagementPolicies of this Bucket.

func (*Bucket) SetProviderConfigReference 

func (mg *Bucket) SetProviderConfigReference(r *xpv1.Reference)

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 BucketDeletionPolicy added in v0.3.0 

type BucketDeletionPolicy string

BucketDeletionPolicy determines how buckets should be deleted when a Bucket is deleted. 

const (
	// DeleteIfEmpty only deletes the bucket if the bucket is empty.
	DeleteIfEmpty BucketDeletionPolicy = "DeleteIfEmpty"
	// DeleteAll recursively deletes all objects in the bucket and then removes it.
	DeleteAll BucketDeletionPolicy = "DeleteAll"
)

type BucketList 

type BucketList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Bucket `json:"items"`
}

BucketList contains a list of Bucket

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 {
	// BucketName is the name of the actual bucket.
	BucketName string `json:"bucketName,omitempty"`
}

BucketObservation are the observable fields of a Bucket.

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 {

	// CredentialsSecretRef contains the reference of the Secret where the credentials of the S3 user are stored.
	// The secret must contain the keys `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
	CredentialsSecretRef corev1.SecretReference `json:"credentialsSecretRef"`

	// Deprecated: Only here for compatibility with legacy Bucket objects
	EndpointURL string `json:"endpointURL,omitempty"`

	// BucketName is the name of the bucket to create.
	// Defaults to `metadata.name` if unset.
	// Cannot be changed after bucket is created.
	// Name must be acceptable by the S3 protocol, which follows RFC 1123.
	// Be aware that S3 providers may require a unique name across the platform or region.
	BucketName string `json:"bucketName,omitempty"`

	// Region is the name of the region where the bucket shall be created.
	// The region must be available in the S3 endpoint.
	// Cannot be changed after bucket is created.
	Region string `json:"region"`

	// BucketDeletionPolicy determines how buckets should be deleted when Bucket is deleted.
	//  `DeleteIfEmpty` only deletes the bucket if the bucket is empty.
	//  `DeleteAll` recursively deletes all objects in the bucket and then removes it.
	// To skip deletion of the bucket (orphan it) set `spec.deletionPolicy=Orphan`.
	BucketDeletionPolicy BucketDeletionPolicy `json:"bucketDeletionPolicy,omitempty"`
}

BucketParameters are the configurable fields of a Bucket.

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 {
	xpv1.ResourceSpec `json:",inline"`
	ForProvider       BucketParameters `json:"forProvider"`
}

BucketSpec defines the desired state of a 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 {
	xpv1.ResourceStatus `json:",inline"`
	Endpoint            string            `json:"endpoint,omitempty"`
	EndpointURL         string            `json:"endpointURL,omitempty"`
	AtProvider          BucketObservation `json:"atProvider,omitempty"`
}

BucketStatus represents the observed state of a 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.

type ObjectsUser 

type ObjectsUser struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   ObjectsUserSpec   `json:"spec"`
	Status ObjectsUserStatus `json:"status,omitempty"`
}

ObjectsUser is the API for creating S3 Objects users on cloudscale.ch.

func (*ObjectsUser) DeepCopy 

func (in *ObjectsUser) DeepCopy() *ObjectsUser

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ObjectsUser.

func (*ObjectsUser) DeepCopyInto 

func (in *ObjectsUser) DeepCopyInto(out *ObjectsUser)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ObjectsUser) DeepCopyObject 

func (in *ObjectsUser) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ObjectsUser) GetCondition 

func (mg *ObjectsUser) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this ObjectsUser.

func (*ObjectsUser) GetDeletionPolicy 

func (mg *ObjectsUser) GetDeletionPolicy() xpv1.DeletionPolicy

GetDeletionPolicy of this ObjectsUser.

func (*ObjectsUser) GetDisplayName 

func (in *ObjectsUser) GetDisplayName() string

GetDisplayName returns the ObjectsUser display name in the following precedence: 

.spec.forProvider.displayName
.metadata.annotations."crossplane.io/external-name"
.metadata.name

func (*ObjectsUser) GetManagementPolicies added in v0.5.1 

func (mg *ObjectsUser) GetManagementPolicies() xpv1.ManagementPolicies

GetManagementPolicies of this ObjectsUser.

func (*ObjectsUser) GetProviderConfigReference 

func (mg *ObjectsUser) GetProviderConfigReference() *xpv1.Reference

GetProviderConfigReference of this ObjectsUser.

func (*ObjectsUser) GetPublishConnectionDetailsTo 

func (mg *ObjectsUser) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo

GetPublishConnectionDetailsTo of this ObjectsUser.

func (*ObjectsUser) GetWriteConnectionSecretToReference 

func (mg *ObjectsUser) GetWriteConnectionSecretToReference() *xpv1.SecretReference

GetWriteConnectionSecretToReference of this ObjectsUser.

func (*ObjectsUser) SetConditions 

func (mg *ObjectsUser) SetConditions(c ...xpv1.Condition)

SetConditions of this ObjectsUser.

func (*ObjectsUser) SetDeletionPolicy 

func (mg *ObjectsUser) SetDeletionPolicy(r xpv1.DeletionPolicy)

SetDeletionPolicy of this ObjectsUser.

func (*ObjectsUser) SetManagementPolicies added in v0.5.1 

func (mg *ObjectsUser) SetManagementPolicies(r xpv1.ManagementPolicies)

SetManagementPolicies of this ObjectsUser.

func (*ObjectsUser) SetProviderConfigReference 

func (mg *ObjectsUser) SetProviderConfigReference(r *xpv1.Reference)

SetProviderConfigReference of this ObjectsUser.

func (*ObjectsUser) SetPublishConnectionDetailsTo 

func (mg *ObjectsUser) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)

SetPublishConnectionDetailsTo of this ObjectsUser.

func (*ObjectsUser) SetWriteConnectionSecretToReference 

func (mg *ObjectsUser) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)

SetWriteConnectionSecretToReference of this ObjectsUser.

type ObjectsUserList 

type ObjectsUserList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []ObjectsUser `json:"items"`
}

ObjectsUserList contains a list of ObjectsUser

func (*ObjectsUserList) DeepCopy 

func (in *ObjectsUserList) DeepCopy() *ObjectsUserList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ObjectsUserList.

func (*ObjectsUserList) DeepCopyInto 

func (in *ObjectsUserList) DeepCopyInto(out *ObjectsUserList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ObjectsUserList) DeepCopyObject 

func (in *ObjectsUserList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ObjectsUserList) GetItems 

func (l *ObjectsUserList) GetItems() []resource.Managed

GetItems of this ObjectsUserList.

type ObjectsUserObservation 

type ObjectsUserObservation struct {
	// UserID is the unique ID as generated by cloudscale.ch.
	UserID string `json:"userID,omitempty"`
	// Tags contains the key-value map as observed in cloudscale.ch
	Tags Tags `json:"tags,omitempty"`
	// DisplayName is the observed name of the ObjectsUser.
	DisplayName string `json:"displayName,omitempty"`
}

ObjectsUserObservation contains the observed fields of an ObjectsUser.

func (*ObjectsUserObservation) DeepCopy 

func (in *ObjectsUserObservation) DeepCopy() *ObjectsUserObservation

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ObjectsUserObservation.

func (*ObjectsUserObservation) DeepCopyInto 

func (in *ObjectsUserObservation) DeepCopyInto(out *ObjectsUserObservation)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ObjectsUserParameters 

type ObjectsUserParameters struct {
	// DisplayName is the name of the objects user as presented in the cloudscale.ch UI.
	// If empty, the value of `.metadata.annotations."crossplane.io/external-name"` is used.
	// There can be multiple users that have the same display name in cloudscale.ch, but they will have different user IDs.
	DisplayName string `json:"displayName,omitempty"`

	// Tags contain additional key-value information of an ObjectsUser.
	// If this map is empty, existing tags will be removed.
	Tags Tags `json:"tags,omitempty"`
}

ObjectsUserParameters are the configurable fields of an ObjectsUser.

func (*ObjectsUserParameters) DeepCopy 

func (in *ObjectsUserParameters) DeepCopy() *ObjectsUserParameters

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ObjectsUserParameters.

func (*ObjectsUserParameters) DeepCopyInto 

func (in *ObjectsUserParameters) DeepCopyInto(out *ObjectsUserParameters)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ObjectsUserSpec 

type ObjectsUserSpec struct {
	xpv1.ResourceSpec `json:",inline"`
	ForProvider       ObjectsUserParameters `json:"forProvider"`
}

ObjectsUserSpec defines the desired state of an ObjectsUser.

func (*ObjectsUserSpec) DeepCopy 

func (in *ObjectsUserSpec) DeepCopy() *ObjectsUserSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ObjectsUserSpec.

func (*ObjectsUserSpec) DeepCopyInto 

func (in *ObjectsUserSpec) DeepCopyInto(out *ObjectsUserSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ObjectsUserStatus 

type ObjectsUserStatus struct {
	xpv1.ResourceStatus `json:",inline"`

	AtProvider ObjectsUserObservation `json:"atProvider,omitempty"`
}

ObjectsUserStatus represents the observed state of a ObjectsUser.

func (*ObjectsUserStatus) DeepCopy 

func (in *ObjectsUserStatus) DeepCopy() *ObjectsUserStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ObjectsUserStatus.

func (*ObjectsUserStatus) DeepCopyInto 

func (in *ObjectsUserStatus) DeepCopyInto(out *ObjectsUserStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Tags 

type Tags map[string]string

Tags are additional key-value information that can be attached to cloudscale.ch resources.

func (Tags) DeepCopy 

func (in Tags) DeepCopy() Tags

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Tags.

func (Tags) DeepCopyInto 

func (in Tags) DeepCopyInto(out *Tags)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.