From 98d7d0d21e5ab8096a2313dd96b4457dfcdcdbfa Mon Sep 17 00:00:00 2001 From: shariff-6 Date: Thu, 9 Oct 2025 16:10:17 +0300 Subject: [PATCH 01/20] 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 02/20] 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 ``` From 882725569a53945abca5d979804fe621d493e504 Mon Sep 17 00:00:00 2001 From: Michael Kofi Armah Date: Tue, 28 Oct 2025 16:30:18 +0000 Subject: [PATCH 03/20] Refactor documentation structure --- .../cloud-providers/aws-v3/examples.md | 2 +- .../_category_.json | 4 ++ .../amazon-simple-queue-service.md | 41 +++++++++++++++++++ .../aws-sqs-queue}/_sqs_queue_blueprint.mdx | 8 +++- .../_sqs_queue_port_app_config.mdx | 8 +++- .../aws-sqs-queue}/_sqs_queue_properties.mdx | 8 +++- .../resource-and-property-reference.md | 11 +++++ .../guides-section/guide-metadata.json | 2 +- 8 files changed, 79 insertions(+), 5 deletions(-) create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/_category_.json create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md rename docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/{examples/sqs/queues => resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue}/_sqs_queue_blueprint.mdx (91%) rename docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/{examples/sqs/queues => resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue}/_sqs_queue_port_app_config.mdx (85%) rename docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/{examples/sqs/queues => resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue}/_sqs_queue_properties.mdx (97%) create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md 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 960c07f3db..52b554576d 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 @@ -28,7 +28,7 @@ These examples demonstrate how to create blueprints and configure mappings to in ## AWS Account -### AccountInfo +### Account Info The following example demonstrates how to ingest your AWS Account information to Port. diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/_category_.json b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/_category_.json new file mode 100644 index 0000000000..ccefe2de6d --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Resource and Property Reference", + "position": 4 +} diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md new file mode 100644 index 0000000000..37c6e60a07 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md @@ -0,0 +1,41 @@ +# Amazon Simple Queue Service + +import SqsQueueBlueprint from './aws-sqs-queue/_sqs_queue_blueprint.mdx' +import SqsQueueConfig from './aws-sqs-queue/_sqs_queue_port_app_config.mdx' +import SqsQueueProperties from './aws-sqs-queue/_sqs_queue_properties.mdx' + + + + +## 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 | +|----------------------------|------------------------------------------------------------------------------------------|-----------| +| **ListQueuesAction** | Discover all SQS queues across your AWS account. [Reference](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ListQueues.html) | Default | +| **GetQueueAttributesAction** | Retrieve detailed configuration and operational data for each queue. [Reference](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueAttributes.html) | Default | +| **GetQueueTagsAction** | Bring in custom tags assigned to your queues for advanced catalog filtering and grouping. [Reference](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ListQueueTags.html) | Optional | + +::::tip Enhance your SQS catalog +Enable queue tags for advanced filtering, streamlined workload tracking, and a more organized software catalog experience. +:::: + + +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). + + 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/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_blueprint.mdx similarity index 91% rename from docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_blueprint.mdx rename to docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_blueprint.mdx index 222393c9f6..6af27837e6 100644 --- 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/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_blueprint.mdx @@ -1,5 +1,9 @@ +--- +unlisted: true +--- +
-SQS queue blueprint (Click to expand) +SQS Queue Blueprint (Click to expand) ```json showLineNumbers { @@ -48,3 +52,5 @@ ```
+ + 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/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_port_app_config.mdx similarity index 85% rename from docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_port_app_config.mdx rename to docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_port_app_config.mdx index 7c3843c6e5..171a1ba3d8 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/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_port_app_config.mdx @@ -1,5 +1,9 @@ +--- +unlisted: true +--- +
-SQS queue mapping configuration (Click to expand) +SQS Queue Mapping Configuration (Click to expand) ```yaml showLineNumbers resources: @@ -23,3 +27,5 @@ resources: ```
+ + 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/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_properties.mdx similarity index 97% rename from docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/sqs/queues/_sqs_queue_properties.mdx rename to docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_properties.mdx index 4052740b31..22d22df8fc 100644 --- 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/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_properties.mdx @@ -1,5 +1,9 @@ +--- +unlisted: true +--- +
-SQS queue properties (Click to expand) +SQS Queue Properties (Click to expand) | Property | Type | Description | Action Required | |----------|------|-------------|-----------------| @@ -29,3 +33,5 @@ | `Tags` | object | The tags that have been assigned to the queue | GetQueueTagsAction |
+ + diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md new file mode 100644 index 0000000000..2e41d12bfe --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md @@ -0,0 +1,11 @@ +# Resource and Property Reference + +## Supported resource types + +This section contains reference information for all AWS resource and property types that are supported by AWS CloudFormation. + +Similar to cloudformation template, Resource type identifiers always take the following form: + +service-provider::service-name::data-type-name + +- Amazon Simple Queue Service \ No newline at end of file diff --git a/src/components/guides-section/guide-metadata.json b/src/components/guides-section/guide-metadata.json index 2711700115..222857dda2 100644 --- a/src/components/guides-section/guide-metadata.json +++ b/src/components/guides-section/guide-metadata.json @@ -725,7 +725,7 @@ }, "/guides/all/enforce-ai-coding-security-standards": { "creationDate": "2025-08-27T20:00:16.000Z", - "isNew": true + "isNew": false }, "/guides/all/find-internal-documentation-with-ai": { "creationDate": "2025-09-06T12:51:58.000Z", From 06c60505a1686d470cd5d7e3a91286281f570344 Mon Sep 17 00:00:00 2001 From: Michael Kofi Armah Date: Wed, 29 Oct 2025 12:53:30 +0000 Subject: [PATCH 04/20] Cleanup code --- .../cloud-providers/aws-v3/examples.md | 133 --------- .../.cursor/rules/aws_v3_examples.mdc | 282 ------------------ .../aws-v3/examples/_category_.json | 4 - .../account_info/_account_info_blueprint.mdx | 21 -- .../_account_info_port_app_config.mdx | 17 -- .../_organizations_accounts_properties.mdx | 16 - .../s3/buckets/_s3_bucket_properties.mdx | 15 - .../_category_.json | 4 + .../amazon-elastic-compute-cloud.md | 33 ++ .../_ec2_instance_blueprint.mdx | 0 .../_ec2_instance_port_app_config.mdx | 0 .../_ec2_instance_properties.mdx | 110 +++---- .../_category_.json | 4 + .../amazon-elastic-container-service.md | 32 ++ .../_ecs_cluster_blueprint.mdx | 0 .../_ecs_cluster_port_app_config.mdx | 0 .../_ecs_cluster_properties.mdx | 40 +-- .../amazon-simple-queue-service.md | 20 +- .../aws-sqs-queue/_sqs_queue_properties.mdx | 52 ++-- .../_category_.json | 4 + .../amazon-simple-storage-service.md | 37 +++ .../aws-s3-bucket}/_s3_bucket_blueprint.mdx | 0 .../_s3_bucket_port_app_config.mdx | 0 .../aws-s3-bucket/_s3_bucket_properties.mdx | 15 + .../aws-organizations/_category_.json | 4 + .../_organizations_accounts_blueprint.mdx | 4 + ...organizations_accounts_port_app_config.mdx | 4 + .../_organizations_accounts_properties.mdx | 20 ++ .../aws-organizations/aws-organizations.md | 33 ++ .../resource-and-property-reference.md | 8 +- 30 files changed, 311 insertions(+), 601 deletions(-) delete mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples.md delete mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/.cursor/rules/aws_v3_examples.mdc delete mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/_category_.json delete mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/account_info/_account_info_blueprint.mdx delete mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/account_info/_account_info_port_app_config.mdx delete mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/organizations/accounts/_organizations_accounts_properties.mdx delete mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/s3/buckets/_s3_bucket_properties.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/_category_.json create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md rename docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/{examples/ec2/instances => resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance}/_ec2_instance_blueprint.mdx (100%) rename docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/{examples/ec2/instances => resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance}/_ec2_instance_port_app_config.mdx (100%) rename docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/{examples/ec2/instances => resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance}/_ec2_instance_properties.mdx (65%) create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/_category_.json create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md rename docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/{examples/ecs/clusters => resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster}/_ecs_cluster_blueprint.mdx (100%) rename docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/{examples/ecs/clusters => resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster}/_ecs_cluster_port_app_config.mdx (100%) rename docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/{examples/ecs/clusters => resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster}/_ecs_cluster_properties.mdx (57%) create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/_category_.json create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md rename docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/{examples/s3/buckets => resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket}/_s3_bucket_blueprint.mdx (100%) rename docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/{examples/s3/buckets => resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket}/_s3_bucket_port_app_config.mdx (100%) create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_properties.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/_category_.json rename docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/{examples/organizations/accounts => resource-and-property-reference/aws-organizations/aws-organizations-account}/_organizations_accounts_blueprint.mdx (97%) rename docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/{examples/organizations/accounts => resource-and-property-reference/aws-organizations/aws-organizations-account}/_organizations_accounts_port_app_config.mdx (96%) create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_properties.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md 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 deleted file mode 100644 index 52b554576d..0000000000 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -sidebar_position: 4 ---- - -import AccountInfoBlueprint from './examples/account_info/_account_info_blueprint.mdx' -import AccountInfoConfig from './examples/account_info/_account_info_port_app_config.mdx' -import S3BucketBlueprint from './examples/s3/buckets/_s3_bucket_blueprint.mdx' -import S3PortAppConfig from './examples/s3/buckets/_s3_bucket_port_app_config.mdx' -import S3BucketProperties from './examples/s3/buckets/_s3_bucket_properties.mdx' -import EcsClusterBlueprint from './examples/ecs/clusters/_ecs_cluster_blueprint.mdx' -import EcsClusterConfig from './examples/ecs/clusters/_ecs_cluster_port_app_config.mdx' -import EcsClusterProperties from './examples/ecs/clusters/_ecs_cluster_properties.mdx' -import Ec2InstanceBlueprint from './examples/ec2/instances/_ec2_instance_blueprint.mdx' -import Ec2InstanceConfig from './examples/ec2/instances/_ec2_instance_port_app_config.mdx' -import Ec2InstanceProperties from './examples/ec2/instances/_ec2_instance_properties.mdx' -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 - -This page contains practical examples for mapping AWS resources to Port using AWS Hosted by Port. - -These examples demonstrate how to create blueprints and configure mappings to ingest your AWS infrastructure into your Port software catalog. - -## AWS Account - -### Account Info - -The following example demonstrates how to ingest your AWS Account information to Port. - -You can use the following Port blueprint definitions and integration configuration: - - - - - -## AWS Organizations - -### Organizations Accounts - -The following example demonstrates how to ingest your AWS Organizations Accounts to Port. - -You can use the following Port blueprint definitions and integration configuration: - - - - - -You can reference any of the following Organizations Account properties in your mapping configuration: - - - -For more details about Organizations Account properties, refer to the [AWS Organizations API documentation](https://docs.aws.amazon.com/organizations/latest/APIReference/API_DescribeAccount.html). - -## Amazon S3 - -### S3 buckets - -The following example demonstrates how to ingest your AWS S3 buckets to Port. - -You can use the following Port blueprint definitions and integration configuration: - - - - - -You can reference any of the following S3 bucket properties in your mapping configuration: - - - -For more details about S3 bucket properties, refer to the [AWS S3 API documentation](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html). - -## Amazon ECS - -### ECS clusters - -The following example demonstrates how to ingest your AWS ECS clusters to Port. - -You can use the following Port blueprint definitions and integration configuration: - - - - - -You can reference any of the following ECS cluster properties in your mapping configuration: - - - -For more details about ECS cluster properties, refer to the [AWS ECS API documentation](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeClusters.html). - -## Amazon EC2 - -### EC2 instances - -The following example demonstrates how to ingest your AWS EC2 instances to Port. - -You can use the following Port blueprint definitions and integration configuration: - - - - - -You can reference any of the following EC2 instance properties in your mapping configuration: - - - -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/.cursor/rules/aws_v3_examples.mdc b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/.cursor/rules/aws_v3_examples.mdc deleted file mode 100644 index b84390b1e9..0000000000 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/.cursor/rules/aws_v3_examples.mdc +++ /dev/null @@ -1,282 +0,0 @@ ---- -alwaysApply: true ---- -# AWS v3 Documentation Generation Rules - -You are an expert documentation agent for Port's AWS v3 integration examples. Follow these rules exactly when generating AWS resource documentation. - -## Quick Start Process - -1. **Access Ocean Repository Files** (MANDATORY): - - Model file: `curl -s "https://raw.githubusercontent.com/port-labs/ocean/refs/heads/main/integrations/aws-v3/aws/core/exporters/{service}/{resource}/models.py"` - - Actions file: `curl -s "https://raw.githubusercontent.com/port-labs/ocean/refs/heads/main/integrations/aws-v3/aws/core/exporters/{service}/{resource}/actions.py"` - -2. **Extract Information**: - - Properties from `{Resource}Properties` class - - Default vs optional actions from `ActionMap` class - -3. **Generate 3 Files**: - - `_{service}_{resource}_blueprint.mdx` (3-5 basic properties) - - `_{service}_{resource}_port_app_config.mdx` (mapping configuration) - - `_{service}_{resource}_properties.mdx` (complete properties table) - -4. **Update examples.md** following service-based organization - -## Required Information Checklist - -``` -□ AWS CloudFormation Resource Kind (e.g., AWS::ECS::Cluster) -□ Ocean model file path (e.g., ocean/integrations/aws-v3/aws/core/exporters/ecs/cluster/models.py) -□ Ocean actions file path (e.g., ocean/integrations/aws-v3/aws/core/exporters/ecs/cluster/actions.py) -□ Resource description (one sentence) -□ Identifier property (ARN/ID/Name) -□ Title property (human-readable name) -□ 3-5 basic properties for blueprint -□ Complete properties list from Ocean model -□ Default actions list from ActionMap -□ Optional actions list from ActionMap -□ AWS API documentation URL -``` - -**Response for missing info:** "Required information missing: [list items]. Provide all details to generate documentation." - -## Ocean Repository Integration - -**Critical Requirements:** -- **MANDATORY**: Use `run_terminal_cmd` with curl for direct file access -- **Extract ALL properties** from the `{Resource}Properties` class -- **Extract default and optional actions** from the `ActionMap` class -- **Use exact property names** and types from the model -- **Map JQ paths** using the `alias` field from Pydantic model -- **Include ALL available properties** in the complete properties reference table - -**URL Pattern:** -``` -curl -s "https://raw.githubusercontent.com/port-labs/ocean/refs/heads/main/integrations/aws-v3/aws/core/exporters/{service}/{resource}/models.py" -curl -s "https://raw.githubusercontent.com/port-labs/ocean/refs/heads/main/integrations/aws-v3/aws/core/exporters/{service}/{resource}/actions.py" -``` - -## Action Requirements - -**Action Types:** -- **Default actions**: Always included automatically (no limit) -- **Optional actions**: Must be explicitly requested via `includeActions` (maximum 3 per resource kind) - -**Action Mapping Rules:** -- **{ActionName} (default)**: Property available without additional action -- **{ActionName} (optional)**: Property requires this specific action to be included - -**Action Selection Strategy:** -- Choose based on property importance -- Focus on properties users commonly need -- Respect the 3-action limit per resource kind - -## Property Mapping & Selection - -**Type Mapping:** -- `str` → `"string"`, `int` → `"number"`, `bool` → `"boolean"` -- `List[str]` → `{"type": "array", "items": {"type": "string"}}` -- `List[Dict[str, Any]]` → `{"type": "array", "items": {"type": "object"}}` -- `Optional[Dict[str, Any]]` → `"object"` -- **Tags**: Always use array format with Key/Value objects -- **Optional fields**: Treat as required type (remove Optional wrapper) - -**Basic Properties Selection (exactly 3-5):** -1. **arn** (if available) - Always include unique identifier -2. **Primary identifier** (name/id) - Always include human-readable identifier -3. **tags** (if available) - Always include for AWS resources -4. **status/state** (if available) - Key operational property -5. **One additional operational property** - Choose from capacity/configuration, region, or runtime metrics - -**Mapping Rules:** -- **Blueprint properties**: Use camelCase from the model field names -- **JQ paths**: Use the `alias` field from Pydantic Field definitions - -## File Structure & Naming - -**Generate exactly this structure:** -``` -examples/{service-name}/{resource-type}/ -├── _{service-name}_{resource_type}_blueprint.mdx -├── _{service-name}_{resource_type}_port_app_config.mdx -└── _{service-name}_{resource_type}_properties.mdx -``` - -**Naming Rules:** -- Service directory: `{service-name}` (lowercase, e.g., `ecs`, `s3`, `lambda`) -- Resource directory: `{resource-type}` (lowercase, e.g., `clusters`, `buckets`, `functions`) -- Blueprint identifier: `camelCase` (e.g., `ecsCluster`, `s3Bucket`) - -**Service Name Mapping Examples:** -- `AWS::ECS::Cluster` → `ecs/clusters/` -- `AWS::S3::Bucket` → `s3/buckets/` -- `AWS::Lambda::Function` → `lambda/functions/` -- `AWS::EC2::Instance` → `ec2/instances/` -- `AWS::RDS::DBInstance` → `rds/instances/` - -## Generation Templates - -### Blueprint Template -```mdx -
-{RESOURCE_NAME} blueprint (Click to expand) - -```json showLineNumbers -{ - "identifier": "{CAMEL_CASE_IDENTIFIER}", - "description": "This blueprint represents an AWS {RESOURCE_NAME} in our software catalog", - "title": "{RESOURCE_NAME}", - "icon": "AWS", - "schema": { - "properties": { - // EXACTLY 3-5 PROPERTIES ONLY - USE PROVIDED BASIC PROPERTIES - // FORMAT: "propertyName": {"type": "string", "title": "Property Name"} - }, - "required": [] - }, - "mirrorProperties": {}, - "calculationProperties": {}, - "aggregationProperties": {}, - "relations": { - "account": { - "title": "Account", - "target": "awsAccount", - "required": true, - "many": false - } - } -} -``` - -
-``` - -### Config Template -```mdx -
-{RESOURCE_NAME} mapping configuration (Click to expand) - -```yaml showLineNumbers -resources: - - kind: {AWS_CLOUDFORMATION_KIND} - selector: - query: 'true' - includeActions: - # Optional: Include up to 3 additional actions for more properties - # Choose based on which properties you need most - # - {ActionName1} - # - {ActionName2} - # - {ActionName3} - port: - entity: - mappings: - identifier: .Properties.{IDENTIFIER_PROPERTY} - title: .Properties.{TITLE_PROPERTY} - blueprint: '"{CAMEL_CASE_IDENTIFIER}"' - properties: - // MAP SAME 3-5 PROPERTIES AS BLUEPRINT - // FORMAT: propertyName: .Properties.PropertyName - relations: - account: .__ExtraContext.AccountId -``` - -
-``` - -### Properties Template -```mdx -
-{RESOURCE_NAME} properties (Click to expand) - -| Property | JQ Path | Type | Action Required | -|----------|---------|------|-----------------| -{COMPLETE_PROPERTIES_TABLE} - -
-``` - -### examples.md Section Template -```markdown -import {PASCAL_CASE_NAME}Blueprint from './{service-name}/{resource-type}/_{service-name}_{resource_type}_blueprint.mdx'; -import {PASCAL_CASE_NAME}Config from './{service-name}/{resource-type}/_{service-name}_{resource_type}_port_app_config.mdx'; -import {PASCAL_CASE_NAME}Properties from './{service-name}/{resource-type}/_{service-name}_{resource_type}_properties.mdx'; - -## Amazon {SERVICE_NAME} - -### {RESOURCE_NAME}s - -The following example demonstrates how to ingest your AWS {RESOURCE_NAME}s to Port. - -You can use the following Port blueprint definitions and integration configuration: - -<{PASCAL_CASE_NAME}Blueprint/> - -<{PASCAL_CASE_NAME}Config/> - -You can reference any of the following {RESOURCE_NAME} properties in your mapping configuration: - -<{PASCAL_CASE_NAME}Properties/> - -For more details about {RESOURCE_NAME} properties, refer to the [AWS {SERVICE} API documentation]({AWS_API_URL}). -``` - -## Service-Based Organization Rules - -**Organization Logic:** -1. **If the service already exists** (e.g., Amazon ECS), add the new resource under the existing service section -2. **If the service doesn't exist** (e.g., Amazon Lambda), create a new service section - -**Placement Rules:** -- **New service**: Add after the last existing service section -- **New resource in existing service**: Add after the last resource in that service - -## Quality Validation - -**Verify before output:** -``` -□ Ocean model and actions files read via curl -□ Property count matches Ocean model exactly -□ File names match naming convention -□ Blueprint has 3-5 properties only -□ Config maps same properties as blueprint -□ Account relation present in both files -□ Complete properties table includes everything -□ All placeholder values replaced -□ No syntax errors -□ AWS API link valid -□ Service-based organization followed in examples.md -``` - -## Agent Output Format - -**Required Output Structure:** -1. **Ocean Repository Evidence** (show curl access): - - Property count from Ocean model: X properties - - Sample properties from model: [list 3-5 actual property names] - - Default actions from ActionMap: [list default actions] - - Optional actions from ActionMap: [list optional actions] - - Model file URL: [Raw GitHub URL accessed via curl] - - Actions file URL: [Raw GitHub URL accessed via curl] - -2. **Complete File Contents** (provide full content for each file) - -3. **examples.md Addition** (import statements + new section) - -4. **Validation Status:** `✅ All requirements verified including Ocean model and actions reading` - -## Error Handling - -**Missing information:** Stop. List missing items. Do not generate partial content. - -**Invalid property count:** Use exactly 3-5 basic properties. No exceptions. - -**Template modifications:** Templates cannot be modified. Work within constraints. - -## Success Criteria - -Generated documentation is successful when: -- All files can be copied directly into project -- Naming conventions followed exactly -- Property selection meets rules -- Quality validation passes 100% -- Service-based organization maintained in examples.md \ No newline at end of file diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/_category_.json b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/_category_.json deleted file mode 100644 index 62e826eef5..0000000000 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Examples", - "position": 3 -} diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/account_info/_account_info_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/account_info/_account_info_blueprint.mdx deleted file mode 100644 index 1dc06bf3a0..0000000000 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/account_info/_account_info_blueprint.mdx +++ /dev/null @@ -1,21 +0,0 @@ -
-AccountInfo blueprint (Click to expand) - -```json showLineNumbers -{ - "identifier": "awsAccount", - "description": "This blueprint represents an AWS Account in our software catalog", - "title": "Account", - "icon": "AWS", - "schema": { - "properties": {}, - "required": [] - }, - "mirrorProperties": {}, - "calculationProperties": {}, - "aggregationProperties": {}, - "relations": {} -} -``` - -
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/account_info/_account_info_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/account_info/_account_info_port_app_config.mdx deleted file mode 100644 index 5e4d499975..0000000000 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/account_info/_account_info_port_app_config.mdx +++ /dev/null @@ -1,17 +0,0 @@ -
-AccountInfo mapping configuration (Click to expand) - -```yaml showLineNumbers -resources: - - kind: AccountInfo - selector: - query: 'true' - port: - entity: - mappings: - identifier: .Properties.Id - title: .Properties.Name - blueprint: '"awsAccount"' -``` - -
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/organizations/accounts/_organizations_accounts_properties.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/organizations/accounts/_organizations_accounts_properties.mdx deleted file mode 100644 index eb27e954da..0000000000 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/organizations/accounts/_organizations_accounts_properties.mdx +++ /dev/null @@ -1,16 +0,0 @@ -
-Organizations Account properties (Click to expand) - -| Property | JQ Path | Type | Action Required | -|----------|---------|------|-----------------| -| Id | .Properties.Id | string | ListAccountsAction (default) | -| AccountName | .Properties.AccountName | string | ListAccountsAction (default) | -| Arn | .Properties.Arn | string | ListAccountsAction (default) | -| Email | .Properties.Email | string | ListAccountsAction (default) | -| Status | .Properties.Status | string | ListAccountsAction (default) | -| JoinedTimestamp | .Properties.JoinedTimestamp | string | ListAccountsAction (default) | -| JoinedMethod | .Properties.JoinedMethod | string | ListAccountsAction (default) | -| Tags | .Properties.Tags | array | ListTagsForResourceAction (optional) | -| Parents | .Properties.Parents | array | ListParentsAction (optional) | - -
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/s3/buckets/_s3_bucket_properties.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/s3/buckets/_s3_bucket_properties.mdx deleted file mode 100644 index f9b010afb4..0000000000 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/s3/buckets/_s3_bucket_properties.mdx +++ /dev/null @@ -1,15 +0,0 @@ -
-S3 bucket properties (Click to expand) - -| Property | JQ Path | Type | Action Required | -|----------|---------|------|-----------------| -| Bucket Name | `.Properties.BucketName` | string | ListBucketsAction (default) | -| ARN | `.Properties.Arn` | string | ListBucketsAction (default) | -| Creation Date | `.Properties.CreationDate` | datetime | ListBucketsAction (default) | -| Region | `.Properties.LocationConstraint` | string | GetBucketLocationAction (default) | -| Tags | `.Properties.Tags` | array | GetBucketTaggingAction (default) | -| Bucket Encryption | `.Properties.BucketEncryption` | object | GetBucketEncryptionAction (optional) | -| Public Access Block Configuration | `.Properties.PublicAccessBlockConfiguration` | object | GetBucketPublicAccessBlockAction (optional) | -| Ownership Controls | `.Properties.OwnershipControls` | object | GetBucketOwnershipControlsAction (optional) | - -
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/_category_.json b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/_category_.json new file mode 100644 index 0000000000..b43bcce25b --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Amazon Elastic Compute Cloud", + "position": 3 +} diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md new file mode 100644 index 0000000000..efadb50c2d --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md @@ -0,0 +1,33 @@ +# Amazon Elastic Compute Cloud + +import Ec2InstanceBlueprint from './aws-ec2-instance/_ec2_instance_blueprint.mdx' +import Ec2InstanceConfig from './aws-ec2-instance/_ec2_instance_port_app_config.mdx' +import Ec2InstanceProperties from './aws-ec2-instance/_ec2_instance_properties.mdx' + + + +## AWS::EC2::Instance + +The following example demonstrates how to ingest your AWS EC2 instances to Port. + +#### EC2 Instance Supported Actions + +The table below summarizes the available actions for ingesting Amazon EC2 Instance resources in Port: + +| Action | Description | Type | Required AWS Permission | +|-----------------------------|------------------------------------------------------------|----------|--------------------------------| +| **DescribeInstancesAction** | Discover EC2 instances and retrieve detailed configuration data. [Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) | Default | `ec2:DescribeInstances` | +| **GetInstanceStatusAction** | Retrieve instance status information. [Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstanceStatus.html) | Optional | `ec2:DescribeInstanceStatus` | + +:::info 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: + + + + + +For more details about EC2 instance properties, refer to the [AWS EC2 API documentation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Welcome.html). diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/ec2/instances/_ec2_instance_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_blueprint.mdx similarity index 100% rename from docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/ec2/instances/_ec2_instance_blueprint.mdx rename to docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_blueprint.mdx diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/ec2/instances/_ec2_instance_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_port_app_config.mdx similarity index 100% rename from docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/ec2/instances/_ec2_instance_port_app_config.mdx rename to docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_port_app_config.mdx diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/ec2/instances/_ec2_instance_properties.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_properties.mdx similarity index 65% rename from docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/ec2/instances/_ec2_instance_properties.mdx rename to docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_properties.mdx index 084f9dd01c..06f6c8c2f3 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/ec2/instances/_ec2_instance_properties.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_properties.mdx @@ -1,60 +1,60 @@
EC2 instance properties (Click to expand) -| Property | JQ Path | Type | Action Required | -|----------|---------|------|-----------------| -| Instance ARN | `.Properties.InstanceArn` | string | DescribeInstancesAction (default) | -| Instance ID | `.Properties.InstanceId` | string | DescribeInstancesAction (default) | -| Instance Type | `.Properties.InstanceType` | string | DescribeInstancesAction (default) | -| Availability Zone | `.Properties.AvailabilityZone` | string | DescribeInstancesAction (default) | -| Tags | `.Properties.Tags` | array | DescribeInstancesAction (default) | -| AMI Launch Index | `.Properties.AmiLaunchIndex` | number | DescribeInstancesAction (default) | -| Architecture | `.Properties.Architecture` | string | DescribeInstancesAction (default) | -| Block Device Mappings | `.Properties.BlockDeviceMappings` | array | DescribeInstancesAction (default) | -| Boot Mode | `.Properties.BootMode` | string | DescribeInstancesAction (default) | -| Capacity Reservation Specification | `.Properties.CapacityReservationSpecification` | object | DescribeInstancesAction (default) | -| Client Token | `.Properties.ClientToken` | string | DescribeInstancesAction (default) | -| CPU Options | `.Properties.CpuOptions` | object | DescribeInstancesAction (default) | -| Current Instance Boot Mode | `.Properties.CurrentInstanceBootMode` | string | DescribeInstancesAction (default) | -| EBS Optimized | `.Properties.EbsOptimized` | boolean | DescribeInstancesAction (default) | -| Enclave Options | `.Properties.EnclaveOptions` | object | DescribeInstancesAction (default) | -| ENA Support | `.Properties.EnaSupport` | boolean | DescribeInstancesAction (default) | -| Events | `.Properties.Events` | array | DescribeInstancesAction (default) | -| Hibernation Options | `.Properties.HibernationOptions` | object | DescribeInstancesAction (default) | -| Hypervisor | `.Properties.Hypervisor` | string | DescribeInstancesAction (default) | -| Image ID | `.Properties.ImageId` | string | DescribeInstancesAction (default) | -| Instance Status | `.Properties.InstanceStatus` | object | GetInstanceStatusAction (optional) | -| Instance State | `.Properties.InstanceState` | object | DescribeInstancesAction (default) | -| Key Name | `.Properties.KeyName` | string | DescribeInstancesAction (default) | -| Launch Time | `.Properties.LaunchTime` | datetime | DescribeInstancesAction (default) | -| Maintenance Options | `.Properties.MaintenanceOptions` | object | DescribeInstancesAction (default) | -| Metadata Options | `.Properties.MetadataOptions` | object | DescribeInstancesAction (default) | -| Monitoring | `.Properties.Monitoring` | object | DescribeInstancesAction (default) | -| Network Interfaces | `.Properties.NetworkInterfaces` | array | DescribeInstancesAction (default) | -| Network Performance Options | `.Properties.NetworkPerformanceOptions` | object | DescribeInstancesAction (default) | -| Operator | `.Properties.Operator` | object | DescribeInstancesAction (default) | -| Placement | `.Properties.Placement` | object | DescribeInstancesAction (default) | -| Platform | `.Properties.Platform` | string | DescribeInstancesAction (default) | -| Platform Details | `.Properties.PlatformDetails` | string | DescribeInstancesAction (default) | -| Private DNS Name | `.Properties.PrivateDnsName` | string | DescribeInstancesAction (default) | -| Private DNS Name Options | `.Properties.PrivateDnsNameOptions` | object | DescribeInstancesAction (default) | -| Private IP Address | `.Properties.PrivateIpAddress` | string | DescribeInstancesAction (default) | -| Product Codes | `.Properties.ProductCodes` | array | DescribeInstancesAction (default) | -| Public DNS Name | `.Properties.PublicDnsName` | string | DescribeInstancesAction (default) | -| Public IP Address | `.Properties.PublicIpAddress` | string | DescribeInstancesAction (default) | -| Reason | `.Properties.Reason` | string | DescribeInstancesAction (default) | -| Root Device Name | `.Properties.RootDeviceName` | string | DescribeInstancesAction (default) | -| Root Device Type | `.Properties.RootDeviceType` | string | DescribeInstancesAction (default) | -| Security Groups | `.Properties.SecurityGroups` | array | DescribeInstancesAction (default) | -| Source Dest Check | `.Properties.SourceDestCheck` | boolean | DescribeInstancesAction (default) | -| State | `.Properties.State` | object | DescribeInstancesAction (default) | -| State Reason | `.Properties.StateReason` | object | DescribeInstancesAction (default) | -| State Transition Reason | `.Properties.StateTransitionReason` | string | DescribeInstancesAction (default) | -| Subnet ID | `.Properties.SubnetId` | string | DescribeInstancesAction (default) | -| System Status | `.Properties.SystemStatus` | object | DescribeInstancesAction (default) | -| Usage Operation | `.Properties.UsageOperation` | string | DescribeInstancesAction (default) | -| Usage Operation Update Time | `.Properties.UsageOperationUpdateTime` | datetime | DescribeInstancesAction (default) | -| Virtualization Type | `.Properties.VirtualizationType` | string | DescribeInstancesAction (default) | -| VPC ID | `.Properties.VpcId` | string | DescribeInstancesAction (default) | +| Property | JQ Path | Type | Action Required | Availability | +|----------|---------|------|-----------------|--------------| +| Instance ARN | `.Properties.InstanceArn` | string | DescribeInstancesAction | Default | +| Instance ID | `.Properties.InstanceId` | string | DescribeInstancesAction | Default | +| Instance Type | `.Properties.InstanceType` | string | DescribeInstancesAction | Default | +| Availability Zone | `.Properties.AvailabilityZone` | string | DescribeInstancesAction | Default | +| Tags | `.Properties.Tags` | array | DescribeInstancesAction | Default | +| AMI Launch Index | `.Properties.AmiLaunchIndex` | number | DescribeInstancesAction | Default | +| Architecture | `.Properties.Architecture` | string | DescribeInstancesAction | Default | +| Block Device Mappings | `.Properties.BlockDeviceMappings` | array | DescribeInstancesAction | Default | +| Boot Mode | `.Properties.BootMode` | string | DescribeInstancesAction | Default | +| Capacity Reservation Specification | `.Properties.CapacityReservationSpecification` | object | DescribeInstancesAction | Default | +| Client Token | `.Properties.ClientToken` | string | DescribeInstancesAction | Default | +| CPU Options | `.Properties.CpuOptions` | object | DescribeInstancesAction | Default | +| Current Instance Boot Mode | `.Properties.CurrentInstanceBootMode` | string | DescribeInstancesAction | Default | +| EBS Optimized | `.Properties.EbsOptimized` | boolean | DescribeInstancesAction | Default | +| Enclave Options | `.Properties.EnclaveOptions` | object | DescribeInstancesAction | Default | +| ENA Support | `.Properties.EnaSupport` | boolean | DescribeInstancesAction | Default | +| Events | `.Properties.Events` | array | DescribeInstancesAction | Default | +| Hibernation Options | `.Properties.HibernationOptions` | object | DescribeInstancesAction | Default | +| Hypervisor | `.Properties.Hypervisor` | string | DescribeInstancesAction | Default | +| Image ID | `.Properties.ImageId` | string | DescribeInstancesAction | Default | +| Instance Status | `.Properties.InstanceStatus` | object | GetInstanceStatusAction | Optional | +| Instance State | `.Properties.InstanceState` | object | DescribeInstancesAction | Default | +| Key Name | `.Properties.KeyName` | string | DescribeInstancesAction | Default | +| Launch Time | `.Properties.LaunchTime` | datetime | DescribeInstancesAction | Default | +| Maintenance Options | `.Properties.MaintenanceOptions` | object | DescribeInstancesAction | Default | +| Metadata Options | `.Properties.MetadataOptions` | object | DescribeInstancesAction | Default | +| Monitoring | `.Properties.Monitoring` | object | DescribeInstancesAction | Default | +| Network Interfaces | `.Properties.NetworkInterfaces` | array | DescribeInstancesAction | Default | +| Network Performance Options | `.Properties.NetworkPerformanceOptions` | object | DescribeInstancesAction | Default | +| Operator | `.Properties.Operator` | object | DescribeInstancesAction | Default | +| Placement | `.Properties.Placement` | object | DescribeInstancesAction | Default | +| Platform | `.Properties.Platform` | string | DescribeInstancesAction | Default | +| Platform Details | `.Properties.PlatformDetails` | string | DescribeInstancesAction | Default | +| Private DNS Name | `.Properties.PrivateDnsName` | string | DescribeInstancesAction | Default | +| Private DNS Name Options | `.Properties.PrivateDnsNameOptions` | object | DescribeInstancesAction | Default | +| Private IP Address | `.Properties.PrivateIpAddress` | string | DescribeInstancesAction | Default | +| Product Codes | `.Properties.ProductCodes` | array | DescribeInstancesAction | Default | +| Public DNS Name | `.Properties.PublicDnsName` | string | DescribeInstancesAction | Default | +| Public IP Address | `.Properties.PublicIpAddress` | string | DescribeInstancesAction | Default | +| Reason | `.Properties.Reason` | string | DescribeInstancesAction | Default | +| Root Device Name | `.Properties.RootDeviceName` | string | DescribeInstancesAction | Default | +| Root Device Type | `.Properties.RootDeviceType` | string | DescribeInstancesAction | Default | +| Security Groups | `.Properties.SecurityGroups` | array | DescribeInstancesAction | Default | +| Source Dest Check | `.Properties.SourceDestCheck` | boolean | DescribeInstancesAction | Default | +| State | `.Properties.State` | object | DescribeInstancesAction | Default | +| State Reason | `.Properties.StateReason` | object | DescribeInstancesAction | Default | +| State Transition Reason | `.Properties.StateTransitionReason` | string | DescribeInstancesAction | Default | +| Subnet ID | `.Properties.SubnetId` | string | DescribeInstancesAction | Default | +| System Status | `.Properties.SystemStatus` | object | DescribeInstancesAction | Default | +| Usage Operation | `.Properties.UsageOperation` | string | DescribeInstancesAction | Default | +| Usage Operation Update Time | `.Properties.UsageOperationUpdateTime` | datetime | DescribeInstancesAction | Default | +| Virtualization Type | `.Properties.VirtualizationType` | string | DescribeInstancesAction | Default | +| VPC ID | `.Properties.VpcId` | string | DescribeInstancesAction | Default |
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/_category_.json b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/_category_.json new file mode 100644 index 0000000000..7720c3b540 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Amazon Elastic Container Service", + "position": 4 +} diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md new file mode 100644 index 0000000000..6d38bfb12a --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md @@ -0,0 +1,32 @@ +# Amazon Elastic Container Service + +import EcsClusterBlueprint from './aws-ecs-cluster/_ecs_cluster_blueprint.mdx' +import EcsClusterConfig from './aws-ecs-cluster/_ecs_cluster_port_app_config.mdx' +import EcsClusterProperties from './aws-ecs-cluster/_ecs_cluster_properties.mdx' + + + +## AWS::ECS::Cluster + +The following example demonstrates how to ingest your AWS ECS clusters to Port. + +#### ECS Cluster Supported Actions + +The table below summarizes the available actions for ingesting Amazon ECS Cluster resources in Port: + +| 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` | + +:::info All properties available by default +ECS clusters expose their key properties via the default DescribeClusters action. +::: + + +You can use the following Port blueprint definitions and integration configuration: + + + + + +For more details about ECS cluster properties, refer to the [AWS ECS API documentation](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/Welcome.html). diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/ecs/clusters/_ecs_cluster_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_blueprint.mdx similarity index 100% rename from docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/ecs/clusters/_ecs_cluster_blueprint.mdx rename to docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_blueprint.mdx diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/ecs/clusters/_ecs_cluster_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_port_app_config.mdx similarity index 100% rename from docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/ecs/clusters/_ecs_cluster_port_app_config.mdx rename to docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_port_app_config.mdx diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/ecs/clusters/_ecs_cluster_properties.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_properties.mdx similarity index 57% rename from docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/ecs/clusters/_ecs_cluster_properties.mdx rename to docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_properties.mdx index b0579b4614..9eb3821e27 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/ecs/clusters/_ecs_cluster_properties.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_properties.mdx @@ -1,23 +1,27 @@ +--- +unlisted: true +--- +
ECS cluster properties (Click to expand) -| Property | JQ Path | Type | Action Required | -|----------|---------|------|-----------------| -| Cluster Name | `.Properties.ClusterName` | string | DescribeClustersAction (default) | -| Cluster ARN | `.Properties.ClusterArn` | string | DescribeClustersAction (default) | -| Status | `.Properties.Status` | string | DescribeClustersAction (default) | -| Capacity Providers | `.Properties.CapacityProviders` | array | DescribeClustersAction (default) | -| Tags | `.Properties.Tags` | array | DescribeClustersAction (default) | -| Cluster Settings | `.Properties.ClusterSettings` | array | DescribeClustersAction (default) | -| Configuration | `.Properties.Configuration` | object | DescribeClustersAction (default) | -| Default Capacity Provider Strategy | `.Properties.DefaultCapacityProviderStrategy` | array | DescribeClustersAction (default) | -| Service Connect Defaults | `.Properties.ServiceConnectDefaults` | object | DescribeClustersAction (default) | -| Attachments | `.Properties.Attachments` | array | DescribeClustersAction (default) | -| Attachments Status | `.Properties.AttachmentsStatus` | string | DescribeClustersAction (default) | -| Statistics | `.Properties.Statistics` | array | DescribeClustersAction (default) | -| Active Services Count | `.Properties.ActiveServicesCount` | number | DescribeClustersAction (default) | -| Pending Tasks Count | `.Properties.PendingTasksCount` | number | DescribeClustersAction (default) | -| Running Tasks Count | `.Properties.RunningTasksCount` | number | DescribeClustersAction (default) | -| Registered Container Instances Count | `.Properties.RegisteredContainerInstancesCount` | number | DescribeClustersAction (default) | +| Property | JQ Path | Type | Action Required | Availability | +|----------|---------|------|-----------------|--------------| +| Cluster Name | `.Properties.ClusterName` | string | DescribeClustersAction | Default | +| Cluster ARN | `.Properties.ClusterArn` | string | DescribeClustersAction | Default | +| Status | `.Properties.Status` | string | DescribeClustersAction | Default | +| Capacity Providers | `.Properties.CapacityProviders` | array | DescribeClustersAction | Default | +| Tags | `.Properties.Tags` | array | DescribeClustersAction | Default | +| Cluster Settings | `.Properties.ClusterSettings` | array | DescribeClustersAction | Default | +| Configuration | `.Properties.Configuration` | object | DescribeClustersAction | Default | +| Default Capacity Provider Strategy | `.Properties.DefaultCapacityProviderStrategy` | array | DescribeClustersAction | Default | +| Service Connect Defaults | `.Properties.ServiceConnectDefaults` | object | DescribeClustersAction | Default | +| Attachments | `.Properties.Attachments` | array | DescribeClustersAction | Default | +| Attachments Status | `.Properties.AttachmentsStatus` | string | DescribeClustersAction | Default | +| Statistics | `.Properties.Statistics` | array | DescribeClustersAction | Default | +| Active Services Count | `.Properties.ActiveServicesCount` | number | DescribeClustersAction | Default | +| Pending Tasks Count | `.Properties.PendingTasksCount` | number | DescribeClustersAction | Default | +| Running Tasks Count | `.Properties.RunningTasksCount` | number | DescribeClustersAction | Default | +| Registered Container Instances Count | `.Properties.RegisteredContainerInstancesCount` | number | DescribeClustersAction | Default |
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md index 37c6e60a07..d83163d637 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md @@ -15,15 +15,15 @@ The following example demonstrates how to ingest your AWS SQS queues to Port. The table below summarizes the available actions for ingesting Amazon SQS Queue resources in Port: -| Action | Description | Type | -|----------------------------|------------------------------------------------------------------------------------------|-----------| -| **ListQueuesAction** | Discover all SQS queues across your AWS account. [Reference](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ListQueues.html) | Default | -| **GetQueueAttributesAction** | Retrieve detailed configuration and operational data for each queue. [Reference](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueAttributes.html) | Default | -| **GetQueueTagsAction** | Bring in custom tags assigned to your queues for advanced catalog filtering and grouping. [Reference](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ListQueueTags.html) | Optional | +| Action | Description | Type | Required AWS Permission | +|-----------------------------|------------------------------------------------------------------------------------------|----------|-------------------------| +| **ListQueuesAction** | Discover all SQS queues across your AWS account. [Reference](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ListQueues.html) | Default | `sqs:ListQueues` | +| **GetQueueAttributesAction**| Retrieve detailed configuration and operational data for each queue. [Reference](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueAttributes.html) | Default | `sqs:GetQueueAttributes`| +| **GetQueueTagsAction** | Bring in custom tags assigned to your queues for advanced catalog filtering and grouping. [Reference](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ListQueueTags.html) | Optional | `sqs:ListQueueTags` | -::::tip Enhance your SQS catalog -Enable queue tags for advanced filtering, streamlined workload tracking, and a more organized software catalog experience. -:::: +:::info 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: @@ -32,10 +32,6 @@ You can use the following Port blueprint definitions and integration configurati -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). diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_properties.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_properties.mdx index 22d22df8fc..e9a99f0b59 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_properties.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_properties.mdx @@ -5,32 +5,32 @@ unlisted: true
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 | +| Property | Type | Description | Action Required | Availability | +|----------|------|-------------|-----------------|--------------| +| `QueueName` | string | The name of the SQS queue | Default | Default | +| `QueueUrl` | string | The URL of the SQS queue | Default | Default | +| `QueueArn` | string | The Amazon Resource Name (ARN) of the SQS queue | Default | Default | +| `ApproximateNumberOfMessages` | number | The approximate number of messages available for retrieval from the queue | Default | Default | +| `ApproximateNumberOfMessagesNotVisible` | number | The approximate number of messages in the queue that are delayed and not available for reading immediately | Default | Default | +| `ApproximateNumberOfMessagesDelayed` | number | The approximate number of messages in the queue that are delayed and not available for reading immediately | Default | Default | +| `CreatedTimestamp` | string | The time when the queue was created (Unix timestamp) | Default | Default | +| `LastModifiedTimestamp` | string | The time when the queue was last changed (Unix timestamp) | Default | Default | +| `VisibilityTimeout` | number | The visibility timeout for the queue in seconds | Default | Default | +| `MaximumMessageSize` | number | The limit of how many bytes a message can contain before Amazon SQS rejects it | Default | Default | +| `MessageRetentionPeriod` | number | The number of seconds for which Amazon SQS retains a message | Default | Default | +| `DelaySeconds` | number | The default delay for a message in the queue in seconds | Default | Default | +| `ReceiveMessageWaitTimeSeconds` | number | The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive | Default | Default | +| `Policy` | string | The queue's policy | Default | Default | +| `RedrivePolicy` | string | The string that includes the parameters for the dead-letter queue functionality | Default | Default | +| `RedriveAllowPolicy` | string | The string that includes the parameters for the permissions for the dead-letter queue redrive permission | Default | Default | +| `KmsMasterKeyId` | string | The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK | Default | 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 | Default | +| `SqsManagedSseEnabled` | boolean | Returns true if the queue is using SSE-SQS encryption using SQS owned encryption keys | Default | Default | +| `FifoQueue` | boolean | Returns true if the queue is a FIFO queue | Default | Default | +| `ContentBasedDeduplication` | boolean | Returns true if content-based deduplication is enabled for the queue | Default | Default | +| `DeduplicationScope` | string | Specifies whether message deduplication occurs at the message group or queue level | Default | Default | +| `FifoThroughputLimit` | string | Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group | Default | Default | +| `Tags` | object | The tags that have been assigned to the queue | GetQueueTagsAction | Optional |
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/_category_.json b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/_category_.json new file mode 100644 index 0000000000..6ce2191215 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Amazon Simple Storage Service", + "position": 2 +} diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md new file mode 100644 index 0000000000..5eee6c3a9a --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md @@ -0,0 +1,37 @@ +# Amazon Simple Storage Service + +import S3BucketBlueprint from './aws-s3-bucket/_s3_bucket_blueprint.mdx' +import S3BucketConfig from './aws-s3-bucket/_s3_bucket_port_app_config.mdx' +import S3BucketProperties from './aws-s3-bucket/_s3_bucket_properties.mdx' + + + +## AWS::S3::Bucket + +The following example demonstrates how to ingest your AWS S3 buckets to Port. + +#### S3 Bucket Supported Actions + +The table below summarizes the available actions for ingesting Amazon S3 Bucket resources in Port: + +| Action | Description | Type | Required AWS Permission | +|--------------------------------------|----------------------------------------------------------------|----------|---------------------------------------------------------| +| **ListBucketsAction** | Discover all S3 buckets across your AWS account. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html) | Default | `s3:ListAllMyBuckets` | +| **GetBucketLocationAction** | Retrieve the bucket's region. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLocation.html) | Default | `s3:GetBucketLocation` | +| **GetBucketTaggingAction** | Bring in bucket tags for catalog filtering and grouping. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html) | Default | `s3:GetBucketTagging` | +| **GetBucketEncryptionAction** | Retrieve server-side encryption configuration for the bucket. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html) | Optional | `s3:GetBucketEncryption` | +| **GetBucketPublicAccessBlockAction** | Retrieve public access block configuration. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) | Optional | `s3:GetBucketPublicAccessBlock` | +| **GetBucketOwnershipControlsAction** | Retrieve bucket ownership controls. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketOwnershipControls.html) | Optional | `s3:GetBucketOwnershipControls` | + +:::info 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: + + + + + +For more details about S3 bucket properties, refer to the [AWS S3 API documentation](https://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html). diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/s3/buckets/_s3_bucket_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_blueprint.mdx similarity index 100% rename from docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/s3/buckets/_s3_bucket_blueprint.mdx rename to docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_blueprint.mdx diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/s3/buckets/_s3_bucket_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_port_app_config.mdx similarity index 100% rename from docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/s3/buckets/_s3_bucket_port_app_config.mdx rename to docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_port_app_config.mdx diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_properties.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_properties.mdx new file mode 100644 index 0000000000..755ce1fbdc --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_properties.mdx @@ -0,0 +1,15 @@ +
+S3 bucket properties (Click to expand) + +| Property | JQ Path | Type | Action Required | Availability | +|----------|---------|------|-----------------|--------------| +| Bucket Name | `.Properties.BucketName` | string | ListBucketsAction | Default | +| ARN | `.Properties.Arn` | string | ListBucketsAction | Default | +| Creation Date | `.Properties.CreationDate` | datetime | ListBucketsAction | Default | +| Region | `.Properties.LocationConstraint` | string | GetBucketLocationAction | Default | +| Tags | `.Properties.Tags` | array | GetBucketTaggingAction | Default | +| Bucket Encryption | `.Properties.BucketEncryption` | object | GetBucketEncryptionAction | Optional | +| Public Access Block Configuration | `.Properties.PublicAccessBlockConfiguration` | object | GetBucketPublicAccessBlockAction | Optional | +| Ownership Controls | `.Properties.OwnershipControls` | object | GetBucketOwnershipControlsAction | Optional | + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/_category_.json b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/_category_.json new file mode 100644 index 0000000000..f6d3d7df82 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "AWS Organizations", + "position": 5 +} diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/organizations/accounts/_organizations_accounts_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_blueprint.mdx similarity index 97% rename from docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/organizations/accounts/_organizations_accounts_blueprint.mdx rename to docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_blueprint.mdx index a0d7a6a671..f89367c2fb 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/organizations/accounts/_organizations_accounts_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_blueprint.mdx @@ -1,3 +1,7 @@ +--- +unlisted: true +--- +
Organizations Account blueprint (Click to expand) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/organizations/accounts/_organizations_accounts_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_port_app_config.mdx similarity index 96% rename from docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/organizations/accounts/_organizations_accounts_port_app_config.mdx rename to docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_port_app_config.mdx index af47e5ed3e..167d16c16b 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/organizations/accounts/_organizations_accounts_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_port_app_config.mdx @@ -1,3 +1,7 @@ +--- +unlisted: true +--- +
Organizations Account mapping configuration (Click to expand) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_properties.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_properties.mdx new file mode 100644 index 0000000000..2905a391e7 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_properties.mdx @@ -0,0 +1,20 @@ +--- +unlisted: true +--- + +
+Organizations Account properties (Click to expand) + +| Property | JQ Path | Type | Action Required | Availability | +|----------|---------|------|-----------------|--------------| +| Id | .Properties.Id | string | ListAccountsAction | Default | +| AccountName | .Properties.AccountName | string | ListAccountsAction | Default | +| Arn | .Properties.Arn | string | ListAccountsAction | Default | +| Email | .Properties.Email | string | ListAccountsAction | Default | +| Status | .Properties.Status | string | ListAccountsAction | Default | +| JoinedTimestamp | .Properties.JoinedTimestamp | string | ListAccountsAction | Default | +| JoinedMethod | .Properties.JoinedMethod | string | ListAccountsAction | Default | +| Tags | .Properties.Tags | array | ListTagsForResourceAction | Optional | +| Parents | .Properties.Parents | array | ListParentsAction | Optional | + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md new file mode 100644 index 0000000000..3a3461ec75 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md @@ -0,0 +1,33 @@ +# AWS Organizations + +import OrganizationsAccountBlueprint from './aws-organizations-account/_organizations_accounts_blueprint.mdx' +import OrganizationsAccountConfig from './aws-organizations-account/_organizations_accounts_port_app_config.mdx' +import OrganizationsAccountProperties from './aws-organizations-account/_organizations_accounts_properties.mdx' + + + +## AWS::Organizations::Account + +The following example demonstrates how to ingest your AWS Organizations accounts to Port. + +#### Organizations Account Supported Actions + +The table below summarizes the available actions for ingesting AWS Organizations Account resources in Port: + +| Action | Description | Type | Required AWS Permission | +|-----------------------------|------------------------------------------------------------------|----------|-----------------------------------| +| **ListAccountsAction** | Discover organization accounts and retrieve account metadata. [Reference](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListAccounts.html) | Default | `organizations:ListAccounts` | +| **ListTagsForResourceAction** | Retrieve tags for the specified account. [Reference](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListTagsForResource.html) | Optional | `organizations:ListTagsForResource`| +| **ListParentsAction** | Retrieve parent information for the specified account. [Reference](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListParents.html) | Optional | `organizations:ListParents` | + +:::info 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: + + + + + +For more details about Organizations accounts, refer to the [AWS Organizations API documentation](https://docs.aws.amazon.com/organizations/latest/APIReference/Welcome.html). diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md index 2e41d12bfe..243c6de758 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md @@ -6,6 +6,10 @@ This section contains reference information for all AWS resource and property ty Similar to cloudformation template, Resource type identifiers always take the following form: -service-provider::service-name::data-type-name +`service-provider::service-name::data-type-name` -- Amazon Simple Queue Service \ No newline at end of file +- [Amazon Simple Queue Service](./amazon-simple-queue-service/amazon-simple-queue-service.md) +- [Amazon Simple Storage Service](./amazon-simple-storage-service/amazon-simple-storage-service.md) +- [Amazon Elastic Compute Cloud](./amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md) +- [Amazon Elastic Container Service](./amazon-elastic-container-service/amazon-elastic-container-service.md) +- [AWS Organizations](./aws-organizations/aws-organizations.md) \ No newline at end of file From 5210b1de78cd033967a8f4531afdab8455976bb6 Mon Sep 17 00:00:00 2001 From: Michael Kofi Armah Date: Wed, 29 Oct 2025 14:01:09 +0000 Subject: [PATCH 05/20] Talk about actions --- .../resource-and-property-reference.md | 69 +++++++++++++++++-- 1 file changed, 63 insertions(+), 6 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md index 243c6de758..c38c55371d 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md @@ -1,15 +1,72 @@ -# Resource and Property Reference +# AWS Resource and Property Reference -## Supported resource types +Welcome to the reference guide for AWS resource and property types, as supported by AWS CloudFormation and used in Port integrations. -This section contains reference information for all AWS resource and property types that are supported by AWS CloudFormation. +## Overview of Supported Resource Types -Similar to cloudformation template, Resource type identifiers always take the following form: +Explore detailed documentation for each AWS resource and property type available for integration. For each type, you'll find information about supported actions, key properties, required permissions, and usage best practices. -`service-provider::service-name::data-type-name` +Resource type identifiers follow a standardized format, allowing you to easily recognize and reference each AWS entity: + +``` +service-provider::service-name::data-type-name +``` + +For example, an EC2 instance is identified as: + +``` +AWS::EC2::Instance +``` + +Refer to the sidebar or the list below to navigate to individual resource reference pages where you'll find actionable integration details, sample configurations, and official AWS documentation links. - [Amazon Simple Queue Service](./amazon-simple-queue-service/amazon-simple-queue-service.md) - [Amazon Simple Storage Service](./amazon-simple-storage-service/amazon-simple-storage-service.md) - [Amazon Elastic Compute Cloud](./amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md) - [Amazon Elastic Container Service](./amazon-elastic-container-service/amazon-elastic-container-service.md) -- [AWS Organizations](./aws-organizations/aws-organizations.md) \ No newline at end of file +- [AWS Organizations](./aws-organizations/aws-organizations.md) + + +## Actions + +**Actions** define the set of API operations performed to discover and fetch resources within your AWS environment. These actions are mapped directly to AWS API calls—for example, `DescribeInstances` for EC2 or `ListBuckets` for S3—which determine the resource data that Port can ingest and keep up to date. + +### How Actions Map to AWS Operations + +Each Port-supported resource type comes with a set of actions that align with AWS's official API operations. For instance: + +- For **Amazon S3 Buckets**, the `ListBucketsAction` leverages the [ListBuckets API](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html), and additional actions like `GetBucketTaggingAction` or `GetBucketEncryptionAction` invoke their respective AWS endpoints. +- For **EC2 Instances**, `DescribeInstancesAction` maps to the [DescribeInstances API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) and brings in detailed instance configuration. + +These mappings ensure that only the properties available from the selected AWS actions are ingested into your Port catalog. + +### How to Enable and Customize Actions + +Port allows you to tailor the discovery and ingestion of AWS resource data by configuring which actions are enabled for each resource type. Actions determine what properties are collected and what AWS permissions are needed. + +- **Default Actions**: These actions are automatically enabled and provide basic resource discovery (such as listing all S3 buckets or EC2 instances). +- **Optional Actions**: Enable these to enrich your catalog with additional resource properties, such as tags, encryption settings, or advanced metadata. Optional actions must be explicitly specified in your integration configuration. + +:::tip Enabling optional actions for more data +To collect extra properties from AWS resources, add the relevant optional actions to your Port integration configuration. For instance, if you want to ingest the status of EC2 instances, include `DescribeInstanceStatusAction` in the configuration. +::: + +```yaml +- kind: AWS::EC2::Instance + selector: + query: 'true' + includeActions: + - DescribeInstanceStatusAction +``` + +:::caution Ensure required AWS permissions are granted +Each action requires specific AWS IAM permissions. Your integration’s AWS credentials must have these permissions; otherwise, the action will not succeed and its data will not be available in Port. +::: + +### Summary + +- **Actions in Port = AWS API Calls**: The available and enabled actions directly control what data about AWS resources Port can ingest. +- **Configurable per Resource**: Optional actions let you tailor the integration based on the level of detail required. +- **Permissions matter**: Ensure AWS IAM users or roles associated with your integration grant all permissions required by your chosen actions. + +Refer to the individual resource documentation pages for a table of actions, their AWS mapping, and necessary IAM permissions. From 2bd0bb69283e17eb59e1833363394b9ee1381fed Mon Sep 17 00:00:00 2001 From: Michael Kofi Armah Date: Wed, 29 Oct 2025 14:39:56 +0000 Subject: [PATCH 06/20] Fix links --- .../sync-data-to-catalog/cloud-providers/aws-v3/advanced.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/advanced.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/advanced.md index 4e0552d3f7..8edb86aeb1 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/advanced.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/advanced.md @@ -36,7 +36,7 @@ You can include a **maximum of 3 optional actions per resource kind** (excluding Each AWS resource has its own set of available actions. To find which actions are available for a specific resource, you can: -1. Check the resource's properties table in the [Examples](./examples.md) page +1. Check the resource's properties table in the [Resource and Property Reference](./resource-and-property-reference/resource-and-property-reference.md) section 2. Look at the "Action Required" column to see which properties need optional actions 3. Use the action names shown in that column in your `includeActions` list From 94e16c90559efc887b00fb7a1c32e8edfc98ee0a Mon Sep 17 00:00:00 2001 From: Michael Kofi Armah Date: Wed, 29 Oct 2025 16:23:35 +0000 Subject: [PATCH 07/20] Revert changes made to guide-metadata.json --- src/components/guides-section/guide-metadata.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/components/guides-section/guide-metadata.json b/src/components/guides-section/guide-metadata.json index 222857dda2..2711700115 100644 --- a/src/components/guides-section/guide-metadata.json +++ b/src/components/guides-section/guide-metadata.json @@ -725,7 +725,7 @@ }, "/guides/all/enforce-ai-coding-security-standards": { "creationDate": "2025-08-27T20:00:16.000Z", - "isNew": false + "isNew": true }, "/guides/all/find-internal-documentation-with-ai": { "creationDate": "2025-09-06T12:51:58.000Z", From 5df5a80f91f1d25040e55a159fe6efb2f254ba31 Mon Sep 17 00:00:00 2001 From: Michael Kofi Armah Date: Thu, 30 Oct 2025 15:15:52 +0000 Subject: [PATCH 08/20] remove advanced --- .../cloud-providers/aws-v3/advanced.md | 84 ------------------- .../resource-and-property-reference.md | 29 ++++--- 2 files changed, 14 insertions(+), 99 deletions(-) delete mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/advanced.md diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/advanced.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/advanced.md deleted file mode 100644 index 8edb86aeb1..0000000000 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/advanced.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Advanced - -The AWS v3 integration supports additional configuration options to access optional properties from AWS resources. - -## Optional actions configuration - -Some AWS resource properties require additional API calls to retrieve. You can use the `includeActions` parameter to access these optional properties. - -### Configuration - -You can add `includeActions` to your resource configuration under the `selector` section: - -```yaml showLineNumbers -resources: - - kind: AWS::EC2::Instance - selector: - query: 'true' - includeActions: - # Optional: Include up to 3 additional actions for more properties - - GetInstanceStatusAction - port: - entity: - mappings: - # ... your mappings -``` - -:::caution Action limit -You can include a **maximum of 3 optional actions per resource kind** (excluding default actions). To use more than 3 actions, you can configure multiple resource kinds in your integration. -::: - -### Finding available actions - -Each AWS resource has its own set of available actions. To find which actions are available for a specific resource, you can: - -1. Check the resource's properties table in the [Resource and Property Reference](./resource-and-property-reference/resource-and-property-reference.md) section -2. Look at the "Action Required" column to see which properties need optional actions -3. Use the action names shown in that column in your `includeActions` list - -## Property availability - -AWS resource properties fall into two categories: - -- **Default properties**: Always available, no additional configuration needed -- **Optional properties**: Require specific actions via `includeActions` - -Each resource example includes a properties reference table with an "Action Required" column showing which properties need optional actions. - -## Configuration examples - -### Multiple actions example - -```yaml showLineNumbers -resources: - - kind: AWS::S3::Bucket - selector: - query: 'true' - includeActions: - - GetBucketEncryptionAction - - GetBucketPublicAccessBlockAction - port: - entity: - mappings: - identifier: .Properties.Arn - title: .Properties.BucketName - blueprint: '"s3Bucket"' - properties: - # Default properties (always available) - arn: .Properties.Arn - region: .Properties.LocationConstraint - creationDate: .Properties.CreationDate - tags: .Properties.Tags - # Optional properties (require includeActions) - bucketEncryption: .Properties.BucketEncryption - publicAccessBlock: .Properties.PublicAccessBlockConfiguration - relations: - account: .__ExtraContext.AccountId -``` - - - diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md index c38c55371d..483832dd42 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md @@ -2,7 +2,7 @@ Welcome to the reference guide for AWS resource and property types, as supported by AWS CloudFormation and used in Port integrations. -## Overview of Supported Resource Types +## Supported Resource Types Explore detailed documentation for each AWS resource and property type available for integration. For each type, you'll find information about supported actions, key properties, required permissions, and usage best practices. @@ -31,6 +31,10 @@ Refer to the sidebar or the list below to navigate to individual resource refere **Actions** define the set of API operations performed to discover and fetch resources within your AWS environment. These actions are mapped directly to AWS API calls—for example, `DescribeInstances` for EC2 or `ListBuckets` for S3—which determine the resource data that Port can ingest and keep up to date. +:::caution Ensure required AWS permissions are granted +Each action requires specific AWS IAM permissions. Your integration’s AWS credentials must have these permissions; otherwise, the action will not succeed and its data will not be available in Port. +::: + ### How Actions Map to AWS Operations Each Port-supported resource type comes with a set of actions that align with AWS's official API operations. For instance: @@ -40,16 +44,14 @@ Each Port-supported resource type comes with a set of actions that align with AW These mappings ensure that only the properties available from the selected AWS actions are ingested into your Port catalog. -### How to Enable and Customize Actions +### Enabling and Customizing Actions -Port allows you to tailor the discovery and ingestion of AWS resource data by configuring which actions are enabled for each resource type. Actions determine what properties are collected and what AWS permissions are needed. +With Port, you have full control over which AWS resource properties are discovered and ingested into your catalog by specifying the actions to use for each resource type. Actions define what data you collect and the AWS permissions required. -- **Default Actions**: These actions are automatically enabled and provide basic resource discovery (such as listing all S3 buckets or EC2 instances). -- **Optional Actions**: Enable these to enrich your catalog with additional resource properties, such as tags, encryption settings, or advanced metadata. Optional actions must be explicitly specified in your integration configuration. +- **Default Actions**: These are enabled automatically, ensuring basic discovery such as listing all S3 buckets or EC2 instances without additional configuration. +- **Optional Actions**: Enable these to collect more detailed properties for your AWS resources. You must explicitly add optional actions in your integration configuration for Port to use them. -:::tip Enabling optional actions for more data -To collect extra properties from AWS resources, add the relevant optional actions to your Port integration configuration. For instance, if you want to ingest the status of EC2 instances, include `DescribeInstanceStatusAction` in the configuration. -::: +To collect additional properties from AWS resources, add the optional actions you need to the `includeActions` field of your configuration. For example, to include status details from EC2 instances by enabling the `DescribeInstanceStatusAction`, add the following: ```yaml - kind: AWS::EC2::Instance @@ -59,14 +61,11 @@ To collect extra properties from AWS resources, add the relevant optional action - DescribeInstanceStatusAction ``` -:::caution Ensure required AWS permissions are granted -Each action requires specific AWS IAM permissions. Your integration’s AWS credentials must have these permissions; otherwise, the action will not succeed and its data will not be available in Port. -::: +In this configuration, Port will enrich your catalog by fetching all properties provided by the [DescribeInstanceStatus API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstanceStatus.html) for every EC2 instance. -### Summary +:::caution Action limit +You can include a **maximum of 3 optional actions per resource kind** (excluding default actions). To use more than 3 actions, you can configure multiple resource kinds in your integration. +::: -- **Actions in Port = AWS API Calls**: The available and enabled actions directly control what data about AWS resources Port can ingest. -- **Configurable per Resource**: Optional actions let you tailor the integration based on the level of detail required. -- **Permissions matter**: Ensure AWS IAM users or roles associated with your integration grant all permissions required by your chosen actions. Refer to the individual resource documentation pages for a table of actions, their AWS mapping, and necessary IAM permissions. From b8a0af586be10b72249d999b4aa7a968f72b8000 Mon Sep 17 00:00:00 2001 From: Michael Kofi Armah Date: Thu, 30 Oct 2025 16:32:58 +0000 Subject: [PATCH 09/20] Add more service --- .../amazon-elastic-compute-cloud.md | 1 - .../_ec2_instance_blueprint.mdx | 2 +- .../_ec2_instance_port_app_config.mdx | 2 +- .../_ec2_instance_properties.mdx | 60 ------------- .../amazon-elastic-container-service.md | 29 ++++++- .../_ecs_cluster_blueprint.mdx | 2 +- .../_ecs_cluster_port_app_config.mdx | 2 +- .../_ecs_cluster_properties.mdx | 27 ------ .../_ecs_service_blueprint.mdx | 76 +++++++++++++++++ .../_ecs_service_port_app_config.mdx | 29 +++++++ .../_category_.json | 4 + .../amazon-elastic-kubernetes-service.md | 30 +++++++ .../_eks_cluster_blueprint.mdx | 66 +++++++++++++++ .../_eks_cluster_port_app_config.mdx | 27 ++++++ .../_category_.json | 4 + .../amazon-relational-database-service.md | 31 +++++++ .../_rds_db_instance_blueprint.mdx | 84 +++++++++++++++++++ .../_rds_db_instance_port_app_config.mdx | 27 ++++++ .../amazon-simple-queue-service.md | 1 - .../aws-sqs-queue/_sqs_queue_properties.mdx | 37 -------- .../amazon-simple-storage-service.md | 2 +- .../aws-s3-bucket/_s3_bucket_blueprint.mdx | 2 +- .../_s3_bucket_port_app_config.mdx | 2 +- .../aws-s3-bucket/_s3_bucket_properties.mdx | 2 +- .../aws-lambda/_category_.json | 4 + .../_lambda_function_blueprint.mdx | 68 +++++++++++++++ .../_lambda_function_port_app_config.mdx | 28 +++++++ .../aws-lambda/aws-lambda.md | 31 +++++++ .../_organizations_accounts_properties.mdx | 20 ----- .../aws-organizations/aws-organizations.md | 1 - .../resource-and-property-reference.md | 3 + 31 files changed, 548 insertions(+), 156 deletions(-) delete mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_properties.mdx delete mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_properties.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-service/_ecs_service_blueprint.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-service/_ecs_service_port_app_config.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/_category_.json create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/amazon-elastic-kubernetes-service.md create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/aws-eks-cluster/_eks_cluster_blueprint.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/aws-eks-cluster/_eks_cluster_port_app_config.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/_category_.json create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/amazon-relational-database-service.md create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/aws-rds-db-instance/_rds_db_instance_blueprint.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/aws-rds-db-instance/_rds_db_instance_port_app_config.mdx delete mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_properties.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/_category_.json create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda-function/_lambda_function_blueprint.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda-function/_lambda_function_port_app_config.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda.md delete mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_properties.mdx diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md index efadb50c2d..5e84e77db7 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md @@ -2,7 +2,6 @@ import Ec2InstanceBlueprint from './aws-ec2-instance/_ec2_instance_blueprint.mdx' import Ec2InstanceConfig from './aws-ec2-instance/_ec2_instance_port_app_config.mdx' -import Ec2InstanceProperties from './aws-ec2-instance/_ec2_instance_properties.mdx' diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_blueprint.mdx index 8e4c9cd6c1..8e087cb828 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_blueprint.mdx @@ -1,5 +1,5 @@
-EC2 instance blueprint (Click to expand) +EC2 Instance Blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_port_app_config.mdx index 4036395f07..bd7b17f83b 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_port_app_config.mdx @@ -1,5 +1,5 @@
-EC2 instance mapping configuration (Click to expand) +EC2 Instance Mapping Configuration (Click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_properties.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_properties.mdx deleted file mode 100644 index 06f6c8c2f3..0000000000 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_properties.mdx +++ /dev/null @@ -1,60 +0,0 @@ -
-EC2 instance properties (Click to expand) - -| Property | JQ Path | Type | Action Required | Availability | -|----------|---------|------|-----------------|--------------| -| Instance ARN | `.Properties.InstanceArn` | string | DescribeInstancesAction | Default | -| Instance ID | `.Properties.InstanceId` | string | DescribeInstancesAction | Default | -| Instance Type | `.Properties.InstanceType` | string | DescribeInstancesAction | Default | -| Availability Zone | `.Properties.AvailabilityZone` | string | DescribeInstancesAction | Default | -| Tags | `.Properties.Tags` | array | DescribeInstancesAction | Default | -| AMI Launch Index | `.Properties.AmiLaunchIndex` | number | DescribeInstancesAction | Default | -| Architecture | `.Properties.Architecture` | string | DescribeInstancesAction | Default | -| Block Device Mappings | `.Properties.BlockDeviceMappings` | array | DescribeInstancesAction | Default | -| Boot Mode | `.Properties.BootMode` | string | DescribeInstancesAction | Default | -| Capacity Reservation Specification | `.Properties.CapacityReservationSpecification` | object | DescribeInstancesAction | Default | -| Client Token | `.Properties.ClientToken` | string | DescribeInstancesAction | Default | -| CPU Options | `.Properties.CpuOptions` | object | DescribeInstancesAction | Default | -| Current Instance Boot Mode | `.Properties.CurrentInstanceBootMode` | string | DescribeInstancesAction | Default | -| EBS Optimized | `.Properties.EbsOptimized` | boolean | DescribeInstancesAction | Default | -| Enclave Options | `.Properties.EnclaveOptions` | object | DescribeInstancesAction | Default | -| ENA Support | `.Properties.EnaSupport` | boolean | DescribeInstancesAction | Default | -| Events | `.Properties.Events` | array | DescribeInstancesAction | Default | -| Hibernation Options | `.Properties.HibernationOptions` | object | DescribeInstancesAction | Default | -| Hypervisor | `.Properties.Hypervisor` | string | DescribeInstancesAction | Default | -| Image ID | `.Properties.ImageId` | string | DescribeInstancesAction | Default | -| Instance Status | `.Properties.InstanceStatus` | object | GetInstanceStatusAction | Optional | -| Instance State | `.Properties.InstanceState` | object | DescribeInstancesAction | Default | -| Key Name | `.Properties.KeyName` | string | DescribeInstancesAction | Default | -| Launch Time | `.Properties.LaunchTime` | datetime | DescribeInstancesAction | Default | -| Maintenance Options | `.Properties.MaintenanceOptions` | object | DescribeInstancesAction | Default | -| Metadata Options | `.Properties.MetadataOptions` | object | DescribeInstancesAction | Default | -| Monitoring | `.Properties.Monitoring` | object | DescribeInstancesAction | Default | -| Network Interfaces | `.Properties.NetworkInterfaces` | array | DescribeInstancesAction | Default | -| Network Performance Options | `.Properties.NetworkPerformanceOptions` | object | DescribeInstancesAction | Default | -| Operator | `.Properties.Operator` | object | DescribeInstancesAction | Default | -| Placement | `.Properties.Placement` | object | DescribeInstancesAction | Default | -| Platform | `.Properties.Platform` | string | DescribeInstancesAction | Default | -| Platform Details | `.Properties.PlatformDetails` | string | DescribeInstancesAction | Default | -| Private DNS Name | `.Properties.PrivateDnsName` | string | DescribeInstancesAction | Default | -| Private DNS Name Options | `.Properties.PrivateDnsNameOptions` | object | DescribeInstancesAction | Default | -| Private IP Address | `.Properties.PrivateIpAddress` | string | DescribeInstancesAction | Default | -| Product Codes | `.Properties.ProductCodes` | array | DescribeInstancesAction | Default | -| Public DNS Name | `.Properties.PublicDnsName` | string | DescribeInstancesAction | Default | -| Public IP Address | `.Properties.PublicIpAddress` | string | DescribeInstancesAction | Default | -| Reason | `.Properties.Reason` | string | DescribeInstancesAction | Default | -| Root Device Name | `.Properties.RootDeviceName` | string | DescribeInstancesAction | Default | -| Root Device Type | `.Properties.RootDeviceType` | string | DescribeInstancesAction | Default | -| Security Groups | `.Properties.SecurityGroups` | array | DescribeInstancesAction | Default | -| Source Dest Check | `.Properties.SourceDestCheck` | boolean | DescribeInstancesAction | Default | -| State | `.Properties.State` | object | DescribeInstancesAction | Default | -| State Reason | `.Properties.StateReason` | object | DescribeInstancesAction | Default | -| State Transition Reason | `.Properties.StateTransitionReason` | string | DescribeInstancesAction | Default | -| Subnet ID | `.Properties.SubnetId` | string | DescribeInstancesAction | Default | -| System Status | `.Properties.SystemStatus` | object | DescribeInstancesAction | Default | -| Usage Operation | `.Properties.UsageOperation` | string | DescribeInstancesAction | Default | -| Usage Operation Update Time | `.Properties.UsageOperationUpdateTime` | datetime | DescribeInstancesAction | Default | -| Virtualization Type | `.Properties.VirtualizationType` | string | DescribeInstancesAction | Default | -| VPC ID | `.Properties.VpcId` | string | DescribeInstancesAction | Default | - -
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md index 6d38bfb12a..992ae73702 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md @@ -2,7 +2,8 @@ import EcsClusterBlueprint from './aws-ecs-cluster/_ecs_cluster_blueprint.mdx' import EcsClusterConfig from './aws-ecs-cluster/_ecs_cluster_port_app_config.mdx' -import EcsClusterProperties from './aws-ecs-cluster/_ecs_cluster_properties.mdx' +import EcsServiceBlueprint from './aws-ecs-service/_ecs_service_blueprint.mdx' +import EcsServiceConfig from './aws-ecs-service/_ecs_service_port_app_config.mdx' @@ -29,4 +30,30 @@ You can use the following Port blueprint definitions and integration configurati + + +## AWS::ECS::Service + +The following example demonstrates how to ingest your AWS ECS services to Port. + +#### ECS Service Supported Actions + +The table below summarizes the available actions for ingesting Amazon ECS Service resources in Port: + +| Action | Description | Type | Required AWS Permission | +|-----------------------------|---------------------------------------------------------------------------------------------------------|----------|--------------------------------------| +| **DescribeServicesAction** | Discover ECS services within your clusters and retrieve detailed configuration data. [Reference](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServices.html) | Default | `ecs:ListServices`, `ecs:DescribeServices` | + +:::info 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: + + + + + + + For more details about ECS cluster properties, refer to the [AWS ECS API documentation](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/Welcome.html). diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_blueprint.mdx index d66a75cb76..721b8a4c8e 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_blueprint.mdx @@ -1,5 +1,5 @@
-ECS cluster blueprint (Click to expand) +ECS Cluster Blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_port_app_config.mdx index da31fa4c87..06547d1a17 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_port_app_config.mdx @@ -1,5 +1,5 @@
-ECS cluster mapping configuration (Click to expand) +ECS Cluster Mapping Configuration (Click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_properties.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_properties.mdx deleted file mode 100644 index 9eb3821e27..0000000000 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_properties.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -unlisted: true ---- - -
-ECS cluster properties (Click to expand) - -| Property | JQ Path | Type | Action Required | Availability | -|----------|---------|------|-----------------|--------------| -| Cluster Name | `.Properties.ClusterName` | string | DescribeClustersAction | Default | -| Cluster ARN | `.Properties.ClusterArn` | string | DescribeClustersAction | Default | -| Status | `.Properties.Status` | string | DescribeClustersAction | Default | -| Capacity Providers | `.Properties.CapacityProviders` | array | DescribeClustersAction | Default | -| Tags | `.Properties.Tags` | array | DescribeClustersAction | Default | -| Cluster Settings | `.Properties.ClusterSettings` | array | DescribeClustersAction | Default | -| Configuration | `.Properties.Configuration` | object | DescribeClustersAction | Default | -| Default Capacity Provider Strategy | `.Properties.DefaultCapacityProviderStrategy` | array | DescribeClustersAction | Default | -| Service Connect Defaults | `.Properties.ServiceConnectDefaults` | object | DescribeClustersAction | Default | -| Attachments | `.Properties.Attachments` | array | DescribeClustersAction | Default | -| Attachments Status | `.Properties.AttachmentsStatus` | string | DescribeClustersAction | Default | -| Statistics | `.Properties.Statistics` | array | DescribeClustersAction | Default | -| Active Services Count | `.Properties.ActiveServicesCount` | number | DescribeClustersAction | Default | -| Pending Tasks Count | `.Properties.PendingTasksCount` | number | DescribeClustersAction | Default | -| Running Tasks Count | `.Properties.RunningTasksCount` | number | DescribeClustersAction | Default | -| Registered Container Instances Count | `.Properties.RegisteredContainerInstancesCount` | number | DescribeClustersAction | Default | - -
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-service/_ecs_service_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-service/_ecs_service_blueprint.mdx new file mode 100644 index 0000000000..606e46983d --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-service/_ecs_service_blueprint.mdx @@ -0,0 +1,76 @@ +
+ECS Service Blueprint (Click to expand) + +```json showLineNumbers +{ + "identifier": "ecsService", + "title": "ECS Service", + "icon": "AWS", + "schema": { + "properties": { + "serviceName": { + "type": "string", + "title": "Service Name", + "description": "The name of the ECS service" + }, + "serviceArn": { + "type": "string", + "title": "ARN", + "description": "The Amazon Resource Name (ARN) of the service" + }, + "clusterArn": { + "type": "string", + "title": "Cluster ARN", + "description": "The ARN of the cluster that hosts the service" + }, + "taskDefinition": { + "type": "string", + "title": "Task Definition", + "description": "The ARN of the task definition associated with the service" + }, + "desiredCount": { + "type": "number", + "title": "Desired Count", + "description": "The desired number of tasks for the service" + }, + "runningCount": { + "type": "number", + "title": "Running Count", + "description": "The number of tasks that are currently running" + }, + "launchType": { + "type": "string", + "title": "Launch Type", + "description": "The launch type of the service", + "enum": ["EC2", "FARGATE", "EXTERNAL"] + }, + "status": { + "type": "string", + "title": "Status", + "description": "The current status of the service", + "enum": ["ACTIVE", "DRAINING", "INACTIVE"] + } + }, + "required": [] + }, + "mirrorProperties": {}, + "calculationProperties": {}, + "aggregationProperties": {}, + "relations": { + "account": { + "title": "Account", + "target": "awsAccount", + "required": false, + "many": false + }, + "cluster": { + "title": "Cluster", + "target": "ecsCluster", + "required": false, + "many": false + } + } +} +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-service/_ecs_service_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-service/_ecs_service_port_app_config.mdx new file mode 100644 index 0000000000..92257c2b6a --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-service/_ecs_service_port_app_config.mdx @@ -0,0 +1,29 @@ +
+ECS Service Mapping Configuration (Click to expand) + +```yaml showLineNumbers +resources: + - kind: AWS::ECS::Service + selector: + query: 'true' + port: + entity: + mappings: + identifier: .Properties.ServiceArn + title: .Properties.ServiceName + blueprint: '"ecsService"' + properties: + serviceName: .Properties.ServiceName + serviceArn: .Properties.ServiceArn + clusterArn: .Properties.ClusterArn + taskDefinition: .Properties.TaskDefinition + desiredCount: .Properties.DesiredCount + runningCount: .Properties.RunningCount + launchType: .Properties.LaunchType + status: .Properties.Status + relations: + account: .__ExtraContext.AccountId + cluster: .Properties.ClusterArn +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/_category_.json b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/_category_.json new file mode 100644 index 0000000000..112dc4a663 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Amazon Elastic Kubernetes Service", + "position": 5 +} diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/amazon-elastic-kubernetes-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/amazon-elastic-kubernetes-service.md new file mode 100644 index 0000000000..d28d01de65 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/amazon-elastic-kubernetes-service.md @@ -0,0 +1,30 @@ +# Amazon Elastic Kubernetes Service + +import EksClusterBlueprint from './aws-eks-cluster/_eks_cluster_blueprint.mdx' +import EksClusterConfig from './aws-eks-cluster/_eks_cluster_port_app_config.mdx' + + + +## AWS::EKS::Cluster + +The following example demonstrates how to ingest your AWS EKS clusters to Port. + +#### EKS Cluster Supported Actions + +The table below summarizes the available actions for ingesting Amazon EKS Cluster resources in Port: + +| Action | Description | Type | Required AWS Permission | +|---------------------------|--------------------------------------------------------------------------------------------------------------|---------|-------------------------| +| **DescribeClusterAction** | Retrieve detailed configuration data for each cluster. [Reference](https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeCluster.html) | Default | `eks:DescribeCluster` `eks:ListClusters` | + +::::info All properties available by default +EKS clusters expose their key properties via the default DescribeCluster action. +:::: + +You can use the following Port blueprint definitions and integration configuration: + + + + + +For more details about EKS cluster properties, refer to the [AWS EKS API documentation](https://docs.aws.amazon.com/eks/latest/APIReference/Welcome.html). diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/aws-eks-cluster/_eks_cluster_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/aws-eks-cluster/_eks_cluster_blueprint.mdx new file mode 100644 index 0000000000..987e1fc873 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/aws-eks-cluster/_eks_cluster_blueprint.mdx @@ -0,0 +1,66 @@ +
+EKS Cluster Blueprint (Click to expand) + +```json showLineNumbers +{ + "identifier": "eksCluster", + "title": "EKS Cluster", + "icon": "AWS", + "schema": { + "properties": { + "arn": { + "type": "string", + "title": "ARN", + "description": "The Amazon Resource Name (ARN) of the EKS cluster" + }, + "name": { + "type": "string", + "title": "Name", + "description": "The name of the EKS cluster" + }, + "version": { + "type": "string", + "title": "Kubernetes Version", + "description": "The Kubernetes version of the EKS cluster" + }, + "status": { + "type": "string", + "title": "Status", + "description": "The status of the EKS cluster" + }, + "endpoint": { + "type": "string", + "title": "Endpoint", + "description": "The endpoint URL for the EKS cluster" + }, + "roleArn": { + "type": "string", + "title": "Role ARN", + "description": "The IAM role ARN associated with the EKS cluster" + }, + "tags": { + "type": "object", + "title": "Tags", + "description": "Tags associated with the EKS cluster", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [] + }, + "mirrorProperties": {}, + "calculationProperties": {}, + "aggregationProperties": {}, + "relations": { + "account": { + "title": "Account", + "target": "awsAccount", + "required": false, + "many": false + } + } +} +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/aws-eks-cluster/_eks_cluster_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/aws-eks-cluster/_eks_cluster_port_app_config.mdx new file mode 100644 index 0000000000..5b1057d740 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/aws-eks-cluster/_eks_cluster_port_app_config.mdx @@ -0,0 +1,27 @@ +
+EKS Cluster Mapping Configuration (Click to expand) + +```yaml showLineNumbers +resources: + - kind: AWS::EKS::Cluster + selector: + query: 'true' + port: + entity: + mappings: + identifier: .Properties.Arn + title: .Properties.Name + blueprint: '"eksCluster"' + properties: + arn: .Properties.Arn + name: .Properties.Name + version: .Properties.Version + status: .Properties.Status + endpoint: .Properties.Endpoint + roleArn: .Properties.RoleArn + tags: .Properties.Tags + relations: + account: .__ExtraContext.AccountId +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/_category_.json b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/_category_.json new file mode 100644 index 0000000000..3845c1d951 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Amazon Relational Database Service", + "position": 6 +} diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/amazon-relational-database-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/amazon-relational-database-service.md new file mode 100644 index 0000000000..7139953032 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/amazon-relational-database-service.md @@ -0,0 +1,31 @@ +# Amazon Relational Database Service + +import RdsDbInstanceBlueprint from './aws-rds-db-instance/_rds_db_instance_blueprint.mdx' +import RdsDbInstanceConfig from './aws-rds-db-instance/_rds_db_instance_port_app_config.mdx' + + + +## AWS::RDS::DBInstance + +The following example demonstrates how to ingest your AWS RDS DB instances to Port. + +#### RDS DB Instance Supported Actions + +The table below summarizes the available actions for ingesting Amazon RDS DB Instance resources in Port: + +| Action | Description | Type | Required AWS Permission | +|---------------------------------|---------------------------------------------------------------------------------------------------------------------|----------|-------------------------| +| **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` | + +::::info 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: + + + + + +For more details about RDS DB instance properties, refer to the [AWS RDS API documentation](https://docs.aws.amazon.com/rds/latest/APIReference/Welcome.html). diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/aws-rds-db-instance/_rds_db_instance_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/aws-rds-db-instance/_rds_db_instance_blueprint.mdx new file mode 100644 index 0000000000..4ed9fb94fe --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/aws-rds-db-instance/_rds_db_instance_blueprint.mdx @@ -0,0 +1,84 @@ +
+RDS DB Instance Blueprint (Click to expand) + +```json showLineNumbers +{ + "identifier": "rdsDbInstance", + "title": "RDS DB Instance", + "icon": "AWS", + "schema": { + "properties": { + "dbInstanceIdentifier": { + "type": "string", + "title": "DB Instance Identifier", + "description": "The unique identifier of the RDS DB instance" + }, + "dbInstanceArn": { + "type": "string", + "title": "ARN", + "description": "The Amazon Resource Name (ARN) of the DB instance" + }, + "engine": { + "type": "string", + "title": "Engine", + "description": "The database engine type (e.g., mysql, postgres, oracle-ee)" + }, + "dbInstanceClass": { + "type": "string", + "title": "Instance Class", + "description": "The compute and memory capacity of the DB instance (e.g., db.t3.micro, db.m4.xlarge)" + }, + "dbInstanceStatus": { + "type": "string", + "title": "Status", + "description": "The current status of the DB instance", + "enum": [ + "available", + "backing-up", + "creating", + "deleting", + "failed", + "incompatible-credentials", + "incompatible-network", + "incompatible-option-group", + "incompatible-parameters", + "incompatible-restore", + "maintenance", + "modifying", + "rebooting", + "renaming", + "resetting-master-credentials", + "restore-error", + "storage-full", + "storage-optimization", + "upgrading" + ] + }, + "multiAZ": { + "type": "boolean", + "title": "Multi-AZ", + "description": "Whether the DB instance is deployed in multiple Availability Zones" + }, + "storageEncrypted": { + "type": "boolean", + "title": "Storage Encrypted", + "description": "Whether the DB instance storage is encrypted" + } + }, + "required": [] + }, + "mirrorProperties": {}, + "calculationProperties": {}, + "aggregationProperties": {}, + "relations": { + "account": { + "title": "Account", + "target": "awsAccount", + "required": false, + "many": false + } + } +} +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/aws-rds-db-instance/_rds_db_instance_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/aws-rds-db-instance/_rds_db_instance_port_app_config.mdx new file mode 100644 index 0000000000..ad8946ad1b --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/aws-rds-db-instance/_rds_db_instance_port_app_config.mdx @@ -0,0 +1,27 @@ +
+RDS DB Instance Mapping Configuration (Click to expand) + +```yaml showLineNumbers +resources: + - kind: AWS::RDS::DBInstance + selector: + query: 'true' + port: + entity: + mappings: + identifier: .Properties.DBInstanceArn + title: .Properties.DBInstanceIdentifier + blueprint: '"rdsDbInstance"' + properties: + dbInstanceIdentifier: .Properties.DBInstanceIdentifier + dbInstanceArn: .Properties.DBInstanceArn + engine: .Properties.Engine + dbInstanceClass: .Properties.DBInstanceClass + dbInstanceStatus: .Properties.DBInstanceStatus + multiAZ: .Properties.MultiAZ + storageEncrypted: .Properties.StorageEncrypted + relations: + account: .__ExtraContext.AccountId +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md index d83163d637..36b0f9bf10 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md @@ -2,7 +2,6 @@ import SqsQueueBlueprint from './aws-sqs-queue/_sqs_queue_blueprint.mdx' import SqsQueueConfig from './aws-sqs-queue/_sqs_queue_port_app_config.mdx' -import SqsQueueProperties from './aws-sqs-queue/_sqs_queue_properties.mdx' diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_properties.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_properties.mdx deleted file mode 100644 index e9a99f0b59..0000000000 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_properties.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -unlisted: true ---- - -
-SQS Queue Properties (Click to expand) - -| Property | Type | Description | Action Required | Availability | -|----------|------|-------------|-----------------|--------------| -| `QueueName` | string | The name of the SQS queue | Default | Default | -| `QueueUrl` | string | The URL of the SQS queue | Default | Default | -| `QueueArn` | string | The Amazon Resource Name (ARN) of the SQS queue | Default | Default | -| `ApproximateNumberOfMessages` | number | The approximate number of messages available for retrieval from the queue | Default | Default | -| `ApproximateNumberOfMessagesNotVisible` | number | The approximate number of messages in the queue that are delayed and not available for reading immediately | Default | Default | -| `ApproximateNumberOfMessagesDelayed` | number | The approximate number of messages in the queue that are delayed and not available for reading immediately | Default | Default | -| `CreatedTimestamp` | string | The time when the queue was created (Unix timestamp) | Default | Default | -| `LastModifiedTimestamp` | string | The time when the queue was last changed (Unix timestamp) | Default | Default | -| `VisibilityTimeout` | number | The visibility timeout for the queue in seconds | Default | Default | -| `MaximumMessageSize` | number | The limit of how many bytes a message can contain before Amazon SQS rejects it | Default | Default | -| `MessageRetentionPeriod` | number | The number of seconds for which Amazon SQS retains a message | Default | Default | -| `DelaySeconds` | number | The default delay for a message in the queue in seconds | Default | Default | -| `ReceiveMessageWaitTimeSeconds` | number | The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive | Default | Default | -| `Policy` | string | The queue's policy | Default | Default | -| `RedrivePolicy` | string | The string that includes the parameters for the dead-letter queue functionality | Default | Default | -| `RedriveAllowPolicy` | string | The string that includes the parameters for the permissions for the dead-letter queue redrive permission | Default | Default | -| `KmsMasterKeyId` | string | The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK | Default | 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 | Default | -| `SqsManagedSseEnabled` | boolean | Returns true if the queue is using SSE-SQS encryption using SQS owned encryption keys | Default | Default | -| `FifoQueue` | boolean | Returns true if the queue is a FIFO queue | Default | Default | -| `ContentBasedDeduplication` | boolean | Returns true if content-based deduplication is enabled for the queue | Default | Default | -| `DeduplicationScope` | string | Specifies whether message deduplication occurs at the message group or queue level | Default | Default | -| `FifoThroughputLimit` | string | Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group | Default | Default | -| `Tags` | object | The tags that have been assigned to the queue | GetQueueTagsAction | Optional | - -
- - diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md index 5eee6c3a9a..5060c2b1da 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md @@ -17,8 +17,8 @@ The table below summarizes the available actions for ingesting Amazon S3 Bucket | Action | Description | Type | Required AWS Permission | |--------------------------------------|----------------------------------------------------------------|----------|---------------------------------------------------------| | **ListBucketsAction** | Discover all S3 buckets across your AWS account. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html) | Default | `s3:ListAllMyBuckets` | -| **GetBucketLocationAction** | Retrieve the bucket's region. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLocation.html) | Default | `s3:GetBucketLocation` | | **GetBucketTaggingAction** | Bring in bucket tags for catalog filtering and grouping. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html) | Default | `s3:GetBucketTagging` | +| **GetBucketLocationAction** | Retrieve the bucket's region. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLocation.html) | Optional | `s3:GetBucketLocation` | | **GetBucketEncryptionAction** | Retrieve server-side encryption configuration for the bucket. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html) | Optional | `s3:GetBucketEncryption` | | **GetBucketPublicAccessBlockAction** | Retrieve public access block configuration. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) | Optional | `s3:GetBucketPublicAccessBlock` | | **GetBucketOwnershipControlsAction** | Retrieve bucket ownership controls. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketOwnershipControls.html) | Optional | `s3:GetBucketOwnershipControls` | diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_blueprint.mdx index e2a735398d..51b70affca 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_blueprint.mdx @@ -1,5 +1,5 @@
-S3 bucket blueprint (Click to expand) +S3 Bucket Blueprint (Click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_port_app_config.mdx index 274675ca9d..b354f70eb9 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_port_app_config.mdx @@ -1,5 +1,5 @@
-S3 bucket mapping configuration (Click to expand) +S3 Bucket Mapping Configuration (Click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_properties.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_properties.mdx index 755ce1fbdc..e65a543927 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_properties.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_properties.mdx @@ -1,5 +1,5 @@
-S3 bucket properties (Click to expand) +S3 Bucket Properties (Click to expand) | Property | JQ Path | Type | Action Required | Availability | |----------|---------|------|-----------------|--------------| diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/_category_.json b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/_category_.json new file mode 100644 index 0000000000..5df876cbc8 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "AWS Lambda", + "position": 7 +} diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda-function/_lambda_function_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda-function/_lambda_function_blueprint.mdx new file mode 100644 index 0000000000..d9d179d2d2 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda-function/_lambda_function_blueprint.mdx @@ -0,0 +1,68 @@ +
+Lambda Function Blueprint (Click to expand) + +```json showLineNumbers +{ + "identifier": "lambdaFunction", + "title": "Lambda Function", + "icon": "AWS", + "schema": { + "properties": { + "FunctionName": { + "type": "string", + "title": "Function Name", + "description": "The name of the Lambda function" + }, + "FunctionArn": { + "type": "string", + "title": "Function ARN", + "description": "The Amazon Resource Name (ARN) of the Lambda function" + }, + "Runtime": { + "type": "string", + "title": "Runtime", + "description": "The runtime environment for the Lambda function" + }, + "Handler": { + "type": "string", + "title": "Handler", + "description": "The function entry point" + }, + "MemorySize": { + "type": "number", + "title": "Memory Size", + "description": "The amount of memory available to the function in MB" + }, + "Timeout": { + "type": "number", + "title": "Timeout", + "description": "The function execution time limit in seconds" + }, + "State": { + "type": "string", + "title": "State", + "description": "The current state of the function" + }, + "LastModified": { + "type": "string", + "title": "Last Modified", + "description": "The date and time the function was last modified" + } + }, + "required": [] + }, + "mirrorProperties": {}, + "calculationProperties": {}, + "aggregationProperties": {}, + "relations": { + "account": { + "title": "Account", + "target": "awsAccount", + "required": false, + "many": false + } + } +} +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda-function/_lambda_function_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda-function/_lambda_function_port_app_config.mdx new file mode 100644 index 0000000000..06deb20398 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda-function/_lambda_function_port_app_config.mdx @@ -0,0 +1,28 @@ +
+Lambda Function Mapping Configuration (Click to expand) + +```yaml showLineNumbers +resources: + - kind: AWS::Lambda::Function + selector: + query: 'true' + port: + entity: + mappings: + identifier: .Properties.FunctionArn + title: .Properties.FunctionName + blueprint: '"lambdaFunction"' + properties: + FunctionName: .Properties.FunctionName + FunctionArn: .Properties.FunctionArn + Runtime: .Properties.Runtime + Handler: .Properties.Handler + MemorySize: .Properties.MemorySize + Timeout: .Properties.Timeout + State: .Properties.State + LastModified: .Properties.LastModified + relations: + account: .__ExtraContext.AccountId +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda.md new file mode 100644 index 0000000000..c30225f47b --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda.md @@ -0,0 +1,31 @@ +# AWS Lambda + +import LambdaFunctionBlueprint from './aws-lambda-function/_lambda_function_blueprint.mdx' +import LambdaFunctionConfig from './aws-lambda-function/_lambda_function_port_app_config.mdx' + + + +## AWS::Lambda::Function + +The following example demonstrates how to ingest your AWS Lambda functions to Port. + +#### Lambda Function Supported Actions + +The table below summarizes the available actions for ingesting AWS Lambda Function resources in Port: + +| Action | Description | Type | Required AWS Permission | +|---------------------------|-----------------------------------------------------------------------------------------------------------|----------|-------------------------| +| **ListFunctionsAction** | Discover all Lambda functions across your AWS account. [Reference](https://docs.aws.amazon.com/lambda/latest/APIReference/API_ListFunctions.html) | Default | `lambda:ListFunctions` | +| **ListTagsAction** | Retrieve tags for each function. [Reference](https://docs.aws.amazon.com/lambda/latest/APIReference/API_ListTags.html) | Optional | `lambda:ListTags` | + +::::info 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: + + + + + +For more details about Lambda function properties, refer to the [AWS Lambda API documentation](https://docs.aws.amazon.com/lambda/latest/APIReference/Welcome.html). diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_properties.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_properties.mdx deleted file mode 100644 index 2905a391e7..0000000000 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_properties.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -unlisted: true ---- - -
-Organizations Account properties (Click to expand) - -| Property | JQ Path | Type | Action Required | Availability | -|----------|---------|------|-----------------|--------------| -| Id | .Properties.Id | string | ListAccountsAction | Default | -| AccountName | .Properties.AccountName | string | ListAccountsAction | Default | -| Arn | .Properties.Arn | string | ListAccountsAction | Default | -| Email | .Properties.Email | string | ListAccountsAction | Default | -| Status | .Properties.Status | string | ListAccountsAction | Default | -| JoinedTimestamp | .Properties.JoinedTimestamp | string | ListAccountsAction | Default | -| JoinedMethod | .Properties.JoinedMethod | string | ListAccountsAction | Default | -| Tags | .Properties.Tags | array | ListTagsForResourceAction | Optional | -| Parents | .Properties.Parents | array | ListParentsAction | Optional | - -
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md index 3a3461ec75..324ffc0b92 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md @@ -2,7 +2,6 @@ import OrganizationsAccountBlueprint from './aws-organizations-account/_organizations_accounts_blueprint.mdx' import OrganizationsAccountConfig from './aws-organizations-account/_organizations_accounts_port_app_config.mdx' -import OrganizationsAccountProperties from './aws-organizations-account/_organizations_accounts_properties.mdx' diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md index 483832dd42..fa5eb7e1f4 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md @@ -24,6 +24,9 @@ Refer to the sidebar or the list below to navigate to individual resource refere - [Amazon Simple Storage Service](./amazon-simple-storage-service/amazon-simple-storage-service.md) - [Amazon Elastic Compute Cloud](./amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md) - [Amazon Elastic Container Service](./amazon-elastic-container-service/amazon-elastic-container-service.md) +- [Amazon Elastic Kubernetes Service](./amazon-elastic-kubernetes-service/amazon-elastic-kubernetes-service.md) +- [Amazon Relational Database Service](./amazon-relational-database-service/amazon-relational-database-service.md) +- [AWS Lambda](./aws-lambda/aws-lambda.md) - [AWS Organizations](./aws-organizations/aws-organizations.md) From 1e459735a8d9486414574af79e5336eda08f1c95 Mon Sep 17 00:00:00 2001 From: Michael Kofi Armah Date: Thu, 30 Oct 2025 18:51:22 +0000 Subject: [PATCH 10/20] Add account info --- .../cloud-providers/aws-v3/Overview.md | 18 +++++------------ .../aws-account/_category_.json | 4 ++++ .../_aws_account_blueprint.mdx | 20 +++++++++++++++++++ .../_aws_account_port_app_config.mdx | 17 ++++++++++++++++ .../aws-account/aws-account.md | 20 +++++++++++++++++++ .../resource-and-property-reference.md | 12 +++++++++-- 6 files changed, 76 insertions(+), 15 deletions(-) create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/_category_.json create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account-info/_aws_account_blueprint.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account-info/_aws_account_port_app_config.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account.md 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 992d13b9c4..b83f98182e 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 @@ -22,17 +22,6 @@ Easily fill your software catalog with data directly from your AWS Organization, - Use relations to create complete, easily digestible views of your AWS infrastructure inside Port. - Enjoy a fully managed experience with no infrastructure to maintain or updates to apply. -## Supported resources - -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. -::: ## Key advantages @@ -53,6 +42,9 @@ For detailed information about the IAM role architecture and security model, see Port integrations use a [YAML mapping block](/build-your-software-catalog/customize-integrations/configure-mapping#configuration-structure) to ingest data from the third-party api into Port. The mapping makes use of the [JQ JSON processor](https://stedolan.github.io/jq/manual/) to select, modify, concatenate, transform and perform other operations on existing fields and values from the integration API. +::::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. +:::: ### Default mapping configuration @@ -138,6 +130,6 @@ resources: -## Advanced +## Resource and Property Reference -Refer to the [Advanced configuration](./advanced.md) page for advanced use cases and examples. \ No newline at end of file +Refer to the [Resource and Property Reference](./resource-and-property-reference/resource-and-property-reference.md) page for details on available AWS resources, their properties, and mapping examples. \ No newline at end of file diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/_category_.json b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/_category_.json new file mode 100644 index 0000000000..f03555f738 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "AWS Account", + "position": 8 +} diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account-info/_aws_account_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account-info/_aws_account_blueprint.mdx new file mode 100644 index 0000000000..ea9dfabb21 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account-info/_aws_account_blueprint.mdx @@ -0,0 +1,20 @@ +
+AWS Account Blueprint (Click to expand) + +```json showLineNumbers +{ + "identifier": "awsAccount", + "title": "AWS Account", + "icon": "AWS", + "schema": { + "properties": {}, + "required": [] + }, + "mirrorProperties": {}, + "calculationProperties": {}, + "aggregationProperties": {}, + "relations": {} +} +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account-info/_aws_account_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account-info/_aws_account_port_app_config.mdx new file mode 100644 index 0000000000..f643a42e9d --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account-info/_aws_account_port_app_config.mdx @@ -0,0 +1,17 @@ +
+AWS Account Info Mapping Configuration (Click to expand) + +```yaml showLineNumbers +resources: + - kind: AWS::Account::Info + selector: + query: 'true' + port: + entity: + mappings: + identifier: .Properties.Id + title: .Properties.Name + blueprint: '"awsAccount"' +``` + +
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account.md new file mode 100644 index 0000000000..6673a5341b --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account.md @@ -0,0 +1,20 @@ +# AWS Account + +import AwsAccountBlueprint from './aws-account-info/_aws_account_blueprint.mdx' +import AwsAccountConfig from './aws-account-info/_aws_account_port_app_config.mdx' + + + +## AWS::Account::Info + +The following example demonstrates how to ingest AWS account information using a custom resource designed for account resync without AWS Organizations permissions. + +::::info Custom resource for account resync +Use `AWS::Account::Info` to resync AWS account data when you do not have organization-level permissions. If you do have AWS Organizations permissions and want to retrieve richer data (e.g., org account metadata, parents, and tags), see the AWS Organizations documentation under [AWS Organizations](../aws-organizations/aws-organizations.md). +:::: + +You can use the following Port blueprint definitions and integration configuration: + + + + diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md index fa5eb7e1f4..50a13261e9 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md @@ -1,10 +1,10 @@ # AWS Resource and Property Reference -Welcome to the reference guide for AWS resource and property types, as supported by AWS CloudFormation and used in Port integrations. +Welcome to the reference guide for AWS resource, actions and properties, as supported by AWS CloudFormation and used in Port integrations. ## Supported Resource Types -Explore detailed documentation for each AWS resource and property type available for integration. For each type, you'll find information about supported actions, key properties, required permissions, and usage best practices. +Explore detailed documentation for each AWS resource and action available for integration. For each resource type, you'll find information about supported actions, required permissions, and usage best practices. Resource type identifiers follow a standardized format, allowing you to easily recognize and reference each AWS entity: @@ -27,8 +27,16 @@ Refer to the sidebar or the list below to navigate to individual resource refere - [Amazon Elastic Kubernetes Service](./amazon-elastic-kubernetes-service/amazon-elastic-kubernetes-service.md) - [Amazon Relational Database Service](./amazon-relational-database-service/amazon-relational-database-service.md) - [AWS Lambda](./aws-lambda/aws-lambda.md) +- [AWS Account](./aws-account/aws-account.md) - [AWS Organizations](./aws-organizations/aws-organizations.md) +:::info More Resource Types Coming Soon +We're continuously expanding support for additional AWS resource types to ensure comprehensive coverage of your AWS infrastructure. + +If you need support for a specific AWS resource or action that isn’t yet available, please consider opening a feature request or reach out to us through chat, Slack, or our [Support Portal](http://support.port.io/). + +Your feedback helps us prioritize what to build next. +::: ## Actions From fa2b9c9a44945bf316e7b672b3e2ca169dd42c4c Mon Sep 17 00:00:00 2001 From: Michael Kofi Armah Date: Thu, 30 Oct 2025 19:12:41 +0000 Subject: [PATCH 11/20] Remove unlisted tag --- .../aws-sqs-queue/_sqs_queue_blueprint.mdx | 4 ---- .../aws-sqs-queue/_sqs_queue_port_app_config.mdx | 4 ---- .../amazon-simple-storage-service.md | 1 - .../aws-s3-bucket/_s3_bucket_properties.mdx | 15 --------------- .../_organizations_accounts_blueprint.mdx | 4 ---- .../_organizations_accounts_port_app_config.mdx | 4 ---- 6 files changed, 32 deletions(-) delete mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_properties.mdx diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_blueprint.mdx index 6af27837e6..c034813733 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_blueprint.mdx @@ -1,7 +1,3 @@ ---- -unlisted: true ---- -
SQS Queue Blueprint (Click to expand) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_port_app_config.mdx index 171a1ba3d8..2c77a1ca75 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_port_app_config.mdx @@ -1,7 +1,3 @@ ---- -unlisted: true ---- -
SQS Queue Mapping Configuration (Click to expand) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md index 5060c2b1da..7d56d4727b 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md @@ -2,7 +2,6 @@ import S3BucketBlueprint from './aws-s3-bucket/_s3_bucket_blueprint.mdx' import S3BucketConfig from './aws-s3-bucket/_s3_bucket_port_app_config.mdx' -import S3BucketProperties from './aws-s3-bucket/_s3_bucket_properties.mdx' diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_properties.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_properties.mdx deleted file mode 100644 index e65a543927..0000000000 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_properties.mdx +++ /dev/null @@ -1,15 +0,0 @@ -
-S3 Bucket Properties (Click to expand) - -| Property | JQ Path | Type | Action Required | Availability | -|----------|---------|------|-----------------|--------------| -| Bucket Name | `.Properties.BucketName` | string | ListBucketsAction | Default | -| ARN | `.Properties.Arn` | string | ListBucketsAction | Default | -| Creation Date | `.Properties.CreationDate` | datetime | ListBucketsAction | Default | -| Region | `.Properties.LocationConstraint` | string | GetBucketLocationAction | Default | -| Tags | `.Properties.Tags` | array | GetBucketTaggingAction | Default | -| Bucket Encryption | `.Properties.BucketEncryption` | object | GetBucketEncryptionAction | Optional | -| Public Access Block Configuration | `.Properties.PublicAccessBlockConfiguration` | object | GetBucketPublicAccessBlockAction | Optional | -| Ownership Controls | `.Properties.OwnershipControls` | object | GetBucketOwnershipControlsAction | Optional | - -
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_blueprint.mdx index f89367c2fb..a0d7a6a671 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_blueprint.mdx @@ -1,7 +1,3 @@ ---- -unlisted: true ---- -
Organizations Account blueprint (Click to expand) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_port_app_config.mdx index 167d16c16b..af47e5ed3e 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_port_app_config.mdx @@ -1,7 +1,3 @@ ---- -unlisted: true ---- -
Organizations Account mapping configuration (Click to expand) From d36e44f4582cb4d33198423d33d917d359369acc Mon Sep 17 00:00:00 2001 From: Michael Kofi Armah Date: Mon, 3 Nov 2025 13:31:49 +0000 Subject: [PATCH 12/20] Update docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/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> --- .../amazon-simple-storage-service.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md index 7d56d4727b..0a2a30c4b6 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md @@ -17,7 +17,7 @@ The table below summarizes the available actions for ingesting Amazon S3 Bucket |--------------------------------------|----------------------------------------------------------------|----------|---------------------------------------------------------| | **ListBucketsAction** | Discover all S3 buckets across your AWS account. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html) | Default | `s3:ListAllMyBuckets` | | **GetBucketTaggingAction** | Bring in bucket tags for catalog filtering and grouping. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html) | Default | `s3:GetBucketTagging` | -| **GetBucketLocationAction** | Retrieve the bucket's region. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLocation.html) | Optional | `s3:GetBucketLocation` | +| **GetBucketLocationAction** | Retrieve the bucket's region. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLocation.html) | Optional | `s3:GetBucketLocation` | | **GetBucketEncryptionAction** | Retrieve server-side encryption configuration for the bucket. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html) | Optional | `s3:GetBucketEncryption` | | **GetBucketPublicAccessBlockAction** | Retrieve public access block configuration. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) | Optional | `s3:GetBucketPublicAccessBlock` | | **GetBucketOwnershipControlsAction** | Retrieve bucket ownership controls. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketOwnershipControls.html) | Optional | `s3:GetBucketOwnershipControls` | From 49edf940b85853c38a3918598cd8e863f1686e03 Mon Sep 17 00:00:00 2001 From: Michael Kofi Armah Date: Mon, 3 Nov 2025 13:32:15 +0000 Subject: [PATCH 13/20] Update docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/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> --- .../aws-account/aws-account.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account.md index 6673a5341b..179ffef4a1 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account.md @@ -9,9 +9,9 @@ import AwsAccountConfig from './aws-account-info/_aws_account_port_app_config.md The following example demonstrates how to ingest AWS account information using a custom resource designed for account resync without AWS Organizations permissions. -::::info Custom resource for account resync +:::info Custom Resource for Account Resync Use `AWS::Account::Info` to resync AWS account data when you do not have organization-level permissions. If you do have AWS Organizations permissions and want to retrieve richer data (e.g., org account metadata, parents, and tags), see the AWS Organizations documentation under [AWS Organizations](../aws-organizations/aws-organizations.md). -:::: +::: You can use the following Port blueprint definitions and integration configuration: From fcaeca6cca0678c3587191cb0a22f946d2376ead Mon Sep 17 00:00:00 2001 From: Michael Kofi Armah Date: Mon, 3 Nov 2025 16:48:06 +0000 Subject: [PATCH 14/20] Attend to review comments --- .../_category_.json | 2 +- .../amazon-elastic-compute-cloud.md | 2 +- .../_category_.json | 2 +- .../amazon-elastic-container-service.md | 2 +- .../_category_.json | 2 +- .../_category_.json | 2 +- .../amazon-relational-database-service.md | 2 +- .../_category_.json | 4 ++ .../amazon-simple-queue-service.md | 4 +- .../aws-sqs-queue/_sqs_queue_blueprint.mdx | 43 ++++++++++++------- .../_sqs_queue_port_app_config.mdx | 37 ++++++++-------- .../_category_.json | 2 +- .../amazon-simple-storage-service.md | 2 +- .../_s3_bucket_port_app_config.mdx | 6 --- .../aws-lambda/aws-lambda.md | 2 +- .../aws-organizations/aws-organizations.md | 2 +- 16 files changed, 64 insertions(+), 52 deletions(-) create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/_category_.json diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/_category_.json b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/_category_.json index b43bcce25b..cba4bb5a53 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/_category_.json +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/_category_.json @@ -1,4 +1,4 @@ { - "label": "Amazon Elastic Compute Cloud", + "label": "Amazon Elastic Compute Cloud (EC2)", "position": 3 } diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md index 5e84e77db7..d29b12fbe0 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md @@ -18,7 +18,7 @@ The table below summarizes the available actions for ingesting Amazon EC2 Instan | **DescribeInstancesAction** | Discover EC2 instances and retrieve detailed configuration data. [Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) | Default | `ec2:DescribeInstances` | | **GetInstanceStatusAction** | Retrieve instance status information. [Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstanceStatus.html) | Optional | `ec2:DescribeInstanceStatus` | -:::info Optional properties note +:::info 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. ::: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/_category_.json b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/_category_.json index 7720c3b540..23e85810d2 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/_category_.json +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/_category_.json @@ -1,4 +1,4 @@ { - "label": "Amazon Elastic Container Service", + "label": "Amazon Elastic Container Service (ECS)", "position": 4 } diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md index 992ae73702..00526a771b 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md @@ -44,7 +44,7 @@ The table below summarizes the available actions for ingesting Amazon ECS Servic |-----------------------------|---------------------------------------------------------------------------------------------------------|----------|--------------------------------------| | **DescribeServicesAction** | Discover ECS services within your clusters and retrieve detailed configuration data. [Reference](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServices.html) | Default | `ecs:ListServices`, `ecs:DescribeServices` | -:::info Optional properties note +:::info 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. ::: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/_category_.json b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/_category_.json index 112dc4a663..b086f2e6ee 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/_category_.json +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/_category_.json @@ -1,4 +1,4 @@ { - "label": "Amazon Elastic Kubernetes Service", + "label": "Amazon Elastic Kubernetes Service (EKS)", "position": 5 } diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/_category_.json b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/_category_.json index 3845c1d951..4502de18be 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/_category_.json +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/_category_.json @@ -1,4 +1,4 @@ { - "label": "Amazon Relational Database Service", + "label": "Amazon Relational Database Service (RDS)", "position": 6 } diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/amazon-relational-database-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/amazon-relational-database-service.md index 7139953032..9b5e9022dc 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/amazon-relational-database-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/amazon-relational-database-service.md @@ -18,7 +18,7 @@ The table below summarizes the available actions for ingesting Amazon RDS DB Ins | **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` | -::::info Optional properties note +::::info 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. :::: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/_category_.json b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/_category_.json new file mode 100644 index 0000000000..8337352ce5 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Amazon Simple Queue Service (SQS)", + "position": 2 +} diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md index 36b0f9bf10..1652661fe7 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md @@ -1,4 +1,4 @@ -# Amazon Simple Queue Service +# Amazon Simple Queue Service (SQS) import SqsQueueBlueprint from './aws-sqs-queue/_sqs_queue_blueprint.mdx' import SqsQueueConfig from './aws-sqs-queue/_sqs_queue_port_app_config.mdx' @@ -20,7 +20,7 @@ The table below summarizes the available actions for ingesting Amazon SQS Queue | **GetQueueAttributesAction**| Retrieve detailed configuration and operational data for each queue. [Reference](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueAttributes.html) | Default | `sqs:GetQueueAttributes`| | **GetQueueTagsAction** | Bring in custom tags assigned to your queues for advanced catalog filtering and grouping. [Reference](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ListQueueTags.html) | Optional | `sqs:ListQueueTags` | -:::info Optional properties note +:::info 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. ::: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_blueprint.mdx index c034813733..8b357f28a7 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_blueprint.mdx @@ -6,29 +6,42 @@ "identifier": "sqsQueue", "title": "SQS Queue", "icon": "AWS", - "description": "This blueprint represents an AWS SQS queue in our software catalog", "schema": { "properties": { - "queueName": { + "arn": { "type": "string", - "title": "Queue Name" + "title": "ARN", + "description": "The Amazon Resource Name (ARN) of the SQS queue" }, - "queueUrl": { + "region": { "type": "string", - "title": "Queue URL", - "format": "url" + "title": "Region", + "description": "The AWS region where the SQS queue is located" }, - "queueArn": { + "queueUrl": { "type": "string", - "title": "Queue ARN" + "title": "Queue URL", + "description": "The URL of the SQS queue" }, - "fifoQueue": { - "type": "boolean", - "title": "FIFO Queue" + "approximateNumberOfMessages": { + "type": "number", + "title": "Approx Number of Messages", + "description": "The approximate number of messages available for retrieval from the queue" }, "visibilityTimeout": { "type": "number", - "title": "Visibility Timeout (seconds)" + "title": "Visibility Timeout (seconds)", + "description": "The visibility timeout for the queue in seconds" + }, + "messageRetentionPeriod": { + "type": "number", + "title": "Message Retention Period", + "description": "The length of time, in seconds, for which Amazon SQS retains a message" + }, + "sqsManagedSseEnabled": { + "type": "boolean", + "title": "SQS Managed SSE Enabled", + "description": "Whether SQS managed server-side encryption is enabled" } }, "required": [] @@ -37,10 +50,10 @@ "calculationProperties": {}, "aggregationProperties": {}, "relations": { - "awsAccount": { - "title": "AWS Account", + "account": { + "title": "Account", "target": "awsAccount", - "required": true, + "required": false, "many": false } } diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_port_app_config.mdx index 2c77a1ca75..97985aecd6 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_port_app_config.mdx @@ -2,24 +2,25 @@ 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 - relations: - awsAccount: .awsAccount +- kind: AWS::SQS::Queue + selector: + query: 'true' + port: + entity: + mappings: + identifier: .Properties.QueueArn + title: .Properties.QueueUrl | split("/") | .[-1] + blueprint: '"sqsQueue"' + properties: + arn: .Properties.QueueArn + region: .__ExtraContext.Region + queueUrl: .Properties.QueueUrl + approximateNumberOfMessages: .Properties.ApproximateNumberOfMessages + visibilityTimeout: .Properties.VisibilityTimeout + messageRetentionPeriod: .Properties.MessageRetentionPeriod + sqsManagedSseEnabled: .Properties.SqsManagedSseEnabled + relations: + account: .__ExtraContext.AccountId ```
diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/_category_.json b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/_category_.json index 6ce2191215..bbe8f3f380 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/_category_.json +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/_category_.json @@ -1,4 +1,4 @@ { - "label": "Amazon Simple Storage Service", + "label": "Amazon Simple Storage Service (S3)", "position": 2 } diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md index 7d56d4727b..3d82bdeca0 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md @@ -22,7 +22,7 @@ The table below summarizes the available actions for ingesting Amazon S3 Bucket | **GetBucketPublicAccessBlockAction** | Retrieve public access block configuration. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) | Optional | `s3:GetBucketPublicAccessBlock` | | **GetBucketOwnershipControlsAction** | Retrieve bucket ownership controls. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketOwnershipControls.html) | Optional | `s3:GetBucketOwnershipControls` | -:::info Optional properties note +:::info 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. ::: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_port_app_config.mdx index b354f70eb9..9706c6d913 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_port_app_config.mdx @@ -6,12 +6,6 @@ resources: - kind: AWS::S3::Bucket selector: query: 'true' - includeActions: - # Optional: Include up to 3 additional actions for more properties - # Choose based on which properties you need most - # - GetBucketEncryptionAction - # - GetBucketPublicAccessBlockAction - # - GetBucketOwnershipControlsAction port: entity: mappings: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda.md index c30225f47b..1338da9522 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda.md @@ -18,7 +18,7 @@ The table below summarizes the available actions for ingesting AWS Lambda Functi | **ListFunctionsAction** | Discover all Lambda functions across your AWS account. [Reference](https://docs.aws.amazon.com/lambda/latest/APIReference/API_ListFunctions.html) | Default | `lambda:ListFunctions` | | **ListTagsAction** | Retrieve tags for each function. [Reference](https://docs.aws.amazon.com/lambda/latest/APIReference/API_ListTags.html) | Optional | `lambda:ListTags` | -::::info Optional properties note +::::info 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. :::: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md index 324ffc0b92..e682c27ff9 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md @@ -19,7 +19,7 @@ The table below summarizes the available actions for ingesting AWS Organizations | **ListTagsForResourceAction** | Retrieve tags for the specified account. [Reference](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListTagsForResource.html) | Optional | `organizations:ListTagsForResource`| | **ListParentsAction** | Retrieve parent information for the specified account. [Reference](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListParents.html) | Optional | `organizations:ListParents` | -:::info Optional properties note +:::info 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. ::: From 7e379d4177478553efd25c0fd71b3bf87e6df18a Mon Sep 17 00:00:00 2001 From: Michael Kofi Armah Date: Wed, 5 Nov 2025 10:13:21 +0000 Subject: [PATCH 15/20] Address review comments --- .../cloud-providers/aws-v3/Overview.md | 8 ++-- .../cloud-providers/aws-v3/installations.md | 4 ++ .../amazon-elastic-compute-cloud.md | 6 +-- .../_ec2_instance_blueprint.mdx | 2 +- .../_ec2_instance_port_app_config.mdx | 2 +- .../amazon-elastic-container-service.md | 8 ++-- .../_ecs_cluster_blueprint.mdx | 2 +- .../_ecs_cluster_port_app_config.mdx | 2 +- .../_ecs_service_blueprint.mdx | 2 +- .../_ecs_service_port_app_config.mdx | 2 +- .../amazon-elastic-kubernetes-service.md | 4 +- .../_eks_cluster_blueprint.mdx | 2 +- .../_eks_cluster_port_app_config.mdx | 2 +- .../amazon-relational-database-service.md | 6 +-- .../_rds_db_instance_blueprint.mdx | 2 +- .../_rds_db_instance_port_app_config.mdx | 2 +- .../amazon-simple-queue-service.md | 8 ++-- .../aws-sqs-queue/_sqs_queue_blueprint.mdx | 2 +- .../_sqs_queue_port_app_config.mdx | 2 +- .../amazon-simple-storage-service.md | 12 ++--- .../aws-s3-bucket/_s3_bucket_blueprint.mdx | 2 +- .../_s3_bucket_port_app_config.mdx | 2 +- .../_aws_account_blueprint.mdx | 2 +- .../_aws_account_port_app_config.mdx | 2 +- .../_lambda_function_blueprint.mdx | 2 +- .../_lambda_function_port_app_config.mdx | 2 +- .../aws-lambda/aws-lambda.md | 6 +-- .../_organizations_accounts_blueprint.mdx | 2 +- ...organizations_accounts_port_app_config.mdx | 2 +- .../aws-organizations/aws-organizations.md | 6 +-- .../resource-and-property-reference.md | 46 ++++++++++++++++++- 31 files changed, 100 insertions(+), 54 deletions(-) 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 b83f98182e..051ae49bd3 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 @@ -42,9 +42,9 @@ For detailed information about the IAM role architecture and security model, see Port integrations use a [YAML mapping block](/build-your-software-catalog/customize-integrations/configure-mapping#configuration-structure) to ingest data from the third-party api into Port. The mapping makes use of the [JQ JSON processor](https://stedolan.github.io/jq/manual/) to select, modify, concatenate, transform and perform other operations on existing fields and values from the integration API. -::::info Property naming conventions +:::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. -:::: +::: ### Default mapping configuration @@ -130,6 +130,6 @@ resources: -## Resource and Property Reference +## Resource and property reference -Refer to the [Resource and Property Reference](./resource-and-property-reference/resource-and-property-reference.md) page for details on available AWS resources, their properties, and mapping examples. \ No newline at end of file +Refer to the [resource and property reference](./resource-and-property-reference/resource-and-property-reference.md) page for details on available AWS resources, their properties, and mapping examples. \ No newline at end of file diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/installations.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/installations.md index 6676d4fce4..5adc2f785e 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/installations.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/installations.md @@ -162,6 +162,10 @@ You must run the multi-account installation from your AWS Organizations **manage +:::info Region policy +Configure which AWS regions are queried using `regionPolicy`. See [Querying resources from specific regions](./resource-and-property-reference/resource-and-property-reference.md#querying-resources-from-specific-regions). +::: + ## Troubleshooting Common Installation Issue - CloudFormation Stack Creation Failures. diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md index d29b12fbe0..9f7ff309c1 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md @@ -9,14 +9,14 @@ import Ec2InstanceConfig from './aws-ec2-instance/_ec2_instance_port_app_config. The following example demonstrates how to ingest your AWS EC2 instances to Port. -#### EC2 Instance Supported Actions +#### EC2 Instance supported actions The table below summarizes the available actions for ingesting Amazon EC2 Instance resources in Port: | Action | Description | Type | Required AWS Permission | |-----------------------------|------------------------------------------------------------|----------|--------------------------------| -| **DescribeInstancesAction** | Discover EC2 instances and retrieve detailed configuration data. [Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) | Default | `ec2:DescribeInstances` | -| **GetInstanceStatusAction** | Retrieve instance status information. [Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstanceStatus.html) | Optional | `ec2:DescribeInstanceStatus` | +| [DescribeInstancesAction](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) | Discover EC2 instances and retrieve detailed configuration data. | Default | `ec2:DescribeInstances` | +| [GetInstanceStatusAction](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstanceStatus.html) | Retrieve instance status information. | Optional | `ec2:DescribeInstanceStatus` | :::info 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. diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_blueprint.mdx index 8e087cb828..3b8a3523df 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_blueprint.mdx @@ -1,5 +1,5 @@
-EC2 Instance Blueprint (Click to expand) +EC2 Instance blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_port_app_config.mdx index bd7b17f83b..aa0b17acfc 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/aws-ec2-instance/_ec2_instance_port_app_config.mdx @@ -1,5 +1,5 @@
-EC2 Instance Mapping Configuration (Click to expand) +EC2 Instance mapping configuration (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md index 00526a771b..aa1be46fee 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md @@ -11,13 +11,13 @@ import EcsServiceConfig from './aws-ecs-service/_ecs_service_port_app_config.mdx The following example demonstrates how to ingest your AWS ECS clusters to Port. -#### ECS Cluster Supported Actions +#### ECS Cluster supported actions The table below summarizes the available actions for ingesting Amazon ECS Cluster resources in Port: | 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` | +| [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` | :::info All properties available by default ECS clusters expose their key properties via the default DescribeClusters action. @@ -36,13 +36,13 @@ You can use the following Port blueprint definitions and integration configurati The following example demonstrates how to ingest your AWS ECS services to Port. -#### ECS Service Supported Actions +#### ECS Service supported actions The table below summarizes the available actions for ingesting Amazon ECS Service resources in Port: | Action | Description | Type | Required AWS Permission | |-----------------------------|---------------------------------------------------------------------------------------------------------|----------|--------------------------------------| -| **DescribeServicesAction** | Discover ECS services within your clusters and retrieve detailed configuration data. [Reference](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServices.html) | Default | `ecs:ListServices`, `ecs:DescribeServices` | +| [DescribeServicesAction](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeServices.html) | Discover ECS services within your clusters and retrieve detailed configuration data. | Default | `ecs:ListServices`, `ecs:DescribeServices` | :::info 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. diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_blueprint.mdx index 721b8a4c8e..ace07523fc 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_blueprint.mdx @@ -1,5 +1,5 @@
-ECS Cluster Blueprint (Click to expand) +ECS Cluster blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_port_app_config.mdx index 06547d1a17..16ce13789c 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-cluster/_ecs_cluster_port_app_config.mdx @@ -1,5 +1,5 @@
-ECS Cluster Mapping Configuration (Click to expand) +ECS Cluster mapping configuration (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-service/_ecs_service_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-service/_ecs_service_blueprint.mdx index 606e46983d..c28bde9c08 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-service/_ecs_service_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-service/_ecs_service_blueprint.mdx @@ -1,5 +1,5 @@
-ECS Service Blueprint (Click to expand) +ECS Service blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-service/_ecs_service_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-service/_ecs_service_port_app_config.mdx index 92257c2b6a..0b29c9a69b 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-service/_ecs_service_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/aws-ecs-service/_ecs_service_port_app_config.mdx @@ -1,5 +1,5 @@
-ECS Service Mapping Configuration (Click to expand) +ECS Service mapping configuration (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/amazon-elastic-kubernetes-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/amazon-elastic-kubernetes-service.md index d28d01de65..b68c6b67b0 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/amazon-elastic-kubernetes-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/amazon-elastic-kubernetes-service.md @@ -9,13 +9,13 @@ import EksClusterConfig from './aws-eks-cluster/_eks_cluster_port_app_config.mdx The following example demonstrates how to ingest your AWS EKS clusters to Port. -#### EKS Cluster Supported Actions +#### EKS Cluster supported actions The table below summarizes the available actions for ingesting Amazon EKS Cluster resources in Port: | Action | Description | Type | Required AWS Permission | |---------------------------|--------------------------------------------------------------------------------------------------------------|---------|-------------------------| -| **DescribeClusterAction** | Retrieve detailed configuration data for each cluster. [Reference](https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeCluster.html) | Default | `eks:DescribeCluster` `eks:ListClusters` | +| [DescribeClusterAction](https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeCluster.html) | Retrieve detailed configuration data for each cluster. | Default | `eks:DescribeCluster` `eks:ListClusters` | ::::info All properties available by default EKS clusters expose their key properties via the default DescribeCluster action. diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/aws-eks-cluster/_eks_cluster_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/aws-eks-cluster/_eks_cluster_blueprint.mdx index 987e1fc873..378b61a67a 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/aws-eks-cluster/_eks_cluster_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/aws-eks-cluster/_eks_cluster_blueprint.mdx @@ -1,5 +1,5 @@
-EKS Cluster Blueprint (Click to expand) +EKS Cluster blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/aws-eks-cluster/_eks_cluster_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/aws-eks-cluster/_eks_cluster_port_app_config.mdx index 5b1057d740..d7b930d8ea 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/aws-eks-cluster/_eks_cluster_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/aws-eks-cluster/_eks_cluster_port_app_config.mdx @@ -1,5 +1,5 @@
-EKS Cluster Mapping Configuration (Click to expand) +EKS Cluster mapping configuration (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/amazon-relational-database-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/amazon-relational-database-service.md index 9b5e9022dc..acff4b2a60 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/amazon-relational-database-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/amazon-relational-database-service.md @@ -9,14 +9,14 @@ import RdsDbInstanceConfig from './aws-rds-db-instance/_rds_db_instance_port_app The following example demonstrates how to ingest your AWS RDS DB instances to Port. -#### RDS DB Instance Supported Actions +#### RDS DB Instance supported actions The table below summarizes the available actions for ingesting Amazon RDS DB Instance resources in Port: | Action | Description | Type | Required AWS Permission | |---------------------------------|---------------------------------------------------------------------------------------------------------------------|----------|-------------------------| -| **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` | +| [DescribeDBInstancesAction](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.html) | Discover DB instances and retrieve configuration details. | Default | `rds:DescribeDBInstances` | +| [ListTagsForResourceAction](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ListTagsForResource.html) | Retrieve tags for each DB instance. | Optional | `rds:ListTagsForResource` | ::::info 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. diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/aws-rds-db-instance/_rds_db_instance_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/aws-rds-db-instance/_rds_db_instance_blueprint.mdx index 4ed9fb94fe..e7b0e737cc 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/aws-rds-db-instance/_rds_db_instance_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/aws-rds-db-instance/_rds_db_instance_blueprint.mdx @@ -1,5 +1,5 @@
-RDS DB Instance Blueprint (Click to expand) +RDS DB Instance blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/aws-rds-db-instance/_rds_db_instance_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/aws-rds-db-instance/_rds_db_instance_port_app_config.mdx index ad8946ad1b..7c44ff353e 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/aws-rds-db-instance/_rds_db_instance_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/aws-rds-db-instance/_rds_db_instance_port_app_config.mdx @@ -1,5 +1,5 @@
-RDS DB Instance Mapping Configuration (Click to expand) +RDS DB Instance mapping configuration (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md index 1652661fe7..09d45c573c 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md @@ -10,15 +10,15 @@ import SqsQueueConfig from './aws-sqs-queue/_sqs_queue_port_app_config.mdx' The following example demonstrates how to ingest your AWS SQS queues to Port. -#### SQS Queue Supported Actions +#### 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](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ListQueues.html) | Default | `sqs:ListQueues` | -| **GetQueueAttributesAction**| Retrieve detailed configuration and operational data for each queue. [Reference](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueAttributes.html) | Default | `sqs:GetQueueAttributes`| -| **GetQueueTagsAction** | Bring in custom tags assigned to your queues for advanced catalog filtering and grouping. [Reference](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ListQueueTags.html) | Optional | `sqs:ListQueueTags` | +| [ListQueuesAction](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ListQueues.html) | Discover all SQS queues across your AWS account. | Default | `sqs:ListQueues` | +| [GetQueueAttributesAction](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueAttributes.html) | Retrieve detailed configuration and operational data for each queue. | Default | `sqs:GetQueueAttributes`| +| [GetQueueTagsAction](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ListQueueTags.html) | Bring in custom tags assigned to your queues for advanced catalog filtering and grouping. | Optional | `sqs:ListQueueTags` | :::info 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. diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_blueprint.mdx index 8b357f28a7..c07dad80d5 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_blueprint.mdx @@ -1,5 +1,5 @@
-SQS Queue Blueprint (Click to expand) +SQS Queue blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_port_app_config.mdx index 97985aecd6..96c9ef6074 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/aws-sqs-queue/_sqs_queue_port_app_config.mdx @@ -1,5 +1,5 @@
-SQS Queue Mapping Configuration (Click to expand) +SQS Queue mapping configuration (click to expand) ```yaml showLineNumbers - kind: AWS::SQS::Queue diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md index f254557d82..6a9c0d253b 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md @@ -15,12 +15,12 @@ The table below summarizes the available actions for ingesting Amazon S3 Bucket | Action | Description | Type | Required AWS Permission | |--------------------------------------|----------------------------------------------------------------|----------|---------------------------------------------------------| -| **ListBucketsAction** | Discover all S3 buckets across your AWS account. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html) | Default | `s3:ListAllMyBuckets` | -| **GetBucketTaggingAction** | Bring in bucket tags for catalog filtering and grouping. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html) | Default | `s3:GetBucketTagging` | -| **GetBucketLocationAction** | Retrieve the bucket's region. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLocation.html) | Optional | `s3:GetBucketLocation` | -| **GetBucketEncryptionAction** | Retrieve server-side encryption configuration for the bucket. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html) | Optional | `s3:GetBucketEncryption` | -| **GetBucketPublicAccessBlockAction** | Retrieve public access block configuration. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) | Optional | `s3:GetBucketPublicAccessBlock` | -| **GetBucketOwnershipControlsAction** | Retrieve bucket ownership controls. [Reference](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketOwnershipControls.html) | Optional | `s3:GetBucketOwnershipControls` | +| [ListBucketsAction](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html) | Discover all S3 buckets across your AWS account. | Default | `s3:ListAllMyBuckets` | +| [GetBucketTaggingAction](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html) | Bring in bucket tags for catalog filtering and grouping. | Default | `s3:GetBucketTagging` | +| [GetBucketLocationAction](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLocation.html) | Retrieve the bucket's region. | Optional | `s3:GetBucketLocation` | +| [GetBucketEncryptionAction](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html) | Retrieve server-side encryption configuration for the bucket. | Optional | `s3:GetBucketEncryption` | +| [GetBucketPublicAccessBlockAction](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) | Retrieve public access block configuration. | Optional | `s3:GetBucketPublicAccessBlock` | +| [GetBucketOwnershipControlsAction](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketOwnershipControls.html) | Retrieve bucket ownership controls. | Optional | `s3:GetBucketOwnershipControls` | :::info 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. diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_blueprint.mdx index 51b70affca..4c72903e97 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_blueprint.mdx @@ -1,5 +1,5 @@
-S3 Bucket Blueprint (Click to expand) +S3 Bucket blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_port_app_config.mdx index 9706c6d913..3a479f20d5 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_port_app_config.mdx @@ -1,5 +1,5 @@
-S3 Bucket Mapping Configuration (Click to expand) +S3 Bucket mapping configuration (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account-info/_aws_account_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account-info/_aws_account_blueprint.mdx index ea9dfabb21..af685c8ad7 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account-info/_aws_account_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account-info/_aws_account_blueprint.mdx @@ -1,5 +1,5 @@
-AWS Account Blueprint (Click to expand) +AWS Account blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account-info/_aws_account_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account-info/_aws_account_port_app_config.mdx index f643a42e9d..ba878e223e 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account-info/_aws_account_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-account/aws-account-info/_aws_account_port_app_config.mdx @@ -1,5 +1,5 @@
-AWS Account Info Mapping Configuration (Click to expand) +AWS Account info mapping configuration (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda-function/_lambda_function_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda-function/_lambda_function_blueprint.mdx index d9d179d2d2..507cb90574 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda-function/_lambda_function_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda-function/_lambda_function_blueprint.mdx @@ -1,5 +1,5 @@
-Lambda Function Blueprint (Click to expand) +Lambda Function blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda-function/_lambda_function_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda-function/_lambda_function_port_app_config.mdx index 06deb20398..850a07df14 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda-function/_lambda_function_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda-function/_lambda_function_port_app_config.mdx @@ -1,5 +1,5 @@
-Lambda Function Mapping Configuration (Click to expand) +Lambda Function mapping configuration (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda.md index 1338da9522..0163d6245f 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-lambda/aws-lambda.md @@ -9,14 +9,14 @@ import LambdaFunctionConfig from './aws-lambda-function/_lambda_function_port_ap The following example demonstrates how to ingest your AWS Lambda functions to Port. -#### Lambda Function Supported Actions +#### Lambda Function supported actions The table below summarizes the available actions for ingesting AWS Lambda Function resources in Port: | Action | Description | Type | Required AWS Permission | |---------------------------|-----------------------------------------------------------------------------------------------------------|----------|-------------------------| -| **ListFunctionsAction** | Discover all Lambda functions across your AWS account. [Reference](https://docs.aws.amazon.com/lambda/latest/APIReference/API_ListFunctions.html) | Default | `lambda:ListFunctions` | -| **ListTagsAction** | Retrieve tags for each function. [Reference](https://docs.aws.amazon.com/lambda/latest/APIReference/API_ListTags.html) | Optional | `lambda:ListTags` | +| [ListFunctionsAction](https://docs.aws.amazon.com/lambda/latest/api/API_ListFunctions.html) | Discover all Lambda functions across your AWS account. | Default | `lambda:ListFunctions` | +| [ListTagsAction](https://docs.aws.amazon.com/lambda/latest/api/API_ListTags.html) | Retrieve tags for each function. | Optional | `lambda:ListTags` | ::::info 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. diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_blueprint.mdx index a0d7a6a671..ddd5e7e80e 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_blueprint.mdx @@ -1,5 +1,5 @@
-Organizations Account blueprint (Click to expand) +Organizations Account blueprint (click to expand) ```json showLineNumbers { diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_port_app_config.mdx index af47e5ed3e..68f051c567 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations-account/_organizations_accounts_port_app_config.mdx @@ -1,5 +1,5 @@
-Organizations Account mapping configuration (Click to expand) +Organizations Account mapping configuration (click to expand) ```yaml showLineNumbers resources: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md index e682c27ff9..bfe20794e5 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md @@ -15,9 +15,9 @@ The table below summarizes the available actions for ingesting AWS Organizations | Action | Description | Type | Required AWS Permission | |-----------------------------|------------------------------------------------------------------|----------|-----------------------------------| -| **ListAccountsAction** | Discover organization accounts and retrieve account metadata. [Reference](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListAccounts.html) | Default | `organizations:ListAccounts` | -| **ListTagsForResourceAction** | Retrieve tags for the specified account. [Reference](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListTagsForResource.html) | Optional | `organizations:ListTagsForResource`| -| **ListParentsAction** | Retrieve parent information for the specified account. [Reference](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListParents.html) | Optional | `organizations:ListParents` | +| [ListAccountsAction](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListAccounts.html) | Discover organization accounts and retrieve account metadata. | Default | `organizations:ListAccounts` | +| [ListTagsForResourceAction](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListTagsForResource.html) | Retrieve tags for the specified account. | Optional | `organizations:ListTagsForResource`| +| [ListParentsAction](https://docs.aws.amazon.com/organizations/latest/APIReference/API_ListParents.html) | Retrieve parent information for the specified account. | Optional | `organizations:ListParents` | :::info 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. diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md index 50a13261e9..bff695185e 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md @@ -1,8 +1,8 @@ -# AWS Resource and Property Reference +# AWS resource and property reference Welcome to the reference guide for AWS resource, actions and properties, as supported by AWS CloudFormation and used in Port integrations. -## Supported Resource Types +## Supported resource types Explore detailed documentation for each AWS resource and action available for integration. For each resource type, you'll find information about supported actions, required permissions, and usage best practices. @@ -79,4 +79,46 @@ You can include a **maximum of 3 optional actions per resource kind** (excluding ::: +### Querying resources from specific regions + +The `regionPolicy` selector lets you control which AWS regions are queried by the integration. Use it to include or exclude regions per resource. + +- allow: List of regions explicitly permitted for querying +- deny: List of regions explicitly excluded from querying + +#### How `regionPolicy` works + +1. If both lists are empty: all regions are allowed. +2. If the region is in `deny`: it is excluded unless explicitly allowed. +3. If the region is in `allow`: it is included for querying. +4. If a region appears in both lists: it is excluded. +5. If only `deny` is specified: only regions in the `deny` list are excluded. +6. If only `allow` is specified: only regions in the `allow` list are included. + +#### Example configuration + +```yaml showLineNumbers +resources: + - kind: AWS::Lambda::Function + selector: + query: 'true' + regionPolicy: + allow: ["us-east-1", "eu-west-1"] + deny: ["us-west-2"] + port: + entity: + mappings: + identifier: .Properties.Arn + title: .Properties.FunctionName + blueprint: '"lambda"' + properties: + region: .__Region + description: .Properties.Description + arn: .Properties.Arn + relations: + account: .__ExtraContext.AccountId +``` + +In this example, resources in `us-east-1` and `eu-west-1` are allowed, while `us-west-2` is denied. + Refer to the individual resource documentation pages for a table of actions, their AWS mapping, and necessary IAM permissions. From d0a2766816472047461cb6ada9f6f7aac2a956e8 Mon Sep 17 00:00:00 2001 From: Michael Kofi Armah Date: Wed, 5 Nov 2025 10:30:22 +0000 Subject: [PATCH 16/20] Add Short Names to Resources --- .../amazon-elastic-compute-cloud.md | 2 +- .../amazon-elastic-container-service.md | 2 +- .../amazon-elastic-kubernetes-service.md | 2 +- .../amazon-relational-database-service.md | 2 +- .../amazon-simple-storage-service.md | 4 ++-- .../aws-organizations/aws-organizations.md | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md index 9f7ff309c1..1587a701a1 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-compute-cloud/amazon-elastic-compute-cloud.md @@ -1,4 +1,4 @@ -# Amazon Elastic Compute Cloud +# Amazon Elastic Compute Cloud (EC2) import Ec2InstanceBlueprint from './aws-ec2-instance/_ec2_instance_blueprint.mdx' import Ec2InstanceConfig from './aws-ec2-instance/_ec2_instance_port_app_config.mdx' diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md index aa1be46fee..ef6c3ec9ac 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-container-service/amazon-elastic-container-service.md @@ -1,4 +1,4 @@ -# Amazon Elastic Container Service +# Amazon Elastic Container Service (ECS) import EcsClusterBlueprint from './aws-ecs-cluster/_ecs_cluster_blueprint.mdx' import EcsClusterConfig from './aws-ecs-cluster/_ecs_cluster_port_app_config.mdx' diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/amazon-elastic-kubernetes-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/amazon-elastic-kubernetes-service.md index b68c6b67b0..11b5006192 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/amazon-elastic-kubernetes-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-elastic-kubernetes-service/amazon-elastic-kubernetes-service.md @@ -1,4 +1,4 @@ -# Amazon Elastic Kubernetes Service +# Amazon Elastic Kubernetes Service (EKS) import EksClusterBlueprint from './aws-eks-cluster/_eks_cluster_blueprint.mdx' import EksClusterConfig from './aws-eks-cluster/_eks_cluster_port_app_config.mdx' diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/amazon-relational-database-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/amazon-relational-database-service.md index acff4b2a60..4f73cf4b61 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/amazon-relational-database-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-relational-database-service/amazon-relational-database-service.md @@ -1,4 +1,4 @@ -# Amazon Relational Database Service +# Amazon Relational Database Service (RDS) import RdsDbInstanceBlueprint from './aws-rds-db-instance/_rds_db_instance_blueprint.mdx' import RdsDbInstanceConfig from './aws-rds-db-instance/_rds_db_instance_port_app_config.mdx' diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md index 6a9c0d253b..7863d23fe2 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/amazon-simple-storage-service.md @@ -1,4 +1,4 @@ -# Amazon Simple Storage Service +# Amazon Simple Storage Service (S3) import S3BucketBlueprint from './aws-s3-bucket/_s3_bucket_blueprint.mdx' import S3BucketConfig from './aws-s3-bucket/_s3_bucket_port_app_config.mdx' @@ -9,7 +9,7 @@ import S3BucketConfig from './aws-s3-bucket/_s3_bucket_port_app_config.mdx' The following example demonstrates how to ingest your AWS S3 buckets to Port. -#### S3 Bucket Supported Actions +#### S3 Bucket supported actions The table below summarizes the available actions for ingesting Amazon S3 Bucket resources in Port: diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md index bfe20794e5..d0e0e856a4 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/aws-organizations/aws-organizations.md @@ -9,7 +9,7 @@ import OrganizationsAccountConfig from './aws-organizations-account/_organizatio The following example demonstrates how to ingest your AWS Organizations accounts to Port. -#### Organizations Account Supported Actions +#### Organizations Account supported actions The table below summarizes the available actions for ingesting AWS Organizations Account resources in Port: From e7e8bee3ea1261ed7b661144e4a8decf36eab97d Mon Sep 17 00:00:00 2001 From: Michael Kofi Armah Date: Wed, 5 Nov 2025 10:48:47 +0000 Subject: [PATCH 17/20] Align Defaults with integration --- .../amazon-simple-queue-service.md | 2 +- .../aws-s3-bucket/_s3_bucket_blueprint.mdx | 4 ---- .../aws-s3-bucket/_s3_bucket_port_app_config.mdx | 1 - 3 files changed, 1 insertion(+), 6 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md index 09d45c573c..5251a9f74e 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-queue-service/amazon-simple-queue-service.md @@ -18,7 +18,7 @@ The table below summarizes the available actions for ingesting Amazon SQS Queue |-----------------------------|------------------------------------------------------------------------------------------|----------|-------------------------| | [ListQueuesAction](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ListQueues.html) | Discover all SQS queues across your AWS account. | Default | `sqs:ListQueues` | | [GetQueueAttributesAction](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueAttributes.html) | Retrieve detailed configuration and operational data for each queue. | Default | `sqs:GetQueueAttributes`| -| [GetQueueTagsAction](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ListQueueTags.html) | Bring in custom tags assigned to your queues for advanced catalog filtering and grouping. | Optional | `sqs:ListQueueTags` | +| [ListQueueTagsAction](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ListQueueTags.html) | Bring in custom tags assigned to your queues for advanced catalog filtering and grouping. | Optional | `sqs:ListQueueTags` | :::info 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. diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_blueprint.mdx index 4c72903e97..e8b0ffa499 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_blueprint.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_blueprint.mdx @@ -13,10 +13,6 @@ "type": "string", "title": "ARN" }, - "region": { - "type": "string", - "title": "Region" - }, "creationDate": { "type": "string", "format": "date-time", diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_port_app_config.mdx index 3a479f20d5..230e291076 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_port_app_config.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/amazon-simple-storage-service/aws-s3-bucket/_s3_bucket_port_app_config.mdx @@ -14,7 +14,6 @@ resources: blueprint: '"s3Bucket"' properties: arn: .Properties.Arn - region: .Properties.LocationConstraint creationDate: .Properties.CreationDate tags: .Properties.Tags relations: From 08678d3a666ed9eb47dec1802a10a0b463d89d52 Mon Sep 17 00:00:00 2001 From: sivanel97 Date: Wed, 5 Nov 2025 15:57:41 +0200 Subject: [PATCH 18/20] Apply suggestion from @sivanel97 --- .../resource-and-property-reference.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md index bff695185e..0160c1c2c9 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md @@ -64,13 +64,12 @@ With Port, you have full control over which AWS resource properties are discover To collect additional properties from AWS resources, add the optional actions you need to the `includeActions` field of your configuration. For example, to include status details from EC2 instances by enabling the `DescribeInstanceStatusAction`, add the following: -```yaml +```yaml showLineNumbers - kind: AWS::EC2::Instance selector: query: 'true' includeActions: - DescribeInstanceStatusAction -``` In this configuration, Port will enrich your catalog by fetching all properties provided by the [DescribeInstanceStatus API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstanceStatus.html) for every EC2 instance. From 89da7c4a37c15097a15c5131e11f64e60d02b43f Mon Sep 17 00:00:00 2001 From: sivanel97 Date: Wed, 5 Nov 2025 15:58:03 +0200 Subject: [PATCH 19/20] Apply suggestion from @sivanel97 --- .../resource-and-property-reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md index 0160c1c2c9..66d6c88613 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md @@ -4,7 +4,7 @@ Welcome to the reference guide for AWS resource, actions and properties, as supp ## Supported resource types -Explore detailed documentation for each AWS resource and action available for integration. For each resource type, you'll find information about supported actions, required permissions, and usage best practices. +Explore detailed documentation for each AWS resource and action available for integration. For each resource type, you will find information about supported actions, required permissions, and usage best practices. Resource type identifiers follow a standardized format, allowing you to easily recognize and reference each AWS entity: From 1212a33d8c8b7fc69306d7ae78eb926f9706576b Mon Sep 17 00:00:00 2001 From: sivanel97 Date: Wed, 5 Nov 2025 15:58:31 +0200 Subject: [PATCH 20/20] Apply suggestion from @sivanel97 --- .../resource-and-property-reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md index 66d6c88613..b572ce3bf3 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/resource-and-property-reference/resource-and-property-reference.md @@ -18,7 +18,7 @@ For example, an EC2 instance is identified as: AWS::EC2::Instance ``` -Refer to the sidebar or the list below to navigate to individual resource reference pages where you'll find actionable integration details, sample configurations, and official AWS documentation links. +Refer to the sidebar or the list below to navigate to individual resource reference pages where you will find actionable integration details, sample configurations, and official AWS documentation links. - [Amazon Simple Queue Service](./amazon-simple-queue-service/amazon-simple-queue-service.md) - [Amazon Simple Storage Service](./amazon-simple-storage-service/amazon-simple-storage-service.md)