- 
                Notifications
    
You must be signed in to change notification settings  - Fork 60
 
Aws V3 Documentation #2960
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
base: main
Are you sure you want to change the base?
Aws V3 Documentation #2960
Conversation
- 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
          PR Compliance Guide 🔍Below is a summary of compliance checks for this PR: 
 Compliance status legend🟢 - Fully Compliant🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label  | 
    |||||||||||||||||||||||
…s/port-docs into aws-v3-documentation-PORT-16286
| 
           This pull request is automatically being deployed by Amplify Hosting (learn more).  | 
    
…s/port-docs into aws-v3-documentation-PORT-16286
…s/port-docs into aws-v3-documentation-PORT-16286
| 
           /review  | 
    
          PR Reviewer Guide 🔍Here are some key observations to aid the review process: 
  | 
    
| 
           /improve  | 
    
          PR Code Suggestions ✨Latest suggestions up to dfd275d 
 Previous suggestions✅ Suggestions up to commit dfd275d
 ✅ Suggestions up to commit fa2b9c9
  | 
    ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 
           /improve  | 
    
| 
           Persistent suggestions updated to latest commit dfd275d  | 
    
| 
           /improve  | 
    
| 
           Persistent suggestions updated to latest commit dfd275d  | 
    
        
          
                ...source-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md
              
                Outdated
          
            Show resolved
            Hide resolved
        
              
          
                ...to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account.md
              
                Outdated
          
            Show resolved
            Hide resolved
        
      …oviders/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md Co-authored-by: qodo-merge-pro[bot] <151058649+qodo-merge-pro[bot]@users.noreply.github.com>
…oviders/aws-v3/resource-and-property-reference/aws-account/aws-account.md Co-authored-by: qodo-merge-pro[bot] <151058649+qodo-merge-pro[bot]@users.noreply.github.com>
| ::::info Property naming conventions | ||
| The AWS Hosted by Port integration returns all resource properties in **PascalCase** (for example: `Arn`, `BucketName`, `CreationDate`). When writing mappings and JQ expressions, reference properties using PascalCasing as shown in the examples below. | ||
| :::: | 
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.
Suggestion: Fix admonition syntax and casing
| ::::info Property naming conventions | |
| The AWS Hosted by Port integration returns all resource properties in **PascalCase** (for example: `Arn`, `BucketName`, `CreationDate`). When writing mappings and JQ expressions, reference properties using PascalCasing as shown in the examples below. | |
| :::: | |
| :::info Property naming conventions | |
| The AWS Hosted by Port integration returns all resource properties in **PascalCase** (for example: `Arn`, `BucketName`, `CreationDate`). When writing mappings and JQ expressions, reference properties using PascalCase as shown in the examples below. | |
| ::: | 
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.
Left some comments as examples.
Mostly the capitalization is a bit off, only the first letter in the headers and titles should be capitalized.
And also suggested a new placement for the reference link in the tables in each resource page.
| 
               | 
          ||
| The following example demonstrates how to ingest your AWS EC2 instances to Port. | ||
| 
               | 
          ||
| #### EC2 Instance Supported Actions | 
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.
| #### EC2 Instance Supported Actions | |
| #### EC2 instance supported actions | 
| @@ -1,5 +1,5 @@ | |||
| <details> | |||
| <summary><b>EC2 instance blueprint (Click to expand)</b></summary> | |||
| <summary><b>EC2 Instance Blueprint (Click to expand)</b></summary> | |||
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.
| <summary><b>EC2 Instance Blueprint (Click to expand)</b></summary> | |
| <summary><b>EC2 instance blueprint (click to expand)</b></summary> | 
All headers should have a capital letter only for the first word :)
| @@ -1,5 +1,5 @@ | |||
| <details> | |||
| <summary><b>EC2 instance mapping configuration (Click to expand)</b></summary> | |||
| <summary><b>EC2 Instance Mapping Configuration (Click to expand)</b></summary> | |||
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.
| <summary><b>EC2 Instance Mapping Configuration (Click to expand)</b></summary> | |
| <summary><b>EC2 instance mapping configuration (click to expand)</b></summary> | 
same :)
| @@ -1,5 +1,5 @@ | |||
| <details> | |||
| <summary><b>ECS cluster blueprint (Click to expand)</b></summary> | |||
| <summary><b>ECS Cluster Blueprint (Click to expand)</b></summary> | |||
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.
| <summary><b>ECS Cluster Blueprint (Click to expand)</b></summary> | |
| <summary><b>ECS cluster blueprint (click to expand)</b></summary> | 
same here and in the other instances
| @@ -0,0 +1,82 @@ | |||
| # AWS Resource and Property Reference | |||
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.
| # AWS Resource and Property Reference | |
| # AWS resource and property reference | 
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.
This is fine
| ```yaml | ||
| - kind: AWS::EC2::Instance | ||
| selector: | ||
| query: 'true' | ||
| includeActions: | ||
| - DescribeInstanceStatusAction | ||
| ``` | 
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.
| ```yaml | |
| - kind: AWS::EC2::Instance | |
| selector: | |
| query: 'true' | |
| includeActions: | |
| - DescribeInstanceStatusAction | |
| ``` | |
| ```yaml showLineNumbers | |
| - kind: AWS::EC2::Instance | |
| selector: | |
| query: 'true' | |
| includeActions: | |
| - DescribeInstanceStatusAction | 
| @@ -0,0 +1,4 @@ | |||
| { | |||
| "label": "Amazon Relational Database Service", | |||
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.
| "label": "Amazon Relational Database Service", | |
| "label": "Amazon relational database service", | 
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.
Its a bit tough comprehending this because the casing are actually trademarks of the resource types .
AWS deliberately presents them this way, making a bit unusual if its looked at some other way, I don't know if you get me
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.
| @@ -0,0 +1,31 @@ | |||
| # Amazon Relational Database Service | |||
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.
| # Amazon Relational Database Service | |
| # Amazon relational database service | 
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.
| | **DescribeDBInstancesAction** | Discover DB instances and retrieve configuration details. [Reference](https://docs.aws.amazon.com/rds/latest/APIReference/API_DescribeDBInstances.html) | Default | `rds:DescribeDBInstances` | | ||
| | **ListTagsForResourceAction** | Retrieve tags for each DB instance. [Reference](https://docs.aws.amazon.com/rds/latest/APIReference/API_ListTagsForResource.html) | Optional | `rds:ListTagsForResource` | | 
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.
These links don't seem to work.
https://docs.aws.amazon.com/rds/latest/APIReference/API_DescribeDBInstances.html
| 
               | 
          ||
| | Action | Description | Type | Required AWS Permission | | ||
| |--------------------------|--------------------------------------------------------------------|---------|------------------------------------| | ||
| | **DescribeClustersAction** | Discover ECS clusters and retrieve detailed configuration data. [Reference](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeClusters.html) | Default | `ecs:ListClusters`, `ecs:DescribeClusters` | | 
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.
| | **DescribeClustersAction** | Discover ECS clusters and retrieve detailed configuration data. [Reference](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeClusters.html) | Default | `ecs:ListClusters`, `ecs:DescribeClusters` | | |
| | [**DescribeClustersAction**](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeClusters.html) | Discover ECS clusters and retrieve detailed configuration data. | Default | `ecs:ListClusters`, `ecs:DescribeClusters` | | 
Maybe the reference link can be attached to the action name itself? It just seems a bit odd at the end of the description to have "Reference". WDYT?


User description
Description
This documentation is inspired by aws's documentation(s) and the underlying structure of the integration.
Added docs pages
Please also include the path for the added docs
/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference)/platform-overview/port-components/blueprint)PR Type
Documentation, Enhancement
Description
Restructured AWS v3 documentation from flat examples to organized resource reference
Added comprehensive SQS Queue resource documentation with blueprint and properties
Reorganized existing resources (S3, EC2, ECS, Organizations) into service-based structure
Updated property tables with standardized "Availability" column (Default/Optional)
Added support for SQS queues in Overview.md supported resources list
Diagram Walkthrough
File Walkthrough
29 files
Add SQS Queues to supported resourcesRemove old flat examples structureRemove documentation generation rules fileRemove examples category configurationRemove old account info blueprint fileRemove old account info config fileRemove old organizations properties fileRemove old S3 properties fileCreate resource reference category configurationCreate main resource reference landing pageAdd SQS service documentation with actions tableCreate SQS service category configurationAdd SQS Queue blueprint with five propertiesAdd SQS Queue mapping configurationAdd SQS Queue properties reference tableCreate S3 service category configurationCreate S3 service documentation with actionsMigrate S3 properties with updated table formatCreate EC2 service category configurationCreate EC2 service documentation with actionsUpdate EC2 properties table with Availability columnCreate ECS service category configurationCreate ECS service documentation with actionsUpdate ECS properties table with Availability columnCreate AWS Organizations category configurationCreate Organizations service documentationAdd unlisted frontmatter to Organizations blueprintAdd unlisted frontmatter to Organizations configCreate Organizations properties with Availability column1 files
Update guide metadata isNew flag6 files