aws-ddk-core

<!doctype html> <html class="no-js"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="aws_ddk_core package" href="../core/aws_ddk_core.html" /><link rel="prev" title="AWS DDK API Documentation" href="../index.html" /> <meta name="generator" content="sphinx-4.4.0, furo 2022.01.02"/> <title>aws_ddk package - Contents</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=fade93df149f7c5fedb3ff897f799dc7d283b420" /> <style> body { --color-code-background: #f8f8f8; --color-code-foreground: black; --color-brand-primary: #504bab; --color-brand-content: #232F3E; } body[data-theme="dark"] { --color-code-background: #202020; --color-code-foreground: #d0d0d0; --color-brand-primary: #f1f3f3; --color-brand-content: #f1f3f3; } @media (prefers-color-scheme: dark) { body:not([data-theme="light"]) { --color-code-background: #202020; --color-code-foreground: #d0d0d0; --color-brand-primary: #f1f3f3; --color-brand-content: #f1f3f3; } } </style></head> <body> <script> document.body.dataset.theme = localStorage.getItem("theme") || "auto"; </script> <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> <symbol id="svg-toc" viewBox="0 0 24 24"> <title>Contents</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"> <path stroke="none" d="M0 0h24v24H0z" /> <line x1="4" y1="6" x2="20" y2="6" /> <line x1="10" y1="12" x2="20" y2="12" /> <line x1="6" y1="18" x2="20" y2="18" /> </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-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-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <symbol id="svg-sun" viewBox="0 0 24 24"> <title>Light mode</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun"> <circle cx="12" cy="12" r="5"></circle> <line x1="12" y1="1" x2="12" y2="3"></line> <line x1="12" y1="21" x2="12" y2="23"></line> <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> <line x1="1" y1="12" x2="3" y2="12"></line> <line x1="21" y1="12" x2="23" y2="12"></line> <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> </svg> </symbol> <symbol id="svg-moon" viewBox="0 0 24 24"> <title>Dark mode</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon"> <path stroke="none" d="M0 0h24v24H0z" fill="none" /> <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" /> </svg> </symbol> <symbol id="svg-sun-half" viewBox="0 0 24 24"> <title>Auto light/dark mode</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow"> <path stroke="none" d="M0 0h24v24H0z" fill="none"/> <circle cx="12" cy="12" r="9" /> <path d="M13 12h5" /> <path d="M13 15h4" /> <path d="M13 18h1" /> <path d="M13 9h4" /> <path d="M13 6h1" /> </svg> </symbol> </svg> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation"> <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"> <label class="overlay sidebar-overlay" for="__navigation"> <div class="visually-hidden">Hide navigation sidebar</div> </label> <label class="overlay toc-overlay" for="__toc"> <div class="visually-hidden">Hide table of contents sidebar</div> </label> <div class="page"> <header class="mobile-header"> <div class="header-left"> <label class="nav-overlay-icon" for="__navigation"> <div class="visually-hidden">Toggle site navigation sidebar</div> <i class="icon"><svg><use href="#svg-menu"></use></svg></i> </label> </div> <div class="header-center"> <a href="../index.html"><div class="brand">Contents</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> <button class="theme-toggle"> <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> </button> </div> <label class="toc-overlay-icon toc-header-icon" for="__toc"> <div class="visually-hidden">Toggle table of contents sidebar</div> <i class="icon"><svg><use href="#svg-toc"></use></svg></i> </label> </div> </header> <aside class="sidebar-drawer"> <div class="sidebar-container"> <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html"> <span class="sidebar-brand-text">Contents</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder=Search name="q" aria-label="Search"> <input type="hidden" name="check_keywords" value="yes"> <input type="hidden" name="area" value="default"> </form> <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree"> <p class="caption" role="heading"><span class="caption-text">Packages:</span></p> <ul class="current"> <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">aws_ddk package</a></li> <li class="toctree-l1 has-children"><a class="reference internal" href="../core/aws_ddk_core.html">aws_ddk_core package</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.base.BaseStack.html">aws_ddk_core.base.BaseStack</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.cicd.CICDPipelineStack.html">aws_ddk_core.cicd.CICDPipelineStack</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.config.Config.html">aws_ddk_core.config.Config</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.config.JSONConfigStrategy.html">aws_ddk_core.config.JSONConfigStrategy</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.pipelines.DataPipeline.html">aws_ddk_core.pipelines.DataPipeline</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.pipelines.DataStage.html">aws_ddk_core.pipelines.DataStage</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.resources.GlueFactory.html">aws_ddk_core.resources.GlueFactory</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.resources.KinesisFirehoseFactory.html">aws_ddk_core.resources.KinesisFirehoseFactory</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.resources.KinesisStreamsFactory.html">aws_ddk_core.resources.KinesisStreamsFactory</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.resources.KMSFactory.html">aws_ddk_core.resources.KMSFactory</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.resources.LambdaFactory.html">aws_ddk_core.resources.LambdaFactory</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.resources.S3Factory.html">aws_ddk_core.resources.S3Factory</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.resources.SQSFactory.html">aws_ddk_core.resources.SQSFactory</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.resources.StepFunctionsFactory.html">aws_ddk_core.resources.StepFunctionsFactory</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.stages.AppFlowIngestionStage.html">aws_ddk_core.stages.AppFlowIngestionStage</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.stages.AthenaSQLStage.html">aws_ddk_core.stages.AthenaSQLStage</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.stages.GlueTransformStage.html">aws_ddk_core.stages.GlueTransformStage</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.stages.KinesisToS3Stage.html">aws_ddk_core.stages.KinesisToS3Stage</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.stages.S3EventStage.html">aws_ddk_core.stages.S3EventStage</a></li> <li class="toctree-l2"><a class="reference internal" href="../core/stubs/aws_ddk_core.stages.SqsToLambdaStage.html">aws_ddk_core.stages.SqsToLambdaStage</a></li> </ul> </li> </ul> </div> </div> </div> </div> </aside> <div class="main"> <div class="content"> <div class="article-container"> <div class="content-icon-container"> <div class="theme-toggle-container theme-toggle-content"> <button class="theme-toggle"> <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg> <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> </button> </div> <label class="toc-overlay-icon toc-content-icon" for="__toc"> <div class="visually-hidden">Toggle table of contents sidebar</div> <i class="icon"><svg><use href="#svg-toc"></use></svg></i> </label> </div> <article role="main"> <section id="aws-ddk-package"> <h1>aws_ddk package<a class="headerlink" href="#aws-ddk-package" title="Permalink to this headline">¶</a></h1> <section id="ddk"> <h2>ddk<a class="headerlink" href="#ddk" title="Permalink to this headline">¶</a></h2> <p>AWS DDK CLI.</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>ddk <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>... </pre></div> </div> <p class="rubric">Options</p> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-version"> <span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ddk-version" title="Permalink to this definition">¶</a></dt> <dd><p>Show the version and exit.</p> </dd></dl> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-debug"> <span id="cmdoption-ddk-no-debug"></span><span class="sig-name descname"><span class="pre">--debug</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--no-debug</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ddk-debug" title="Permalink to this definition">¶</a></dt> <dd><p>Turn debug logging on/off.</p> <dl class="field-list simple"> <dt class="field-odd">Default</dt> <dd class="field-odd"><p>False</p> </dd> </dl> </dd></dl> <section id="ddk-bootstrap"> <h3>bootstrap<a class="headerlink" href="#ddk-bootstrap" title="Permalink to this headline">¶</a></h3> <p>Bootstrap the AWS account with DDK resources.</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>ddk bootstrap <span class="o">[</span>OPTIONS<span class="o">]</span> </pre></div> </div> <p class="rubric">Options</p> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-bootstrap-e"> <span id="cmdoption-ddk-bootstrap-environment"></span><span class="sig-name descname"><span class="pre">-e</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--environment</span></span><span class="sig-prename descclassname"> <span class="pre"><environment></span></span><a class="headerlink" href="#cmdoption-ddk-bootstrap-e" title="Permalink to this definition">¶</a></dt> <dd><p><strong>Required</strong> The id of the environment.</p> <dl class="field-list simple"> <dt class="field-odd">Default</dt> <dd class="field-odd"><p>dev</p> </dd> </dl> </dd></dl> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-bootstrap-p"> <span id="cmdoption-ddk-bootstrap-profile"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--profile</span></span><span class="sig-prename descclassname"> <span class="pre"><profile></span></span><a class="headerlink" href="#cmdoption-ddk-bootstrap-p" title="Permalink to this definition">¶</a></dt> <dd><p>Use a specific profile from your AWS credentials file.</p> </dd></dl> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-bootstrap-r"> <span id="cmdoption-ddk-bootstrap-region"></span><span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--region</span></span><span class="sig-prename descclassname"> <span class="pre"><region></span></span><a class="headerlink" href="#cmdoption-ddk-bootstrap-r" title="Permalink to this definition">¶</a></dt> <dd><p>AWS Region name (e.g. us-east-1). If None, it will be inferred.</p> </dd></dl> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-bootstrap-prefix"> <span class="sig-name descname"><span class="pre">--prefix</span></span><span class="sig-prename descclassname"> <span class="pre"><prefix></span></span><a class="headerlink" href="#cmdoption-ddk-bootstrap-prefix" title="Permalink to this definition">¶</a></dt> <dd><p>The prefix to resource names.</p> <dl class="field-list simple"> <dt class="field-odd">Default</dt> <dd class="field-odd"><p>ddk</p> </dd> </dl> </dd></dl> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-bootstrap-qualifier"> <span class="sig-name descname"><span class="pre">--qualifier</span></span><span class="sig-prename descclassname"> <span class="pre"><qualifier></span></span><a class="headerlink" href="#cmdoption-ddk-bootstrap-qualifier" title="Permalink to this definition">¶</a></dt> <dd><p>The CDK bootstrap qualifier.</p> </dd></dl> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-bootstrap-a"> <span id="cmdoption-ddk-bootstrap-trusted-accounts"></span><span class="sig-name descname"><span class="pre">-a</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--trusted-accounts</span></span><span class="sig-prename descclassname"> <span class="pre"><trusted_accounts></span></span><a class="headerlink" href="#cmdoption-ddk-bootstrap-a" title="Permalink to this definition">¶</a></dt> <dd><p>List of trusted AWS accounts to perform deployments (e.g. -a 111111111111 -a 222222222222).</p> </dd></dl> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-bootstrap-i"> <span id="cmdoption-ddk-bootstrap-iam-policies"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--iam-policies</span></span><span class="sig-prename descclassname"> <span class="pre"><iam_policies></span></span><a class="headerlink" href="#cmdoption-ddk-bootstrap-i" title="Permalink to this definition">¶</a></dt> <dd><p>List of IAM managed policy ARNs that should be attached to the role performing deployments. (e.g. -i arn1 -i arn2)</p> </dd></dl> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-bootstrap-permissions-boundary"> <span class="sig-name descname"><span class="pre">--permissions-boundary</span></span><span class="sig-prename descclassname"> <span class="pre"><permissions_boundary></span></span><a class="headerlink" href="#cmdoption-ddk-bootstrap-permissions-boundary" title="Permalink to this definition">¶</a></dt> <dd><p>IAM managed permissions boundary policy ARN that should be attached to the role performing deployments.</p> </dd></dl> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-bootstrap-t"> <span id="cmdoption-ddk-bootstrap-tags"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--tags</span></span><span class="sig-prename descclassname"> <span class="pre"><tags></span></span><a class="headerlink" href="#cmdoption-ddk-bootstrap-t" title="Permalink to this definition">¶</a></dt> <dd><p>List of tags to apply to the stack (e.g -t CostCenter 1984 -t Framework DDK).</p> </dd></dl> </section> <section id="ddk-create-repository"> <h3>create-repository<a class="headerlink" href="#ddk-create-repository" title="Permalink to this headline">¶</a></h3> <blockquote> <div><p>Create a code repository from the source system provider.</p> <p>NAME is the name of the repository.</p> </div></blockquote> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>ddk create-repository <span class="o">[</span>OPTIONS<span class="o">]</span> NAME </pre></div> </div> <p class="rubric">Options</p> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-create-repository-p"> <span id="cmdoption-ddk-create-repository-profile"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--profile</span></span><span class="sig-prename descclassname"> <span class="pre"><profile></span></span><a class="headerlink" href="#cmdoption-ddk-create-repository-p" title="Permalink to this definition">¶</a></dt> <dd><p>Use a specific profile from your AWS credentials file.</p> </dd></dl> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-create-repository-r"> <span id="cmdoption-ddk-create-repository-region"></span><span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--region</span></span><span class="sig-prename descclassname"> <span class="pre"><region></span></span><a class="headerlink" href="#cmdoption-ddk-create-repository-r" title="Permalink to this definition">¶</a></dt> <dd><p>AWS Region name (e.g. us-east-1). If None, it will be inferred.</p> </dd></dl> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-create-repository-d"> <span id="cmdoption-ddk-create-repository-description"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--description</span></span><span class="sig-prename descclassname"> <span class="pre"><description></span></span><a class="headerlink" href="#cmdoption-ddk-create-repository-d" title="Permalink to this definition">¶</a></dt> <dd><p>The description of the repository.</p> </dd></dl> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-create-repository-t"> <span id="cmdoption-ddk-create-repository-tags"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--tags</span></span><span class="sig-prename descclassname"> <span class="pre"><tags></span></span><a class="headerlink" href="#cmdoption-ddk-create-repository-t" title="Permalink to this definition">¶</a></dt> <dd><p>List of tags to apply to the repository (e.g -t CostCenter 1984 -t Framework DDK).</p> </dd></dl> <p class="rubric">Arguments</p> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-create-repository-arg-NAME"> <span id="cmdoption-ddk-create-repository-arg-name"></span><span class="sig-name descname"><span class="pre">NAME</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ddk-create-repository-arg-NAME" title="Permalink to this definition">¶</a></dt> <dd><p>Required argument</p> </dd></dl> </section> <section id="ddk-deploy"> <h3>deploy<a class="headerlink" href="#ddk-deploy" title="Permalink to this headline">¶</a></h3> <p>Deploy DDK stacks to AWS account.</p> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>ddk deploy <span class="o">[</span>OPTIONS<span class="o">]</span> </pre></div> </div> <p class="rubric">Options</p> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-deploy-p"> <span id="cmdoption-ddk-deploy-profile"></span><span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--profile</span></span><span class="sig-prename descclassname"> <span class="pre"><profile></span></span><a class="headerlink" href="#cmdoption-ddk-deploy-p" title="Permalink to this definition">¶</a></dt> <dd><p>Use a specific profile from your AWS credentials file.</p> </dd></dl> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-deploy-require-approval"> <span class="sig-name descname"><span class="pre">--require-approval</span></span><span class="sig-prename descclassname"> <span class="pre"><require_approval></span></span><a class="headerlink" href="#cmdoption-ddk-deploy-require-approval" title="Permalink to this definition">¶</a></dt> <dd><p>What security-sensitive changes need manual approval.</p> <dl class="field-list simple"> <dt class="field-odd">Options</dt> <dd class="field-odd"><p>never | any-change | broadening</p> </dd> </dl> </dd></dl> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-deploy-f"> <span id="cmdoption-ddk-deploy-force"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--force</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ddk-deploy-f" title="Permalink to this definition">¶</a></dt> <dd><p>Always deploy stack even if templates are identical.</p> </dd></dl> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-deploy-o"> <span id="cmdoption-ddk-deploy-output-dir"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output-dir</span></span><span class="sig-prename descclassname"> <span class="pre"><output_dir></span></span><a class="headerlink" href="#cmdoption-ddk-deploy-o" title="Permalink to this definition">¶</a></dt> <dd><p>Directory where cloud assembly is synthesized.</p> </dd></dl> </section> <section id="ddk-init"> <h3>init<a class="headerlink" href="#ddk-init" title="Permalink to this headline">¶</a></h3> <blockquote> <div><p>Create the local structure for a new AWS DDK Python project.</p> <p>NAME is the name of the project.</p> </div></blockquote> <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>ddk init <span class="o">[</span>OPTIONS<span class="o">]</span> NAME </pre></div> </div> <p class="rubric">Options</p> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-init-e"> <span id="cmdoption-ddk-init-environment"></span><span class="sig-name descname"><span class="pre">-e</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--environment</span></span><span class="sig-prename descclassname"> <span class="pre"><environment></span></span><a class="headerlink" href="#cmdoption-ddk-init-e" title="Permalink to this definition">¶</a></dt> <dd><p><strong>Required</strong> The id of the environment.</p> <dl class="field-list simple"> <dt class="field-odd">Default</dt> <dd class="field-odd"><p>dev</p> </dd> </dl> </dd></dl> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-init-t"> <span id="cmdoption-ddk-init-template"></span><span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--template</span></span><span class="sig-prename descclassname"> <span class="pre"><template></span></span><a class="headerlink" href="#cmdoption-ddk-init-t" title="Permalink to this definition">¶</a></dt> <dd><p>A directory containing a project template directory, or a URL to a git repository</p> </dd></dl> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-init-generate-only"> <span class="sig-name descname"><span class="pre">--generate-only</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ddk-init-generate-only" title="Permalink to this definition">¶</a></dt> <dd><p>If true, only generates project files, without setting up a git repo or a virtual environment</p> <dl class="field-list simple"> <dt class="field-odd">Default</dt> <dd class="field-odd"><p>False</p> </dd> </dl> </dd></dl> <p class="rubric">Arguments</p> <dl class="std option"> <dt class="sig sig-object std" id="cmdoption-ddk-init-arg-NAME"> <span id="cmdoption-ddk-init-arg-name"></span><span class="sig-name descname"><span class="pre">NAME</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ddk-init-arg-NAME" title="Permalink to this definition">¶</a></dt> <dd><p>Required argument</p> </dd></dl> </section> </section> </section> </article> </div> <footer> <div class="related-pages"> <a class="next-page" href="../core/aws_ddk_core.html"> <div class="page-info"> <div class="context"> <span>Next</span> </div> <div class="title">aws_ddk_core package</div> </div> <svg> <use href="#svg-arrow-right"></use> </svg> </a> <a class="prev-page" href="../index.html"> <svg> <use href="#svg-arrow-right"></use> </svg> <div class="page-info"> <div class="context"> <span>Previous</span> </div> <div class="title">Home</div> </div> </a> </div> <div class="related-information"> Copyright © 2022, AWS </div> </footer> </div> <aside class="toc-drawer"> <div class="toc-sticky toc-scroll"> <div class="toc-title-container"> <span class="toc-title"> Contents </span> </div> <div class="toc-tree-container"> <div class="toc-tree"> <ul> <li><a class="reference internal" href="#">aws_ddk package</a><ul> <li><a class="reference internal" href="#ddk">ddk</a><ul> <li><a class="reference internal" href="#ddk-bootstrap">bootstrap</a></li> <li><a class="reference internal" href="#ddk-create-repository">create-repository</a></li> <li><a class="reference internal" href="#ddk-deploy">deploy</a></li> <li><a class="reference internal" href="#ddk-init">init</a></li> </ul> </li> </ul> </li> </ul> </div> </div> </div> </aside> </div> </div><script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> <script src="../_static/jquery.js"></script> <script src="../_static/underscore.js"></script> <script src="../_static/doctools.js"></script> <script src="../_static/scripts/furo.js"></script> </body> </html>