LogoLogo
Documentation and Guides
Documentation and Guides
  • ABOUT APONO
    • Why Choose Apono
    • Security and Architecture
    • Glossary
  • GETTING STARTED
    • How Apono Works
    • Getting started
    • Access Discovery
    • Integrating with Apono
  • CONNECTORS AND SECRETS
    • Apono Integration Secret
    • High Availability for Connectors
    • Installing a connector with Docker
    • Manage integrations
    • Manage connectors
    • S3 Storage
  • AWS ENVIRONMENT
    • AWS Overview
    • Apono Connector for AWS
      • Installing a connector on EKS Using Terraform
      • Updating a connector in AWS
      • Installing a connector on AWS ECS using Terraform
    • AWS Integrations
      • Integrate an AWS account or organization
        • Auto Discover AWS RDS Instances
        • AWS Best Practices
      • Amazon Redshift
      • RDS PostgreSQL
      • AWS RDS MySQL
      • Integrate with EKS
      • AWS Lambda Custom Integration
      • EC2 via Systems Manager Agent (SSM)
  • AZURE ENVIRONMENT
    • Apono Connector for Azure
      • Install an Azure connector on ACI using Azure CLI
      • Install an Azure connector on ACI using PowerShell
      • Install an Azure connector on ACI using Terraform
      • Updating a connector in Azure
    • Azure Integrations
      • Integrate with Azure Management Group or Subscription
        • Auto Discover Azure SQL Databases
      • Azure MySQL
      • Azure PostgreSQL
      • Integrate with AKS
  • GCP ENVIRONMENT
    • Apono Connector for GCP
      • Installing a GCP connector on Cloud Run using CLI
      • Installing a GCP connector on GKE using CLI (Helm)
      • Installing a GCP connector on GKE using Terraform
      • Updating a connector in Google Cloud
    • GCP Integrations
      • Integrate a GCP organization or project
      • CloudSQL - MySQL
      • CloudSQL - PostgreSQL
      • Google Cloud Functions
      • Integrate with GKE
      • AlloyDB
  • KUBERNETES ENVIRONMENT
    • Apono Connector for Kubernetes
      • Installing a connector on Kubernetes with AWS permissions
      • Updating a Kubernetes connector
    • Kubernetes Integrations
      • Integrate with Self-Managed Kubernetes
  • ADDITIONAL INTEGRATIONS
    • Databases and Data Repositories
      • Microsoft SQL Server
      • MongoDB
      • MongoDB Atlas
      • MongoDB Atlas Portal
      • MySQL
      • Oracle Database
      • PostgreSQL
      • RabbitMQ
      • Redis Cloud (Redislabs)
      • Snowflake
      • Vertica
      • MariaDB
    • Network Management
      • SSH Servers
      • RDP Servers
      • Windows Domain Controller
      • AWS EC2 SSH Servers
      • Azure VM SSH Servers
      • Installing the Apono HTTP Proxy
    • Development Tools
      • GitHub
      • Rancher
    • Identity Providers
      • Okta SCIM
      • Okta Groups
      • Okta SSO for Apono logins
      • Google Workspace (Gsuite)
      • Google Workspace (GSuite) Groups
      • Azure Active Directory (Microsoft Entra ID)
      • Azure Active Directory (Entra ID) Groups
      • Jumpcloud
      • JumpCloud Groups
      • OneLogin
      • OneLogin Group
      • LDAP Groups
      • The Manager Attribute in Access Flows
      • HiBob
      • Ping Identity SSO
    • Incident Response Integrations
      • Opsgenie
      • PagerDuty
      • VictorOps (Splunk On-Call)
      • Zenduty
    • ChatOps Integrations
      • Slack integration
      • Teams integration
      • Backstage Integration
    • Secret Management
      • 1Password
  • WEBHOOK INTEGRATIONS
    • Webhooks Overview
    • Anomaly Webhook
    • Audit Log Webhook
    • Request Webhook
      • Custom Webhooks
      • Communications and Notifications
        • Slack Outbound Webhooks
        • Teams
        • Outlook and Gmail (Using Azure Logic App)
      • ITSM
        • Freshdesk
        • Jira
        • ServiceNow
        • Zendesk
        • Freshservice
        • ServiceDesk Plus
      • Logs and SIEMs
        • Coralogix
        • Datadog
        • Logz.io
        • Grafana
        • New Relic
        • SolarWinds
        • Sumo Logic
        • Cortex
        • Logpoint
        • Splunk
        • Microsoft Sentinel
      • Orchestration and workflow builders
        • Okta Workflows
        • Torq
    • Integration Webhook
    • Webhook Payload References
      • Audit Log Webhook Payload Schema Reference
      • Webhook Payload Schema Reference
    • Manage webhooks
    • Troubleshoot a webhook
    • Manual Webhook
      • ITSM
        • PagerDuty
  • ACCESS FLOWS
    • Access Flows
      • What are Access Flows?
    • Create Access Flows
      • Self Serve Access Flows
      • Automatic Access Flows
      • Access Duration
    • Manage Access Flows
      • Right Sizing
    • Revoke Access
    • Dynamic Access Management
      • Resource and Integration Owners
    • Common Use Cases
      • Ensuring SLA
      • Protecting PII and Customer Data
      • Production Stability and Management
      • Break Glass Protocol
    • Create Bundles
    • Manage Bundles
  • ACCESS REQUESTS AND APPROVALS
    • Slack
      • Requesting Access with Slack
      • Approving Access with Slack
      • Reviewing historical requests with Slack
    • Teams
      • Requesting Access with Teams
      • Approving Access with Teams
    • CLI
      • Install and manage the Apono CLI
      • Requesting Access with CLI
    • Web Portal
      • Requesting Access with the Web Portal
      • Approving Access with the Web Portal
      • Reviewing historical requests with the Web Portal
    • Freshservice
    • Favorites
  • Inventory
    • Inventory Overview
    • Inventory
    • Access Scopes
    • Risk Scores
    • Apono Query Language
  • AUDITS AND REPORTS
    • Activity Overview
      • Activity
      • Create Reports
      • Manage Reports
    • Compliance: Audit and Reporting
    • Auditing Access in Apono
    • Admin Audit Log (Syslog)
  • HELP AND DEBUGGING
    • Integration Status Page
    • Troubleshooting Errors
  • ARCHITECTURE AND SECURITY
    • Anomaly Detection
    • Multi-factor Authentication
    • Credentials Rotation Policy
    • Periodic User Cleanup & Deletion
    • End-user Authentication
    • Personal API Tokens
  • User Administration
    • Role-Based Access Control (RBAC) Reference
    • Create Identities
    • Manage Identities
Powered by GitBook
On this page
  • Terraform
  • CLI
  • Existing Secret

Was this helpful?

Export as PDF
  1. AWS ENVIRONMENT

Creating Secrets for Apono in AWS Secret Store

Last updated 6 months ago

Was this helpful?

A connector uses a secret to connect Apono to resources without storing any credentials. For AWS-based integrations, secrets are created and managed through the .

You can use one of three methods to prepare a secret for use with your integration:

  • : (Recommended) Provision and manage your secrets through configuration files and commands.

  • : Use a command-line shell with the AWS CLI.

  • : Use an existing secret.

The following sections explain how to execute each method.


Terraform

This method uses Terraform configuration files and commands to manage your secrets for resource integration via an Apono connector.

Prerequisites

Item
Description

Terraform

Region

Integration Credentials

Credentials for the instance of the integration used to replace the KEY1 = "VALUE1",KEY2 = "VALUE2" placeholders when creating a secret

Terraform Secret Creation

Use the following steps to create a secret through Terraform:

  1. Copy the following snippet into the .tf file for managing your Terraform resources.

resource "aws_secretsmanager_secret" "#SECRET_NAME" {
  name = "#SECRET_NAME"
  // This tag allows the Apono connector role to read the secret with predefined policy 
  tags = {
    "apono-connector-read" = "true"
  }
}

resource "aws_secretsmanager_secret_version" "#SECRET_NAME" {
  secret_id     = aws_secretsmanager_secret.#SECRET_NAME.id
  secret_string = jsonencode({
    KEY1 = "VALUE1",
    KEY2 = "VALUE2"
  })
}
  1. Replace the placeholders:

    • #SECRET_NAME: Unique identifier. This value is used as the connector credential in the Apono UI.

    • KEY1 & VALUE1: Replace these placeholders with the username or account identifier for the integration instance. The user must have admin level privileges.

    • KEY2 & VALUE2: Replace these placeholder with the password or other account credential for the user.

Once terraform apply has been successfully run and the secret created, the secret will be listed in and can be managed from the AWS Secrets Manager console.


CLI

This method uses AWS CLI to provide a streamlined, secure pathway to manage your secrets for resource integration via an Apono connector.

Prerequisites

Items
Notes

AWS Command Line Interface (AWS CLI)

Region

Location of the instance of the integration

Integration Credentials

Credentials for the instance of the integration used to replace the KEY1 = "VALUE1",KEY2 = "VALUE2" placeholders when creating a secret

CLI Secret Creation

User the following steps to create a secret through the AWS CLI

  1. Copy the following command into a text editor.

aws secretsmanager create-secret \
--name "#SECRET_NAME" \
--tags '[{"Key":"apono-connector-read","Value":"true"}]' \
--region #REGION \
--secret-string '{"KEY1":"VALUE1","KEY2":"VALUE2"}'
  1. Replace the placeholders:

    • #SECRET_NAME: Unique identifier. This value is used as the connector credential in the Apono UI.

    • #REGION: Replace this placeholder with the region.

    • KEY1 & VALUE1: Replace these placeholders with the username or account identifier for the integration instance. The user must have admin level privileges.

    • KEY2 & VALUE2: Replace these placeholder with the password or other account credential for the user

  2. In the command-line interface of your local machine, paste and run the edited command.

When the secret is successfully generated, the AWS CLI provides a JSON response containing details about the newly created secret, resembling the following structure.

Example AWS CLI Response
{
   "ARN": "arn:aws:secretsmanager:your-region:your-account-id:secret:your-secret-name-XYZ",
   "Name": "your-secret-name",
   "VersionId": "example-version-id"
}

The secret will be listed in and can be managed from the AWS Secrets Manager console.


Existing Secret

You can use an existing secret. To enable an Apono connector to use an existing secret, add a tag with the following key and value information:

  • Key: apono-connector-read

  • Value: true

Tool to provision and manage infrastructure available from Once Terraform is installed, the following items must be defined and configured:

Location of the instance of the integration Set this value when configuring the in Terraform.

At the terminal prompt in the same folder as the .tf file, run the and commands.

Open source tool enabling interacting with AWS services using commands in your command-line shell available from

plan
apply
AWS Secret Store
Terraform
Command Line Interface (CLI)
Existing Secret
HashiCorp
AWS Provider
AWS secrets-manager module
AWS Provider
AWS
Amazon RDS PostgreSQL
Amazon Redshift
Redis Cloud (Redislabs)
Redis Cloud (Redislabs)
Amazon Redshift
Amazon RDS PostgreSQL