Amazon Relational Database Service (RDS)

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.	Default	rds:DescribeDBInstances
ListTagsForResourceAction	Retrieve tags for each DB instance.	Optional	rds:ListTagsForResource

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:

RDS DB Instance blueprint (click to expand)

{
  "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
    }
  }
}

RDS DB Instance mapping configuration (click to expand)

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

For more details about RDS DB instance properties, refer to the AWS RDS API documentation.

AWS::RDS::DBCluster

The following example demonstrates how to ingest your AWS RDS DB clusters (for example, Aurora clusters) to Port.

RDS DB Cluster supported actions

The table below summarizes the available actions for ingesting Amazon RDS DB Cluster resources in Port:

Action	Description	Type	Required AWS Permission
DescribeDBClustersAction	Discover DB clusters and retrieve configuration details such as engine mode, endpoints, and cluster members.	Default	rds:DescribeDBClusters
ListTagsForResourceAction	Retrieve tags for each DB cluster.	Optional	rds:ListTagsForResource

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:

RDS DB Cluster blueprint (click to expand)

{
  "identifier": "rdsDbCluster",
  "title": "RDS DB Cluster",
  "icon": "AWS",
  "schema": {
    "properties": {
      "activityStreamStatus": {
        "type": "string",
        "title": "Activity Stream Status",
        "description": "The status of the database activity stream"
      },
      "associatedRoles": {
        "type": "array",
        "title": "Associated Roles",
        "description": "The IAM roles associated with the DB cluster",
        "items": {
          "type": "object"
        }
      },
      "autoMinorVersionUpgrade": {
        "type": "boolean",
        "title": "Auto Minor Version Upgrade",
        "description": "Whether minor version upgrades are applied automatically"
      },
      "availabilityZones": {
        "type": "array",
        "title": "Availability Zones",
        "description": "The Availability Zones where the DB cluster is deployed",
        "items": {
          "type": "string"
        }
      },
      "backupRetentionPeriod": {
        "type": "number",
        "title": "Backup Retention Period",
        "description": "The number of days to retain automated backups"
      },
      "clusterCreateTime": {
        "type": "string",
        "title": "Cluster Create Time",
        "description": "The time when the DB cluster was created"
      },
      "copyTagsToSnapshot": {
        "type": "boolean",
        "title": "Copy Tags To Snapshot",
        "description": "Whether to copy tags to snapshots"
      },
      "crossAccountClone": {
        "type": "boolean",
        "title": "Cross Account Clone",
        "description": "Whether cross-account cloning is enabled"
      },
      "databaseName": {
        "type": "string",
        "title": "Database Name",
        "description": "The name of the initial database"
      },
      "dbClusterArn": {
        "type": "string",
        "title": "ARN",
        "description": "The Amazon Resource Name (ARN) of the DB cluster"
      },
      "dbClusterIdentifier": {
        "type": "string",
        "title": "DB Cluster Identifier",
        "description": "The unique identifier of the RDS DB cluster"
      },
      "dbClusterMembers": {
        "type": "array",
        "title": "DB Cluster Members",
        "description": "The DB instances that belong to the cluster",
        "items": {
          "type": "object"
        }
      },
      "dbClusterResourceId": {
        "type": "string",
        "title": "DB Cluster Resource ID",
        "description": "The unique resource identifier for the DB cluster"
      },
      "deletionProtection": {
        "type": "boolean",
        "title": "Deletion Protection",
        "description": "Whether deletion protection is enabled"
      },
      "earliestRestorableTime": {
        "type": "string",
        "title": "Earliest Restorable Time",
        "description": "The earliest time to which the DB cluster can be restored"
      },
      "endpoint": {
        "type": "string",
        "title": "Writer Endpoint",
        "description": "The writer endpoint for the DB cluster"
      },
      "engine": {
        "type": "string",
        "title": "Engine",
        "description": "The database engine type (e.g., aurora-mysql, aurora-postgresql)"
      },
      "engineMode": {
        "type": "string",
        "title": "Engine Mode",
        "description": "The engine mode of the DB cluster (e.g., provisioned, serverless)"
      },
      "engineVersion": {
        "type": "string",
        "title": "Engine Version",
        "description": "The version of the database engine"
      },
      "globalWriteForwardingStatus": {
        "type": "string",
        "title": "Global Write Forwarding Status",
        "description": "The status of write forwarding for a secondary cluster in a global database"
      },
      "httpEndpointEnabled": {
        "type": "boolean",
        "title": "HTTP Endpoint Enabled",
        "description": "Whether the HTTP endpoint (Data API) is enabled for Aurora Serverless"
      },
      "iamDatabaseAuthenticationEnabled": {
        "type": "boolean",
        "title": "IAM Database Authentication Enabled",
        "description": "Whether IAM database authentication is enabled"
      },
      "kmsKeyId": {
        "type": "string",
        "title": "KMS Key ID",
        "description": "The KMS key identifier for encryption"
      },
      "latestRestorableTime": {
        "type": "string",
        "title": "Latest Restorable Time",
        "description": "The latest time to which the DB cluster can be restored"
      },
      "masterUsername": {
        "type": "string",
        "title": "Master Username",
        "description": "The master username for the DB cluster"
      },
      "multiAZ": {
        "type": "boolean",
        "title": "Multi-AZ",
        "description": "Whether the DB cluster is deployed across multiple Availability Zones"
      },
      "networkType": {
        "type": "string",
        "title": "Network Type",
        "description": "The network type for the DB cluster"
      },
      "port": {
        "type": "number",
        "title": "Port",
        "description": "The port number for the DB cluster"
      },
      "preferredBackupWindow": {
        "type": "string",
        "title": "Preferred Backup Window",
        "description": "The preferred backup window"
      },
      "preferredMaintenanceWindow": {
        "type": "string",
        "title": "Preferred Maintenance Window",
        "description": "The preferred maintenance window"
      },
      "readerEndpoint": {
        "type": "string",
        "title": "Reader Endpoint",
        "description": "The reader endpoint for load-balancing read connections across cluster members"
      },
      "status": {
        "type": "string",
        "title": "Status",
        "description": "The current status of the DB cluster",
        "enum": [
          "available",
          "backing-up",
          "creating",
          "deleting",
          "failing-over",
          "inaccessible-encryption-credentials",
          "maintenance",
          "migrating",
          "modifying",
          "promoting",
          "renaming",
          "resetting-master-credentials",
          "scaling",
          "starting",
          "stopped",
          "stopping",
          "upgrading"
        ]
      },
      "storageEncrypted": {
        "type": "boolean",
        "title": "Storage Encrypted",
        "description": "Whether the DB cluster storage is encrypted"
      },
      "storageType": {
        "type": "string",
        "title": "Storage Type",
        "description": "The storage type of the DB cluster"
      },
      "tags": {
        "type": "array",
        "title": "Tags",
        "description": "The tags associated with the DB cluster",
        "items": {
          "type": "object",
          "properties": {
            "Key": {
              "type": "string"
            },
            "Value": {
              "type": "string"
            }
          }
        }
      },
      "vpcSecurityGroups": {
        "type": "array",
        "title": "VPC Security Groups",
        "description": "The VPC security groups associated with the DB cluster",
        "items": {
          "type": "object"
        }
      },
      "dbSubnetGroup": {
        "type": "string",
        "title": "DB Subnet Group",
        "description": "The subnet group associated with the DB cluster"
      }
    },
    "required": []
  },
  "mirrorProperties": {},
  "calculationProperties": {},
  "aggregationProperties": {},
  "relations": {
    "account": {
      "title": "Account",
      "target": "awsAccount",
      "required": false,
      "many": false
    }
  }
}

RDS DB Cluster mapping configuration (click to expand)

resources:
  - kind: AWS::RDS::DBCluster
    selector:
      query: 'true'
    port:
      entity:
        mappings:
          identifier: .Properties.DBClusterArn
          title: .Properties.DBClusterIdentifier
          blueprint: '"rdsDbCluster"'
          properties:
            activityStreamStatus: .Properties.ActivityStreamStatus
            associatedRoles: .Properties.AssociatedRoles
            autoMinorVersionUpgrade: .Properties.AutoMinorVersionUpgrade
            availabilityZones: .Properties.AvailabilityZones
            backupRetentionPeriod: .Properties.BackupRetentionPeriod
            clusterCreateTime: .Properties.ClusterCreateTime
            copyTagsToSnapshot: .Properties.CopyTagsToSnapshot
            crossAccountClone: .Properties.CrossAccountClone
            databaseName: .Properties.DatabaseName
            dbClusterArn: .Properties.DBClusterArn
            dbClusterIdentifier: .Properties.DBClusterIdentifier
            dbClusterMembers: .Properties.DBClusterMembers
            dbClusterResourceId: .Properties.DbClusterResourceId
            deletionProtection: .Properties.DeletionProtection
            earliestRestorableTime: .Properties.EarliestRestorableTime
            endpoint: .Properties.Endpoint
            engine: .Properties.Engine
            engineMode: .Properties.EngineMode
            engineVersion: .Properties.EngineVersion
            globalWriteForwardingStatus: .Properties.GlobalWriteForwardingStatus
            httpEndpointEnabled: .Properties.HttpEndpointEnabled
            iamDatabaseAuthenticationEnabled: .Properties.IAMDatabaseAuthenticationEnabled
            kmsKeyId: .Properties.KmsKeyId
            latestRestorableTime: .Properties.LatestRestorableTime
            masterUsername: .Properties.MasterUsername
            multiAZ: .Properties.MultiAZ
            networkType: .Properties.NetworkType
            port: .Properties.Port
            preferredBackupWindow: .Properties.PreferredBackupWindow
            preferredMaintenanceWindow: .Properties.PreferredMaintenanceWindow
            readerEndpoint: .Properties.ReaderEndpoint
            status: .Properties.Status
            storageEncrypted: .Properties.StorageEncrypted
            storageType: .Properties.StorageType
            tags: .Properties.Tags
            vpcSecurityGroups: .Properties.VpcSecurityGroups
            dbSubnetGroup: .Properties.DBSubnetGroup
          relations:
            account: .__ExtraContext.AccountId

For more details about RDS DB cluster properties, refer to the AWS RDS API documentation.