You are viewing documentation for version 1 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: AWS::EC2::VPC

Inherits:
Resource
  • Object
show all
Includes:
TaggedItem
Defined in:
lib/aws/ec2/vpc.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from TaggedItem

#add_tag, #clear_tags, #tags

Constructor Details

#initialize(vpc_id, options = {}) ⇒ VPC

Returns a new instance of VPC



25
26
27
28
 
# File 'lib/aws/ec2/vpc.rb', line 25

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

Instance Attribute Details

#cidr_block ⇒ String (readonly)

Returns the current value of cidr_block

Returns:

  • (String) —

    the current value of cidr_block



21
22
23
 
# File 'lib/aws/ec2/vpc.rb', line 21

def cidr_block
  @cidr_block
end

#dhcp_options_id ⇒ String (readonly)

Returns the current value of dhcp_options_id

Returns:

  • (String) —

    the current value of dhcp_options_id



21
22
23
 
# File 'lib/aws/ec2/vpc.rb', line 21

def dhcp_options_id
  @dhcp_options_id
end

#instance_tenancy ⇒ Symbol (readonly)

Returns the current value of instance_tenancy

Returns:

  • (Symbol) —

    the current value of instance_tenancy



21
22
23
 
# File 'lib/aws/ec2/vpc.rb', line 21

def instance_tenancy
  @instance_tenancy
end

#state ⇒ Symbol (readonly)

Returns the current value of state

Returns:

  • (Symbol) —

    the current value of state



21
22
23
 
# File 'lib/aws/ec2/vpc.rb', line 21

def state
  @state
end

#vpc_id ⇒ String (readonly) Also known as: id

Returns:

  • (String) 


31
32
33
 
# File 'lib/aws/ec2/vpc.rb', line 31

def vpc_id
  @vpc_id
end

Instance Method Details

#delete ⇒ nil

Deletes the current VPC. The VPC must be empty before it can be deleted.

Returns:

  • (nil) 


64
65
66
67
 
# File 'lib/aws/ec2/vpc.rb', line 64

def delete
  client.delete_vpc(:vpc_id => vpc_id)
  nil
end

#dhcp_options ⇒ DHCPOptions

Returns the dhcp options associated with this VPC.

Returns:

  • (DHCPOptions) —

    Returns the dhcp options associated with this VPC.



163
164
165
 
# File 'lib/aws/ec2/vpc.rb', line 163

def dhcp_options
  DHCPOptions.new(dhcp_options_id, :config => config)
end

#dhcp_options=(dhcp_options) ⇒ Object

Associates the given dhcp options with this VPC.

vpc.dhcp_optinos = ec2.dhcp_options['dopt-a1234abc']

You can also specify the string 'default' to use Amazon's default dhcp options.

vpc.dhcp_optinos = 'default'

Parameters:



179
180
181
182
183
184
 
# File 'lib/aws/ec2/vpc.rb', line 179

def dhcp_options= dhcp_options
  unless dhcp_options.is_a?(DHCPOptions)
    dhcp_options = DHCPOptions.new(dhcp_options, :config => config)
  end
  dhcp_options.associate(self)
end

#dns_hostnames ⇒ Boolean

Returns true if instances launched in the VPC get DNS hostnames in this VPC

Returns:

  • (Boolean) —

    Returns true if instances launched in the VPC get DNS hostnames in this VPC



211
212
213
214
 
# File 'lib/aws/ec2/vpc.rb', line 211

def dns_hostnames
  resp = client.describe_vpc_attribute(:vpc_id => vpc_id, :attribute => 'enableDnsHostnames')
  resp.enable_dns_hostnames
end

#dns_hostnames=(enable_dns_hostnames) ⇒ Object

Enables DNS hostnames for this VPC



217
218
219
220
 
# File 'lib/aws/ec2/vpc.rb', line 217

def dns_hostnames= enable_dns_hostnames
  client.modify_vpc_attribute(:vpc_id => vpc_id, :enable_dns_hostnames => { :value => enable_dns_hostnames } )
  enable_dns_hostnames
end

#dns_support ⇒ Boolean

Returns true if DNS resolution is supported for this VPC

Returns:

  • (Boolean) —

    Returns true if DNS resolution is supported for this VPC



198
199
200
201
 
# File 'lib/aws/ec2/vpc.rb', line 198

def dns_support
  resp = client.describe_vpc_attribute(:vpc_id => vpc_id, :attribute => 'enableDnsSupport')
  resp.enable_dns_support
end

#dns_support=(enable_dns_support) ⇒ Object

Enables DNS resolution support for this VPC



204
205
206
207
 
# File 'lib/aws/ec2/vpc.rb', line 204

def dns_support= enable_dns_support
  client.modify_vpc_attribute(:vpc_id => vpc_id, :enable_dns_support => { :value => enable_dns_support } )
  enable_dns_support
end

#exists? ⇒ Boolean

Returns true if the resource exists.

Returns:

  • (Boolean) —

    Returns true if the resource exists.



54
55
56
57
58
59
 
# File 'lib/aws/ec2/vpc.rb', line 54

def exists?
  get_resource
  true
rescue Errors::InvalidVpcID::NotFound
  false
end

#instances ⇒ InstanceCollection

Returns a filtered collection of instances that are in this VPC.

Returns:

  • (InstanceCollection) —

    Returns a filtered collection of instances that are in this VPC.



71
72
73
 
# File 'lib/aws/ec2/vpc.rb', line 71

def instances
  InstanceCollection.new(:config => config).filter('vpc-id', vpc_id)
end

#internet_gateway ⇒ InternetGateway?

Returns the internet gateway attached to this VPC. If no internet gateway has been attached, then nil is returned.

Returns:

  • (InternetGateway, nil) —

    Returns the internet gateway attached to this VPC. If no internet gateway has been attached, then nil is returned.



120
121
122
123
 
# File 'lib/aws/ec2/vpc.rb', line 120

def internet_gateway
  gateways = InternetGatewayCollection.new(:config => config)
  gateways.filter('attachment.vpc-id', vpc_id).first
end

#internet_gateway=(internet_gateway) ⇒ Object

Attaches the given internet gateway to this VPC. If there is already an internet gateway attached, it will be detached from this VPC first. If you pass nil, this will leave the current VPC without an attached internet gateway.

vpc.internet_gateway = gateway_1 vpc.internet_gateway = gateway_2 # detaches gateway_1 first vpc.internet_gateway = nil # detaches gateway_2

Parameters:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/aws/ec2/vpc.rb', line 137

def internet_gateway= internet_gateway

  # remove currently attached internet gateway
  gateway = self.internet_gateway
  gateway.detach(self) if gateway

  if internet_gateway
    unless internet_gateway.is_a?(InternetGateway)
      internet_gateway = InternetGateway.new(internet_gateway,
        :config => config)
    end
    internet_gateway.attach(self)
  end

end

#network_acls ⇒ NetworkACLCollection

Returns a filtered collection of network ACLs that are in this VPC.

Returns:



89
90
91
 
# File 'lib/aws/ec2/vpc.rb', line 89

def network_acls
  NetworkACLCollection.new(:config => config).filter('vpc-id', vpc_id)
end

#network_interfaces ⇒ NetworkInterfaceCollection

Returns a filtered collection of network interfaces that are in this VPC.

Returns:



101
102
103
 
# File 'lib/aws/ec2/vpc.rb', line 101

def network_interfaces
  NetworkInterfaceCollection.new(:config => config).filter('vpc-id', id)
end

#peer_to(vpc) ⇒ VPCPeeringConnection

Create a VPC peering connection between this VPC and another VPC owned by the same user, and accept it.

Returns:



190
191
192
193
194
 
# File 'lib/aws/ec2/vpc.rb', line 190

def peer_to vpc
  peering_connection = peering_connections.create(self, vpc)
  peering_connection.accept
  peering_connection
end

#peering_connections ⇒ VPCPeeringConnectionCollection

Returns a filtered collection of VPC peering connection to this VPC.

Returns:



107
108
109
 
# File 'lib/aws/ec2/vpc.rb', line 107

def peering_connections
  VPCPeeringConnectionCollection.new(:config => config).filter('requester-vpc-info.vpc-id', vpc_id)
end

#route_tables ⇒ RouteTableCollection

Returns a filtered collection of route tables that are in this VPC.

Returns:



95
96
97
 
# File 'lib/aws/ec2/vpc.rb', line 95

def route_tables
  RouteTableCollection.new(:config => config).filter('vpc-id', vpc_id)
end

#security_groups ⇒ SecurityGroupCollection

Returns a filtered collection of security groups that are in this VPC.

Returns:



77
78
79
 
# File 'lib/aws/ec2/vpc.rb', line 77

def security_groups
  SecurityGroupCollection.new(:config => config).filter('vpc-id', vpc_id)
end

#subnets ⇒ SubnetCollection

Returns a filtered collection of subnets that are in this VPC.

Returns:

  • (SubnetCollection) —

    Returns a filtered collection of subnets that are in this VPC.



83
84
85
 
# File 'lib/aws/ec2/vpc.rb', line 83

def subnets
  SubnetCollection.new(:config => config).filter('vpc-id', vpc_id)
end

#vpn_gateway ⇒ VPNGateway?

Returns the vpn gateway attached to this VPC. If no vpn gateway has been attached, then nil is returned.

Returns:

  • (VPNGateway, nil) —

    Returns the vpn gateway attached to this VPC. If no vpn gateway has been attached, then nil is returned.



156
157
158
159
 
# File 'lib/aws/ec2/vpc.rb', line 156

def vpn_gateway
  gateways = VPNGatewayCollection.new(:config => config)
  gateways.filter('attachment.vpc-id', vpc_id).first
end