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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -107,6 +110,24 @@ You can reference any of the following EC2 instance properties in your mapping c

For more details about EC2 instance properties, refer to the [AWS EC2 API documentation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html).

## Amazon 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:

<RdsDbInstanceBlueprint/>

<RdsDbInstanceConfig/>

You can reference any of the following RDS instance properties in your mapping configuration:

<RdsDbInstanceProperties/>

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

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

</details>


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

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

</details>


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

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

</details>