From 55afabda4b6cac8d4c147e991d2a7ea9c57fc442 Mon Sep 17 00:00:00 2001 From: shariff-6 Date: Thu, 2 Oct 2025 13:30:41 +0300 Subject: [PATCH] Ads RDS DB Instance --- .../cloud-providers/aws-v3/examples.md | 21 ++++++ .../_rds_db_instance_blueprint.mdx | 62 ++++++++++++++++++ .../_rds_db_instance_port_app_config.mdx | 31 +++++++++ .../_rds_db_instance_properties.mdx | 65 +++++++++++++++++++ 4 files changed, 179 insertions(+) create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/rds/db_instance/_rds_db_instance_blueprint.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/rds/db_instance/_rds_db_instance_port_app_config.mdx create mode 100644 docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/rds/db_instance/_rds_db_instance_properties.mdx 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..0b510c2bbf 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 @@ -13,6 +13,9 @@ import EcsClusterProperties from './examples/ecs/clusters/_ecs_cluster_propertie 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 RdsDbInstanceBlueprint from './examples/rds/db_instance/_rds_db_instance_blueprint.mdx' +import RdsDbInstanceConfig from './examples/rds/db_instance/_rds_db_instance_port_app_config.mdx' +import RdsDbInstanceProperties from './examples/rds/db_instance/_rds_db_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' @@ -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 RDS + +### DB instance + +The following example demonstrates how to ingest your AWS RDS DB instances to Port. + +You can use the following Port blueprint definitions and integration configuration: + + + + + +You can reference any of the following RDS instance properties in your mapping configuration: + + + +For more details about RDS instance properties, refer to the [AWS RDS API documentation](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DescribeDBInstances.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/rds/db_instance/_rds_db_instance_blueprint.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/rds/db_instance/_rds_db_instance_blueprint.mdx new file mode 100644 index 0000000000..8f28947191 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/rds/db_instance/_rds_db_instance_blueprint.mdx @@ -0,0 +1,62 @@ +
+DB instance blueprint (Click to expand) + +```json showLineNumbers +{ + "identifier": "rdsInstance", + "description": "This blueprint represents an AWS RDS DB instance in our software catalog", + "title": "DB instance", + "icon": "AWS", + "schema": { + "properties": { + "dbInstanceArn": { + "type": "string", + "title": "DB Instance ARN" + }, + "dbInstanceIdentifier": { + "type": "string", + "title": "DB Instance Identifier" + }, + "dbInstanceStatus": { + "type": "string", + "title": "DB Instance Status" + }, + "engine": { + "type": "string", + "title": "Engine" + }, + "tags": { + "type": "array", + "title": "Tags", + "items": { + "type": "object", + "properties": { + "Key": { + "type": "string" + }, + "Value": { + "type": "string" + } + } + } + } + }, + "required": [] + }, + "mirrorProperties": {}, + "calculationProperties": {}, + "aggregationProperties": {}, + "relations": { + "account": { + "title": "Account", + "target": "awsAccount", + "required": true, + "many": false + } + } +} +``` + +
+ + diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/rds/db_instance/_rds_db_instance_port_app_config.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/rds/db_instance/_rds_db_instance_port_app_config.mdx new file mode 100644 index 0000000000..534c2077d2 --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/rds/db_instance/_rds_db_instance_port_app_config.mdx @@ -0,0 +1,31 @@ +
+DB instance mapping configuration (Click to expand) + +```yaml showLineNumbers +resources: + - kind: AWS::RDS::DBInstance + selector: + query: 'true' + includeActions: + # Optional: Include up to 3 additional actions for more properties + # Choose based on which properties you need most + # - ListTagsForResourceAction + port: + entity: + mappings: + identifier: .Properties.DBInstanceIdentifier + title: .Properties.DBInstanceIdentifier + blueprint: '"rdsInstance"' + properties: + dbInstanceArn: .Properties.DBInstanceArn + dbInstanceIdentifier: .Properties.DBInstanceIdentifier + dbInstanceStatus: .Properties.DBInstanceStatus + engine: .Properties.Engine + tags: .Properties.Tags + relations: + account: .__ExtraContext.AccountId +``` + +
+ + diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/rds/db_instance/_rds_db_instance_properties.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/rds/db_instance/_rds_db_instance_properties.mdx new file mode 100644 index 0000000000..b8dba6a8ba --- /dev/null +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/aws-v3/examples/rds/db_instance/_rds_db_instance_properties.mdx @@ -0,0 +1,65 @@ +
+DB instance properties (Click to expand) + +| Property | JQ Path | Type | Action Required | +|----------|---------|------|-----------------| +| Allocated Storage | `.Properties.AllocatedStorage` | number | DescribeDBInstancesAction (default) | +| Auto Minor Version Upgrade | `.Properties.AutoMinorVersionUpgrade` | boolean | DescribeDBInstancesAction (default) | +| Availability Zone | `.Properties.AvailabilityZone` | string | DescribeDBInstancesAction (default) | +| Backup Retention Period | `.Properties.BackupRetentionPeriod` | number | DescribeDBInstancesAction (default) | +| CA Certificate Identifier | `.Properties.CACertificateIdentifier` | string | DescribeDBInstancesAction (default) | +| Character Set Name | `.Properties.CharacterSetName` | string | DescribeDBInstancesAction (default) | +| Copy Tags To Snapshot | `.Properties.CopyTagsToSnapshot` | boolean | DescribeDBInstancesAction (default) | +| DB Instance ARN | `.Properties.DBInstanceArn` | string | DescribeDBInstancesAction (default) | +| DB Instance Class | `.Properties.DBInstanceClass` | string | DescribeDBInstancesAction (default) | +| DB Instance Identifier | `.Properties.DBInstanceIdentifier` | string | DescribeDBInstancesAction (default) | +| Port | `.Properties.Port` | number | DescribeDBInstancesAction (default) | +| DB Instance Status | `.Properties.DBInstanceStatus` | string | DescribeDBInstancesAction (default) | +| DB Name | `.Properties.DBName` | string | DescribeDBInstancesAction (default) | +| DB Parameter Groups | `.Properties.DBParameterGroups` | array | DescribeDBInstancesAction (default) | +| DB Security Groups | `.Properties.DBSecurityGroups` | array | DescribeDBInstancesAction (default) | +| DB Subnet Group | `.Properties.DBSubnetGroup` | object | DescribeDBInstancesAction (default) | +| DBI Resource Id | `.Properties.DbiResourceId` | string | DescribeDBInstancesAction (default) | +| Domain Memberships | `.Properties.DomainMemberships` | array | DescribeDBInstancesAction (default) | +| Enable IAM Database Authentication | `.Properties.EnableIAMDatabaseAuthentication` | boolean | DescribeDBInstancesAction (default) | +| Enable Performance Insights | `.Properties.EnablePerformanceInsights` | boolean | DescribeDBInstancesAction (default) | +| Endpoint | `.Properties.Endpoint` | object | DescribeDBInstancesAction (default) | +| Engine | `.Properties.Engine` | string | DescribeDBInstancesAction (default) | +| Engine Version | `.Properties.EngineVersion` | string | DescribeDBInstancesAction (default) | +| Enhanced Monitoring Resource Arn | `.Properties.EnhancedMonitoringResourceArn` | string | DescribeDBInstancesAction (default) | +| Instance Create Time | `.Properties.InstanceCreateTime` | datetime | DescribeDBInstancesAction (default) | +| IOPS | `.Properties.Iops` | number | DescribeDBInstancesAction (default) | +| KMS Key Id | `.Properties.KmsKeyId` | string | DescribeDBInstancesAction (default) | +| Latest Restorable Time | `.Properties.LatestRestorableTime` | datetime | DescribeDBInstancesAction (default) | +| License Model | `.Properties.LicenseModel` | string | DescribeDBInstancesAction (default) | +| Master Username | `.Properties.MasterUsername` | string | DescribeDBInstancesAction (default) | +| Monitoring Interval | `.Properties.MonitoringInterval` | number | DescribeDBInstancesAction (default) | +| Monitoring Role Arn | `.Properties.MonitoringRoleArn` | string | DescribeDBInstancesAction (default) | +| Multi-AZ | `.Properties.MultiAZ` | boolean | DescribeDBInstancesAction (default) | +| Option Group Memberships | `.Properties.OptionGroupMemberships` | array | DescribeDBInstancesAction (default) | +| Pending Modified Values | `.Properties.PendingModifiedValues` | object | DescribeDBInstancesAction (default) | +| Preferred Backup Window | `.Properties.PreferredBackupWindow` | string | DescribeDBInstancesAction (default) | +| Preferred Maintenance Window | `.Properties.PreferredMaintenanceWindow` | string | DescribeDBInstancesAction (default) | +| Publicly Accessible | `.Properties.PubliclyAccessible` | boolean | DescribeDBInstancesAction (default) | +| Read Replica DB Instance Identifiers | `.Properties.ReadReplicaDBInstanceIdentifiers` | array | DescribeDBInstancesAction (default) | +| Secondary Availability Zone | `.Properties.SecondaryAvailabilityZone` | string | DescribeDBInstancesAction (default) | +| Storage Encrypted | `.Properties.StorageEncrypted` | boolean | DescribeDBInstancesAction (default) | +| Storage Type | `.Properties.StorageType` | string | DescribeDBInstancesAction (default) | +| Tags | `.Properties.Tags` | array | ListTagsForResourceAction (optional) | +| VPC Security Groups | `.Properties.VPCSecurityGroups` | array | DescribeDBInstancesAction (default) | +| Database Insights Mode | `.Properties.DatabaseInsightsMode` | string | DescribeDBInstancesAction (default) | +| Deletion Protection | `.Properties.DeletionProtection` | boolean | DescribeDBInstancesAction (default) | +| Associated Roles | `.Properties.AssociatedRoles` | array | DescribeDBInstancesAction (default) | +| Customer Owned IP Enabled | `.Properties.CustomerOwnedIpEnabled` | boolean | DescribeDBInstancesAction (default) | +| Activity Stream Status | `.Properties.ActivityStreamStatus` | string | DescribeDBInstancesAction (default) | +| Backup Target | `.Properties.BackupTarget` | string | DescribeDBInstancesAction (default) | +| Network Type | `.Properties.NetworkType` | string | DescribeDBInstancesAction (default) | +| Storage Throughput | `.Properties.StorageThroughput` | number | DescribeDBInstancesAction (default) | +| Certificate Details | `.Properties.CertificateDetails` | object | DescribeDBInstancesAction (default) | +| Dedicated Log Volume | `.Properties.DedicatedLogVolume` | boolean | DescribeDBInstancesAction (default) | +| Is Storage Config Upgrade Available | `.Properties.IsStorageConfigUpgradeAvailable` | boolean | DescribeDBInstancesAction (default) | +| Engine Lifecycle Support | `.Properties.EngineLifecycleSupport` | string | DescribeDBInstancesAction (default) | + +
+ +