Documentation
¶
Overview ¶
+k8s:deepcopy-gen=package Package v1alpha1 is the v1alpha1 version of the dsql.services.k8s.aws API. +groupName=dsql.services.k8s.aws
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is the API Group Version used to register the objects GroupVersion = schema.GroupVersion{Group: "dsql.services.k8s.aws", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type Cluster ¶
type Cluster struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ClusterSpec `json:"spec,omitempty"`
Status ClusterStatus `json:"status,omitempty"`
}
Cluster is the Schema for the Clusters API +kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:printcolumn:name="ENDPOINT",type=string,priority=0,JSONPath=`.status.endpoint` +kubebuilder:printcolumn:name="ID",type=string,priority=0,JSONPath=`.status.identifier` +kubebuilder:printcolumn:name="STATUS",type=string,priority=0,JSONPath=`.status.status` +kubebuilder:printcolumn:name="Synced",type="string",priority=0,JSONPath=".status.conditions[?(@.type==\"ACK.ResourceSynced\")].status"
func (*Cluster) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Cluster.
func (*Cluster) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Cluster) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterList ¶
type ClusterList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Cluster `json:"items"`
}
ClusterList contains a list of Cluster +kubebuilder:object:root=true
func (*ClusterList) DeepCopy ¶
func (in *ClusterList) DeepCopy() *ClusterList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterList.
func (*ClusterList) DeepCopyInto ¶
func (in *ClusterList) DeepCopyInto(out *ClusterList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ClusterList) DeepCopyObject ¶
func (in *ClusterList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ClusterSpec ¶
type ClusterSpec struct {
// If enabled, you can't delete your cluster. You must first disable this property
// before you can delete your cluster.
DeletionProtectionEnabled *bool `json:"deletionProtectionEnabled,omitempty"`
// The KMS key that encrypts and protects the data on your cluster. You can
// specify the ARN, ID, or alias of an existing key or have Amazon Web Services
// create a default key for you.
//
// Regex Pattern: `^[a-zA-Z0-9:/_-]+$`
KMSEncryptionKey *string `json:"kmsEncryptionKey,omitempty"`
KMSEncryptionKeyRef *ackv1alpha1.AWSResourceReferenceWrapper `json:"kmsEncryptionKeyRef,omitempty"`
// The configuration settings when creating a multi-Region cluster, including
// the witness region and linked cluster properties.
MultiRegionProperties *MultiRegionProperties `json:"multiRegionProperties,omitempty"`
// An optional resource-based policy document in JSON format that defines access
// permissions for the cluster.
Policy *string `json:"policy,omitempty"`
// A map of key and value pairs to use to tag your cluster.
Tags map[string]*string `json:"tags,omitempty"`
}
ClusterSpec defines the desired state of Cluster.
func (*ClusterSpec) DeepCopy ¶
func (in *ClusterSpec) DeepCopy() *ClusterSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterSpec.
func (*ClusterSpec) DeepCopyInto ¶
func (in *ClusterSpec) DeepCopyInto(out *ClusterSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterStatus ¶
type ClusterStatus struct {
// All CRs managed by ACK have a common `Status.ACKResourceMetadata` member
// that is used to contain resource sync state, account ownership,
// constructed ARN for the resource
// +kubebuilder:validation:Optional
ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"`
// All CRs managed by ACK have a common `Status.Conditions` member that
// contains a collection of `ackv1alpha1.Condition` objects that describe
// the various terminal states of the CR and its backend AWS service API
// resource
// +kubebuilder:validation:Optional
Conditions []*ackv1alpha1.Condition `json:"conditions"`
// The time of when created the cluster.
// +kubebuilder:validation:Optional
CreationTime *metav1.Time `json:"creationTime,omitempty"`
// The encryption configuration for the cluster that was specified during the
// creation process, including the KMS key identifier and encryption state.
// +kubebuilder:validation:Optional
EncryptionDetails *EncryptionDetails `json:"encryptionDetails,omitempty"`
// The connection endpoint for the created cluster.
//
// Regex Pattern: `^[a-zA-Z0-9.-]+$`
// +kubebuilder:validation:Optional
Endpoint *string `json:"endpoint,omitempty"`
// The ID of the created cluster.
//
// Regex Pattern: `^[a-z0-9]{26}$`
// +kubebuilder:validation:Optional
Identifier *string `json:"identifier,omitempty"`
// The status of the created cluster.
// +kubebuilder:validation:Optional
Status *string `json:"status,omitempty"`
}
ClusterStatus defines the observed state of Cluster
func (*ClusterStatus) DeepCopy ¶
func (in *ClusterStatus) DeepCopy() *ClusterStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterStatus.
func (*ClusterStatus) DeepCopyInto ¶
func (in *ClusterStatus) DeepCopyInto(out *ClusterStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ClusterStatus_SDK ¶
type ClusterStatus_SDK string
const ( ClusterStatus_SDK_ACTIVE ClusterStatus_SDK = "ACTIVE" ClusterStatus_SDK_CREATING ClusterStatus_SDK = "CREATING" ClusterStatus_SDK_DELETED ClusterStatus_SDK = "DELETED" ClusterStatus_SDK_DELETING ClusterStatus_SDK = "DELETING" ClusterStatus_SDK_FAILED ClusterStatus_SDK = "FAILED" ClusterStatus_SDK_IDLE ClusterStatus_SDK = "IDLE" ClusterStatus_SDK_INACTIVE ClusterStatus_SDK = "INACTIVE" ClusterStatus_SDK_PENDING_DELETE ClusterStatus_SDK = "PENDING_DELETE" ClusterStatus_SDK_PENDING_SETUP ClusterStatus_SDK = "PENDING_SETUP" ClusterStatus_SDK_UPDATING ClusterStatus_SDK = "UPDATING" )
type ClusterSummary ¶
type ClusterSummary struct {
// The Amazon Resource Name of the cluster.
ARN *string `json:"arn,omitempty"`
// The ID of the cluster.
Identifier *string `json:"identifier,omitempty"`
}
A summary of the properties of a cluster.
func (*ClusterSummary) DeepCopy ¶
func (in *ClusterSummary) DeepCopy() *ClusterSummary
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterSummary.
func (*ClusterSummary) DeepCopyInto ¶
func (in *ClusterSummary) DeepCopyInto(out *ClusterSummary)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type EncryptionDetails ¶
type EncryptionDetails struct {
EncryptionStatus *string `json:"encryptionStatus,omitempty"`
EncryptionType *string `json:"encryptionType,omitempty"`
KMSKeyARN *string `json:"kmsKeyARN,omitempty"`
}
Configuration details about encryption for the cluster including the KMS key ARN, encryption type, and encryption status.
func (*EncryptionDetails) DeepCopy ¶
func (in *EncryptionDetails) DeepCopy() *EncryptionDetails
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EncryptionDetails.
func (*EncryptionDetails) DeepCopyInto ¶
func (in *EncryptionDetails) DeepCopyInto(out *EncryptionDetails)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type EncryptionStatus ¶
type EncryptionStatus string
const ( EncryptionStatus_ENABLED EncryptionStatus = "ENABLED" EncryptionStatus_ENABLING EncryptionStatus = "ENABLING" EncryptionStatus_KMS_KEY_INACCESSIBLE EncryptionStatus = "KMS_KEY_INACCESSIBLE" EncryptionStatus_UPDATING EncryptionStatus = "UPDATING" )
type EncryptionType ¶
type EncryptionType string
const ( EncryptionType_AWS_OWNED_KMS_KEY EncryptionType = "AWS_OWNED_KMS_KEY" EncryptionType_CUSTOMER_MANAGED_KMS_KEY EncryptionType = "CUSTOMER_MANAGED_KMS_KEY" )
type MultiRegionProperties ¶
type MultiRegionProperties struct {
// A list of the Amazon Resource Names of the cluster.
Clusters []*string `json:"clusters,omitempty"`
// Region name.
WitnessRegion *string `json:"witnessRegion,omitempty"`
}
Defines the structure for multi-Region cluster configurations, containing the witness region and linked cluster settings.
func (*MultiRegionProperties) DeepCopy ¶
func (in *MultiRegionProperties) DeepCopy() *MultiRegionProperties
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MultiRegionProperties.
func (*MultiRegionProperties) DeepCopyInto ¶
func (in *MultiRegionProperties) DeepCopyInto(out *MultiRegionProperties)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ValidationExceptionReason ¶
type ValidationExceptionReason string
const ( ValidationExceptionReason_cannotParse ValidationExceptionReason = "cannotParse" ValidationExceptionReason_deletionProtectionEnabled ValidationExceptionReason = "deletionProtectionEnabled" ValidationExceptionReason_fieldValidationFailed ValidationExceptionReason = "fieldValidationFailed" ValidationExceptionReason_other ValidationExceptionReason = "other" ValidationExceptionReason_unknownOperation ValidationExceptionReason = "unknownOperation" )