Skip to content

AWS

Connecting NeuBird to your AWS environment enables collection of resource configurations, CloudTrail change events, CloudWatch metrics, logs, and alarms. The scope of data NeuBird can access depends on the permissions assigned to the AWS role.

NeuBird follows AWS best practices by using an assumed role with an external ID for secure, read-only access.

You can create the role using the AWS CLI (recommended for automation) or the AWS Console (recommended for most users).

Open CloudShell from the terminal icon at the top of the AWS Console and run:

AWS CloudShell

Terminal window
aws iam create-role \
--role-name NeuBird \
--assume-role-policy-document '{
"Version": "2012-10-17",
"Statement": [{
"Effect": "Allow",
"Principal": { "AWS": "arn:aws:iam::905418326654:root" },
"Action": "sts:AssumeRole",
"Condition": {
"StringEquals": { "sts:ExternalId": "YOUR_EXTERNAL_ID" }
}
}]
}' \
--description "NeuBird read-only access"
aws iam attach-role-policy \
--role-name NeuBird \
--policy-arn arn:aws:iam::aws:policy/ReadOnlyAccess
aws iam get-role --role-name NeuBird --query 'Role.Arn' --output text

Replace YOUR_EXTERNAL_ID with the External ID shown in the NeuBird connection dialog.

What this does:

  1. Creates an IAM role called NeuBird that allows AWS account 905418326654 (NeuBird) to assume it, verified by an external ID
  2. Attaches the AWS-managed ReadOnlyAccess policy — NeuBird can view but not modify your resources
  3. Outputs the Role ARN you’ll need for the connection
  1. Access IAM: Navigate to the IAM service in the AWS Console.

    Access IAM

  2. Create a new role: In the navigation pane, choose Roles > Create role.

    Create a new role

  3. Choose trusted entity: Select Another AWS account as the type of trusted entity.

    Choose trusted entity

  4. Enter credentials:

    • Account ID: Enter 905418326654 (NeuBird’s AWS account)
    • External ID: Copy the External ID from the NeuBird connection dialog and paste it here

    External ID from NeuBird

    Enter External ID

    Click Next to continue.

  5. Assign permissions: Filter by AWS managed - job function and select ReadOnlyAccess.

    Assign ReadOnlyAccess

    Click Next to continue.

  6. Review and create: Enter a name (e.g. NeuBird) and description, review the configuration, then click Create role.

    Name and review

    Create role

  7. Copy the Role ARN: Open the newly created role and copy the Role ARN.

    Copy Role ARN

Skip this step if you don’t use EKS.

For each EKS cluster you want NeuBird to monitor:

  1. Go to Amazon EKS > select your cluster > Access tab. In IAM access entries, click Manage.

    EKS Access tab

  2. Create access entry: Enter the NeuBird role ARN as the IAM principal, type Standard, click Next.

    Create access entry

  3. Add access policy: Select AmazonEKSViewPolicy (minimum required) with Cluster scope.

    Add access policy

  4. Review and create.

    Review and create

If your EKS cluster endpoint has CIDR restrictions (not 0.0.0.0/0), add NeuBird’s IP:

Endpoint access settings

Add the following CIDR block:

54.236.215.157/32

CIDR configuration

Or via CLI:

Terminal window
aws eks update-cluster-config --resources-vpc-config endpointPublicAccess=true,publicAccessCidrs=<your-existing-cidrs>,54.236.215.157/32

Step 3: Enable Configuration Change Telemetry

Section titled “Step 3: Enable Configuration Change Telemetry”

Skip this step if you already have CloudTrail delivering to a CloudWatch Log Group.

NeuBird uses CloudTrail to monitor configuration changes across your AWS resources.

  1. Navigate to CloudWatch in the AWS Console.

    CloudWatch service

  2. Go to Logs > Log groups > Create log group.

    Create log group

  3. Enter a log group name and click Create.

    Enter log group name

  1. Navigate to CloudTrail and click Create trail.

    CloudTrail service

    Create trail

  2. Enter a trail name and create a new S3 bucket for storage.

    Trail name and S3 bucket

  3. Enable CloudWatch Logs and select the log group you created.

    Enable CloudWatch Logs

  4. For IAM Role, choose New or select an existing role. Click Next.

    IAM Role

  5. Select all event types and proceed.

    Event types

    Continue

  6. Review and click Create trail.

    Review

    Create trail

In IAM, find the role attached to your CloudTrail and attach these policies:

Find CloudTrail role

  • AWSCloudTrail_FullAccess
  • CloudWatchLogsFullAccess

Attach policies

Check your CloudWatch log group to confirm logs from CloudTrail are being delivered.

Verify logs

In CloudWatch, go to Alarms > Create alarm and choose metrics related to CloudTrail logs.

Create alarm

Select metrics

NeuBird supports three authentication methods:

FieldRequiredDescription
NameYesA descriptive name for this connection
DescriptionNoOptional note about what this connection is for
Role ARNYesThe ARN of the IAM role created in Step 1
RegionsYesAWS regions to collect telemetry from
FieldRequiredDescription
NameYesA descriptive name for this connection
DescriptionNoOptional note about what this connection is for
Access Key IDYesIAM user access key ID
Access Key SecretYesIAM user secret access key
RegionsYesAWS regions to collect telemetry from
FieldRequiredDescription
NameYesA descriptive name for this connection
DescriptionNoOptional note about what this connection is for
RegionsYesAWS regions to collect telemetry from

The OIDC method redirects you to authenticate directly with your AWS account.


For general instructions on creating and managing connections, see the Connections Overview.