Amazon Simple Queue Service

AWS::SQS::Queue

The following example demonstrates how to ingest your AWS SQS queues to Port.

SQS Queue Supported Actions

The table below summarizes the available actions for ingesting Amazon SQS Queue resources in Port:

Action	Description	Type	Required AWS Permission
ListQueuesAction	Discover all SQS queues across your AWS account. Reference	Default	sqs:ListQueues
GetQueueAttributesAction	Retrieve detailed configuration and operational data for each queue. Reference	Default	sqs:GetQueueAttributes
GetQueueTagsAction	Bring in custom tags assigned to your queues for advanced catalog filtering and grouping. Reference	Optional	sqs:ListQueueTags

Optional properties note

Properties of optional actions will not appear in the response unless you explicitly include the action that provides them in your configuration.

You can use the following Port blueprint definitions and integration configuration:

SQS Queue Blueprint (Click to expand)

{
  "identifier": "sqsQueue",
  "title": "SQS Queue",
  "icon": "AWS",
  "description": "This blueprint represents an AWS SQS queue in our software catalog",
  "schema": {
    "properties": {
      "queueName": {
        "type": "string",
        "title": "Queue Name"
      },
      "queueUrl": {
        "type": "string",
        "title": "Queue URL",
        "format": "url"
      },
      "queueArn": {
        "type": "string",
        "title": "Queue ARN"
      },
      "fifoQueue": {
        "type": "boolean",
        "title": "FIFO Queue"
      },
      "visibilityTimeout": {
        "type": "number",
        "title": "Visibility Timeout (seconds)"
      }
    },
    "required": []
  },
  "mirrorProperties": {},
  "calculationProperties": {},
  "aggregationProperties": {},
  "relations": {
    "awsAccount": {
      "title": "AWS Account",
      "target": "awsAccount",
      "required": true,
      "many": false
    }
  }
}

SQS Queue Mapping Configuration (Click to expand)

resources:
  - kind: AWS::SQS::Queue
    selector:
      query: 'true'
    port:
      entity:
        mappings:
          identifier: .QueueUrl
          title: .QueueName
          blueprint: sqsQueue
          properties:
            queueName: .QueueName
            queueUrl: .QueueUrl
            queueArn: .QueueArn
            fifoQueue: .FifoQueue
            visibilityTimeout: .VisibilityTimeout
          relations:
            awsAccount: .awsAccount

For more details about SQS queue properties, refer to the AWS SQS API documentation.