aws_ec2_environment 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 737e9d6f8e8b401117093eafc846a8522f1904afda0f44a98de3568e3ced961d
-  data.tar.gz: 702df72ea4cdac5293012c0eb4a73dc5bfdda61a5d6b98d61e6e69bbe9961945
+  metadata.gz: b294268a688df38dfde011db33d1cf3e69f6d5562424b93a487224e180f5268d
+  data.tar.gz: 6aff34b804255143bf4095d1346d13fc4635e6549d767b22b512d37129f8b6e8
 SHA512:
-  metadata.gz: 9bde699e347ad8add1e517e8fa52a6703ea155d76def3ed488097a4037068235b7fb715b655e14c5d6929a8ae99406551f912dfb017a73728c31a4844a04d244
-  data.tar.gz: d4078cf90c5a8395e29818e8d07c4de064e78ca9ccdb66e8facd96c25031adf9b734553914870221bb42ad094afab5940d4fb236083db6fae604816ff03d8613
+  metadata.gz: 5219053812134a5b2143d22be1c882f73cba47bbb06f41fbd560cdfbbac43e93d987169bd10fa62bd8b57126ded34bfcfd894303edeb4eaf81431a5ebd1239b7
+  data.tar.gz: e18d61043d7a0acc999b98e11cec1fb733e1c48e52bd41762233c67f7a2cd669b190663c442a411f383fd158ca395478697c13b27e3389fce61ba957fd844f04

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.2.0] - 2026-01-09
+
+### Added
+
+- Support using alternative documents and parameters with
+  `SsmPortForwardingSession`
+  ([#22](https://github.com/ackama/aws_ec2_environment/pull/22))
+
 ## [0.1.1] - 2025-12-15
 
 ### Fixed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    aws_ec2_environment (0.1.1)
+    aws_ec2_environment (0.2.0)
       aws-sdk-ec2 (~> 1.0)
       aws-sdk-ssm (~> 1.0)
 

data/README.md

@@ -199,6 +199,44 @@ task :forward_port, %i[instance_id remote_port local_port] => :environment do |_
 end
 ```
 
+You can also use specific documents, and pass in extra parameters, which can be
+useful for using tunnels to access other private resources like database
+instances:
+
+```ruby
+require "aws_ec2_environment"
+
+desc "Dumps a copy of the postgres database using AWS and PG environment variables"
+task :dump_pg_database, %i[instance_id dump_file] => :environment do |_, args|
+  instance_id = args.fetch(:instance_id)
+  dump_file = args.fetch(:dump_file)
+
+  remote_host = ENV.fetch("PGHOST")
+  remote_port = ENV.fetch("PGPORT", 5432).to_i
+
+  session = AwsEc2Environment::SsmPortForwardingSession.new(
+    instance_id,
+    remote_port,
+    document: "AWS-StartPortForwardingSessionToRemoteHost",
+    extra_params: { "host" => [remote_host] }
+  )
+
+  at_exit { session.close }
+
+  local_port = session.wait_for_local_port
+
+  system(
+    "pg_dump",
+    "--format=c",
+    "--no-owner",
+    "--no-privileges",
+    "--host=localhost",
+    "--port=#{local_port}",
+    "--file=#{dump_file}",
+  )
+end
+```
+
 ### AWS Authentication and Permissions
 
 Since this gem interacts with AWS, it must be configured with credentials - see

data/lib/aws_ec2_environment/ssm_port_forwarding_session.rb

@@ -22,8 +22,9 @@ class AwsEc2Environment
     # rubocop:disable Metrics/ParameterLists
     def initialize(
       instance_id, remote_port,
+      document: "AWS-StartPortForwardingSession",
       local_port: nil, logger: Logger.new($stdout),
-      timeout: 15, reason: nil
+      timeout: 15, reason: nil, extra_params: {}
     )
       # rubocop:enable Metrics/ParameterLists
       @logger = logger
@@ -32,7 +33,7 @@ class AwsEc2Environment
       @local_port = nil
       @timeout = timeout
 
-      @reader, @writer, @pid = PTY.spawn(ssm_port_forward_cmd(local_port, reason))
+      @reader, @writer, @pid = PTY.spawn(ssm_port_forward_cmd(local_port, reason, document, extra_params))
 
       @cmd_output = +""
       @session_id = wait_for_session_id
@@ -64,9 +65,8 @@ class AwsEc2Environment
 
     private
 
-    def ssm_port_forward_cmd(local_port, reason)
-      document_name = "AWS-StartPortForwardingSession"
-      parameters = { "portNumber" => [remote_port.to_s] }
+    def ssm_port_forward_cmd(local_port, reason, document_name, extra_params)
+      parameters = extra_params.merge({ "portNumber" => [remote_port.to_s] })
       parameters["localPortNumber"] = [local_port.to_s] unless local_port.nil?
       flags = [
         ["--target", instance_id],

data/lib/aws_ec2_environment/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class AwsEc2Environment
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/sig/aws_ec2_environment/ssm_port_forwarding_session.rbs

@@ -16,10 +16,12 @@ class AwsEc2Environment
     def initialize: (
         String instance_id,
         Integer remote_port,
+        ?document: String,
         ?local_port: Integer | nil,
         ?logger: Logger,
         ?timeout: Numeric,
-        ?reason: String | nil
+        ?reason: String | nil,
+        ?extra_params: Hash[String, untyped]
       ) -> void
 
     def close: () -> void
@@ -38,7 +40,12 @@ class AwsEc2Environment
     @writer: IO
     @cmd_output: String
 
-    def ssm_port_forward_cmd: (Integer | nil local_port, String | nil reason) -> String
+    def ssm_port_forward_cmd: (
+        Integer | nil local_port,
+        String | nil reason,
+        String document_name,
+        Hash[String, untyped] extra_params
+      ) -> String
 
     # Checks the cmd process output until either the given +pattern+ matches or the +timeout+ is over.
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws_ec2_environment
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Gareth Jones