v1beta1

package
v0.50.5 Latest Latest
Warning

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

 Go to latest Published: Nov 8, 2024 License: Apache-2.0 Imports: 12 Imported by: 2

Documentation

Overview

Package v1beta1 contains managed resources for AWS SQS resources such as Queues. +kubebuilder:object:generate=true +groupName=sqs.aws.crossplane.io +versionName=v1beta1

Index

Constants

View Source 
const (
	AttributeAll                                   string = "All"
	AttributePolicy                                string = "Policy"
	AttributeVisibilityTimeout                     string = "VisibilityTimeout"
	AttributeMaximumMessageSize                    string = "MaximumMessageSize"
	AttributeMessageRetentionPeriod                string = "MessageRetentionPeriod"
	AttributeApproximateNumberOfMessages           string = "ApproximateNumberOfMessages"
	AttributeApproximateNumberOfMessagesNotVisible string = "ApproximateNumberOfMessagesNotVisible"
	AttributeCreatedTimestamp                      string = "CreatedTimestamp"
	AttributeLastModifiedTimestamp                 string = "LastModifiedTimestamp"
	AttributeQueueArn                              string = "QueueArn"
	AttributeApproximateNumberOfMessagesDelayed    string = "ApproximateNumberOfMessagesDelayed"
	AttributeDelaySeconds                          string = "DelaySeconds"
	AttributeReceiveMessageWaitTimeSeconds         string = "ReceiveMessageWaitTimeSeconds"
	AttributeRedrivePolicy                         string = "RedrivePolicy"
	AttributeFifoQueue                             string = "FifoQueue"
	AttributeContentBasedDeduplication             string = "ContentBasedDeduplication"
	AttributeKmsMasterKeyID                        string = "KmsMasterKeyId"
	AttributeKmsDataKeyReusePeriodSeconds          string = "KmsDataKeyReusePeriodSeconds"
	AttributeSqsManagedSseEnabled                  string = "SqsManagedSseEnabled"
)

Enum values for Queue attribute names

View Source 
const (
	Group   = "sqs.aws.crossplane.io"
	Version = "v1beta1"
)

Package type metadata.

Variables

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 (
	QueueKind             = reflect.TypeOf(Queue{}).Name()
	QueueGroupKind        = schema.GroupKind{Group: Group, Kind: QueueKind}.String()
	QueueKindAPIVersion   = QueueKind + "." + SchemeGroupVersion.String()
	QueueGroupVersionKind = SchemeGroupVersion.WithKind(QueueKind)
)

Queue type metadata.

Functions

func QueueARN 

func QueueARN() reference.ExtractValueFn

QueueARN returns ARN of the Queue resource.

Types

type Queue 

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

	Spec   QueueSpec   `json:"spec"`
	Status QueueStatus `json:"status,omitempty"`
}

A Queue is a managed resource that represents a AWS Simple Queue +kubebuilder:printcolumn:name="ARN",type="string",JSONPath=".status.atProvider.arn" +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,aws}

func (*Queue) DeepCopy 

func (in *Queue) DeepCopy() *Queue

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

func (*Queue) DeepCopyInto 

func (in *Queue) DeepCopyInto(out *Queue)

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

func (*Queue) DeepCopyObject 

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

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

func (*Queue) GetCondition 

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

GetCondition of this Queue.

func (*Queue) GetDeletionPolicy 

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

GetDeletionPolicy of this Queue.

func (*Queue) GetManagementPolicies added in v0.43.0 

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

GetManagementPolicies of this Queue.

func (*Queue) GetProviderConfigReference 

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

GetProviderConfigReference of this Queue.

func (*Queue) GetPublishConnectionDetailsTo 

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

GetPublishConnectionDetailsTo of this Queue.

func (*Queue) GetWriteConnectionSecretToReference 

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

GetWriteConnectionSecretToReference of this Queue.

func (*Queue) ResolveReferences 

func (mg *Queue) ResolveReferences(ctx context.Context, c client.Reader) error

ResolveReferences of this Queue.

func (*Queue) SetConditions 

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

SetConditions of this Queue.

func (*Queue) SetDeletionPolicy 

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

SetDeletionPolicy of this Queue.

func (*Queue) SetManagementPolicies added in v0.43.0 

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

SetManagementPolicies of this Queue.

func (*Queue) SetProviderConfigReference 

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

SetProviderConfigReference of this Queue.

func (*Queue) SetPublishConnectionDetailsTo 

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

SetPublishConnectionDetailsTo of this Queue.

func (*Queue) SetWriteConnectionSecretToReference 

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

SetWriteConnectionSecretToReference of this Queue.

type QueueList 

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

QueueList contains a list of Queue

func (*QueueList) DeepCopy 

func (in *QueueList) DeepCopy() *QueueList

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

func (*QueueList) DeepCopyInto 

func (in *QueueList) DeepCopyInto(out *QueueList)

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

func (*QueueList) DeepCopyObject 

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

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

func (*QueueList) GetItems 

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

GetItems of this QueueList.

type QueueObservation 

type QueueObservation struct {
	// The URL of the created Amazon SQS queue.
	URL string `json:"url,omitempty"`

	// The Amazon resource name (ARN) of the queue.
	ARN string `json:"arn,omitempty"`

	// ApproximateNumberOfMessages - The approximate number of messages
	// available for retrieval from the queue.
	ApproximateNumberOfMessages int64 `json:"approximateNumberOfMessages,omitempty"`

	// ApproximateNumberOfMessagesDelayed - The approximate number
	// of messages in the queue that are delayed and not available for reading
	// immediately. This can happen when the queue is configured as a delay queue
	// or when a message has been sent with a delay parameter.
	ApproximateNumberOfMessagesDelayed int64 `json:"approximateNumberOfMessagesDelayed,omitempty"`

	// ApproximateNumberOfMessagesNotVisible - The approximate number
	// of messages that are in flight. Messages are considered to be in flight
	// if they have been sent to a client but have not yet been deleted or have
	// not yet reached the end of their visibility window.
	ApproximateNumberOfMessagesNotVisible int64 `json:"approximateNumberOfMessagesNotVisible,omitempty"`

	// CreatedTimestamp is the time when the queue was created
	CreatedTimestamp *metav1.Time `json:"createdTimestamp,omitempty"`

	// LastModifiedTimestamp - Returns the time when the queue was last changed.
	LastModifiedTimestamp *metav1.Time `json:"lastModifiedTimestamp,omitempty"`
}

QueueObservation is the representation of the current state that is observed

func (*QueueObservation) DeepCopy 

func (in *QueueObservation) DeepCopy() *QueueObservation

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

func (*QueueObservation) DeepCopyInto 

func (in *QueueObservation) DeepCopyInto(out *QueueObservation)

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

type QueueParameters 

type QueueParameters struct {
	// Region is the region you'd like your Queue to be created in.
	Region string `json:"region"`

	// DelaySeconds - The length of time, in seconds, for which the delivery
	// of all messages in the queue is delayed. Valid values: An integer from
	// 0 to 900 (15 minutes). Default: 0.
	// +optional
	DelaySeconds *int64 `json:"delaySeconds,omitempty"`

	// MaximumMessageSize is the limit of how many bytes a message can contain
	// before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes
	// (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
	// +optional
	MaximumMessageSize *int64 `json:"maximumMessageSize,omitempty"`

	// MessageRetentionPeriod - The length of time, in seconds, for which Amazon
	// SQS retains a message. Valid values: An integer representing seconds,
	// from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).
	// +optional
	MessageRetentionPeriod *int64 `json:"messageRetentionPeriod,omitempty"`

	// The queue's policy. A valid AWS policy. For more information
	// about policy structure, see Overview of AWS IAM Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html)
	// in the Amazon IAM User Guide.
	// +optional
	Policy *string `json:"policy,omitempty"`

	// ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for
	// which a ReceiveMessage action waits for a message to arrive. Valid values:
	// an integer from 0 to 20 (seconds). Default: 0.
	// +optional
	ReceiveMessageWaitTimeSeconds *int64 `json:"receiveMessageWaitTimeSeconds,omitempty"`

	// RedrivePolicy includes the parameters for the dead-letter
	// queue functionality of the source queue. For more information about the
	// redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter
	// Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html)
	// in the Amazon Simple Queue Service Developer Guide
	// +optional
	RedrivePolicy *RedrivePolicy `json:"redrivePolicy,omitempty"`

	// VisibilityTimeout - The visibility timeout for the queue, in seconds.
	// Valid values: an integer from 0 to 43,200 (12 hours). Default: 30. For
	// more information about the visibility timeout, see Visibility Timeout
	// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html)
	// in the Amazon Simple Queue Service Developer Guide.
	// +optional
	VisibilityTimeout *int64 `json:"visibilityTimeout,omitempty"`

	// KMSMasterKeyID - The ID of an AWS-managed customer master key (CMK)
	// for Amazon SQS or a custom CMK. For more information, see Key Terms (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms).
	// While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs,
	// the alias of a custom CMK can, for example, be alias/MyAlias . For more
	// examples, see KeyId (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters)
	// in the AWS Key Management Service API Reference.
	// Applies only to server-side-encryption (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html):
	// +optional
	// +crossplane:generate:reference:type=github.com/crossplane-contrib/provider-aws/apis/kms/v1alpha1.Key
	KMSMasterKeyID *string `json:"kmsMasterKeyId,omitempty"`

	KMSMasterKeyIDRef *xpv1.Reference `json:"kmsMasterKeyIdRef,omitempty"`

	KMSMasterKeyIDSelector *xpv1.Selector `json:"kmsMasterKeyIdSelector,omitempty"`

	// KMSDataKeyReusePeriodSeconds - The length of time, in seconds, for which
	// Amazon SQS can reuse a data key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys)
	// to encrypt or decrypt messages before calling AWS KMS again. An integer
	// representing seconds, between 60 seconds (1 minute) and 86,400 seconds
	// (24 hours). Default: 300 (5 minutes). A shorter time period provides better
	// security but results in more calls to KMS which might incur charges after
	// Free Tier. For more information, see How Does the Data Key Reuse Period
	// Work? (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work).
	// Applies only to server-side-encryption (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html):
	// +optional
	KMSDataKeyReusePeriodSeconds *int64 `json:"kmsDataKeyReusePeriodSeconds,omitempty"`

	// FIFOQueue - Designates a queue as FIFO. Valid values: true, false. If
	//	you don't specify the FifoQueue attribute, Amazon SQS creates a standard
	//	queue. You can provide this attribute only during queue creation. You
	//	can't change it for an existing queue. When you set this attribute, you
	//	must also provide the MessageGroupId for your messages explicitly. For
	//	more information, see FIFO Queue Logic (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic)
	//	in the Amazon Simple Queue Service Developer Guide.
	// +immutable
	// +optional
	FIFOQueue *bool `json:"fifoQueue,omitempty"`

	// ContentBasedDeduplication - Enables content-based deduplication. Valid
	// values: true, false. For more information, see Exactly-Once Processing
	// (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing)
	// in the Amazon Simple Queue Service Developer Guide. Every message must
	// have a unique MessageDeduplicationId, You may provide a MessageDeduplicationId
	// explicitly. If you aren't able to provide a MessageDeduplicationId and
	// you enable ContentBasedDeduplication for your queue, Amazon SQS uses a
	// SHA-256 hash to generate the MessageDeduplicationId using the body of
	// the message (but not the attributes of the message). If you don't provide
	// a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication
	// set, the action fails with an error. If the queue has ContentBasedDeduplication
	// set, your MessageDeduplicationId overrides the generated one. When ContentBasedDeduplication
	// is in effect, messages with identical content sent within the deduplication
	// interval are treated as duplicates and only one copy of the message is
	// delivered. If you send one message with ContentBasedDeduplication enabled
	// and then another message with a MessageDeduplicationId that is the same
	// as the one generated for the first MessageDeduplicationId, the two messages
	// are treated as duplicates and only one copy of the message is delivered.
	// +optional
	ContentBasedDeduplication *bool `json:"contentBasedDeduplication,omitempty"`

	// Boolean to enable server-side encryption (SSE) of
	// message content with SQS-owned encryption keys. See Encryption at rest.
	SqsManagedSseEnabled *bool `json:"sseEnabled,omitempty"`

	// Tags add cost allocation tags to the specified Amazon SQS queue.
	// +optional
	Tags map[string]string `json:"tags,omitempty"`
}

QueueParameters define the desired state of an AWS Queue

func (*QueueParameters) DeepCopy 

func (in *QueueParameters) DeepCopy() *QueueParameters

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

func (*QueueParameters) DeepCopyInto 

func (in *QueueParameters) DeepCopyInto(out *QueueParameters)

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

type QueueSpec 

type QueueSpec struct {
	xpv1.ResourceSpec `json:",inline"`
	ForProvider       QueueParameters `json:"forProvider"`
}

QueueSpec defines the desired state of a Queue.

func (*QueueSpec) DeepCopy 

func (in *QueueSpec) DeepCopy() *QueueSpec

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

func (*QueueSpec) DeepCopyInto 

func (in *QueueSpec) DeepCopyInto(out *QueueSpec)

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

type QueueStatus 

type QueueStatus struct {
	xpv1.ResourceStatus `json:",inline"`
	AtProvider          QueueObservation `json:"atProvider,omitempty"`
}

QueueStatus represents the observed state of a Queue.

func (*QueueStatus) DeepCopy 

func (in *QueueStatus) DeepCopy() *QueueStatus

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

func (*QueueStatus) DeepCopyInto 

func (in *QueueStatus) DeepCopyInto(out *QueueStatus)

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

type RedrivePolicy 

type RedrivePolicy struct {
	// The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon
	// SQS moves messages after the value of maxReceiveCount is exceeded.
	// +crossplane:generate:reference:type=Queue
	// +crossplane:generate:reference:extractor=QueueARN()
	DeadLetterTargetARN *string `json:"deadLetterTargetArn,omitempty"`

	// DeadLetterTargetARNRef reference a Queue to retrieve its ARN.
	// +optional
	DeadLetterTargetARNRef *xpv1.Reference `json:"deadLetterTargetArnRef,omitempty"`

	// DeadLetterTargetARNSelector selects reference to a Queue to retrieve its ARN
	// +optional
	DeadLetterTargetARNSelector *xpv1.Selector `json:"deadLetterTargetArnSelector,omitempty"`

	// The number of times a message is delivered to the source queue before
	// being moved to the dead-letter queue.
	MaxReceiveCount int64 `json:"maxReceiveCount"`
}

RedrivePolicy includes the parameters for the dead-letter queue functionality of the source queue.

func (*RedrivePolicy) DeepCopy 

func (in *RedrivePolicy) DeepCopy() *RedrivePolicy

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

func (*RedrivePolicy) DeepCopyInto 

func (in *RedrivePolicy) DeepCopyInto(out *RedrivePolicy)

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.