AWS EC2 SSH

EC2 SSH allows secure remote access to Amazon EC2 instances for configuration, management, and troubleshooting.

Example Usage

---

Terraform

aws-ec2-ssh-integration.tf

resource "apono_integration" "aws-ec2-ssh-integration" {
  name                     = "AWS EC2 SSH"
  type                     = "aws-ec2-ssh"
  connector_id             = "apono-connector-id"
  connected_resource_types = ["aws-ec2-ssh-server"]
  metadata = {
    region = "<Region>"
    user = "<User>"
    groups = "<User Groups>"
    shell = "<User&#39;s Login Shell>"
    user_key_name = "<User Key Name>"
    ip_type_preference = "<IP Type Preference>"
    cross_account_role_arn = "<Cross Account Role ARN>"
    credentials_rotation_period_in_days = "<Credentials rotation period (in days)>"
    credentials_cleanup_period_in_days = "<User cleanup after access is revoked (in days)>"
  }
  aws_secret = {
    region    = "aws_region_template_value"
    secret_id = "aws_secret_id_template_value"
  }
}

Terraform V2

aws-ec2-ssh-integration.tf

resource "apono_resource_integration" "aws-ec2-ssh-integration" {
  name                     = "AWS EC2 SSH"
  type                     = "aws-ec2-ssh"
  connector_id             = "apono-connector-id"
  connected_resource_types = ["aws-ec2-ssh-server"]
  integration_config = {
    region = "<Region>"
    user = "<User>"
    groups = "<User Groups>"
    shell = "<User&#39;s Login Shell>"
    user_key_name = "<User Key Name>"
    ip_type_preference = "<IP Type Preference>"
    cross_account_role_arn = "<Cross Account Role ARN>"
    credentials_rotation_period_in_days = "<Credentials rotation period (in days)>"
    credentials_cleanup_period_in_days = "<User cleanup after access is revoked (in days)>"
  }
  secret_store_config = {
    aws = {
      region    = "aws_region_template_value"
      secret_id = "aws_secret_id_template_value"
    }
}

Public API

aws-ec2-ssh-integration.json

{
    "aws-ec2-ssh-integration": {
        "name": "AWS EC2 SSH",
        "type": "aws-ec2-ssh",
        "connector_id": "apono-connector-id",
        "connected_resource_types": [
            "aws-ec2-ssh-server"
        ],
        "integration_config": {
            "region": "<Region>",
            "user": "<User>",
            "groups": "<User Groups>",
            "shell": "<User&#39;s Login Shell>",
            "user_key_name": "<User Key Name>",
            "ip_type_preference": "<IP Type Preference>",
            "cross_account_role_arn": "<Cross Account Role ARN>",
            "credentials_rotation_period_in_days": "<Credentials rotation period (in days)>",
            "credentials_cleanup_period_in_days": "<User cleanup after access is revoked (in days)>",
        },
	"secret_store_config": {
    	    "region": "aws_region_template_value",
    	    "secret_id": "aws_secret_id_template_value"
  	    }
    }
}

Schema

---

• type aws-ec2-ssh

• connected_resource_types List of resource types to sync.

Available resource types you can use

• aws-ec2-ssh-server

Integration Config

---

• region (Required | String) Region

  • Possible values: us-east-1, us-east-2, us-west-1, us-west-2, eu-central-1, eu-central-2, eu-west-1, eu-west-2, eu-south-1, eu-south-2, eu-west-3, eu-north-1, af-south-1, ap-east-1, ap-southeast-3, ap-southeast-4, ap-southeast-5, ap-southeast-7, ap-south-1, ap-south-2, ap-northeast-3, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-northeast-1, ca-central-1, ca-west-1, me-south-1, me-central-1, sa-east-1, il-central-1, mx-central-1

• user (Required | String) User

• groups (Optional | String) User Groups

• shell (Optional | String) User's Login Shell

• user_key_name (Optional | String) User Key Name

• ip_type_preference (Optional | String) IP Type Preference

  • Default value: public

  • Possible values: public, private

• cross_account_role_arn (Optional | String) Cross Account Role ARN

• credentials_rotation_period_in_days (Optional | String) Credentials rotation period (in days)

• credentials_cleanup_period_in_days (Optional | String) User cleanup after access is revoked (in days)