v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the rds v1alpha1 API group +kubebuilder:object:generate=true +groupName=rds.services.k8s.aws.adobe.io

Index

• Variables
• type DBReplicationGroup
  • func (in *DBReplicationGroup) DeepCopy() *DBReplicationGroup
  • func (in *DBReplicationGroup) DeepCopyInto(out *DBReplicationGroup)
  • func (in *DBReplicationGroup) DeepCopyObject() runtime.Object
• type DBReplicationGroupList
  • func (in *DBReplicationGroupList) DeepCopy() *DBReplicationGroupList
  • func (in *DBReplicationGroupList) DeepCopyInto(out *DBReplicationGroupList)
  • func (in *DBReplicationGroupList) DeepCopyObject() runtime.Object
• type DBReplicationGroupSpec
  • func (in *DBReplicationGroupSpec) DeepCopy() *DBReplicationGroupSpec
  • func (in *DBReplicationGroupSpec) DeepCopyInto(out *DBReplicationGroupSpec)
• type DBReplicationGroupStatus
  • func (in *DBReplicationGroupStatus) DeepCopy() *DBReplicationGroupStatus
  • func (in *DBReplicationGroupStatus) DeepCopyInto(out *DBReplicationGroupStatus)
• type DBUser
  • func (in *DBUser) DeepCopy() *DBUser
  • func (in *DBUser) DeepCopyInto(out *DBUser)
  • func (in *DBUser) DeepCopyObject() runtime.Object
• type DBUserList
  • func (in *DBUserList) DeepCopy() *DBUserList
  • func (in *DBUserList) DeepCopyInto(out *DBUserList)
  • func (in *DBUserList) DeepCopyObject() runtime.Object
• type DBUserSpec
  • func (in *DBUserSpec) DeepCopy() *DBUserSpec
  • func (in *DBUserSpec) DeepCopyInto(out *DBUserSpec)
• type DBUserStatus
  • func (in *DBUserStatus) DeepCopy() *DBUserStatus
  • func (in *DBUserStatus) DeepCopyInto(out *DBUserStatus)
• type Engine
• type IdentifierType

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "rds.services.k8s.aws.adobe.io", 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
)

Types

type DBReplicationGroup

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

	Spec   DBReplicationGroupSpec   `json:"spec,omitempty"`
	Status DBReplicationGroupStatus `json:"status,omitempty"`
}

DBReplicationGroup is the Schema for the dbreplicationgroups API

func (*DBReplicationGroup) DeepCopy

func (in *DBReplicationGroup) DeepCopy() *DBReplicationGroup

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

func (*DBReplicationGroup) DeepCopyInto

func (in *DBReplicationGroup) DeepCopyInto(out *DBReplicationGroup)

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

func (*DBReplicationGroup) DeepCopyObject

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

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

type DBReplicationGroupList

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

DBReplicationGroupList contains a list of DBReplicationGroup objects

func (*DBReplicationGroupList) DeepCopy

func (in *DBReplicationGroupList) DeepCopy() *DBReplicationGroupList

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

func (*DBReplicationGroupList) DeepCopyInto

func (in *DBReplicationGroupList) DeepCopyInto(out *DBReplicationGroupList)

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

func (*DBReplicationGroupList) DeepCopyObject

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

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

type DBReplicationGroupSpec

type DBReplicationGroupSpec struct {
	// NumReplicas is the number of replicas to create
	// +kubebuilder:validation:Required
	NumReplicas *int `json:"numReplicas"`

	// DBInstance is the base DBInstance specification. All replica instances are cloned from this specification.
	//
	// Note: the DBInstance.AvailabilityZone specification will be overridden by the main AvailabilityZone specification above in each replica.
	// Note: the DBInstance.MultiAZ specification will be explicitly overridden to false
	//
	// For more information see the ACK RDS Controller DBInstance API
	//
	// +kubebuilder:validation:Required
	DBInstance *rdstypes.DBInstanceSpec `json:"dbInstance"`
}

DBReplicationGroupSpec defines the desired state of DBReplicationGroup

func (*DBReplicationGroupSpec) DeepCopy

func (in *DBReplicationGroupSpec) DeepCopy() *DBReplicationGroupSpec

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

func (*DBReplicationGroupSpec) DeepCopyInto

func (in *DBReplicationGroupSpec) DeepCopyInto(out *DBReplicationGroupSpec)

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

type DBReplicationGroupStatus

type DBReplicationGroupStatus struct {
	DBInstanceBaseIdentifier *string `json:"dbInstanceBaseIdentifier"`

	DBInstanceIdentifiers []*string `json:"dbInstanceIdentifiers"`
}

DBReplicationGroupStatus defines the observed state of DBReplicationGroup

func (*DBReplicationGroupStatus) DeepCopy

func (in *DBReplicationGroupStatus) DeepCopy() *DBReplicationGroupStatus

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

func (*DBReplicationGroupStatus) DeepCopyInto

func (in *DBReplicationGroupStatus) DeepCopyInto(out *DBReplicationGroupStatus)

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

type DBUser

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

	Spec   DBUserSpec   `json:"spec,omitempty"`
	Status DBUserStatus `json:"status,omitempty"`
}

DBUser is the Schema for the dbusers API

func (*DBUser) DeepCopy

func (in *DBUser) DeepCopy() *DBUser

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

func (*DBUser) DeepCopyInto

func (in *DBUser) DeepCopyInto(out *DBUser)

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

func (*DBUser) DeepCopyObject

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

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

type DBUserList

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

DBUserList contains a list of DBUser

func (*DBUserList) DeepCopy

func (in *DBUserList) DeepCopy() *DBUserList

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

func (*DBUserList) DeepCopyInto

func (in *DBUserList) DeepCopyInto(out *DBUserList)

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

func (*DBUserList) DeepCopyObject

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

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

type DBUserSpec

type DBUserSpec struct {

	// DBInstanceIdentifier is the identifier of the DBInstance to connect to when creating the DBUser.
	//
	// Note: Either DBClusterIdentifier or DBInstanceIdentifier must be specified, but not both
	//
	// +kubebuilder:validation:Optional
	// +nullable
	DBInstanceIdentifier *string `json:"dbInstanceIdentifier,omitempty"`

	// DBClusterIdentifier is the identifier of the Aurora cluster to connect to when creating the DBUser.
	//
	// Note: Either DBClusterIdentifier or DBInstanceIdentifier must be specified, but not both
	//
	// +kubebuilder:validation:Optional
	// +nullable
	DBClusterIdentifier *string `json:"dbClusterIdentifier,omitempty"`

	// Username is the role name of the DBUser to create
	// +kubebuilder:validation:Required
	Username *string `json:"username"`

	// Password is the password of the DBUser to create.
	//
	// Default: No user password is created
	//
	// Note: Either Password or UseIAMAuthentication must be specified, but not both
	//
	// +kubebuilder:validation:Optional
	// +nullable
	Password *ackv1alpha1.SecretKeyReference `json:"password"`

	// UseIAMAuthentication is a boolean value which specifies whether or not to use AWS IAM for Authentication
	// instead of a password.
	//
	// See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.DBAccounts.html
	//
	// Note: Either Password or UseIAMAuthentication must be specified, but not both
	//
	// +kubebuilder:validation:Optional
	// +nullable
	UseIAMAuthentication *bool `json:"useIAMAuthentication"`

	// GrantStatement is the GRANT statement run after user creation to provide the user specific privileges.
	//
	// Note: use `?` to denote the username in the statement: `GRANT ... ON `%`.* TO ?`
	//
	// Note: The RDS Master User (DBInstance.MasterUsername) does not have super user privileges. Thus, you
	//       when you use `GRANT ALL PRIVILEGES ON `%`.* TO ?`, the user will still only be granted certain
	//       privileges.
	//       See: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.MasterAccounts.html
	//
	// +kubebuilder:validation:Required
	GrantStatement *string `json:"grantStatement"`

	// ApplyGrantWhenExists is a boolean value which specifies whether or not to apply GrantStatement even if
	// the user already exists.
	// +kubebuilder:validation:Optional
	// +nullable
	ApplyGrantWhenExists *bool `json:"applyGrantWhenExists,omitempty"`
}

DBUserSpec defines the desired state of DBUser

func (*DBUserSpec) DeepCopy

func (in *DBUserSpec) DeepCopy() *DBUserSpec

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

func (*DBUserSpec) DeepCopyInto

func (in *DBUserSpec) DeepCopyInto(out *DBUserSpec)

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

type DBUserStatus

type DBUserStatus struct {
	IdentifierType IdentifierType `json:"identifierType"`

	Engine Engine `json:"engine"`

	Usernames []*string `json:"Usernames"`
}

DBUserStatus defines the observed state of DBUser

func (*DBUserStatus) DeepCopy

func (in *DBUserStatus) DeepCopy() *DBUserStatus

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

func (*DBUserStatus) DeepCopyInto

func (in *DBUserStatus) DeepCopyInto(out *DBUserStatus)

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

type Engine

type Engine int

const (
	MySQL Engine = iota
	Postgres
)

type IdentifierType

type IdentifierType int

const (
	IdentifierTypeCluster IdentifierType = iota
	IdentifierTypeInstance
)