SQS

2 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

SQSQueue # GA

SQSQueue is the Schema for managing SQS Queues.

kubectl get sqsqueues · example on GitHub

Example

# SQSQueue — SQS
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/sqs.html#sqsqueue
apiVersion: aws.konfig.io/v1alpha1
kind: SQSQueue
metadata:
  name: example-sqsqueue
  namespace: default
spec:
  delaySeconds: 1
  fifo: false
  kmsKeyId: arn:aws:kms:us-east-1:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab
  messageRetentionPeriod: 60
  policy: '{"Version": "2012-10-17", "Statement": [{"Effect": "Allow", "Action": ["s3:GetObject"], "Resource":
    "*"}]}'
  providerRef:
    name: example-sqsqueue
    region: us-east-1
  queueName: example-sqsqueue
  receiveMessageWaitTime: 1
  redrivePolicy:
    deadLetterQueueRef: example
    maxReceiveCount: 1
  tags:
    environment: dev
    team: platform
  visibilityTimeout: 1

Spec

Field	Type	Required	Description
`delaySeconds`	integer	—	DelaySeconds is the time (seconds) messages are delayed before delivery.
`fifo`	boolean	—	FIFO enables FIFO queue ordering and exactly-once processing.
`kmsKeyId`	string	—	KMSKeyID is the KMS key ARN or alias for SSE-KMS encryption.
`messageRetentionPeriod`	integer	—	MessageRetentionPeriod is how long (seconds) messages are retained.
`policy`	string	—	Policy is a JSON resource policy to attach to the queue.
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`queueName`	string	yes	QueueName is the name of the queue.
`receiveMessageWaitTime`	integer	—	ReceiveMessageWaitTime enables long polling when > 0 (seconds).
`redrivePolicy`	object	—	RedrivePolicy configures a dead-letter queue.
`redrivePolicy.deadLetterQueueRef`	string	yes	DeadLetterQueueRef is the name of an SQSQueue CR in the same namespace.
`redrivePolicy.maxReceiveCount`	integer	yes	MaxReceiveCount is the number of times a message can be received before it is sent to the dead-letter queue.
`tags`	map<string>	—	Tags are AWS resource tags to apply.
`visibilityTimeout`	integer	—	VisibilityTimeout is the duration (seconds) that a received message is hidden.

Status

Field	Type	Required	Description
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`queueArn`	string	—	QueueARN is the ARN of the SQS queue.
`queueUrl`	string	—	QueueURL is the URL of the SQS queue.

SQSQueueInlinePolicy # CLOUD CONTROL · AWS::SQS::QueueInlinePolicy

SQSQueueInlinePolicy manages AWS::SQS::QueueInlinePolicy through the AWS Cloud Control API.

kubectl get sqsqueueinlinepolicies · example on GitHub

Example

# SQSQueueInlinePolicy — SQS
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/sqs.html#sqsqueueinlinepolicy
apiVersion: aws.konfig.io/v1alpha1
kind: SQSQueueInlinePolicy
metadata:
  name: example-sqsqueueinlinepolicy
  namespace: default
spec:
  providerRef:
    name: example-sqsqueueinlinepolicy
    region: us-east-1
  queue: example

Spec

Field	Type	Required	Description
`policyDocument`	object	yes	A policy document that contains permissions to add to the specified SQS queue
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`queue`	string	yes	The URL of the SQS queue.

Status

Field	Type	Required	Description
`attempt`	integer	—	Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`identifier`	string	—	Identifier is the Cloud Control primary identifier of the resource.
`lastSyncTime`	string	—
`observedGeneration`	integer	—
`operation`	string	—	Operation is the in-flight operation (CREATE, UPDATE, DELETE).
`operationStatus`	string	—	OperationStatus is the last reported operation status.
`requestToken`	string	—	RequestToken tracks an in-flight asynchronous operation.