aws-sdk-v1 1.52.0

data/lib/aws/ec2/vpc.rb

@@ -0,0 +1,174 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class EC2
+
+    # @attr_reader [Symbol] state
+    # @attr_reader [String] cidr_block
+    # @attr_reader [String] dhcp_options_id
+    # @attr_reader [Symbol] instance_tenancy
+    class VPC < Resource
+
+      include TaggedItem
+
+      def initialize vpc_id, options = {}
+        @vpc_id = vpc_id
+        super
+      end
+
+      # @return [String]
+      attr_reader :vpc_id
+
+      alias_method :id, :vpc_id
+
+      attribute :state, :to_sym => true
+
+      attribute :cidr_block, :static => true
+
+      attribute :dhcp_options_id
+
+      attribute :instance_tenancy, :static => true, :to_sym => true
+
+      populates_from(:create_vpc) do |resp|
+        resp.vpc if resp.vpc.vpc_id == vpc_id
+      end
+
+      populates_from(:describe_vpcs) do |resp|
+        resp.vpc_set.find{|v| v.vpc_id == vpc_id }
+      end
+
+      # @return [Boolean] Returns `true` if the resource exists.
+      def exists?
+        get_resource
+        true
+      rescue Errors::InvalidVpcID::NotFound
+        false
+      end
+
+      # Deletes the current VPC.  The VPC must be empty before it can
+      # be deleted.
+      # @return [nil]
+      def delete
+        client.delete_vpc(:vpc_id => vpc_id)
+        nil
+      end
+
+      # @return [InstanceCollection] Returns a filtered collection of
+      #   instances that are in this VPC.
+      def instances
+        InstanceCollection.new(:config => config).filter('vpc-id', vpc_id)
+      end
+
+      # @return [SecurityGroupCollection] Returns a filtered collection of
+      #   security groups that are in this VPC.
+      def security_groups
+        SecurityGroupCollection.new(:config => config).filter('vpc-id', vpc_id)
+      end
+
+      # @return [SubnetCollection] Returns a filtered collection of
+      #   subnets that are in this VPC.
+      def subnets
+        SubnetCollection.new(:config => config).filter('vpc-id', vpc_id)
+      end
+
+      # @return [NetworkACLCollection] Returns a filtered collection of
+      #   network ACLs that are in this VPC.
+      def network_acls
+        NetworkACLCollection.new(:config => config).filter('vpc-id', vpc_id)
+      end
+
+      # @return [RouteTableCollection] Returns a filtered collection of
+      #   route tables that are in this VPC.
+      def route_tables
+        RouteTableCollection.new(:config => config).filter('vpc-id', vpc_id)
+      end
+
+      # @return [NetworkInterfaceCollection] Returns a filtered collection of
+      #   network interfaces that are in this VPC.
+      def network_interfaces
+        NetworkInterfaceCollection.new(:config => config).filter('vpc-id', id)
+      end
+
+      # @return [InternetGateway,nil] Returns the internet gateway attached to
+      #   this VPC.  If no internet gateway has been attached, then
+      #   nil is returned.
+      def internet_gateway
+        gateways = InternetGatewayCollection.new(:config => config)
+        gateways.filter('attachment.vpc-id', vpc_id).first
+      end
+
+      # 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
+      #
+      # @param [InternetGateway,String] internet_gateway An {InternetGateway}
+      #   object or internet gateway id string.
+      #
+      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
+
+      # @return [VPNGateway,nil] Returns the vpn gateway attached to
+      #   this VPC.  If no vpn gateway has been attached, then
+      #   nil is returned.
+      def vpn_gateway
+        gateways = VPNGatewayCollection.new(:config => config)
+        gateways.filter('attachment.vpc-id', vpc_id).first
+      end
+
+      # @return [DHCPOptions] Returns the dhcp options associated with
+      #   this VPC.
+      def dhcp_options
+        DHCPOptions.new(dhcp_options_id, :config => config)
+      end
+
+      # 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'
+      #
+      # @param [DHCPOptions,String] dhcp_options A {DHCPOptions} object
+      #   or a dhcp options id string.
+      #
+      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
+
+    end
+  end
+end

data/lib/aws/ec2/vpc_collection.rb

@@ -0,0 +1,70 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class EC2
+
+    class VPCCollection < Collection
+
+      include TaggedCollection
+      include Core::Collection::Simple
+
+      # Creates a VPC with the CIDR block you specify. The smallest VPC you
+      # can create uses a /28 netmask (16 IP addresses), and the largest
+      # uses a /16 netmask (65,536 IP addresses).
+      #
+      #     vpc = ec2.vpcs.create('10.0.0.0/16')
+      #
+      # @param [String] cidr_block The CIDR block you want the VPC to
+      #   cover (e.g., 10.0.0.0/16).
+      #
+      # @param [Hash] options
+      #
+      # @option options [Symbol] :instance_tenancy (:default)
+      #   The allowed tenancy of instances launched into the VPC. A value of
+      #   `:default` means instances can be launched with any tenancy; a value
+      #   of `:dedicated` means all instances launched into the VPC will be launched with
+      #   dedicated tenancy regardless of the tenancy assigned to the instance at launch.
+      #
+      # @return [VPC]
+      #
+      def create cidr_block, options = {}
+
+        tenancy = options.key?(:instance_tenancy) ?
+          options[:instance_tenancy].to_s : 'default'
+
+        client_opts = {}
+        client_opts[:cidr_block] = cidr_block
+        client_opts[:instance_tenancy] = tenancy
+
+        resp = client.create_vpc(client_opts)
+
+        VPC.new_from(:create_vpc, resp.vpc, resp.vpc.vpc_id, :config => config)
+
+      end
+
+      def [] vpc_id
+        VPC.new(vpc_id, :config => config)
+      end
+
+      protected
+      def _each_item options = {}, &block
+        response = filtered_request(:describe_vpcs, options, &block)
+        response.vpc_set.each do |v|
+          yield(VPC.new_from(:describe_vpcs, v, v.vpc_id, :config => config))
+        end
+      end
+
+    end
+  end
+end

data/lib/aws/ec2/vpn_connection.rb

@@ -0,0 +1,99 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+require 'aws/ec2/vpn_connection/telemetry'
+
+module AWS
+  class EC2
+
+    # @attr_reader [Symbol] state
+    #
+    # @attr_reader [String] vpn_type
+    #
+    # @attr_reader [String] vpn_gateway_id
+    #
+    # @attr_reader [String] customer_gateway_id
+    #
+    # @attr_reader [String] customer_gateway_configuration
+    #   Configuration XML for the VPN connection's customer gateway This
+    #   attribute is always present after creating a vpn connection while
+    #   the connection state is :pending or :available.
+    #
+    class VPNConnection < Resource
+
+      include TaggedItem
+
+      # @api private
+      def initialize vpn_connection_id, options = {}
+        @vpn_connection_id = vpn_connection_id
+        super
+      end
+
+      # @return [String]
+      attr_reader :vpn_connection_id
+
+      alias_method :id, :vpn_connection_id
+
+      attribute :state, :to_sym => true
+
+      attribute :vpn_type, :static => true
+
+      attribute :vpn_gateway_id, :static => true
+
+      attribute :customer_gateway_id, :static => true
+
+      attribute :customer_gateway_configuration, :static => true
+
+      attribute :vgw_telemetry_details, :from => :vgw_telemetry
+
+      protected :vgw_telemetry_details
+
+      populates_from(:create_vpn_connection) do |resp|
+        resp.vpn_connection if resp.vpn_connection.vpn_connection_id == id
+      end
+
+      populates_from(:describe_vpn_connections) do |resp|
+        resp.vpn_connection_set.find do |vpn_connection|
+          vpn_connection.vpn_connection_id == vpn_connection_id
+        end
+      end
+
+      # @return [VPNGateway]
+      def vpn_gateway
+        VPNGateway.new(vpn_gateway_id, :config => config)
+      end
+
+      # @return [CustomerGateway]
+      def customer_gateway
+        CustomerGateway.new(customer_gateway_id, :config => config)
+      end
+
+      # @return [Array<Telemetry>]
+      def vgw_telemetry
+        vgw_telemetry_details.collect do |details|
+          Telemetry.new(self, details)
+        end
+      end
+
+      # Deletes this vpn connection.
+      # @return [nil]
+      def delete
+        client_opts = {}
+        client_opts[:vpn_connection_id] = vpn_connection_id
+        client.delete_vpn_connection(client_opts)
+        nil
+      end
+
+    end
+  end
+end

data/lib/aws/ec2/vpn_connection/telemetry.rb

@@ -0,0 +1,49 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class EC2
+    class VPNConnection < Resource
+      class Telemetry
+
+        def initialize vpn_connection, details
+          @vpn_connection = vpn_connection
+          @outside_ip_address = details.outside_ip_address
+          @status = details.status.downcase.to_sym
+          @last_status_change = details.last_status_change
+          @status_message = details.status_message
+          @accepted_route_count = details.accepted_route_count
+        end
+
+        # @return [VPNConnection]
+        attr_reader :vpn_connection
+
+        # @return [String]
+        attr_reader :outside_ip_address
+
+        # @return [Symbol] :up or :down
+        attr_reader :status
+
+        # @return [Time]
+        attr_reader :last_status_change
+
+        # @return [String]
+        attr_reader :status_message
+
+        # @return [Integer]
+        attr_reader :accepted_route_count
+
+      end
+    end
+  end
+end

data/lib/aws/ec2/vpn_connection_collection.rb

@@ -0,0 +1,96 @@
+# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+#     http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+
+module AWS
+  class EC2
+
+    class VPNConnectionCollection < Collection
+
+      include TaggedCollection
+      include Core::Collection::Simple
+
+      # Creates a new VPN connection between an existing virtual private
+      # gateway and a VPN customer gateway.
+      #
+      # @param [Hash] options
+      #
+      # @option options [CustomerGateway,String] :customer_gateway
+      #   The {CustomerGateway} object or customer gateway id string.
+      #
+      # @option options [VPNGateway,String] :vpn_gateway
+      #   The {VPNGateway} object or vpn gateway id string.
+      #
+      # @option options [String] :vpn_type ('ipsec.1')
+      #   The type of VPN connection.
+      #
+      # @return [VPNConnection]
+      #
+      def create options = {}
+
+        client_opts = {}
+        client_opts[:customer_gateway_id] = customer_gateway_id(options)
+        client_opts[:vpn_gateway_id] = vpn_gateway_id(options)
+        client_opts[:type] = options[:vpn_type] || 'ipsec.1'
+
+        resp = client.create_vpn_connection(client_opts)
+
+        VPNConnection.new_from(:create_vpn_connection, resp,
+          resp.vpn_connection.vpn_connection_id, :config => config)
+
+      end
+
+      # Returns a reference to the VPN connection with the given id.
+      #
+      #     vpn_connection = ec2.vpn_connections['vpn-connection-id']
+      #
+      # @param [String] vpn_connection_id
+      #
+      # @return [VPNConnection]
+      #
+      def [] vpn_connection_id
+        VPNConnection.new(vpn_connection_id, :config => config)
+      end
+
+      protected
+
+      def _each_item options = {}, &block
+        response = filtered_request(:describe_vpn_connections, options, &block)
+        response.vpn_connection_set.each do |c|
+
+          vpn_connection = VPNConnection.new_from(:describe_vpn_connections,
+            c, c.vpn_connection_id, :config => config)
+
+          yield(vpn_connection)
+
+        end
+      end
+
+      def customer_gateway_id options
+        gateway_id = options.delete(:customer_gateway)
+        gateway_id ||= options[:customer_gateway_id]
+        gateway_id ||= filter_value_for('customer-gateway-id')
+        gateway_id = gateway_id.id if gateway_id.is_a?(CustomerGateway)
+        gateway_id
+      end
+
+      def vpn_gateway_id options
+        gateway_id = options.delete(:vpn_gateway)
+        gateway_id ||= options[:vpn_gateway_id]
+        gateway_id ||= filter_value_for('vpn-gateway-id')
+        gateway_id = gateway_id.id if gateway_id.is_a?(VPNGateway)
+        gateway_id
+      end
+
+    end
+  end
+end