Skip to main content

Amazon ECS

Amazon ECS (Elastic Container Service) by Amazon Web Services (AWS) provides container orchestration for deploying, managing, and scaling containerized applications. You can bring cluster, service, task, and task definition data from Amazon ECS into Brinqa to gain a unified view of your container workloads, thus strengthening your cybersecurity posture.

This document details the information you must provide for the connector to authenticate with Amazon ECS and how to obtain that information from Amazon. See create a data integration for step-by-step instructions on setting up the integration.

Required connection settings

When setting up a data integration, select Amazon ECS from the Connector dropdown. If you cannot find the connector in the dropdown, make sure that you have installed it first. You must provide the following information to authenticate Amazon ECS with Brinqa:

  • Access key ID and Secret access key: The access keys associated with the AWS account. The account must have the required read-only permissions for the specific AWS service. For additional information, see Create an IAM user for AWS access.

  • Default region: The AWS region for the connector. If not specified, the connector uses the AWS Default Region Provider Chain.

Create an IAM user for AWS access

For detailed steps on creating an IAM user and obtaining access keys, see the Amazon EC2 connector documentation. Follow the same process, but attach the required ECS permissions (ecs:ListClusters, ecs:DescribeClusters, ecs:ListServices, ecs:DescribeServices, ecs:ListTasks, ecs:DescribeTasks, ecs:ListTaskDefinitions, ecs:DescribeTaskDefinition) instead of the EC2 permissions.

The connector authenticates using the AWS SDK's credential resolution chain. If an assume-role ARN is configured, the connector assumes that IAM role using the provided credentials. Otherwise, it uses the provided access keys directly, falling back to the AWS Default Credential Provider Chain (environment variables, ~/.aws/credentials, or EC2 instance metadata).

Additional settings

The Amazon ECS connector contains additional options for specific configuration:

  • Assume role ARN: ARN of an IAM role to assume. Comma-separated to assume multiple roles in the same sync.

  • Session duration: Assume-role session duration in seconds. The default setting is 3600.

  • Page size: The maximum number of records to get per API request. The default setting is 100. It is not recommended to go over 100.

  • Parallel requests: The maximum number of parallel API requests. The default setting is 8.

  • Maximum retries: The maximum number of times that the integration attempts to connect to the Amazon ECS API before giving up and reporting a failure. The default setting is 10.

Types of data to retrieve

The Amazon ECS connector can retrieve the following types of data from the Amazon ECS API:

Table 1: Data retrieved from Amazon ECS

Connector ObjectRequiredMaps to Data Model
EcsClusterYesCloud Resource
EcsServiceYesCloud Resource
EcsTaskYesCloud Resource
EcsTaskDefinitionYesCloud Resource
info

For detailed steps on how to view the data retrieved from Amazon ECS in the Brinqa Platform, see How to view your data.

Attribute mappings

Expand the sections below to view the mappings between the source and the Brinqa data model attributes.

EcsCluster

Table 2: EcsCluster attribute mappings

Source Field NameSDM Attribute
cluster.activeServicesCountACTIVE_SERVICES_COUNT
cluster.capacityProvidersCAPACITY_PROVIDERS
cluster.clusterArnCLUSTER_ARN
cluster.clusterArnUID
cluster.clusterNameCLUSTER_NAME
cluster.clusterName (fallback: ARN)NAME
cluster.pendingTasksCountPENDING_TASKS_COUNT
cluster.registeredContainerInstancesCountREGISTERED_CONTAINER_INSTANCE_COUNT
cluster.runningTasksCountRUNNING_TASKS_COUNT
cluster.statusSOURCE_STATUS
cluster.tagsTAGS
Generated (constant AWS)CLOUD_PROVIDER
Generated (sync region)REGION
Generated (sync timestamp)LAST_CAPTURED
EcsService

Table 3: EcsService attribute mappings

Source Field NameSDM Attribute
awsvpcConfiguration.assignPublicIp == ENABLEDASSIGN_PUBLIC_IP
awsvpcConfiguration.securityGroupsSECURITY_GROUP_IDS
awsvpcConfiguration.subnetsSUBNET_IDS
service.clusterArnCLUSTER_ARN
service.createdAtFIRST_SEEN
service.desiredCountDESIRED_COUNT
service.launchTypeAsString()LAUNCH_TYPE
service.loadBalancers[*].targetGroupArnTARGET_GROUP_ARNS
service.pendingCountPENDING_COUNT
service.platformFamilyPLATFORM_FAMILY
service.platformVersionPLATFORM_VERSION
service.roleArnSERVICE_ROLE_ARN
service.runningCountRUNNING_COUNT
service.schedulingStrategyAsString()SCHEDULING_STRATEGY
service.serviceArnSERVICE_ARN
service.serviceArnUID
service.serviceNameSERVICE_NAME
service.serviceName (fallback: ARN)NAME
service.statusSOURCE_STATUS
service.tagsTAGS
service.taskDefinitionTASK_DEFINITION
Generated (constant AWS)CLOUD_PROVIDER
Generated (sync region)REGION
Generated (sync timestamp)LAST_CAPTURED
EcsTask

Table 4: EcsTask attribute mappings

Source Field NameSDM Attribute
attachment details networkInterfaceIdNETWORK_INTERFACE_IDS
attachment details privateIPv4AddressPRIVATE_IP_ADDRESSES
attachment details subnetIdSUBNET_IDS
task.availabilityZoneAVAILABILITY_ZONE
task.clusterArnCLUSTER_ARN
task.containerInstanceArnCONTAINER_INSTANCE_ARN
task.containers[*].imageCONTAINER_IMAGES
task.cpuCPU
task.createdAtFIRST_SEEN
task.desiredStatusDESIRED_STATUS
task.groupGROUP
task.lastStatusSOURCE_STATUS
task.launchTypeAsString()LAUNCH_TYPE
task.memoryMEMORY
task.platformVersionPLATFORM_VERSION
task.startedAtLAST_STARTED
task.stoppedAtLAST_STOPPED
task.tagsTAGS
task.taskArnNAME
task.taskArnTASK_ARN
task.taskArnUID
task.taskDefinitionArnTASK_DEFINITION_ARN
Generated (constant AWS)CLOUD_PROVIDER
Generated (sync region)REGION
Generated (sync timestamp)LAST_CAPTURED
EcsTaskDefinition

Table 5: EcsTaskDefinition attribute mappings

Source Field NameSDM Attribute
containerDefinitions[*].environment[*].nameENVIRONMENT_KEYS
containerDefinitions[*].imageCONTAINER_IMAGES
containerDefinitions[*].secrets[*]SECRET_REFS
family:revision (fallback: ARN)NAME
taskDefinition.cpuCPU
taskDefinition.executionRoleArnEXECUTION_ROLE_ARN
taskDefinition.familyFAMILY
taskDefinition.memoryMEMORY
taskDefinition.networkModeAsString()NETWORK_MODE
taskDefinition.registeredAtFIRST_SEEN
taskDefinition.requiresCompatibilitiesAsStrings()REQUIRES_COMPATIBILITIES
taskDefinition.revisionREVISION
taskDefinition.statusAsString()SOURCE_STATUS
taskDefinition.taskDefinitionArnTASK_DEFINITION_ARN
taskDefinition.taskDefinitionArnUID
taskDefinition.taskRoleArnTASK_ROLE_ARN
Generated (constant AWS)CLOUD_PROVIDER
Generated (sync region)REGION
Generated (sync timestamp)LAST_CAPTURED

Operation options

The Amazon ECS connector supports the following operation options. See connector operation options for information about how to apply them.

Table 6: Amazon ECS operation options

Connector ObjectOptionAll Possible ValuesDescriptionExample
EcsTaskfetchStoppedTaskstrue, falseWhen set to true, the connector additionally retrieves tasks with desiredStatus=STOPPED. By default, only tasks with desiredStatus=RUNNING are synced. Enabling this option increases sync volume in busy clusters. The default value is false.Key: fetchStoppedTasks Value: true. This key and value combination retrieves both running and recently stopped tasks.
note

The option keys and values are case-sensitive as they are shown in this documentation.

APIs

The Amazon ECS connector uses the Amazon ECS API. Specifically, it uses the following endpoints:

Table 7: Amazon ECS API endpoints

Connector ObjectAPI Endpoint
EcsClusterecs:ListClusters
ecs:DescribeClusters
EcsServiceecs:ListClusters
ecs:ListServices
ecs:DescribeServices
EcsTaskecs:ListClusters
ecs:ListTasks
ecs:DescribeTasks
EcsTaskDefinitionecs:ListTaskDefinitions
ecs:DescribeTaskDefinition

Changelog

The Amazon ECS connector has undergone the following changes:

note

This connector is part of a bundled release with other connectors from the same vendor. If a version shows "No change", it means that the connector version was updated for consistency as part of the bundle, but no functional changes were made to this specific connector. You can update to or skip this version without affecting your existing configuration.

Table 8: Amazon ECS changelog

VersionDescriptionDate Published
3.1.0Initial Integration+ release.June 1st, 2026