v1beta1

Documentation

Overview

Package v1beta1 contains API Schema definitions for the queue v1beta1 API group +kubebuilder:object:generate=true +groupName=queue.govsvc.uk

Index

• Constants
• Variables
• type AWS
  • func (in *AWS) DeepCopy() *AWS
  • func (in *AWS) DeepCopyInto(out *AWS)
• type SQS
  • func (in *SQS) DeepCopy() *SQS
  • func (in *SQS) DeepCopyInto(out *SQS)
  • func (in *SQS) DeepCopyObject() runtime.Object
  • func (s *SQS) GetSecretName() string
  • func (s *SQS) GetStackName() string
  • func (s *SQS) GetStackRoleParameters(roleName string) ([]*cloudformation.Parameter, error)
  • func (s *SQS) GetStackTemplate() (*cloudformation.Template, error)
• type SQSList
  • func (in *SQSList) DeepCopy() *SQSList
  • func (in *SQSList) DeepCopyInto(out *SQSList)
  • func (in *SQSList) DeepCopyObject() runtime.Object
• type SQSSpec
  • func (in *SQSSpec) DeepCopy() *SQSSpec
  • func (in *SQSSpec) DeepCopyInto(out *SQSSpec)

Constants

const (
	SQSResourceName      = "SQSQueue"
	SQSDLQResourceName   = "SQSDLQueue"
	SQSOutputURL         = "QueueURL"
	SQSDLQOutputURL      = "DLQueueURL"
	SQSResourceIAMPolicy = "SQSSIAMPolicy"
	IAMRoleParameterName = "IAMRoleName"
)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "queue.govsvc.uk", Version: "v1beta1"}

	// 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 AWS

type AWS struct {
	ContentBasedDeduplication     bool `json:"contentBasedDeduplication,omitempty"`
	DelaySeconds                  int  `json:"delaySeconds,omitempty"`
	FifoQueue                     bool `json:"fifoQueue,omitempty"`
	MaximumMessageSize            int  `json:"maximumMessageSize,omitempty"`
	MessageRetentionPeriod        int  `json:"messageRetentionPeriod,omitempty"`
	ReceiveMessageWaitTimeSeconds int  `json:"receiveMessageWaitTimeSeconds,omitempty"`
	RedriveMaxReceiveCount        int  `json:"redriveMaxReceiveCount,omitempty"`
	VisibilityTimeout             int  `json:"visibilityTimeout,omitempty"`
}

AWS allows specifying configuration for the SQS queue

func (*AWS) DeepCopy

func (in *AWS) DeepCopy() *AWS

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

func (*AWS) DeepCopyInto

func (in *AWS) DeepCopyInto(out *AWS)

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

type SQS

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

	Spec          SQSSpec `json:"spec,omitempty"`
	object.Status `json:"status,omitempty"`
}

SQS is the Schema for the SQS API

func (*SQS) DeepCopy

func (in *SQS) DeepCopy() *SQS

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

func (*SQS) DeepCopyInto

func (in *SQS) DeepCopyInto(out *SQS)

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

func (*SQS) DeepCopyObject

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

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

func (*SQS) GetSecretName

func (s *SQS) GetSecretName() string

SecretName returns the name of the secret that will be populated with data

func (*SQS) GetStackName

func (s *SQS) GetStackName() string

Name returns the name of the SQS cloudformation stack

func (*SQS) GetStackRoleParameters

func (s *SQS) GetStackRoleParameters(roleName string) ([]*cloudformation.Parameter, error)

GetStackRoleParameters returns additional params based on a target principal resource

func (*SQS) GetStackTemplate

func (s *SQS) GetStackTemplate() (*cloudformation.Template, error)

Template returns a cloudformation Template for provisioning an SQS queue

type SQSList

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

SQSList contains a list of SQS

func (*SQSList) DeepCopy

func (in *SQSList) DeepCopy() *SQSList

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

func (*SQSList) DeepCopyInto

func (in *SQSList) DeepCopyInto(out *SQSList)

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

func (*SQSList) DeepCopyObject

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

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

type SQSSpec

type SQSSpec struct {
	// AWS specific subsection of the resource.
	AWS AWS `json:"aws,omitempty"`
	// Secret name to be used for storing relevant instance secrets for further use.
	Secret string `json:"secret,omitempty"`
}

SQSSpec defines the desired state of SQS

func (*SQSSpec) DeepCopy

func (in *SQSSpec) DeepCopy() *SQSSpec

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

func (*SQSSpec) DeepCopyInto

func (in *SQSSpec) DeepCopyInto(out *SQSSpec)

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