
Amazon Elastic Beanstalk
Amazon Web Services- Overview
- Setup
- Data & mappings
- Operations & API
- Changelog
Integrates with AWS Elastic Beanstalk to inventory the Elastic Beanstalk environments in the configured AWS accounts and regions. Elastic Beanstalk is a platform-as-a-service for deploying and scaling web applications. For each environment the connector captures its application/version, platform, health, endpoint, attached load balancers, and tags, and emits one Brinqa object per environment.
Data retrieved from Amazon Elastic Beanstalk
| Connector Object | Required | Maps to Data Model |
|---|---|---|
| Beanstalk Environment | Yes | Cloud Resource |
For detailed steps on how to view the data retrieved from Amazon Elastic Beanstalk in the Brinqa Platform, see How to view your data.
Connection settings
When setting up a data integration, select Amazon Elastic Beanstalk from the Connector dropdown and provide the following:
| Setting | Required | Default | Description |
|---|---|---|---|
| Access key ID | No | — | AWS user access key ID, if not specified, the connector consults the default credentials provider chain to try and determine the \ |
| Secret access key | No | — | AWS user secret access key, if not specified, the connector consults the default credentials provider chain to try and determine the \ |
| Default region | No | — | Default AWS region, if not specified, the connector consults the default region provider chain to try and determine the region to use. |
| Assume role | No | — | Amazon Resource Name for the role to assume. |
| Session duration | No | 900 | Assume role session duration in seconds. |
| Page size | No | 100 | The maximum number of results to retrieve per operation. |
Authentication
Authentication is shared across the AWS connector bundle via the AwsConfiguration base class.
The Elastic Beanstalk sub-connector uses the AWS SDK for Java v2 ElasticBeanstalkClient, which
signs every request with AWS SigV4 using credentials resolved through the following chain (in order):
- STS AssumeRole — if
assumeRoleARNis configured, the connector assumes that role (using the credentials below as the principal) and uses the resulting temporary session credentials. - Static access keys — if
accessKey/secretKeyare configured, they are used directly. - Default credentials provider chain — environment variables,
~/.aws/credentials, container role, or EC2 instance metadata.
Assumed-role sessions use the configurable sessionDuration (default 900 s) with a unique session
name per sync. assumeRoleARN may be a comma-separated list to sync multiple accounts in one run.
An ElasticBeanstalkClient is constructed per role per region and closed when its region has been
fully synced.
Required AWS API permissions
| Permission | Purpose |
|---|---|
elasticbeanstalk:DescribeEnvironments | List and page through environments in a region |
elasticbeanstalk:DescribeEnvironmentResources | Retrieve attached load-balancer names per environment |
elasticbeanstalk:ListTagsForResource | Retrieve tags per environment |
sts:AssumeRole | Only when assumeRoleARN is set |
How to obtain Amazon Elastic Beanstalk credentials
Create an IAM user for AWS access
For the Amazon Elastic Beanstalk connector to interact with the AWS SDK and retrieve data, you must provide specific AWS credentials and permissions. To create an IAM user, follow these steps:
-
Log in to your organization's AWS Management Console as an administrator.
-
Navigate to the Identity and Access Management (IAM) dashboard.
-
From the navigation pane under Access management, click Users, and then click Create user.
-
Provide a User name, leave the Provide user access to AWS Management Console option unchecked, and then click Next.
-
Click the Attach policies directly option and then click Create policy.
-
Click the JSON tab and paste the following minimum required policy:
{"Version": "2012-10-17","Statement": [{"Effect": "Allow","Action": ["elasticbeanstalk:DescribeEnvironments","elasticbeanstalk:DescribeEnvironmentResources","elasticbeanstalk:ListTagsForResource"],"Resource": "*"}]} -
Click Next, provide a name for the policy, and then click Create policy.
-
Back on the Add permissions page, search for and select the policy you just created, and then click Next.
-
Click Create user.
Obtain access keys
After you have created an IAM user, generate the access keys that are required for the connector. To do so, follow these steps:
-
Navigate to the IAM dashboard.
-
From the navigation pane under Access management, click Users.
-
Choose the IAM user you created in the earlier steps.
-
Click the Security credentials tab and then click Create access key.
-
Select the Application running outside AWS use case and then click Next.
-
Provide a description and then click Create access key.
The access key ID and secret access key display. The secret access key is shown only once and cannot be retrieved again, so copy the key and save it to a secure location.
Note: If you do not have the permissions to create access keys, contact your AWS administrator. For additional information, see AWS documentation.
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).
Attribute mappings
Expand the sections below to view the mappings between the source and the Brinqa data model attributes:
Beanstalk Environment
| Source Field Name | SDM Attribute |
|---|---|
| constant "AWS" | CLOUD_PROVIDER |
DescribeEnvironmentResources.environmentResources().loadBalancers[].name | LOAD_BALANCER_NAMES (multivalued) |
EnvironmentDescription.applicationName | APPLICATION_NAME |
EnvironmentDescription.cname | CNAME |
EnvironmentDescription.dateCreated | FIRST_SEEN |
EnvironmentDescription.dateUpdated | SOURCE_LAST_MODIFIED |
EnvironmentDescription.endpointURL | URL |
EnvironmentDescription.environmentArn | UID |
EnvironmentDescription.environmentArn | ENVIRONMENT_ARN |
EnvironmentDescription.environmentId | ENVIRONMENT_ID |
EnvironmentDescription.environmentName | ENVIRONMENT_NAME |
EnvironmentDescription.environmentName (fallback environmentArn) | NAME |
EnvironmentDescription.healthAsString | HEALTH |
EnvironmentDescription.healthStatusAsString | HEALTH_STATUS |
EnvironmentDescription.platformArn | PLATFORM_ARN |
EnvironmentDescription.solutionStackName | SOLUTION_STACK_NAME |
EnvironmentDescription.statusAsString | SOURCE_STATUS |
EnvironmentDescription.tier().name + : + tier().type | TIER |
EnvironmentDescription.versionLabel | VERSION_LABEL |
ListTagsForResource.resourceTags[] (key:value) | TAGS (multivalued) |
| sync region | REGION |
| sync timestamp | LAST_CAPTURED |
Operations & API
Expand each connector object to see its operation options, delta-sync behavior, and the API it uses. See connector operation options for how to apply operation options (keys and values are case-sensitive).
Beanstalk Environment
Operation options
| Option | Type | Default | Description |
|---|---|---|---|
region / regions | Comma-separated list of regions to query (one client per region). regions takes precedence over region. | Resolved from configuration / region provider chain | |
pageSize | Page size (maxRecords) for each DescribeEnvironments call. | Shared pageSize configuration (100) | |
parallelismLevel | Number of parallel worker threads. | min(4, CPU cores) | No |
Delta sync
The connector README does not document sync behavior for this object.
API
- Type: AWS SDK for Java v2 (
ElasticBeanstalkClient) · Endpoint:elasticbeanstalk:DescribeEnvironments
Changelog
The Amazon Elastic Beanstalk connector has undergone the following changes:
| Version | Description | Migration Steps |
|---|---|---|
| 3.2.1 | No changes in this release. | N/A |
| 3.2.0 | No changes in this release. | N/A |
| 3.1.0 | New Features - New connector — syncs Elastic Beanstalk environments. Improvements - Sync failures are now visible. Previously, certain AWS API errors (throttling, server errors, transient network failures, validation errors) could be silently swallowed during multi-region sync, producing empty results without indicating a problem. These now surface as sync failures with a clear log entry detailing the HTTP status, AWS error code, request id, and service name. Per-region permission gaps (HTTP 401 / 403) still allow the sync to continue across other regions, but are now visible in logs. | N/A |