docs/en-US/aws-ec2-timeouts.xml

<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>

<!-- Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements.  See the NOTICE file
 distributed with this work for additional information
 regarding copyright ownership.  The ASF licenses this file
 to you under the Apache License, Version 2.0 (the
 "License"); you may not use this file except in compliance
 with the License.  You may obtain a copy of the License at
 
   http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing,
 software distributed under the License 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.
-->

<section id="aws-ec2-timeouts">
  <title>Using Timeouts to Ensure AWS API Command Completion</title>
  <para>The Amazon EC2 command-line tools have a default connection timeout. When used with &PRODUCT;, a longer timeout might be needed for some commands. If you find that commands are not completing due to timeouts, you can specify a custom timeouts. You can add the following optional command-line parameters to any &PRODUCT;-supported EC2 command:</para>
  <informaltable frame="all">
    <tgroup cols="2" align="left" colsep="1" rowsep="1">
      <colspec colname="c1" />
      <colspec colname="c2" />
      <tbody>
        <row>
          <entry><programlisting>--connection-timeout <replaceable>TIMEOUT</replaceable></programlisting></entry>
          <entry>Specifies a connection timeout (in seconds). 
            Example: <programlisting>--connection-timeout 30</programlisting>
          </entry>
        </row>
        <row>
          <entry><programlisting>--request-timeout <replaceable>TIMEOUT</replaceable></programlisting></entry>
          <entry>Specifies a request timeout (in seconds). 
            Example: <programlisting>--request-timeout 45</programlisting>
          </entry>
        </row>
      </tbody>
    </tgroup>
  </informaltable>
  <para>Example:</para>
  <programlisting>ec2-run-instances 2 –z us-test1 –n 1-3 --connection-timeout 120 --request-timeout 120</programlisting>
  <note><para>The timeouts optional arguments are not specific to &PRODUCT;.</para></note>
</section>