-
Notifications
You must be signed in to change notification settings - Fork 60
feat(aws-v3): add SQS queue example documentation #2870
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
shariff-6
wants to merge
7
commits into
main
Choose a base branch
from
PORT-16518-AWS-SQS-Queue-Kind
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
98d7d0d
feat(aws-v3): add SQS queue example documentation
shariff-6 9a6d937
Update sqs mapping
shariff-6 08a3721
Merge branch 'main' into PORT-16518-AWS-SQS-Queue-Kind
shariff-6 b921002
Merge branch 'main' into PORT-16518-AWS-SQS-Queue-Kind
shariff-6 18eeb38
Merge branch 'main' into PORT-16518-AWS-SQS-Queue-Kind
mk-armah 7648e25
Merge branch 'main' into PORT-16518-AWS-SQS-Queue-Kind
mk-armah acb942e
Merge branch 'main' into PORT-16518-AWS-SQS-Queue-Kind
mk-armah File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
50 changes: 50 additions & 0 deletions
50
...-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_blueprint.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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> |
25 changes: 25 additions & 0 deletions
25
...talog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_port_app_config.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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> |
31 changes: 31 additions & 0 deletions
31
...to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_properties.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add
organizationsandaccounts