
VPC
***


boto.vpc
========

Represents a connection to the EC2 service.

class class boto.vpc.VPCConnection(aws_access_key_id=None, aws_secret_access_key=None, is_secure=True, host=None, port=None, proxy=None, proxy_port=None, proxy_user=None, proxy_pass=None, debug=0, https_connection_factory=None, region=None, path='/', api_version=None, security_token=None, validate_certs=True)

   Init method to create a new connection to EC2.

   associate_dhcp_options(dhcp_options_id, vpc_id)

      Associate a set of Dhcp Options with a VPC.

      Parameters:
         * **dhcp_options_id** (*str*) -- The ID of the Dhcp Options

         * **vpc_id** (*str*) -- The ID of the VPC.

      Return type:
         bool

      Returns:
         True if successful

   associate_route_table(route_table_id, subnet_id)

      Associates a route table with a specific subnet.

      Parameters:
         * **route_table_id** (*str*) -- The ID of the route table to
           associate.

         * **subnet_id** (*str*) -- The ID of the subnet to associate
           with.

      Return type:
         str

      Returns:
         The ID of the association created

   attach_internet_gateway(internet_gateway_id, vpc_id)

      Attach an internet gateway to a specific VPC.

      Parameters:
         * **internet_gateway_id** (*str*) -- The ID of the internet
           gateway to delete.

         * **vpc_id** (*str*) -- The ID of the VPC to attach to.

      Return type:
         Bool

      Returns:
         True if successful

   attach_vpn_gateway(vpn_gateway_id, vpc_id)

      Attaches a VPN gateway to a VPC.

      Parameters:
         * **vpn_gateway_id** (*str*) -- The ID of the vpn_gateway to
           attach

         * **vpc_id** (*str*) -- The ID of the VPC you want to attach
           the gateway to.

      Return type:
         An attachment

      Returns:
         a "boto.vpc.vpngateway.Attachment"

   create_customer_gateway(type, ip_address, bgp_asn)

      Create a new Customer Gateway

      Parameters:
         * **type** (*str*) -- Type of VPN Connection.  Only valid
           valid currently is 'ipsec.1'

         * **ip_address** (*str*) -- Internet-routable IP address for
           customer's gateway. Must be a static address.

         * **bgp_asn** (*str*) -- Customer gateway's Border Gateway
           Protocol (BGP) Autonomous System Number (ASN)

      Return type:
         The newly created CustomerGateway

      Returns:
         A "boto.vpc.customergateway.CustomerGateway" object

   create_dhcp_options(domain_name=None, domain_name_servers=None, ntp_servers=None, netbios_name_servers=None, netbios_node_type=None)

      Create a new DhcpOption

      This corresponds to
      http://docs.amazonwebservices.com/AWSEC2/latest/APIReference
      /ApiReference-query-CreateDhcpOptions.html

      Parameters:
         * **domain_name** (*str*) -- A domain name of your choice
           (for example, example.com)

         * **domain_name_servers** (*list of strings*) -- The IP
           address of a domain name server. You can specify up to four
           addresses.

         * **ntp_servers** (*list of strings*) -- The IP address of a
           Network Time Protocol (NTP) server. You can specify up to
           four addresses.

         * **netbios_name_servers** (*list of strings*) -- The IP
           address of a NetBIOS name server. You can specify up to
           four addresses.

         * **netbios_node_type** (*str*) -- The NetBIOS node type (1,
           2, 4, or 8). For more information about the values, see RFC
           2132. We recommend you only use 2 at this time (broadcast
           and multicast are currently not supported).

      Return type:
         The newly created DhcpOption

      Returns:
         A "boto.vpc.customergateway.DhcpOption" object

   create_internet_gateway()

      Creates an internet gateway for VPC.

      Return type:
         Newly created internet gateway.

      Returns:
         *boto.vpc.internetgateway.InternetGateway*

   create_route(route_table_id, destination_cidr_block, gateway_id=None, instance_id=None)

      Creates a new route in the route table within a VPC. The route's
      target can be either a gateway attached to the VPC or a NAT
      instance in the VPC.

      Parameters:
         * **route_table_id** (*str*) -- The ID of the route table for
           the route.

         * **destination_cidr_block** (*str*) -- The CIDR address
           block used for the destination match.

         * **gateway_id** (*str*) -- The ID of the gateway attached to
           your VPC.

         * **instance_id** (*str*) -- The ID of a NAT instance in your
           VPC.

      Return type:
         bool

      Returns:
         True if successful

   create_route_table(vpc_id)

      Creates a new route table.

      Parameters:
         **vpc_id** (*str*) -- The VPC ID to associate this route
         table with.

      Return type:
         The newly created route table

      Returns:
         A "boto.vpc.routetable.RouteTable" object

   create_subnet(vpc_id, cidr_block, availability_zone=None)

      Create a new Subnet

      Parameters:
         * **vpc_id** (*str*) -- The ID of the VPC where you want to
           create the subnet.

         * **cidr_block** (*str*) -- The CIDR block you want the
           subnet to cover.

         * **availability_zone** (*str*) -- The AZ you want the subnet
           in

      Return type:
         The newly created Subnet

      Returns:
         A "boto.vpc.customergateway.Subnet" object

   create_vpc(cidr_block)

      Create a new Virtual Private Cloud.

      Parameters:
         **cidr_block** (*str*) -- A valid CIDR block

      Return type:
         The newly created VPC

      Returns:
         A "boto.vpc.vpc.VPC" object

   create_vpn_connection(type, customer_gateway_id, vpn_gateway_id)

      Create a new VPN Connection.

      Parameters:
         * **type** (*str*) -- The type of VPN Connection.  Currently
           only 'ipsec.1' is supported

         * **customer_gateway_id** (*str*) -- The ID of the customer
           gateway.

         * **vpn_gateway_id** (*str*) -- The ID of the VPN gateway.

      Return type:
         The newly created VpnConnection

      Returns:
         A "boto.vpc.vpnconnection.VpnConnection" object

   create_vpn_connection_route(destination_cidr_block, vpn_connection_id)

      Creates a new static route associated with a VPN connection
      between an existing virtual private gateway and a VPN customer
      gateway. The static route allows traffic to be routed from the
      virtual private gateway to the VPN customer gateway.

      Parameters:
         **destination_cidr_block** (*str*) -- The CIDR block
         associated with the local

      subnet of the customer data center.

      Parameters:
         **vpn_connection_id** (*str*) -- The ID of the VPN
         connection.

      Return type:
         bool

      Returns:
         True if successful

   create_vpn_gateway(type, availability_zone=None)

      Create a new Vpn Gateway

      Parameters:
         * **type** (*str*) -- Type of VPN Connection.  Only valid
           valid currently is 'ipsec.1'

         * **availability_zone** (*str*) -- The Availability Zone
           where you want the VPN gateway.

      Return type:
         The newly created VpnGateway

      Returns:
         A "boto.vpc.vpngateway.VpnGateway" object

   delete_customer_gateway(customer_gateway_id)

      Delete a Customer Gateway.

      Parameters:
         **customer_gateway_id** (*str*) -- The ID of the
         customer_gateway to be deleted.

      Return type:
         bool

      Returns:
         True if successful

   delete_dhcp_options(dhcp_options_id)

      Delete a DHCP Options

      Parameters:
         **dhcp_options_id** (*str*) -- The ID of the DHCP Options to
         be deleted.

      Return type:
         bool

      Returns:
         True if successful

   delete_internet_gateway(internet_gateway_id)

      Deletes an internet gateway from the VPC.

      Parameters:
         **internet_gateway_id** (*str*) -- The ID of the internet
         gateway to delete.

      Return type:
         Bool

      Returns:
         True if successful

   delete_route(route_table_id, destination_cidr_block)

      Deletes a route from a route table within a VPC.

      Parameters:
         * **route_table_id** (*str*) -- The ID of the route table
           with the route.

         * **destination_cidr_block** (*str*) -- The CIDR address
           block used for destination match.

      Return type:
         bool

      Returns:
         True if successful

   delete_route_table(route_table_id)

      Delete a route table.

      Parameters:
         **route_table_id** (*str*) -- The ID of the route table to
         delete.

      Return type:
         bool

      Returns:
         True if successful

   delete_subnet(subnet_id)

      Delete a subnet.

      Parameters:
         **subnet_id** (*str*) -- The ID of the subnet to be deleted.

      Return type:
         bool

      Returns:
         True if successful

   delete_vpc(vpc_id)

      Delete a Virtual Private Cloud.

      Parameters:
         **vpc_id** (*str*) -- The ID of the vpc to be deleted.

      Return type:
         bool

      Returns:
         True if successful

   delete_vpn_connection(vpn_connection_id)

      Delete a VPN Connection.

      Parameters:
         **vpn_connection_id** (*str*) -- The ID of the vpn_connection
         to be deleted.

      Return type:
         bool

      Returns:
         True if successful

   delete_vpn_connection_route(destination_cidr_block, vpn_connection_id)

      Deletes a static route associated with a VPN connection between
      an existing virtual private gateway and a VPN customer gateway.
      The static route allows traffic to be routed from the virtual
      private gateway to the VPN customer gateway.

      Parameters:
         **destination_cidr_block** (*str*) -- The CIDR block
         associated with the local

      subnet of the customer data center.

      Parameters:
         **vpn_connection_id** (*str*) -- The ID of the VPN
         connection.

      Return type:
         bool

      Returns:
         True if successful

   delete_vpn_gateway(vpn_gateway_id)

      Delete a Vpn Gateway.

      Parameters:
         **vpn_gateway_id** (*str*) -- The ID of the vpn_gateway to be
         deleted.

      Return type:
         bool

      Returns:
         True if successful

   detach_internet_gateway(internet_gateway_id, vpc_id)

      Detach an internet gateway from a specific VPC.

      Parameters:
         * **internet_gateway_id** (*str*) -- The ID of the internet
           gateway to detach.

         * **vpc_id** (*str*) -- The ID of the VPC to attach to.

      Return type:
         Bool

      Returns:
         True if successful

   disable_vgw_route_propagation(route_table_id, gateway_id)

      Disables a virtual private gateway (VGW) from propagating routes
      to the routing tables of an Amazon VPC.

      Parameters:
         * **route_table_id** (*str*) -- The ID of the routing table.

         * **gateway_id** (*str*) -- The ID of the virtual private
           gateway.

      Return type:
         bool

      Returns:
         True if successful

   disassociate_route_table(association_id)

      Removes an association from a route table. This will cause all
      subnets that would've used this association to now use the main
      routing association instead.

      Parameters:
         **association_id** (*str*) -- The ID of the association to
         disassociate.

      Return type:
         bool

      Returns:
         True if successful

   enable_vgw_route_propagation(route_table_id, gateway_id)

      Enables a virtual private gateway (VGW) to propagate routes to
      the routing tables of an Amazon VPC.

      Parameters:
         * **route_table_id** (*str*) -- The ID of the routing table.

         * **gateway_id** (*str*) -- The ID of the virtual private
           gateway.

      Return type:
         bool

      Returns:
         True if successful

   get_all_customer_gateways(customer_gateway_ids=None, filters=None)

      Retrieve information about your CustomerGateways.  You can
      filter results to return information only about those
      CustomerGateways that match your search parameters.  Otherwise,
      all CustomerGateways associated with your account are returned.

      Parameters:
         * **customer_gateway_ids** (*list*) -- A list of strings with
           the desired CustomerGateway ID's.

         * **filters** (*list of tuples*) --

           A list of tuples containing filters.  Each tuple consists
           of a filter key and a filter value. Possible filter keys
           are:

              * *state*, the state of the CustomerGateway
                (pending,available,deleting,deleted)

              * *type*, the type of customer gateway (ipsec.1)

              * *ipAddress* the IP address of customer gateway's
                internet-routable external inteface

      Return type:
         list

      Returns:
         A list of "boto.vpc.customergateway.CustomerGateway"

   get_all_dhcp_options(dhcp_options_ids=None)

      Retrieve information about your DhcpOptions.

      Parameters:
         **dhcp_options_ids** (*list*) -- A list of strings with the
         desired DhcpOption ID's

      Return type:
         list

      Returns:
         A list of "boto.vpc.dhcpoptions.DhcpOptions"

   get_all_internet_gateways(internet_gateway_ids=None, filters=None)

      Get a list of internet gateways. You can filter results to
      return information about only those gateways that you're
      interested in.

      Parameters:
         * **internet_gateway_ids** (*list*) -- A list of strings with
           the desired gateway IDs.

         * **filters** (*list of tuples*) -- A list of tuples
           containing filters.  Each tuple consists of a filter key
           and a filter value.

   get_all_route_tables(route_table_ids=None, filters=None)

      Retrieve information about your routing tables. You can filter
      results to return information only about those route tables that
      match your search parameters. Otherwise, all route tables
      associated with your account are returned.

      Parameters:
         * **route_table_ids** (*list*) -- A list of strings with the
           desired route table IDs.

         * **filters** (*list of tuples*) -- A list of tuples
           containing filters. Each tuple consists of a filter key and
           a filter value.

      Return type:
         list

      Returns:
         A list of "boto.vpc.routetable.RouteTable"

   get_all_subnets(subnet_ids=None, filters=None)

      Retrieve information about your Subnets.  You can filter results
      to return information only about those Subnets that match your
      search parameters.  Otherwise, all Subnets associated with your
      account are returned.

      Parameters:
         * **subnet_ids** (*list*) -- A list of strings with the
           desired Subnet ID's

         * **filters** (*list of tuples*) --

           A list of tuples containing filters.  Each tuple consists
           of a filter key and a filter value. Possible filter keys
           are:

           * *state*, a list of states of the Subnet
             (pending,available)

           * *vpcId*, a list of IDs of teh VPC the subnet is in.

           * *cidrBlock*, a list of CIDR blocks of the subnet

           * *availabilityZone*, list of the Availability Zones the
             subnet is in.

      Return type:
         list

      Returns:
         A list of "boto.vpc.subnet.Subnet"

   get_all_vpcs(vpc_ids=None, filters=None)

      Retrieve information about your VPCs.  You can filter results to
      return information only about those VPCs that match your search
      parameters.  Otherwise, all VPCs associated with your account
      are returned.

      Parameters:
         * **vpc_ids** (*list*) -- A list of strings with the desired
           VPC ID's

         * **filters** (*list of tuples*) --

           A list of tuples containing filters.  Each tuple consists
           of a filter key and a filter value. Possible filter keys
           are:

           * *state* - a list of states of the VPC (pending or
             available)

           * *cidrBlock* - a list CIDR blocks of the VPC

           * *dhcpOptionsId* - a list of IDs of a set of DHCP options

      Return type:
         list

      Returns:
         A list of "boto.vpc.vpc.VPC"

   get_all_vpn_connections(vpn_connection_ids=None, filters=None)

      Retrieve information about your VPN_CONNECTIONs.  You can filter
      results to return information only about those VPN_CONNECTIONs
      that match your search parameters.  Otherwise, all
      VPN_CONNECTIONs associated with your account are returned.

      Parameters:
         * **vpn_connection_ids** (*list*) -- A list of strings with
           the desired VPN_CONNECTION ID's

         * **filters** (*list of tuples*) --

           A list of tuples containing filters.  Each tuple consists
           of a filter key and a filter value. Possible filter keys
           are:

           * *state*, a list of states of the VPN_CONNECTION
             pending,available,deleting,deleted

           * *type*, a list of types of connection, currently
             'ipsec.1'

           * *customerGatewayId*, a list of IDs of the customer
             gateway associated with the VPN

           * *vpnGatewayId*, a list of IDs of the VPN gateway
             associated with the VPN connection

      Return type:
         list

      Returns:
         A list of "boto.vpn_connection.vpnconnection.VpnConnection"

   get_all_vpn_gateways(vpn_gateway_ids=None, filters=None)

      Retrieve information about your VpnGateways.  You can filter
      results to return information only about those VpnGateways that
      match your search parameters.  Otherwise, all VpnGateways
      associated with your account are returned.

      Parameters:
         * **vpn_gateway_ids** (*list*) -- A list of strings with the
           desired VpnGateway ID's

         * **filters** (*list of tuples*) --

           A list of tuples containing filters.  Each tuple consists
           of a filter key and a filter value. Possible filter keys
           are:

           * *state*, a list of states of the VpnGateway
             (pending,available,deleting,deleted)

           * *type*, a list types of customer gateway (ipsec.1)

           * *availabilityZone*, a list of  Availability zones the VPN
             gateway is in.

      Return type:
         list

      Returns:
         A list of "boto.vpc.customergateway.VpnGateway"

   replace_route(route_table_id, destination_cidr_block, gateway_id=None, instance_id=None, interface_id=None)

      Replaces an existing route within a route table in a VPC.

      Parameters:
         * **route_table_id** (*str*) -- The ID of the route table for
           the route.

         * **destination_cidr_block** (*str*) -- The CIDR address
           block used for the destination match.

         * **gateway_id** (*str*) -- The ID of the gateway attached to
           your VPC.

         * **instance_id** (*str*) -- The ID of a NAT instance in your
           VPC.

         * **interface_id** (*str*) -- Allows routing to network
           interface attachments.

      Return type:
         bool

      Returns:
         True if successful

boto.vpc.connect_to_region(region_name, **kw_params)

   Given a valid region name, return a "boto.vpc.VPCConnection". Any
   additional parameters after the region_name are passed on to the
   connect method of the region object.

   Type :
      str

   Parameters:
      **region_name** -- The name of the region to connect to.

   Return type:
      "boto.vpc.VPCConnection" or "None"

   Returns:
      A connection to the given region, or None if an invalid region
      name is given

boto.vpc.regions(**kw_params)

   Get all available regions for the EC2 service. You may pass any of
   the arguments accepted by the VPCConnection object's constructor as
   keyword arguments and they will be passed along to the
   VPCConnection object.

   Return type:
      list

   Returns:
      A list of "boto.ec2.regioninfo.RegionInfo"


boto.vpc.customergateway
========================

Represents a Customer Gateway

class class boto.vpc.customergateway.CustomerGateway(connection=None)

   endElement(name, value, connection)


boto.vpc.dhcpoptions
====================

Represents a DHCP Options set

class class boto.vpc.dhcpoptions.DhcpConfigSet

   endElement(name, value, connection)

   startElement(name, attrs, connection)

class class boto.vpc.dhcpoptions.DhcpOptions(connection=None)

   endElement(name, value, connection)

   startElement(name, attrs, connection)

class class boto.vpc.dhcpoptions.DhcpValueSet

   endElement(name, value, connection)

   startElement(name, attrs, connection)


boto.vpc.subnet
===============

Represents a Subnet

class class boto.vpc.subnet.Subnet(connection=None)

   endElement(name, value, connection)


boto.vpc.vpc
============

Represents a Virtual Private Cloud.

class class boto.vpc.vpc.VPC(connection=None)

   delete()

   endElement(name, value, connection)


boto.vpc.vpnconnection
======================

Represents a VPN Connectionn

class class boto.vpc.vpnconnection.VpnConnection(connection=None)

   delete()

   endElement(name, value, connection)


boto.vpc.vpngateway
===================

Represents a Vpn Gateway

class class boto.vpc.vpngateway.Attachment(connection=None)

   endElement(name, value, connection)

   startElement(name, attrs, connection)

class class boto.vpc.vpngateway.VpnGateway(connection=None)

   attach(vpc_id)

   endElement(name, value, connection)

   startElement(name, attrs, connection)
