From 98d7d0d21e5ab8096a2313dd96b4457dfcdcdbfa Mon Sep 17 00:00:00 2001 From: shariff-6 Date: Thu, 9 Oct 2025 16:10:17 +0300 Subject: [PATCH 1/2] feat(aws-v3): add SQS queue example documentation - Add comprehensive SQS queue example for AWS v3 integration - Include blueprint definition with 5 key properties (queueName, queueUrl, queueArn, fifoQueue, visibilityTimeout) - Add complete mapping configuration with all 24 SQS queue properties - Add detailed properties table with action requirements (Default vs GetQueueTagsAction) - Update examples.md with SQS queue section and imports - Update Overview.md to include SQS queues in supported resources list --- .../cloud-providers/aws-v3/Overview.md | 1 + .../cloud-providers/aws-v3/examples.md | 21 ++++++++ .../sqs/queues/_sqs_queue_blueprint.mdx | 50 +++++++++++++++++++ .../sqs/queues/_sqs_queue_port_app_config.mdx | 44 ++++++++++++++++ .../sqs/queues/_sqs_queue_properties.mdx | 31 ++++++++++++ 5 files changed, 147 insertions(+) create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_blueprint.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_port_app_config.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_properties.mdx diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/Overview.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/Overview.md index dcb05d823b..8e8d375b68 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/Overview.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/Overview.md @@ -32,6 +32,7 @@ The integration currently supports the following AWS resource types: - `S3 Buckets`: Complete bucket information including properties, tags, and metadata. - `ECS Clusters`: Cluster details, services, and task definitions. - `EC2 Instances`: Instance information, security groups, and networking details. +- `SQS Queues`: Queue information including attributes, policies, and configuration details. :::info More Resource Types Coming Soon We're actively working on adding support for additional AWS resource types to provide comprehensive coverage of your AWS infrastructure. diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples.md index 676070c90f..960c07f3db 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples.md @@ -16,6 +16,9 @@ import Ec2InstanceProperties from './examples/ec2/instances/_ec2_instance_proper import OrganizationsAccountBlueprint from './examples/organizations/accounts/_organizations_accounts_blueprint.mdx' import OrganizationsAccountConfig from './examples/organizations/accounts/_organizations_accounts_port_app_config.mdx' import OrganizationsAccountProperties from './examples/organizations/accounts/_organizations_accounts_properties.mdx' +import SqsQueueBlueprint from './examples/sqs/queues/_sqs_queue_blueprint.mdx' +import SqsQueueConfig from './examples/sqs/queues/_sqs_queue_port_app_config.mdx' +import SqsQueueProperties from './examples/sqs/queues/_sqs_queue_properties.mdx' # Examples @@ -107,6 +110,24 @@ You can reference any of the following EC2 instance properties in your mapping c For more details about EC2 instance properties, refer to the [AWS EC2 API documentation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html). +## Amazon SQS + +### SQS queues + +The following example demonstrates how to ingest your AWS SQS queues to Port. + +You can use the following Port blueprint definitions and integration configuration: + + + + + +You can reference any of the following SQS queue properties in your mapping configuration: + + + +For more details about SQS queue properties, refer to the [AWS SQS API documentation](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueAttributes.html). + :::info More resource types coming soon We're actively working on adding support for additional AWS resource types to provide comprehensive coverage of your AWS infrastructure. ::: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_blueprint.mdx new file mode 100644 index 0000000000..222393c9f6 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_blueprint.mdx @@ -0,0 +1,50 @@ +
+SQS queue blueprint (Click to expand) + +```json showLineNumbers +{ + "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 + } + } +} +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_port_app_config.mdx new file mode 100644 index 0000000000..03acfe0dbf --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_port_app_config.mdx @@ -0,0 +1,44 @@ +
+SQS queue mapping configuration (Click to expand) + +```yaml showLineNumbers +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 + approximateNumberOfMessages: .ApproximateNumberOfMessages + approximateNumberOfMessagesNotVisible: .ApproximateNumberOfMessagesNotVisible + approximateNumberOfMessagesDelayed: .ApproximateNumberOfMessagesDelayed + createdTimestamp: .CreatedTimestamp + lastModifiedTimestamp: .LastModifiedTimestamp + maximumMessageSize: .MaximumMessageSize + messageRetentionPeriod: .MessageRetentionPeriod + delaySeconds: .DelaySeconds + receiveMessageWaitTimeSeconds: .ReceiveMessageWaitTimeSeconds + policy: .Policy + redrivePolicy: .RedrivePolicy + redriveAllowPolicy: .RedriveAllowPolicy + kmsMasterKeyId: .KmsMasterKeyId + kmsDataKeyReusePeriodSeconds: .KmsDataKeyReusePeriodSeconds + sqsManagedSseEnabled: .SqsManagedSseEnabled + contentBasedDeduplication: .ContentBasedDeduplication + deduplicationScope: .DeduplicationScope + fifoThroughputLimit: .FifoThroughputLimit + tags: .Tags + relations: + awsAccount: .awsAccount +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_properties.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_properties.mdx new file mode 100644 index 0000000000..4052740b31 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_properties.mdx @@ -0,0 +1,31 @@ +
+SQS queue properties (Click to expand) + +| Property | Type | Description | Action Required | +|----------|------|-------------|-----------------| +| `QueueName` | string | The name of the SQS queue | Default | +| `QueueUrl` | string | The URL of the SQS queue | Default | +| `QueueArn` | string | The Amazon Resource Name (ARN) of the SQS queue | Default | +| `ApproximateNumberOfMessages` | number | The approximate number of messages available for retrieval from the queue | Default | +| `ApproximateNumberOfMessagesNotVisible` | number | The approximate number of messages in the queue that are delayed and not available for reading immediately | Default | +| `ApproximateNumberOfMessagesDelayed` | number | The approximate number of messages in the queue that are delayed and not available for reading immediately | Default | +| `CreatedTimestamp` | string | The time when the queue was created (Unix timestamp) | Default | +| `LastModifiedTimestamp` | string | The time when the queue was last changed (Unix timestamp) | Default | +| `VisibilityTimeout` | number | The visibility timeout for the queue in seconds | Default | +| `MaximumMessageSize` | number | The limit of how many bytes a message can contain before Amazon SQS rejects it | Default | +| `MessageRetentionPeriod` | number | The number of seconds for which Amazon SQS retains a message | Default | +| `DelaySeconds` | number | The default delay for a message in the queue in seconds | Default | +| `ReceiveMessageWaitTimeSeconds` | number | The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive | Default | +| `Policy` | string | The queue's policy | Default | +| `RedrivePolicy` | string | The string that includes the parameters for the dead-letter queue functionality | Default | +| `RedriveAllowPolicy` | string | The string that includes the parameters for the permissions for the dead-letter queue redrive permission | Default | +| `KmsMasterKeyId` | string | The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK | Default | +| `KmsDataKeyReusePeriodSeconds` | number | The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again | Default | +| `SqsManagedSseEnabled` | boolean | Returns true if the queue is using SSE-SQS encryption using SQS owned encryption keys | Default | +| `FifoQueue` | boolean | Returns true if the queue is a FIFO queue | Default | +| `ContentBasedDeduplication` | boolean | Returns true if content-based deduplication is enabled for the queue | Default | +| `DeduplicationScope` | string | Specifies whether message deduplication occurs at the message group or queue level | Default | +| `FifoThroughputLimit` | string | Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group | Default | +| `Tags` | object | The tags that have been assigned to the queue | GetQueueTagsAction | + +
From 9a6d93751709fa2003ce1f4abffffaf868e06646 Mon Sep 17 00:00:00 2001 From: shariff-6 Date: Thu, 9 Oct 2025 16:14:11 +0300 Subject: [PATCH 2/2] Update sqs mapping --- .../sqs/queues/_sqs_queue_port_app_config.mdx | 19 ------------------- 1 file changed, 19 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_port_app_config.mdx index 03acfe0dbf..7c3843c6e5 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_port_app_config.mdx @@ -18,25 +18,6 @@ resources: queueArn: .QueueArn fifoQueue: .FifoQueue visibilityTimeout: .VisibilityTimeout - approximateNumberOfMessages: .ApproximateNumberOfMessages - approximateNumberOfMessagesNotVisible: .ApproximateNumberOfMessagesNotVisible - approximateNumberOfMessagesDelayed: .ApproximateNumberOfMessagesDelayed - createdTimestamp: .CreatedTimestamp - lastModifiedTimestamp: .LastModifiedTimestamp - maximumMessageSize: .MaximumMessageSize - messageRetentionPeriod: .MessageRetentionPeriod - delaySeconds: .DelaySeconds - receiveMessageWaitTimeSeconds: .ReceiveMessageWaitTimeSeconds - policy: .Policy - redrivePolicy: .RedrivePolicy - redriveAllowPolicy: .RedriveAllowPolicy - kmsMasterKeyId: .KmsMasterKeyId - kmsDataKeyReusePeriodSeconds: .KmsDataKeyReusePeriodSeconds - sqsManagedSseEnabled: .SqsManagedSseEnabled - contentBasedDeduplication: .ContentBasedDeduplication - deduplicationScope: .DeduplicationScope - fifoThroughputLimit: .FifoThroughputLimit - tags: .Tags relations: awsAccount: .awsAccount ```