Class: AWS::EC2::ElasticIp

Inherits:

Resource

• Object
• Core::Resource
• Resource
• AWS::EC2::ElasticIp

show all

Defined in:

lib/aws/ec2/elastic_ip.rb

Instance Attribute Summary (collapse)

• - (String^?) allocation_id readonly

  The ID representing the allocation of the address for use with Amazon VPC.

• - (String^?) association_id readonly

  The ID of the association between this elastic ip address and an EC2 VPC instance (VPC only).

• - (String) domain readonly

  Indicates whether this elastic ip address is for EC2 instances ('standard') or VPC instances ('vpc').

• - (String^?) instance_id readonly

  Returns the instance id if assigned to an EC2 instance, nil otherwise.

• - (String^?) network_interface_id readonly

  The ID of the network interface (VPC only).

• - (String^?) network_interface_owner_id readonly

  The ID of the AWS account that owns the network interface (VPC only).

• - (String) public_ip (also: #ip_address) readonly

  The public IP address.

Instance Method Summary (collapse)

• - (String) associate(options)

  Associates this elastic IP address with an instance or a network interface.

• - (Boolean) associated? (also: #attached?)

  Returns true if this IP address is associated with an EC2 instance or a network interface.

• - (nil) delete (also: #release)

  Releases the elastic IP address.

• - (nil) disassociate

  Disassociates this elastic IP address from an EC2 instance.

• - (Boolean) exists?

  Returns true the elastic ip address exists in your account.

• - (ElasticIp) initialize(public_ip, options = {}) constructor

  A new instance of ElasticIp.

• - (Instance^?) instance

  If associated, returns the Instance this elastic IP address is associated to, nil otherwise.

• - (NetworkInterface^?) network_interface

  Returns the network interface this elastic ip is associated with.

• - (String) to_s

  Returns the public IP address.

• - (Boolean) vpc?

  Returns true if this is an EC2 VPC Elastic IP.

38
39
40
41

# File 'lib/aws/ec2/elastic_ip.rb', line 38

def initialize public_ip, options = {}
  @public_ip = public_ip
  super
end

36
37
38

# File 'lib/aws/ec2/elastic_ip.rb', line 36

def allocation_id
  @allocation_id
end

36
37
38

# File 'lib/aws/ec2/elastic_ip.rb', line 36

def association_id
  @association_id
end

36
37
38

# File 'lib/aws/ec2/elastic_ip.rb', line 36

def domain
  @domain
end

36
37
38

# File 'lib/aws/ec2/elastic_ip.rb', line 36

def instance_id
  @instance_id
end

36
37
38

# File 'lib/aws/ec2/elastic_ip.rb', line 36

def network_interface_id
  @network_interface_id
end

36
37
38

# File 'lib/aws/ec2/elastic_ip.rb', line 36

def network_interface_owner_id
  @network_interface_owner_id
end

44
45
46

# File 'lib/aws/ec2/elastic_ip.rb', line 44

def public_ip
  @public_ip
end

# associate with an instance
eip.associate :instance => 'i-12345678'

# associate with a network interface
eip.associate :network_interface => 'ni-12345678'

132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

# File 'lib/aws/ec2/elastic_ip.rb', line 132

def associate options

  client_opts = {}

  [:instance,:network_interface].each do |opt|
    if value = options[opt]
      client_opts[:#{opt}_id"] = value.is_a?(Resource) ? value.id : value
    end
  end

  if vpc?
    client_opts[:allocation_id] = allocation_id
  else
    client_opts[:public_ip] = public_ip
  end

  resp = client.associate_address(client_opts)
  resp.data[:association_id]

end

73
74
75

# File 'lib/aws/ec2/elastic_ip.rb', line 73

def associated?
  !!(instance_id || association_id)
end

102
103
104
105
106
107
108
109

# File 'lib/aws/ec2/elastic_ip.rb', line 102

def delete
  if vpc?
    client.release_address(:allocation_id => allocation_id)
  else
    client.release_address(:public_ip => public_ip)
  end
  nil
end

157
158
159
160
161
162
163
164

# File 'lib/aws/ec2/elastic_ip.rb', line 157

def disassociate
  if vpc?
    client.disassociate_address(:association_id => association_id)
  else
    client.disassociate_address(:public_ip => public_ip)
  end
  nil
end

168
169
170
171
172
173
174
175

# File 'lib/aws/ec2/elastic_ip.rb', line 168

def exists?
  begin
    get_resource
    true
  rescue Errors::InvalidAddress::NotFound
    false
  end
end

81
82
83
84
85

# File 'lib/aws/ec2/elastic_ip.rb', line 81

def instance
  if instance_id = self.instance_id
    Instance.new(instance_id, :config => config)
  end
end

90
91
92
93
94

# File 'lib/aws/ec2/elastic_ip.rb', line 90

def network_interface
  if nid = network_interface_id
    NetworkInterface.new(nid, :config => config)
  end
end

178
179
180

# File 'lib/aws/ec2/elastic_ip.rb', line 178

def to_s
  public_ip.to_s
end

67
68
69

# File 'lib/aws/ec2/elastic_ip.rb', line 67

def vpc?
  domain == 'vpc'
end