json_CloudCredentials.html 6.43 KB
Newer Older
Spiros Koulouzis's avatar
Spiros Koulouzis committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->

  <title>drip-api: CloudCredentials</title>

  <!-- Mobile viewport optimized: j.mp/bplateviewport -->
  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <!-- Bootstrap core CSS -->
  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">

  <!--custom css for these pages-->
  <link rel="stylesheet" href="css/style.css">

  <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
  <!--[if lt IE 9]>
  <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
  <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
  <![endif]-->
</head>

<body data-spy="scroll" data-target="#apinav">

  <nav class="navbar navbar-inverse navbar-fixed-top">
    <div class="container-fluid">
      <div class="navbar-header">
        <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
          <span class="sr-only">Toggle navigation</span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>
        <a class="navbar-brand" href="index.html">drip-api: CloudCredentials</a>
      </div>
      <div id="navbar" class="navbar-collapse collapse">
        <ul class="nav navbar-nav navbar-right">
          <li><a href="resources.html">Resources</a></li>
          <li><a href="data.html">Data Types</a></li>
          <li><a href="downloads.html">Files and Libraries</a></li>
        </ul>
      </div>
    </div>
  </nav>

  <div class="container-fluid">
    <div class="row">
      <div class="col-sm-3 col-md-2 sidebar" id="apinav">
        <ul class="nav nav-sidebar">
          <li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
        </ul>
      </div>

      <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
        <ol class="breadcrumb" id="top">
          <li class="active dropdown"><a href="index.html">Home</a></li>
          <li class="active dropdown"><a href="syntax_json.html">JSON</a></li>
          <li class="dropdown"><a href="json_CloudCredentials.html">CloudCredentials</a></li>
        </ol>

      <h1 class="page-header">CloudCredentials <small>Data Type</small></h1>

Spiros Koulouzis's avatar
Spiros Koulouzis committed
67 68
      <p>This class represents the cloud credentials. They are used by the provisoner
to request for resources.</p>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83

      <dl class="dl-horizontal">
      </dl>

      <table class="table datatype-properties">
        <caption>Properties</caption>
        <thead>
        <tr>
          <th>name</th>
          <th>data type</th>
          <th>description</th>
        </tr>
        </thead>
        <tbody>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
84
          <td>  <span class="property-name">secretKey</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
85 86 87 88
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
89
          <td>  <span class="property-description">It is the secret key / password for accessing a cloud provider.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
90 91 92
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
93
          <td>  <span class="property-name">cloudProviderName</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
94 95 96 97
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
98
          <td>  <span class="property-description">The name of the cloud provider</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
99 100 101
</td>
        </tr>
        <tr>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
102
          <td>  <span class="property-name">accessKeyId</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
103 104 105 106
</td>
          <td>  <span class="datatype-reference">string
</span>
</td>
107
          <td>  <span class="property-description">The access key ID for a cloud provider.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
108 109 110
</td>
        </tr>
        <tr>
111
          <td>  <span class="property-name">keyPairIDs</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
112
</td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
113
          <td>  <span class="datatype-reference">array of string
Spiros Koulouzis's avatar
Spiros Koulouzis committed
114 115
</span>
</td>
116
          <td>  <span class="property-description">The IDs of of the key pairs for accessing the VMs of that cloud provider.</span>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
117 118 119 120 121 122 123 124 125 126 127
</td>
        </tr>
        </tbody>
        <tr>
          <td colspan="3"><h5 class="text-muted">Properties inherited from <a href="json_OwnedObject.html">OwnedObject</a></h5></td>
        </tr>
        <tbody>
        <tr>
          <td><span class="property-name">owner</span></td>
          <td><span class="datatype-reference">string
</span></td>
128 129 130 131 132 133 134 135 136
          <td><span class="property-description">The owner (username) for the particular object. This value is set when
the DAO saves the object based on the principal how made the call</span></td>
        </tr>
        <tr>
          <td><span class="property-name">id</span></td>
          <td><span class="datatype-reference">string
</span></td>
          <td><span class="property-description">The UID of this object. This value is auto generated by the DAO when the
object is saved.</span></td>
Spiros Koulouzis's avatar
Spiros Koulouzis committed
137 138 139 140 141 142 143
        </tr>
        </tbody>
      </table>

      <p class="lead">Example</p>
      
      <pre class="prettyprint language-js example">{
Spiros Koulouzis's avatar
Spiros Koulouzis committed
144
  &quot;secretKey&quot; : &quot;7A7vo19ffdfa4SAsA6gsF5Fgbfb5rtwY6hBxtYt12&quot;,
Spiros Koulouzis's avatar
Spiros Koulouzis committed
145
  &quot;cloudProviderName&quot; : &quot;ec2&quot;,
146 147
  &quot;accessKeyId&quot; : &quot;AKIKIQY9K1ZUQ6M7YBSQ&quot;,
  &quot;keyPairIDs&quot; : [ &quot;AKIKIQY9K1ZUQ6M7YBSQ, LKJ2KIQY9K1F236M7YASD&quot;, &quot;...&quot; ],
148 149
  &quot;owner&quot; : &quot;user1&quot;,
  &quot;id&quot; : &quot;58e3946e0fb4f562d84ba1ad&quot;
Spiros Koulouzis's avatar
Spiros Koulouzis committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
}</pre>

        <footer class="footer">
          <div class="container">
            <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
          </div>
        </footer>

      </div>
    </div>
  </div>


  <!-- JavaScript placed at the end of the document so the pages load faster. -->
  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>

  <!-- Bootstrap core JavaScript
  ================================================== -->
  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>

  <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
  <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script>
  <script>
    $(function() {
      $(".clickable-row").click(function() {
        window.document.location = $(this).data("href");
      });

      $('[data-toggle="tooltip"]').tooltip()
    });
  </script>

</body>
</html>