Documentation ¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the storage v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/crossplaneio/crossplane/pkg/apis/aws/storage +k8s:defaulter-gen=TypeMeta +groupName=storage.aws.crossplane.io
Package v1alpha1 contains API Schema definitions for the storage v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/crossplaneio/crossplane/pkg/apis/aws/storage +k8s:defaulter-gen=TypeMeta +groupName=storage.aws.crossplane.io
Index ¶
- Constants
- Variables
- type S3Bucket
- func (b *S3Bucket) ConnectionSecretName() string
- func (in *S3Bucket) DeepCopy() *S3Bucket
- func (in *S3Bucket) DeepCopyInto(out *S3Bucket)
- func (in *S3Bucket) DeepCopyObject() runtime.Object
- func (b *S3Bucket) Endpoint() string
- func (b *S3Bucket) HasPolicyChanged(policyVersion string) (bool, error)
- func (b *S3Bucket) IsAvailable() bool
- func (b *S3Bucket) IsBound() bool
- func (b *S3Bucket) ObjectReference() *v1.ObjectReference
- func (b *S3Bucket) OwnerReference() metav1.OwnerReference
- func (b *S3Bucket) SetBound(bound bool)
- func (b *S3Bucket) SetUserPolicyVersion(policyVersion string) error
- type S3BucketList
- type S3BucketSpec
- type S3BucketStatus
Constants ¶
const ( Group = "storage.aws.crossplane.io" Version = "v1alpha1" APIVersion = Group + "/" + Version S3BucketKind = "S3Bucket" S3BucketKindAPIVersion = "s3bucket" + "." + APIVersion )
Kubernetes Group, Version, and Kind metadata.
Variables ¶
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} )
Functions ¶
This section is empty.
Types ¶
type S3Bucket ¶
type S3Bucket struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec S3BucketSpec `json:"spec,omitempty"` Status S3BucketStatus `json:"status,omitempty"` }
S3Bucket is the Schema for the S3Bucket API +k8s:openapi-gen=true +groupName=storage.aws +kubebuilder:printcolumn:name="CLASS",type="string",JSONPath=".spec.classRef.name" +kubebuilder:printcolumn:name="PREDEFINED-ACL",type="string",JSONPath=".spec.cannedACL" +kubebuilder:printcolumn:name="LOCAL-PERMISSION",type="string",JSONPath=".spec.localPermission" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp"
func (*S3Bucket) ConnectionSecretName ¶ added in v0.2.0
ConnectionSecretName returns the name of the connection secret
func (*S3Bucket) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new S3Bucket.
func (*S3Bucket) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*S3Bucket) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*S3Bucket) HasPolicyChanged ¶ added in v0.2.0
HasPolicyChanged returns true if the bucket's policy is older than the supplied version.
func (*S3Bucket) IsAvailable ¶ added in v0.2.0
IsAvailable for usage/binding
func (*S3Bucket) IsBound ¶ added in v0.2.0
IsBound returns true if this bucket is bound to a resource claim.
func (*S3Bucket) ObjectReference ¶ added in v0.2.0
func (b *S3Bucket) ObjectReference() *v1.ObjectReference
ObjectReference to this S3Bucket
func (*S3Bucket) OwnerReference ¶ added in v0.2.0
func (b *S3Bucket) OwnerReference() metav1.OwnerReference
OwnerReference to use this instance as an owner
func (*S3Bucket) SetBound ¶ added in v0.2.0
SetBound specifies whether this bucket is bound to a resource claim.
func (*S3Bucket) SetUserPolicyVersion ¶ added in v0.2.0
SetUserPolicyVersion specifies this bucket's policy version.
type S3BucketList ¶
type S3BucketList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []S3Bucket `json:"items"` }
S3BucketList contains a list of S3Buckets
func (*S3BucketList) DeepCopy ¶
func (in *S3BucketList) DeepCopy() *S3BucketList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new S3BucketList.
func (*S3BucketList) DeepCopyInto ¶
func (in *S3BucketList) DeepCopyInto(out *S3BucketList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*S3BucketList) DeepCopyObject ¶
func (in *S3BucketList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type S3BucketSpec ¶
type S3BucketSpec struct { // +kubebuilder:validation:MaxLength=63 // +kubebuilder:validation:MinLength=3 Name string `json:"name,omitempty"` // Region is the aws region for the bucket Region string `json:"region"` // CannedACL applies a standard aws built-in ACL for common bucket use cases. // +kubebuilder:validation:Enum=private,public-read,public-read-write,authenticated-read,log-delivery-write,aws-exec-read CannedACL *s3.BucketCannedACL `json:"cannedACL,omitempty"` Versioning bool `json:"versioning,omitempty"` // +kubebuilder:validation:MaxLength=255 // +kubebuilder:validation:MinLength=1 ConnectionSecretNameOverride string `json:"connectionSecretNameOverride,omitempty"` // LocalPermission is the permissions granted on the bucket for the provider specific // bucket service account that is available in a secret after provisioning. // +kubebuilder:validation:Enum=Read,Write,ReadWrite LocalPermission *storagev1alpha1.LocalPermissionType `json:"localPermission"` ProviderRef v1.LocalObjectReference `json:"providerRef"` ClaimRef *v1.ObjectReference `json:"claimRef,omitempty"` ClassRef *v1.ObjectReference `json:"classRef,omitempty"` // ReclaimPolicy identifies how to handle the cloud resource after the deletion of this type ReclaimPolicy corev1alpha1.ReclaimPolicy `json:"reclaimPolicy,omitempty"` }
S3BucketSpec defines the desired state of S3Bucket
func NewS3BucketSpec ¶ added in v0.2.0
func NewS3BucketSpec(properties map[string]string) *S3BucketSpec
NewS3BucketSpec from properties map
func (*S3BucketSpec) DeepCopy ¶
func (in *S3BucketSpec) DeepCopy() *S3BucketSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new S3BucketSpec.
func (*S3BucketSpec) DeepCopyInto ¶
func (in *S3BucketSpec) DeepCopyInto(out *S3BucketSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type S3BucketStatus ¶
type S3BucketStatus struct { corev1alpha1.ConditionedStatus corev1alpha1.BindingStatusPhase Message string `json:"message,omitempty"` ProviderID string `json:"providerID,omitempty"` // the external ID to identify this resource in the cloud provider ConnectionSecretRef v1.LocalObjectReference `json:"connectionSecretRef,omitempty"` IAMUsername string `json:"iamUsername,omitempty"` LastUserPolicyVersion int `json:"lastUserPolicyVersion,omitempty"` LastLocalPermission storagev1alpha1.LocalPermissionType `json:"lastLocalPermission,omitempty"` }
S3BucketStatus defines the observed state of S3Bucket
func (*S3BucketStatus) DeepCopy ¶
func (in *S3BucketStatus) DeepCopy() *S3BucketStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new S3BucketStatus.
func (*S3BucketStatus) DeepCopyInto ¶
func (in *S3BucketStatus) DeepCopyInto(out *S3BucketStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.