> For the complete documentation index, see llms.txt.
Skip to main content

Check out Port for yourself ➜ 

AWS v3

Loading version...

Port's AWS integration imports your AWS resources into Port, with flexible deployment options to match your needs. The integration periodically syncs your AWS resources so your Port catalog stays up-to-date with your AWS infrastructure.

Supported resources AWS::SQS::QueueAWS::S3::BucketAWS::EC2::InstanceAWS::EC2::VolumeAWS::ECR::RepositoryAWS::ECS::ClusterAWS::ECS::ServiceAWS::ECS::TaskDefinitionAWS::EKS::ClusterAWS::Organizations::AccountAWS::RDS::DBInstanceAWS::RDS::DBClusterAWS::Lambda::FunctionAWS::Account::InfoAWS::MSK::ClusterAWS::MSK::ServerlessClusterAWS::ElastiCache::ClusterAWS::MemoryDB::UserAWS::CodeBuild::ProjectAWS::CodeBuild::BuildRunAWS::CodeDeploy::ApplicationAWS::CodeDeploy::DeploymentGroupAWS::CodeDeploy::DeploymentAWS::CodeDeploy::DeploymentTargetAWS::CodePipeline::PipelineAWS::CodePipeline::StageAWS::CodePipeline::ActionAWS::CodePipeline::PipelineExecutionAWS::CodePipeline::ActionExecution
Open source

Port's AWS integration is open source, view the source code here.

Deployment options​

The integration can be deployed using one of the following methods:

  • Hosted by Port: Fully managed by Port with zero maintenance required. Simply create IAM roles via CloudFormation, and Port handles the rest.
  • Self-hosted: Deploy the integration in your own infrastructure using ECS, EC2, EKS, or as a one-off Docker run for complete control.

For detailed information about the IAM role architecture, see the IAM role architecture section of the installation page.

GovCloud and on-premises support

The integration supports AWS GovCloud.
When running a self-hosted GovCloud integration, it is recommended to run using the AssumeRole mode.

If you run in StaticCredentials mode, you will need to set the OCEAN__INTEGRATION__CONFIG__AWS_PARTITION environment variable to specify your AWS partition (for example, aws-us-gov for GovCloud).

Common use cases​

Easily fill your software catalog with data directly from your AWS Organization, for example:

  • Map all the resources in your AWS Accounts, including ECS Clusters, S3 Buckets, and EC2 Instances with zero maintenance required.
  • Keep your Port catalog synchronized with your AWS infrastructure through periodic updates.
  • 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.
Multi-account support

The integration supports syncing resources across multiple AWS accounts using automatic account discovery via AWS Organizations. See the account discovery section of the installation page for details.

Key advantages​

AWS Hosted by Port provides several advantages over the AWS on-premise integration:

  • Fully hosted: No infrastructure to maintain, update, or monitor.
  • Simplified installation: Just deploy CloudFormation templates to create IAM roles.
  • Complete data: Ensures no missing or incomplete resource information.

Configuration​

Port integrations use a YAML mapping block to ingest data from the third-party api into Port.

The mapping makes use of the JQ JSON processor to select, modify, concatenate, transform and perform other operations on existing fields and values from the integration API.

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​

This is the default mapping configuration you get after installing AWS Hosted by Port.

Default mapping configuration (click to expand)
deleteDependentEntities: true
createMissingRelatedEntities: true
enableMergeEntity: true
resources:
  - kind: AWS::Account::Info
    selector:
      query: 'true'
    port:
      entity:
        mappings:
          identifier: .Properties.Id
          title: .Properties.Name
          blueprint: '"awsAccount"'
  - kind: AWS::S3::Bucket
    selector:
      query: 'true'
    port:
      entity:
        mappings:
          identifier: .Properties.Arn
          title: .Properties.BucketName
          blueprint: '"s3Bucket"'
          properties:
            arn: .Properties.Arn
            region: .Properties.LocationConstraint
            creationDate: .Properties.CreationDate
            tags: .Properties.Tags
          relations:
            account: .__ExtraContext.AccountId
  - kind: AWS::EC2::Instance
    selector:
      query: 'true'
    port:
      entity:
        mappings:
          identifier: .Properties.InstanceId
          title: .Properties.InstanceId
          blueprint: '"ec2Instance"'
          properties:
            instanceType: .Properties.InstanceType
            state: .Properties.State.Name
            publicIpAddress: .Properties.PublicIpAddress
            privateIpAddress: .Properties.PrivateIpAddress
            tags: .Properties.Tags
            arn: >-
              "arn:aws:ec2:" + .__Region + ":" + .__AccountId + ":instance/" +
              .Properties.InstanceId
          relations:
            account: .__ExtraContext.AccountId
  - kind: AWS::ECS::Cluster
    selector:
      query: 'true'
    port:
      entity:
        mappings:
          identifier: .Properties.ClusterArn
          title: .Properties.ClusterName
          blueprint: '"ecsCluster"'
          properties:
            status: .Properties.Status
            runningTasksCount: .Properties.RunningTasksCount
            activeServicesCount: .Properties.ActiveServicesCount
            pendingTasksCount: .Properties.PendingTasksCount
            registeredContainerInstancesCount: .Properties.RegisteredContainerInstancesCount
            capacityProviders: .Properties.CapacityProviders
            clusterArn: .Properties.ClusterArn
            tags: .Properties.Tags
          relations:
            account: .__ExtraContext.AccountId

Monitoring and sync status​

To learn more about how to monitor and check the sync status of your integration, see the relevant documentation.

Mapping & selectors per resource​

The following sections show examples of blueprint definitions and mapping configurations for common AWS resources.

Resource and property reference​

Refer to the resource and property reference page for details on available AWS resources, their properties, and mapping examples.