

<!DOCTYPE html>

<html lang="en-US">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=Edge">

  <link rel="stylesheet" href="/pulumi-lagoon-provider/assets/css/just-the-docs-default.css">

  <link rel="stylesheet" href="/pulumi-lagoon-provider/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet">

  <style id="jtd-nav-activation">
  
    .site-nav ul li a {
      background-image: none;
    }

  </style>

  

  
    <script src="/pulumi-lagoon-provider/assets/js/vendor/lunr.min.js"></script>
  

  <script src="/pulumi-lagoon-provider/assets/js/just-the-docs.js"></script>

  <meta name="viewport" content="width=device-width, initial-scale=1">

  

  <link rel="icon" href="/pulumi-lagoon-provider/assets/images/favicon.ico" type="image/x-icon">



  <!-- Begin Jekyll SEO tag v2.8.0 -->
<title>Pulumi Lagoon Provider | Manage Lagoon hosting platform resources as infrastructure-as-code with Pulumi</title>
<meta name="generator" content="Jekyll v4.4.1" />
<meta property="og:title" content="Pulumi Lagoon Provider" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="Manage Lagoon hosting platform resources as infrastructure-as-code with Pulumi" />
<meta property="og:description" content="Manage Lagoon hosting platform resources as infrastructure-as-code with Pulumi" />
<link rel="canonical" href="https://tag1consulting.github.io/pulumi-lagoon-provider/assets/css/just-the-docs-head-nav.css" />
<meta property="og:url" content="https://tag1consulting.github.io/pulumi-lagoon-provider/assets/css/just-the-docs-head-nav.css" />
<meta property="og:site_name" content="Pulumi Lagoon Provider" />
<meta property="og:type" content="website" />
<meta name="twitter:card" content="summary" />
<meta property="twitter:title" content="Pulumi Lagoon Provider" />
<script type="application/ld+json">
{"@context":"https://schema.org","@type":"WebPage","description":"Manage Lagoon hosting platform resources as infrastructure-as-code with Pulumi","headline":"Pulumi Lagoon Provider","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://tag1consulting.github.io/pulumi-lagoon-provider/assets/images/tag1-logo.svg"}},"url":"https://tag1consulting.github.io/pulumi-lagoon-provider/assets/css/just-the-docs-head-nav.css"}</script>
<!-- End Jekyll SEO tag -->


  <style>
  @font-face {
    font-family: 'Styrene A';
    src: url('/pulumi-lagoon-provider/assets/fonts/StyreneA-Regular-Web.woff2') format('woff2');
    font-weight: 400;
    font-style: normal;
    font-display: swap;
  }
  @font-face {
    font-family: 'Styrene A';
    src: url('/pulumi-lagoon-provider/assets/fonts/StyreneA-Bold-Web.woff2') format('woff2');
    font-weight: 700;
    font-style: normal;
    font-display: swap;
  }
  @font-face {
    font-family: 'Styrene B';
    src: url('/pulumi-lagoon-provider/assets/fonts/StyreneB-Regular-Web.woff2') format('woff2');
    font-weight: 400;
    font-style: normal;
    font-display: swap;
  }
  @font-face {
    font-family: 'Styrene B';
    src: url('/pulumi-lagoon-provider/assets/fonts/StyreneB-Bold-Web.woff2') format('woff2');
    font-weight: 700;
    font-style: normal;
    font-display: swap;
  }
</style>
<script>
document.addEventListener("DOMContentLoaded", function() {
  document.querySelectorAll(".code-tabs").forEach(function(tabGroup) {
    var radios = tabGroup.querySelectorAll('input[type="radio"]');
    var panels = tabGroup.querySelectorAll(".tab-content");

    function showTab() {
      radios.forEach(function(radio, i) {
        if (panels[i]) {
          panels[i].style.display = radio.checked ? "block" : "none";
        }
      });
    }

    radios.forEach(function(radio) {
      radio.addEventListener("change", showTab);
    });

    showTab();
  });
});
</script>



</head>

<body>
  <a class="skip-to-main" href="#main-content">Skip to main content</a>
  <svg xmlns="http://www.w3.org/2000/svg" class="d-none">
  <symbol id="svg-link" viewBox="0 0 24 24">
  <title>Link</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link">
    <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path>
  </svg>
</symbol>

  <symbol id="svg-menu" viewBox="0 0 24 24">
  <title>Menu</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu">
    <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line>
  </svg>
</symbol>

  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
  <title>Expand</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right">
    <polyline points="9 18 15 12 9 6"></polyline>
  </svg>
</symbol>

  <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE -->
<symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link">
  <title id="svg-external-link-title">(external link)</title>
  <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line>
</symbol>

  
    <symbol id="svg-doc" viewBox="0 0 24 24">
  <title>Document</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file">
    <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline>
  </svg>
</symbol>

    <symbol id="svg-search" viewBox="0 0 24 24">
  <title>Search</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search">
    <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line>
  </svg>
</symbol>

  
  
    <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md -->
<symbol id="svg-copy" viewBox="0 0 16 16">
  <title>Copy</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16">
    <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/>
    <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/>
  </svg>
</symbol>
<symbol id="svg-copied" viewBox="0 0 16 16">
  <title>Copied</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16">
    <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/>
    <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/>
  </svg>
</symbol>

  
</svg>

  
    <header class="side-bar">
  <div class="site-header">
    <a href="/pulumi-lagoon-provider/" class="site-title lh-tight">
  <div class="site-logo" role="img" aria-label="Pulumi Lagoon Provider"></div>

</a>
    <button id="menu-button" class="site-button btn-reset" aria-label="Menu" aria-expanded="false">
      <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg>
    </button>
  </div>

  <nav aria-label="Main" id="site-nav" class="site-nav">
  
  
    <ul class="nav-list"><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Getting Started submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/pulumi-lagoon-provider/getting-started.html" class="nav-list-link">Getting Started</a><ul class="nav-list"><li class="nav-list-item"><a href="/pulumi-lagoon-provider/getting-started/installation.html" class="nav-list-link">Installation</a></li><li class="nav-list-item"><a href="/pulumi-lagoon-provider/getting-started/configuration.html" class="nav-list-link">Configuration</a></li><li class="nav-list-item"><a href="/pulumi-lagoon-provider/getting-started/quick-start.html" class="nav-list-link">Quick Start</a></li><li class="nav-list-item"><a href="/pulumi-lagoon-provider/getting-started/importing-resources.html" class="nav-list-link">Importing Resources</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Resources submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/pulumi-lagoon-provider/resources.html" class="nav-list-link">Resources</a><ul class="nav-list"><li class="nav-list-item"><a href="/pulumi-lagoon-provider/resources/core.html" class="nav-list-link">Core Resources</a></li><li class="nav-list-item"><a href="/pulumi-lagoon-provider/resources/deploy-targets.html" class="nav-list-link">Deploy Targets</a></li><li class="nav-list-item"><a href="/pulumi-lagoon-provider/resources/notifications.html" class="nav-list-link">Notifications</a></li><li class="nav-list-item"><a href="/pulumi-lagoon-provider/resources/routes.html" class="nav-list-link">Routes</a></li><li class="nav-list-item"><a href="/pulumi-lagoon-provider/resources/tasks.html" class="nav-list-link">Tasks</a></li><li class="nav-list-item"><a href="/pulumi-lagoon-provider/resources/users.html" class="nav-list-link">Users</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Guides submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/pulumi-lagoon-provider/guides.html" class="nav-list-link">Guides</a><ul class="nav-list"><li class="nav-list-item"><a href="/pulumi-lagoon-provider/guides/multi-cluster.html" class="nav-list-link">Multi-Cluster Deployments</a></li><li class="nav-list-item"><a href="/pulumi-lagoon-provider/guides/drupal-project.html" class="nav-list-link">Managing a Drupal Project</a></li><li class="nav-list-item"><a href="/pulumi-lagoon-provider/guides/lagoon-cli-setup.html" class="nav-list-link">Lagoon CLI Setup</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Examples submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/pulumi-lagoon-provider/examples.html" class="nav-list-link">Examples</a><ul class="nav-list"><li class="nav-list-item"><a href="/pulumi-lagoon-provider/examples/simple-project.html" class="nav-list-link">Simple Project</a></li><li class="nav-list-item"><a href="/pulumi-lagoon-provider/examples/single-cluster.html" class="nav-list-link">Single Cluster</a></li><li class="nav-list-item"><a href="/pulumi-lagoon-provider/examples/multi-cluster.html" class="nav-list-link">Multi-Cluster</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Reference submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/pulumi-lagoon-provider/reference.html" class="nav-list-link">Reference</a><ul class="nav-list"><li class="nav-list-item"><a href="/pulumi-lagoon-provider/reference/provider-config.html" class="nav-list-link">Provider Configuration</a></li><li class="nav-list-item"><a href="/pulumi-lagoon-provider/reference/import-ids.html" class="nav-list-link">Import ID Reference</a></li><li class="nav-list-item"><a href="/pulumi-lagoon-provider/reference/lagoon-compatibility.html" class="nav-list-link">Lagoon Compatibility</a></li><li class="nav-list-item"><a href="/pulumi-lagoon-provider/reference/troubleshooting.html" class="nav-list-link">Troubleshooting</a></li></ul></li><li class="nav-list-item"><a href="/pulumi-lagoon-provider/contributing.html" class="nav-list-link">Contributing</a></li><li class="nav-list-item"><a href="/pulumi-lagoon-provider/release-notes.html" class="nav-list-link">Release Notes</a></li></ul>
  
</nav>


<div class="d-md-block d-none site-footer">
  
  
    This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.
  
  </div>
</header>

  
  <div class="main" id="top">
    <div id="main-header" class="main-header">
  
    

<div class="search" role="search">
  <div class="search-input-wrap">
    <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search Pulumi Lagoon Provider" autocomplete="off">
    <label for="search-input" class="search-label">
      <span class="sr-only">Search Pulumi Lagoon Provider</span>
      <svg viewBox="0 0 24 24" class="search-icon" aria-hidden="true"><use xlink:href="#svg-search"></use></svg>
    </label>
  </div>
  <div id="search-results" class="search-results"></div>
</div>

  
  
  
    <nav aria-label="Auxiliary" class="aux-nav">
  <ul class="aux-nav-list">
    
      <li class="aux-nav-list-item">
        <a href="https://github.com/tag1consulting/pulumi-lagoon-provider" class="site-button"
          
          target="_blank" rel="noopener noreferrer"
          
        >
          View on GitHub
        </a>
      </li>
    
  </ul>
</nav>

  
</div>

    <div class="main-content-wrap">
      
      <div id="main-content" class="main-content">
        <main>
          
            <h.site-nav ul li a {
  background-image: linear-gradient(-90deg, #b8d6e0 0%, rgba(184, 214, 224, 0.8) 80%, rgba(184, 214, 224, 0) 100%);
}

          

          
            
          
        </main>
        
<hr>
<footer>
  

  <div class="tag1-footer">
  Built by <a href="https://www.tag1.com/" target="_blank" rel="noopener">Tag1 Consulting</a>
</div>


  
    <div class="d-flex mt-2">
      
      
        <p class="text-small mb-0">
          <a href="https://github.com/tag1consulting/pulumi-lagoon-provider/tree/main/site/assets/css/just-the-docs-head-nav.css" id="edit-this-page">Edit this page on GitHub</a>
        </p>
      
    </div>
  <div class="d-md-none mt-4 fs-2">
    
    
      This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.
    
  </div>
</footer>

      </div>
    </div>
    
      

<div class="search-overlay"></div>

    
  </div>

  
</body>
</html>

