2022-10-11 14:21:14 -06:00
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0
# Purpose:
# ec2-ruby-example-elastic-ips.rb demonstrates how to
# check whether the specified Amazon Elastic Compute Cloud
# (Amazon EC2) instance exists.
# snippet-start:[ec2.Ruby.elasticIps]
# This code example does the following:
# 1. Displays information about any addresses associated with an
# Amazon Elastic Compute Cloud (Amazon EC2) instance.
# 2. Creates an Elastic IP address in Amazon Virtual Private Cloud (Amazon VPC).
# 3. Associates the address with the instance.
# 4. Displays information again about addresses associated with the instance.
# This time, the new address association should display.
# 5. Releases the address.
# 6. Displays information again about addresses associated with the instance.
# This time, the released address should not display.
2024-09-25 15:25:54 -04:00
require 'aws-sdk-ec2'
2022-10-11 14:21:14 -06:00
# Checks whether the specified Amazon Elastic Compute Cloud
# (Amazon EC2) instance exists.
#
# Prerequisites:
#
# - The Amazon EC2 instance.
#
# @param ec2_client [Aws::EC2::Client] An initialized EC2 client.
# @param instance_id [String] The ID of the instance.
# @return [Boolean] true if the instance exists; otherwise, false.
# @example
# exit 1 unless instance_exists?(
# Aws::EC2::Client.new(region: 'us-west-2'),
# 'i-033c48ef067af3dEX'
# )
def instance_exists? ( ec2_client , instance_id )
ec2_client . describe_instances ( instance_ids : [ instance_id ] )
2024-09-25 15:25:54 -04:00
true
2022-10-11 14:21:14 -06:00
rescue StandardError
2024-09-25 15:25:54 -04:00
false
2022-10-11 14:21:14 -06:00
end
2023-08-24 15:22:35 -04:00
# snippet-start:[ec2.Ruby.allocateElasticIPs]
2022-10-11 14:21:14 -06:00
# Creates an Elastic IP address in Amazon Virtual Private Cloud (Amazon VPC).
#
# @param ec2_client [Aws::EC2::Client] An initialized EC2 client.
# @return [String] The allocation ID corresponding to the Elastic IP address.
# @example
# puts allocate_elastic_ip_address(Aws::EC2::Client.new(region: 'us-west-2'))
def allocate_elastic_ip_address ( ec2_client )
2024-09-25 15:25:54 -04:00
response = ec2_client . allocate_address ( domain : 'vpc' )
response . allocation_id
2022-10-11 14:21:14 -06:00
rescue StandardError = > e
puts " Error allocating Elastic IP address: #{ e . message } "
2024-09-25 15:25:54 -04:00
'Error'
2022-10-11 14:21:14 -06:00
end
2023-08-24 15:22:35 -04:00
# snippet-end:[ec2.Ruby.allocateElasticIPs]
2022-10-11 14:21:14 -06:00
2023-08-24 15:22:35 -04:00
# snippet-start:[ec2.Ruby.associateElasticIPs]
2022-10-11 14:21:14 -06:00
# Associates an Elastic IP address with an Amazon Elastic Compute Cloud
# (Amazon EC2) instance.
#
# Prerequisites:
#
# - The allocation ID corresponding to the Elastic IP address.
# - The Amazon EC2 instance.
#
# @param ec2_client [Aws::EC2::Client] An initialized EC2 client.
# @param allocation_id [String] The ID of the allocation corresponding to
# the Elastic IP address.
# @param instance_id [String] The ID of the instance.
# @return [String] The assocation ID corresponding to the association of the
# Elastic IP address to the instance.
# @example
# puts allocate_elastic_ip_address(
# Aws::EC2::Client.new(region: 'us-west-2'),
# 'eipalloc-04452e528a66279EX',
# 'i-033c48ef067af3dEX')
def associate_elastic_ip_address_with_instance (
ec2_client ,
allocation_id ,
instance_id
)
response = ec2_client . associate_address (
allocation_id : allocation_id ,
2024-09-25 15:25:54 -04:00
instance_id : instance_id
2022-10-11 14:21:14 -06:00
)
2024-09-25 15:25:54 -04:00
response . association_id
2022-10-11 14:21:14 -06:00
rescue StandardError = > e
puts " Error associating Elastic IP address with instance: #{ e . message } "
2024-09-25 15:25:54 -04:00
'Error'
2022-10-11 14:21:14 -06:00
end
2024-09-25 15:25:54 -04:00
2023-08-24 15:22:35 -04:00
# snippet-end:[ec2.Ruby.associateElasticIPs]
#
2022-10-11 14:21:14 -06:00
# Gets information about addresses associated with an
# Amazon Elastic Compute Cloud (Amazon EC2) instance.
#
# Prerequisites:
#
# - The Amazon EC2 instance.
#
# @param ec2_client [Aws::EC2::Client] An initialized EC2 client.
# @param instance_id [String] The ID of the instance.
# @example
# describe_addresses_for_instance(
# Aws::EC2::Client.new(region: 'us-west-2'),
# 'i-033c48ef067af3dEX'
# )
def describe_addresses_for_instance ( ec2_client , instance_id )
response = ec2_client . describe_addresses (
filters : [
{
2024-09-25 15:25:54 -04:00
name : 'instance-id' ,
2022-10-11 14:21:14 -06:00
values : [ instance_id ]
}
]
)
addresses = response . addresses
if addresses . count . zero?
2024-09-25 15:25:54 -04:00
puts 'No addresses.'
2022-10-11 14:21:14 -06:00
else
addresses . each do | address |
2024-09-25 15:25:54 -04:00
puts '-' * 20
2022-10-11 14:21:14 -06:00
puts " Public IP: #{ address . public_ip } "
puts " Private IP: #{ address . private_ip_address } "
end
end
rescue StandardError = > e
puts " Error getting address information for instance: #{ e . message } "
end
2023-08-24 15:22:35 -04:00
# snippet-start:[ec2.Ruby.releaseElasticIPs]
2022-10-11 14:21:14 -06:00
# Releases an Elastic IP address from an
# Amazon Elastic Compute Cloud (Amazon EC2) instance.
#
# Prerequisites:
#
# - An Amazon EC2 instance with an associated Elastic IP address.
#
# @param ec2_client [Aws::EC2::Client] An initialized EC2 client.
# @param allocation_id [String] The ID of the allocation corresponding to
# the Elastic IP address.
# @return [Boolean] true if the Elastic IP address was released;
# otherwise, false.
# @example
# exit 1 unless elastic_ip_address_released?(
# Aws::EC2::Client.new(region: 'us-west-2'),
# 'eipalloc-04452e528a66279EX'
# )
def elastic_ip_address_released? ( ec2_client , allocation_id )
ec2_client . release_address ( allocation_id : allocation_id )
2024-09-25 15:25:54 -04:00
true
2022-10-11 14:21:14 -06:00
rescue StandardError = > e
puts ( " Error releasing Elastic IP address: #{ e . message } " )
2024-09-25 15:25:54 -04:00
false
2022-10-11 14:21:14 -06:00
end
2023-08-24 15:22:35 -04:00
# snippet-end:[ec2.Ruby.releaseElasticIPs]
2022-10-11 14:21:14 -06:00
2024-02-16 11:17:29 -05:00
# Example usage:
2022-10-11 14:21:14 -06:00
def run_me
2024-09-25 15:25:54 -04:00
instance_id = ''
region = ''
2022-10-11 14:21:14 -06:00
# Print usage information and then stop.
2024-09-25 15:25:54 -04:00
if ARGV [ 0 ] == '--help' || ARGV [ 0 ] == '-h'
puts 'Usage: ruby ec2-ruby-example-elastic-ips.rb ' \
'INSTANCE_ID REGION'
2022-10-11 14:21:14 -06:00
# Replace us-west-2 with the AWS Region you're using for Amazon EC2.
2024-09-25 15:25:54 -04:00
puts 'Example: ruby ec2-ruby-example-elastic-ips.rb ' \
'i-033c48ef067af3dEX us-west-2'
2022-10-11 14:21:14 -06:00
exit 1
# If no values are specified at the command prompt, use these default values.
elsif ARGV . count . zero?
2024-09-25 15:25:54 -04:00
instance_id = 'i-033c48ef067af3dEX'
# Replace us-west-2 with the AWS Region you're using for Amazon EC2.
region = 'us-west-2'
2022-10-11 14:21:14 -06:00
# Otherwise, use the values as specified at the command prompt.
else
instance_id = ARGV [ 0 ]
region = ARGV [ 1 ]
end
ec2_client = Aws :: EC2 :: Client . new ( region : region )
unless instance_exists? ( ec2_client , instance_id )
puts " Cannot find instance with ID ' #{ instance_id } '. Stopping program. "
exit 1
end
puts " Addresses for instance with ID ' #{ instance_id } ' before allocating " \
2024-09-25 15:25:54 -04:00
'Elastic IP address:'
2022-10-11 14:21:14 -06:00
describe_addresses_for_instance ( ec2_client , instance_id )
2024-09-25 15:25:54 -04:00
puts 'Allocating Elastic IP address...'
2022-10-11 14:21:14 -06:00
allocation_id = allocate_elastic_ip_address ( ec2_client )
2024-09-25 15:25:54 -04:00
if allocation_id . start_with? ( 'Error' )
puts 'Stopping program.'
2022-10-11 14:21:14 -06:00
exit 1
else
puts " Elastic IP address created with allocation ID ' #{ allocation_id } '. "
end
2024-09-25 15:25:54 -04:00
puts 'Associating Elastic IP address with instance...'
2022-10-11 14:21:14 -06:00
association_id = associate_elastic_ip_address_with_instance (
ec2_client ,
allocation_id ,
instance_id
)
2024-09-25 15:25:54 -04:00
if association_id . start_with? ( 'Error' )
puts 'Stopping program. You must associate the Elastic IP address yourself.'
2022-10-11 14:21:14 -06:00
exit 1
else
2024-09-25 15:25:54 -04:00
puts 'Elastic IP address associated with instance with association ID ' \
2022-10-11 14:21:14 -06:00
" ' #{ association_id } '. "
end
2024-09-25 15:25:54 -04:00
puts 'Addresses for instance after allocating Elastic IP address:'
2022-10-11 14:21:14 -06:00
describe_addresses_for_instance ( ec2_client , instance_id )
2024-09-25 15:25:54 -04:00
puts 'Releasing the Elastic IP address from the instance...'
2022-10-11 14:21:14 -06:00
if elastic_ip_address_released? ( ec2_client , allocation_id ) == false
2024-09-25 15:25:54 -04:00
puts 'Stopping program. You must release the Elastic IP address yourself.'
2022-10-11 14:21:14 -06:00
exit 1
else
2024-09-25 15:25:54 -04:00
puts 'Address released.'
2022-10-11 14:21:14 -06:00
end
2024-09-25 15:25:54 -04:00
puts 'Addresses for instance after releasing Elastic IP address:'
2022-10-11 14:21:14 -06:00
describe_addresses_for_instance ( ec2_client , instance_id )
end
run_me if $PROGRAM_NAME == __FILE__
# snippet-end:[ec2.Ruby.elasticIps]
