Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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:

<SqsQueueBlueprint/>

<SqsQueueConfig/>

You can reference any of the following SQS queue properties in your mapping configuration:

<SqsQueueProperties/>

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.
:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<details>
<summary><b>SQS queue blueprint (Click to expand)</b></summary>

```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
}
}
}
```

</details>
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<details>
<summary><b>SQS queue mapping configuration (Click to expand)</b></summary>

```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
relations:
awsAccount: .awsAccount
```

</details>
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<details>
<summary><b>SQS queue properties (Click to expand)</b></summary>

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

</details>